Skip to content

Commit f95f028

Browse files
marcelklehrmarcelklehr
committed
Refactor: Add location to tree items
- Merge Overwrite and Slave into Unidirectional - Dry up syncProcess#reconcile
1 parent 63b696a commit f95f028

20 files changed

+1297
-1888
lines changed

‎package-lock.json

+660-1,015
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+9-9
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
"@babel/core": "^7.12.10",
2323
"@babel/preset-env": "^7.12.11",
2424
"@babel/preset-react": "^7.12.10",
25-
"@typescript-eslint/eslint-plugin": "^4.10.0",
26-
"@typescript-eslint/parser": "^4.10.0",
25+
"@typescript-eslint/eslint-plugin": "^4.13.0",
26+
"@typescript-eslint/parser": "^4.13.0",
2727
"all-contributors-cli": "^6.19.0",
2828
"babel-eslint": "^10.1.0",
2929
"babel-loader": "^8.2.2",
@@ -42,19 +42,19 @@
4242
"mocha": "^8.2.1",
4343
"node-fetch": "^2.6.1",
4444
"prettier": "^2.2.1",
45-
"sass": "^1.30.0",
45+
"sass": "^1.32.3",
4646
"sass-loader": "^8.0.2",
4747
"seedrandom": "^3.0.5",
4848
"selenium-webdriver": "^4.0.0-alpha.8",
49-
"ts-loader": "^8.0.12",
49+
"ts-loader": "^8.0.14",
5050
"typescript": "^4.1.3",
5151
"vuetify-loader": "^1.6.0",
52-
"webpack": "^4.44.2",
52+
"webpack": "^4.46.0",
5353
"webpack-cli": "^3.3.12",
5454
"webpack-merge": "^4.2.2"
5555
},
5656
"dependencies": {
57-
"async-lock": "^1.2.6",
57+
"async-lock": "^1.2.8",
5858
"async-parallel": "^1.2.3",
5959
"babel-polyfill": "^6.20.0",
6060
"batching-toposort": "^1.2.0",
@@ -68,13 +68,13 @@
6868
"eslint-plugin-promise": "^4.1.1",
6969
"eslint-plugin-standard": "^4.1.0",
7070
"eslint-plugin-vue": "^6.2.2",
71-
"humanize-duration": "^3.25.0",
71+
"humanize-duration": "^3.25.1",
7272
"hyperapp": "^1.2.10",
7373
"install": "^0.13.0",
7474
"js-base64": "^3.6.0",
7575
"lodash": "^4.17.20",
7676
"murmur2js": "^1.0.0",
77-
"npm": "^6.14.10",
77+
"npm": "^6.14.11",
7878
"p-queue": "^5.0.0",
7979
"picostyle": "^1.0.2",
8080
"punycode": "^2.1.1",
@@ -86,7 +86,7 @@
8686
"vue-router": "^3.4.9",
8787
"vue-template-compiler": "^2.6.11",
8888
"vuelidate": "^0.7.6",
89-
"vuetify": "^2.3.21",
89+
"vuetify": "^2.4.2",
9090
"vuex": "^3.6.0",
9191
"vuex-router-sync": "^5.0.0"
9292
}

‎src/lib/Account.js

+13-10
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,14 @@ import WebDavAdapter from './adapters/WebDav'
44
import FakeAdapter from './adapters/Fake'
55
import LocalTree from './LocalTree'
66
import DefaultSyncProcess from './strategies/Default'
7-
import SlaveSyncProcess from './strategies/Slave'
8-
import OverwriteSyncProcess from './strategies/Overwrite'
7+
import UnidirectionalSyncProcess from './strategies/Unidirectional'
98
import Logger from './Logger'
109
import browser from './browser-api'
1110
import AdapterFactory from './AdapterFactory'
1211
import MergeSyncProcess from './strategies/Merge'
1312
import LocalTabs from './LocalTabs'
14-
import { Folder } from './Tree'
15-
import MergeOverwrite from './strategies/OverwriteMerge'
16-
import MergeSlave from './strategies/SlaveMerge'
13+
import { Folder, ItemLocation } from './Tree'
14+
import UnidirectionalMergeSyncProcess from './strategies/UnidirectionalMerge'
1715

