mirror of
https://github.com/overleaf/overleaf.git
synced 2024-09-23 02:55:13 -04:00
fb6746a887
On history react, when the initial screen has been loaded, no default pathname is selected. This PR adds logic for selecting default pathname and getting the diff for that pathname. Also, add some other small changes, the notable ones are: - Refactor some type naming and file structure related to the history file tree - Refactor file tree selectable hooks (merge selectable context provider into the main provider) - prevent clicking on the same file tree item by checking the current pathname before invoking the handler function GitOrigin-RevId: 73c36e9ed918ae3d92dd47108fbe8542a7571bdd
777 lines
18 KiB
TypeScript
777 lines
18 KiB
TypeScript
import { expect } from 'chai'
|
|
import type { HistoryContextValue } from '../../../../../frontend/js/features/history/context/types/history-context-value'
|
|
import type { FileDiff } from '../../../../../frontend/js/features/history/services/types/file'
|
|
import { autoSelectFile } from '../../../../../frontend/js/features/history/utils/auto-select-file'
|
|
import type { User } from '../../../../../frontend/js/features/history/services/types/shared'
|
|
|
|
describe('autoSelectFile', function () {
|
|
const historyUsers: User[] = [
|
|
{
|
|
first_name: 'first_name',
|
|
last_name: 'last_name',
|
|
email: 'email@overleaf.com',
|
|
id: '6266xb6b7a366460a66186xx',
|
|
},
|
|
]
|
|
|
|
const emptySelection: HistoryContextValue['selection'] = {
|
|
docs: {},
|
|
pathname: null,
|
|
range: {
|
|
fromV: null,
|
|
toV: null,
|
|
},
|
|
hoveredRange: {
|
|
fromV: null,
|
|
toV: null,
|
|
},
|
|
diff: null,
|
|
files: [],
|
|
file: null,
|
|
}
|
|
|
|
describe('for `point_in_time` view mode', function () {
|
|
const viewMode: HistoryContextValue['viewMode'] = 'point_in_time'
|
|
|
|
it('return the file with `edited` as the last operation', function () {
|
|
const files: FileDiff[] = [
|
|
{
|
|
pathname: 'main.tex',
|
|
},
|
|
{
|
|
pathname: 'sample.bib',
|
|
},
|
|
{
|
|
pathname: 'frog.jpg',
|
|
},
|
|
{
|
|
pathname: 'newfile5.tex',
|
|
},
|
|
{
|
|
pathname: 'newfolder1/newfolder2/newfile2.tex',
|
|
},
|
|
{
|
|
pathname: 'newfolder1/newfile10.tex',
|
|
operation: 'edited',
|
|
},
|
|
]
|
|
|
|
const selection: HistoryContextValue['selection'] = {
|
|
...emptySelection,
|
|
range: {
|
|
fromV: 26,
|
|
toV: 26,
|
|
},
|
|
}
|
|
|
|
const updates: HistoryContextValue['updates'] = [
|
|
{
|
|
fromV: 25,
|
|
toV: 26,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680888731881,
|
|
end_ts: 1680888731881,
|
|
},
|
|
labels: [],
|
|
pathnames: ['newfolder1/newfile10.tex'],
|
|
project_ops: [],
|
|
},
|
|
{
|
|
fromV: 23,
|
|
toV: 25,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680888725098,
|
|
end_ts: 1680888729123,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
rename: {
|
|
pathname: 'newfolder1/newfile3.tex',
|
|
newPathname: 'newfolder1/newfile10.tex',
|
|
},
|
|
atV: 24,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'newfile3.tex',
|
|
newPathname: 'newfolder1/newfile3.tex',
|
|
},
|
|
atV: 23,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
fromV: 22,
|
|
toV: 23,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680888721015,
|
|
end_ts: 1680888721015,
|
|
},
|
|
labels: [],
|
|
pathnames: ['newfile3.tex'],
|
|
project_ops: [],
|
|
},
|
|
{
|
|
fromV: 19,
|
|
toV: 22,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680888715364,
|
|
end_ts: 1680888718726,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
rename: {
|
|
pathname: 'newfolder1/newfolder2/newfile3.tex',
|
|
newPathname: 'newfile3.tex',
|
|
},
|
|
atV: 21,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'newfolder1/newfile2.tex',
|
|
newPathname: 'newfolder1/newfolder2/newfile2.tex',
|
|
},
|
|
atV: 20,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'newfolder1/newfile5.tex',
|
|
newPathname: 'newfile5.tex',
|
|
},
|
|
atV: 19,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
fromV: 16,
|
|
toV: 19,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680888705042,
|
|
end_ts: 1680888712662,
|
|
},
|
|
labels: [],
|
|
pathnames: [
|
|
'main.tex',
|
|
'newfolder1/newfile2.tex',
|
|
'newfolder1/newfile5.tex',
|
|
],
|
|
project_ops: [],
|
|
},
|
|
{
|
|
fromV: 0,
|
|
toV: 16,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680888456499,
|
|
end_ts: 1680888640774,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
add: {
|
|
pathname: 'newfolder1/newfile2.tex',
|
|
},
|
|
atV: 15,
|
|
},
|
|
{
|
|
remove: {
|
|
pathname: 'newfile2.tex',
|
|
},
|
|
atV: 14,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'newfolder1/frog.jpg',
|
|
newPathname: 'frog.jpg',
|
|
},
|
|
atV: 13,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'newfolder1/newfile2.tex',
|
|
newPathname: 'newfile2.tex',
|
|
},
|
|
atV: 12,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'newfile5.tex',
|
|
newPathname: 'newfolder1/newfile5.tex',
|
|
},
|
|
atV: 11,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'newfile4.tex',
|
|
newPathname: 'newfile5.tex',
|
|
},
|
|
atV: 10,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'newfile4.tex',
|
|
},
|
|
atV: 9,
|
|
},
|
|
{
|
|
remove: {
|
|
pathname: 'newfolder1/newfolder2/newfile1.tex',
|
|
},
|
|
atV: 8,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'frog.jpg',
|
|
newPathname: 'newfolder1/frog.jpg',
|
|
},
|
|
atV: 7,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'newfolder1/newfolder2/newfile3.tex',
|
|
},
|
|
atV: 6,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'newfolder1/newfile2.tex',
|
|
},
|
|
atV: 5,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'newfolder1/newfile1.tex',
|
|
newPathname: 'newfolder1/newfolder2/newfile1.tex',
|
|
},
|
|
atV: 4,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'newfolder1/newfile1.tex',
|
|
},
|
|
atV: 3,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'frog.jpg',
|
|
},
|
|
atV: 2,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'sample.bib',
|
|
},
|
|
atV: 1,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'main.tex',
|
|
},
|
|
atV: 0,
|
|
},
|
|
],
|
|
},
|
|
]
|
|
|
|
const defaultSelection = autoSelectFile(
|
|
files,
|
|
selection,
|
|
viewMode,
|
|
updates
|
|
)
|
|
|
|
expect(defaultSelection.pathname).to.equal('newfolder1/newfile10.tex')
|
|
})
|
|
it('return file with `added` operation on highest `atV` value if no other operation is available on the latest `updates` entry', function () {
|
|
const files: FileDiff[] = [
|
|
{
|
|
pathname: 'main.tex',
|
|
operation: 'added',
|
|
},
|
|
{
|
|
pathname: 'sample.bib',
|
|
operation: 'added',
|
|
},
|
|
{
|
|
pathname: 'frog.jpg',
|
|
operation: 'added',
|
|
},
|
|
{
|
|
pathname: 'newfile1.tex',
|
|
operation: 'added',
|
|
},
|
|
]
|
|
|
|
const selection: HistoryContextValue['selection'] = {
|
|
...emptySelection,
|
|
range: {
|
|
fromV: 4,
|
|
toV: 4,
|
|
},
|
|
}
|
|
|
|
const updates: HistoryContextValue['updates'] = [
|
|
{
|
|
fromV: 0,
|
|
toV: 4,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680861468999,
|
|
end_ts: 1680861491861,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
add: {
|
|
pathname: 'newfile1.tex',
|
|
},
|
|
atV: 3,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'frog.jpg',
|
|
},
|
|
atV: 2,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'sample.bib',
|
|
},
|
|
atV: 1,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'main.tex',
|
|
},
|
|
atV: 0,
|
|
},
|
|
],
|
|
},
|
|
]
|
|
|
|
const defaultSelection = autoSelectFile(
|
|
files,
|
|
selection,
|
|
viewMode,
|
|
updates
|
|
)
|
|
|
|
expect(defaultSelection.pathname).to.equal('newfile1.tex')
|
|
})
|
|
|
|
it('return the last non-`removed` operation with the highest `atV` value', function () {
|
|
const files: FileDiff[] = [
|
|
{
|
|
pathname: 'main.tex',
|
|
operation: 'removed',
|
|
deletedAtV: 6,
|
|
},
|
|
{
|
|
pathname: 'sample.bib',
|
|
},
|
|
{
|
|
pathname: 'main2.tex',
|
|
operation: 'added',
|
|
},
|
|
{
|
|
pathname: 'main3.tex',
|
|
operation: 'added',
|
|
},
|
|
]
|
|
|
|
const selection: HistoryContextValue['selection'] = {
|
|
...emptySelection,
|
|
range: {
|
|
fromV: 7,
|
|
toV: 7,
|
|
},
|
|
}
|
|
|
|
const updates: HistoryContextValue['updates'] = [
|
|
{
|
|
fromV: 4,
|
|
toV: 7,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680874742389,
|
|
end_ts: 1680874755552,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
remove: {
|
|
pathname: 'main.tex',
|
|
},
|
|
atV: 6,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'main3.tex',
|
|
},
|
|
atV: 5,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'main2.tex',
|
|
},
|
|
atV: 4,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
fromV: 0,
|
|
toV: 4,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680861975947,
|
|
end_ts: 1680861988442,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
remove: {
|
|
pathname: 'frog.jpg',
|
|
},
|
|
atV: 3,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'frog.jpg',
|
|
},
|
|
atV: 2,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'sample.bib',
|
|
},
|
|
atV: 1,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'main.tex',
|
|
},
|
|
atV: 0,
|
|
},
|
|
],
|
|
},
|
|
]
|
|
|
|
const defaultSelection = autoSelectFile(
|
|
files,
|
|
selection,
|
|
viewMode,
|
|
updates
|
|
)
|
|
|
|
expect(defaultSelection.pathname).to.equal('main3.tex')
|
|
})
|
|
|
|
it('if `removed` is the last operation, and no other operation is available on the latest `updates` entry, with `main.tex` available as a file name somewhere in the file tree, return `main.tex`', function () {
|
|
const files: FileDiff[] = [
|
|
{
|
|
pathname: 'main.tex',
|
|
},
|
|
{
|
|
pathname: 'sample.bib',
|
|
},
|
|
{
|
|
pathname: 'frog.jpg',
|
|
},
|
|
{
|
|
pathname: 'newfolder/maybewillbedeleted.tex',
|
|
newPathname: 'newfolder2/maybewillbedeleted.tex',
|
|
operation: 'removed',
|
|
deletedAtV: 10,
|
|
},
|
|
]
|
|
|
|
const selection: HistoryContextValue['selection'] = {
|
|
...emptySelection,
|
|
range: {
|
|
fromV: 11,
|
|
toV: 11,
|
|
},
|
|
}
|
|
|
|
const updates: HistoryContextValue['updates'] = [
|
|
{
|
|
fromV: 9,
|
|
toV: 11,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680904414419,
|
|
end_ts: 1680904417538,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
remove: {
|
|
pathname: 'newfolder2/maybewillbedeleted.tex',
|
|
},
|
|
atV: 10,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'newfolder/maybewillbedeleted.tex',
|
|
newPathname: 'newfolder2/maybewillbedeleted.tex',
|
|
},
|
|
atV: 9,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
fromV: 8,
|
|
toV: 9,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680904410333,
|
|
end_ts: 1680904410333,
|
|
},
|
|
labels: [],
|
|
pathnames: ['newfolder/maybewillbedeleted.tex'],
|
|
project_ops: [],
|
|
},
|
|
{
|
|
fromV: 7,
|
|
toV: 8,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680904407448,
|
|
end_ts: 1680904407448,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
rename: {
|
|
pathname: 'newfolder/tobedeleted.tex',
|
|
newPathname: 'newfolder/maybewillbedeleted.tex',
|
|
},
|
|
atV: 7,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
fromV: 6,
|
|
toV: 7,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680904400839,
|
|
end_ts: 1680904400839,
|
|
},
|
|
labels: [],
|
|
pathnames: ['newfolder/tobedeleted.tex'],
|
|
project_ops: [],
|
|
},
|
|
{
|
|
fromV: 5,
|
|
toV: 6,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680904398544,
|
|
end_ts: 1680904398544,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
rename: {
|
|
pathname: 'tobedeleted.tex',
|
|
newPathname: 'newfolder/tobedeleted.tex',
|
|
},
|
|
atV: 5,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
fromV: 4,
|
|
toV: 5,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680904389891,
|
|
end_ts: 1680904389891,
|
|
},
|
|
labels: [],
|
|
pathnames: ['tobedeleted.tex'],
|
|
project_ops: [],
|
|
},
|
|
{
|
|
fromV: 0,
|
|
toV: 4,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680904363778,
|
|
end_ts: 1680904385308,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
add: {
|
|
pathname: 'tobedeleted.tex',
|
|
},
|
|
atV: 3,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'frog.jpg',
|
|
},
|
|
atV: 2,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'sample.bib',
|
|
},
|
|
atV: 1,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'main.tex',
|
|
},
|
|
atV: 0,
|
|
},
|
|
],
|
|
},
|
|
]
|
|
|
|
const defaultSelection = autoSelectFile(
|
|
files,
|
|
selection,
|
|
viewMode,
|
|
updates
|
|
)
|
|
|
|
expect(defaultSelection.pathname).to.equal('main.tex')
|
|
})
|
|
|
|
it('if `removed` is the last operation, and no other operation is available on the latest `updates` entry, with `main.tex` is not available as a file name somewhere in the file tree, return any tex file based on ascending alphabetical order', function () {
|
|
const files: FileDiff[] = [
|
|
{
|
|
pathname: 'certainly_not_main.tex',
|
|
},
|
|
{
|
|
pathname: 'newfile.tex',
|
|
},
|
|
{
|
|
pathname: 'file2.tex',
|
|
},
|
|
]
|
|
|
|
const selection: HistoryContextValue['selection'] = {
|
|
...emptySelection,
|
|
range: {
|
|
fromV: 8,
|
|
toV: 8,
|
|
},
|
|
}
|
|
|
|
const updates: HistoryContextValue['updates'] = [
|
|
{
|
|
fromV: 7,
|
|
toV: 8,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680905536168,
|
|
end_ts: 1680905536168,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
remove: {
|
|
pathname: 'newfolder/tobedeleted.txt',
|
|
},
|
|
atV: 7,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
fromV: 6,
|
|
toV: 7,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680905531816,
|
|
end_ts: 1680905531816,
|
|
},
|
|
labels: [],
|
|
pathnames: ['newfolder/tobedeleted.txt'],
|
|
project_ops: [],
|
|
},
|
|
{
|
|
fromV: 0,
|
|
toV: 6,
|
|
meta: {
|
|
users: historyUsers,
|
|
start_ts: 1680905492130,
|
|
end_ts: 1680905529186,
|
|
},
|
|
labels: [],
|
|
pathnames: [],
|
|
project_ops: [
|
|
{
|
|
rename: {
|
|
pathname: 'tobedeleted.txt',
|
|
newPathname: 'newfolder/tobedeleted.txt',
|
|
},
|
|
atV: 5,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'file2.tex',
|
|
},
|
|
atV: 4,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'newfile.tex',
|
|
},
|
|
atV: 3,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'tobedeleted.txt',
|
|
},
|
|
atV: 2,
|
|
},
|
|
{
|
|
rename: {
|
|
pathname: 'main.tex',
|
|
newPathname: 'certainly_not_main.tex',
|
|
},
|
|
atV: 1,
|
|
},
|
|
{
|
|
add: {
|
|
pathname: 'main.tex',
|
|
},
|
|
atV: 0,
|
|
},
|
|
],
|
|
},
|
|
]
|
|
|
|
const defaultSelection = autoSelectFile(
|
|
files,
|
|
selection,
|
|
viewMode,
|
|
updates
|
|
)
|
|
|
|
expect(defaultSelection.pathname).to.equal('certainly_not_main.tex')
|
|
})
|
|
})
|
|
})
|