1816
// register Adapters
1917
AdapterFactory.register('nextcloud-folders', NextcloudFoldersAdapter)
@@ -174,25 +172,27 @@ export default class Account {
174172
mappings = await this.storage.getMappings()
175173
const cacheTree = localResource instanceof LocalTree ? await this.storage.getCache() : new Folder({title: '', id: 'tabs'})
176174

177-
let strategy
175+
let strategy, direction
178176
switch (this.getData().strategy) {
179177
case 'slave':
180178
if (!cacheTree.children.length) {
181179
Logger.log('Using "merge slave" strategy (no cache available)')
182-
strategy = MergeSlave
180+
strategy = UnidirectionalMergeSyncProcess
183181
} else {
184182
Logger.log('Using slave strategy')
185-
strategy = SlaveSyncProcess
183+
strategy = UnidirectionalSyncProcess
186184
}
185+
direction = ItemLocation.LOCAL
187186
break
188187
case 'overwrite':
189188
if (!cacheTree.children.length) {
190189
Logger.log('Using "merge overwrite" strategy (no cache available)')
191-
strategy = MergeOverwrite
190+
strategy = UnidirectionalMergeSyncProcess
192191
} else {
193192
Logger.log('Using "overwrite" strategy')
194-
strategy = OverwriteSyncProcess
193+
strategy = UnidirectionalSyncProcess
195194
}
195+
direction = ItemLocation.SERVER
196196
break
197197
default:
198198
if (!cacheTree.children.length) {
@@ -214,6 +214,9 @@ export default class Account {
214214
this.setData({ ...this.getData(), syncing: progress })
215215
}
216216
)
217+
if (direction) {
218+
this.syncing.setDirection(direction)
219+
}
217220
await this.syncing.sync()
218221

219222
// update cache

‎src/lib/Diff.ts

+67-63
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { Folder, TItem, ItemType } from './Tree'
2-
import { Mapping } from './Mappings'
1+
import { Folder, TItem, ItemType, TItemLocation, ItemLocation } from './Tree'
2+
import Mappings, { MappingSnapshot } from './Mappings'
33
import Ordering from './interfaces/Ordering'
44
import batchingToposort from 'batching-toposort'
55
import Logger from './Logger'
@@ -40,7 +40,7 @@ export interface ReorderAction {
4040
type: 'REORDER',
4141
payload: TItem,
4242
oldItem?: TItem,
43-
order?: Ordering,
43+
order: Ordering,
4444
oldOrder?: Ordering,
4545
}
4646

@@ -112,16 +112,6 @@ export default class Diff {
112112
}
113113
}
114114

115-
add(diff: Diff, types:TActionType[] = []):void {
116-
if (types.length === 0) {
117-
diff.getActions().forEach(action => this.commit({...action}))
118-
return
119-
}
120-
types.forEach(type =>
121-
diff.getActions(type).forEach(action => this.commit({...action}))
122-
)
123-
}
124-
125115
getActions(type?: TActionType):Action[] {
126116
if (type) {
127117
return this.actions[type].slice()
@@ -170,62 +160,76 @@ export default class Diff {
170160
/**
171161
* on ServerToLocal: don't map removals
172162
* on LocalToServer:
173-
* @param mappings
174-
* @param isLocalToServer
163+
* @param mappingsSnapshot
164+
* @param targetLocation
175165
* @param filter
176166
*/
177-
map(mappings:Mapping, isLocalToServer: boolean, filter: (Action)=>boolean = () => true):void {
167+
map(mappingsSnapshot:MappingSnapshot, targetLocation: TItemLocation, filter: (Action)=>boolean = () => true): Diff {
168+
const newDiff = new Diff
169+
178170
// Map payloads
179-
this.getActions().forEach(action => {
180-
if (action.type === ActionType.REMOVE && !isLocalToServer) {
181-
return
182-
}
171+
this.getActions()
172+
.map(a => a as Action)
173+
.forEach(action => {
174+
let newAction
175+
176+
if (!filter(action)) {
177+
newDiff.commit(action)
178+
return
179+
}
183180

184-
if (!filter(action)) {
185-
return
186-
}
181+
/* if (action.type === ActionType.REMOVE && targetLocation !== ItemLocation.SERVER) {
182+
newDiff.commit({...action})
183+
return
184+
} */
187185

188-
Logger.log('Mapping action ' + action.type + ' ' + (isLocalToServer ? 'LocalToServer' : 'ServerToLocal'), {...action})
186+
Logger.log('Mapping action ' + action.type + ' to ' + targetLocation, {...action})
189187

190-
if (action.type === ActionType.REORDER) {
191-
action.oldOrder = action.order
192-
action.order = action.order.slice().map(item => {
193-
return {...item, id: mappings[item.type ][item.id]}
194-
})
195-
}
196-
197-
// needed because we set oldItem in the first section, so we wouldn't know anymore if it was set before
198-
const oldItem = action.oldItem
199-
200-
// We have two sections here, because we want to be able to take IDs from oldItem even for moves
201-
// but not parentIds (which do change during moves, obviously)
202-
203-
if (oldItem && !isLocalToServer) {
204-
const oldId = action.oldItem.id
205-
const newId = action.payload.id
206-
action.oldItem = action.oldItem.clone()
207-
action.payload = action.payload.clone()
208-
action.payload.id = oldId
209-
action.oldItem.id = newId
210-
} else {
211-
const newPayload = action.payload.clone()
212-
newPayload.id = mappings[newPayload.type][newPayload.id]
213-
action.oldItem = action.payload.clone()
214-
action.payload = newPayload
215-
}
216-
217-
if (oldItem && !isLocalToServer && action.type !== ActionType.MOVE) {
218-
const oldParent = action.oldItem.parentId
219-
const newParent = action.payload.parentId
220-
action.payload.parentId = oldParent
221-
action.oldItem.parentId = newParent
222-
} else {
223-
if (typeof action.payload.parentId !== 'undefined' && typeof mappings.folder[action.payload.parentId] === 'undefined') {
224-
throw new Error('Cannot map parentId:' + action.payload.parentId)
188+
// needed because we set oldItem in the first section, so we wouldn't know anymore if it was set before
189+
const oldItem = action.oldItem
190+
191+
// We have two sections here, because we want to be able to take IDs from oldItem even for moves
192+
// but not parentIds (which do change during moves, obviously)
193+
194+
if (oldItem && targetLocation !== ItemLocation.SERVER) {
195+
const oldId = action.oldItem.id
196+
const newId = action.payload.id
197+
newAction = {
198+
...action,
199+
payload: action.payload.clone(false, targetLocation),
200+
oldItem: action.oldItem.clone(false)
201+
}
202+
newAction.payload.id = oldId
203+
newAction.oldItem.id = newId
204+
} else {
205+
newAction = {
206+
...action,
207+
payload: action.payload.clone(false, targetLocation),
208+
oldItem: action.payload.clone(false)
209+
}
210+
newAction.payload.id = Mappings.mapId(mappingsSnapshot, action.payload, targetLocation)
211+
}
212+
213+
if (oldItem && targetLocation !== ItemLocation.SERVER && action.type !== ActionType.MOVE) {
214+
newAction.payload.parentId = action.oldItem.parentId
215+
newAction.oldItem.parentId = action.payload.parentId
216+
} else {
217+
newAction.oldItem.parentId = action.payload.parentId
218+
newAction.payload.parentId = Mappings.mapParentId(mappingsSnapshot, action.payload, targetLocation)
219+
if (typeof newAction.payload.parentId === 'undefined' && typeof action.payload.parentId !== 'undefined') {
220+
throw new Error('Failed to map parentId: ' + action.payload.parentId)
221+
}
222+
}
223+
224+
if (action.type === ActionType.REORDER) {
225+
newAction.oldOrder = action.order
226+
newAction.order = action.order.slice().map(item => {
227+
return {...item, id: mappingsSnapshot[(targetLocation === ItemLocation.LOCAL ? ItemLocation.SERVER : ItemLocation.LOCAL) + 'To' + targetLocation][item.type][item.id]}
228+
})
225229
}
226-
action.oldItem.parentId = action.payload.parentId
227-
action.payload.parentId = mappings.folder[action.payload.parentId]
228-
}
229-
})
230+
231+
newDiff.commit(newAction)
232+
})
233+
return newDiff
230234
}
231235
}

‎src/lib/LocalTabs.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import browser from './browser-api'
22
import Logger from './Logger'
33
import { IResource } from './interfaces/Resource'
44
import PQueue from 'p-queue'
5-
import { Bookmark, Folder } from './Tree'
5+
import { Bookmark, Folder, ItemLocation } from './Tree'
66
import Ordering from './interfaces/Ordering'
77
import uniq from 'lodash/uniq'
88

@@ -23,16 +23,19 @@ export default class LocalTabs implements IResource {
2323
return new Folder({
2424
title: '',
2525
id: 'tabs',
26+
location: ItemLocation.LOCAL,
2627
children: uniq(tabs.map(t => t.windowId)).map(windowId => {
2728
return new Folder({
2829
title: '',
2930
id: windowId,
3031
parentId: 'tabs',
32+
location: ItemLocation.LOCAL,
3133
children: tabs.filter(t => t.windowId === windowId).sort(t => t.index).map(t => new Bookmark({
3234
id: t.id,
3335
title: '',
3436
url: t.url,
3537
parentId: windowId,
38+
location: ItemLocation.LOCAL,
3639
}))
3740
})
3841
})

‎src/lib/LocalTree.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Tree from './Tree'
44
import { IResource } from './interfaces/Resource'
55
import PQueue from 'p-queue'
66
import Account from './Account'
7-
import { Bookmark, Folder } from './Tree'
7+
import { Bookmark, Folder, ItemLocation } from './Tree'
88
import Ordering from './interfaces/Ordering'
99

1010
export default class LocalTree implements IResource {
@@ -62,6 +62,7 @@ export default class LocalTree implements IResource {
6262
}
6363
if (node.children) {
6464
const folder = new Tree.Folder({
65+
location: ItemLocation.LOCAL,
6566
id: node.id,
6667
parentId,
6768
title: parentId ? overrideTitle || node.title : undefined,
@@ -73,6 +74,7 @@ export default class LocalTree implements IResource {
7374
return folder
7475
} else {
7576
return new Tree.Bookmark({
77+
location: ItemLocation.LOCAL,
7678
id: node.id,
7779
parentId,
7880
title: node.title,

‎src/lib/Mappings.ts

+25-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { TItemType } from './Tree'
1+
import { TItem, TItemLocation, TItemType } from './Tree'
22

33
type InternalItemTypeMapping = { LocalToServer: Record<string, string>, ServerToLocal: Record<string, string> }
44

@@ -101,4 +101,28 @@ export default class Mappings {
101101
}
102102
}
103103
}
104+
105+
static mapId(mappingsSnapshot:MappingSnapshot, item: TItem, target: TItemLocation) : string|number {
106+
if (item.location === target) {
107+
return item.id
108+
}
109+
return mappingsSnapshot[item.location + 'To' + target][item.type][item.id]
110+
}
111+
112+
static mapParentId(mappingsSnapshot:MappingSnapshot, item: TItem, target: TItemLocation) : string|number {
113+
if (item.location === target) {
114+
return item.parentId
115+
}
116+
return mappingsSnapshot[item.location + 'To' + target].folder[item.parentId]
117+
}
118+
119+
static mappable(mappingsSnapshot: MappingSnapshot, item1: TItem, item2: TItem) : boolean {
120+
if (Mappings.mapId(mappingsSnapshot, item1, item2.location) === item2.id) {
121+
return true
122+
}
123+
if (Mappings.mapId(mappingsSnapshot, item2, item1.location) === item1.id) {
124+
return true
125+
}
126+
return false
127+
}
104128
}

0 commit comments

Comments
 (0)