core-3nweb-client-lib 0.25.6 → 0.27.0

package/build/lib-client/3nstorage/xsp-fs/folder-node.js

@@ -24,19 +24,22 @@ exports.FolderNode = void 0;
 const buffer_utils_1 = require("../../../lib-common/buffer-utils");
 const file_1 = require("../../../lib-common/exceptions/file");
 const error_1 = require("../../../lib-common/exceptions/error");
+const common_1 = require("./common");
 const node_in_fs_1 = require("./node-in-fs");
 const file_node_1 = require("./file-node");
 const link_node_1 = require("./link-node");
-const processes_1 = require("../../../lib-common/processes");
+const exceptions_1 = require("../exceptions");
+const deferred_1 = require("../../../lib-common/processes/deferred");
 const json_utils_1 = require("../../../lib-common/json-utils");
 const xsp_files_1 = require("xsp-files");
 const random = require("../../../lib-common/random-node");
 const folder_node_serialization_1 = require("./folder-node-serialization");
 const attrs_1 = require("./attrs");
 const node_persistence_1 = require("./node-persistence");
+const assert_1 = require("../../../lib-common/assert");
 function jsonToInfoAndAttrs(json) {
     const folderInfo = {
-        nodes: json_utils_1.copy(json.nodes)
+        nodes: (0, json_utils_1.copy)(json.nodes)
     };
     for (const node of Object.values(folderInfo.nodes)) {
         node.key = buffer_utils_1.base64.open(node.key);
@@ -51,34 +54,38 @@ class FolderPersistance extends node_persistence_1.NodePersistance {
         Object.seal(this);
     }
     async write(folderInfo, version, attrs, xattrs) {
-        const bytes = folder_node_serialization_1.serializeFolderInfo(folderInfo);
+        const bytes = (0, folder_node_serialization_1.serializeFolderInfo)(folderInfo);
         return this.writeWhole(bytes, version, attrs, xattrs);
     }
     async read(src) {
         const { content, xattrs, attrs } = await this.readAll(src);
-        const folderInfo = folder_node_serialization_1.parseFolderInfo(content);
+        const folderInfo = (0, folder_node_serialization_1.parseFolderInfo)(content);
         return { folderInfo, xattrs, attrs: attrs_1.CommonAttrs.fromAttrs(attrs) };
     }
 }
 Object.freeze(FolderPersistance.prototype);
 Object.freeze(FolderPersistance);
+let nextMoveLabel = Math.floor(Math.random() / 2 * Number.MAX_SAFE_INTEGER);
+function getMoveLabel() {
+    const label = nextMoveLabel;
+    if (nextMoveLabel >= Number.MAX_SAFE_INTEGER) {
+        nextMoveLabel = 0;
+    }
+    else {
+        nextMoveLabel += 1;
+    }
+    return label;
+}
 class FolderNode extends node_in_fs_1.NodeInFS {
     constructor(storage, name, objId, zNonce, version, parentId, key, setNewAttrs) {
         super(storage, 'folder', name, objId, version, parentId);
         this.currentState = { nodes: {} };
-        if (!name && (objId || parentId)) {
-            throw new Error("Root folder must " +
-                "have both objId and parent as nulls.");
+        if (name === undefined) {
+            (0, assert_1.assert)(!objId && !parentId, `Root folder must have both objId and parent as nulls.`);
         }
         else if (objId === null) {
             new Error("Missing objId for non-root folder");
         }
-        if (!zNonce) {
-            if (!objId) {
-                throw new Error(`Missing object id for folder, when zeroth nonce is not given`);
-            }
-            zNonce = xsp_files_1.idToHeaderNonce(objId);
-        }
         this.crypto = new FolderPersistance(zNonce, key, storage.cryptor);
         if (setNewAttrs) {
             this.attrs = attrs_1.CommonAttrs.makeForTimeNow();
@@ -93,20 +100,21 @@ class FolderNode extends node_in_fs_1.NodeInFS {
         return rf;
     }
     static async rootFromObjBytes(storage, name, objId, src, key) {
-        let zNonce = undefined;
-        if (!objId) {
-            const header = await src.readHeader();
-            zNonce = xsp_files_1.calculateNonce(header.subarray(0, xsp_files_1.NONCE_LENGTH), -src.version);
-        }
-        const rf = await FolderNode.readNodeFromObjBytes(storage, name, objId, zNonce, src, key);
+        const rf = await FolderNode.readNodeFromObjBytes(storage, name, objId, src, key);
         rf.storage.nodes.set(rf);
         return rf;
     }
-    static async readNodeFromObjBytes(storage, name, objId, zNonce, src, key) {
+    static async readNodeFromObjBytes(storage, name, objId, src, key) {
+        let zNonce;
+        if (objId) {
+            zNonce = (0, xsp_files_1.idToHeaderNonce)(objId);
+        }
+        else {
+            const header = await src.readHeader();
+            zNonce = (0, xsp_files_1.calculateNonce)(header.subarray(0, xsp_files_1.NONCE_LENGTH), -src.version);
+        }
         const rf = new FolderNode(storage, name, objId, zNonce, src.version, undefined, key, false);
-        const { folderInfo, attrs, xattrs } = await rf.crypto.read(src);
-        rf.currentState = folderInfo;
-        rf.setUpdatedParams(src.version, attrs, xattrs);
+        await rf.setCurrentStateFrom(src);
         return rf;
     }
     static async rootFromLinkParams(storage, params) {
@@ -121,36 +129,94 @@ class FolderNode extends node_in_fs_1.NodeInFS {
             existingNode.crypto.compareKey(params.fKey);
             return existingNode;
         }
-        const src = await storage.getObj(params.objId);
+        const src = await storage.getObjSrc(params.objId);
         const key = buffer_utils_1.base64.open(params.fKey);
         return FolderNode.rootFromObjBytes(storage, params.folderName, params.objId, src, key);
     }
     static rootFromJSON(storage, name, folderJson) {
-        const rf = new FolderNode(storage, name, 'readonly-root', EMPTY_ARR, 0, undefined, undefined, false);
+        const rf = new FolderNode(storage, name, 'readonly-root', EMPTY_ARR, 0, undefined, EMPTY_ARR, false);
         const { folderInfo, attrs, xattrs } = jsonToInfoAndAttrs(folderJson);
         rf.currentState = folderInfo;
         rf.setUpdatedParams(0, attrs, xattrs);
         return rf;
     }
-    list() {
-        const names = Object.keys(this.currentState.nodes);
-        const lst = new Array(names.length);
-        for (let i = 0; i < names.length; i += 1) {
-            const entity = this.currentState.nodes[names[i]];
-            const info = { name: entity.name };
-            if (entity.isFolder) {
-                info.isFolder = true;
-            }
-            else if (entity.isFile) {
-                info.isFile = true;
+    async setCurrentStateFrom(src) {
+        const { folderInfo, attrs, xattrs } = await this.crypto.read(src);
+        this.currentState = folderInfo;
+        this.setUpdatedParams(src.version, attrs, xattrs);
+    }
+    async adoptRemote(opts) {
+        const objsToRm = await this.doChange(true, async () => {
+            try {
+                const adopted = await this.syncedStorage().adoptRemote(this.objId, opts);
+                if (!adopted) {
+                    return;
+                }
+                const src = await this.storage.getObjSrc(this.objId, adopted);
+                const originalState = this.currentState;
+                await this.setCurrentStateFrom(src);
+                const newState = this.currentState;
+                const { renamedNodes, addedNodes, removedNodes } = identifyChanges(originalState.nodes, newState.nodes);
+                for (const node of removedNodes) {
+                    const event = {
+                        type: 'entry-removal',
+                        src: 'sync',
+                        path: this.name,
+                        newVersion: this.version,
+                        name: node.name
+                    };
+                    this.broadcastEvent(event, false, node.objId);
+                }
+                for (const node of addedNodes) {
+                    const event = {
+                        type: 'entry-addition',
+                        src: 'sync',
+                        entry: nodeInfoToListingEntry(node),
+                        path: this.name,
+                        newVersion: this.version
+                    };
+                    this.broadcastEvent(event, false, node.objId);
+                }
+                for (const { objId, oldName, newName } of renamedNodes) {
+                    const event = {
+                        type: 'entry-renaming',
+                        src: 'sync',
+                        oldName,
+                        newName,
+                        path: this.name,
+                        newVersion: this.version
+                    };
+                    this.broadcastEvent(event, false, objId);
+                }
+                return removedNodes;
             }
-            else if (entity.isLink) {
-                info.isLink = true;
+            catch (exc) {
+                throw (0, common_1.setPathInExc)(exc, this.name);
             }
-            lst[i] = info;
+        });
+        if (!objsToRm) {
+            return;
+        }
+        for (const objToRm of objsToRm) {
+            (await this.getOrMakeChildNodeForInfo(objToRm)).removeObj('sync');
         }
+    }
+    list() {
+        const lst = Object.values(this.currentState.nodes)
+            .map(nodeInfoToListingEntry);
         return { lst, version: this.version };
     }
+    async childExistsInSyncedVersion(childObjId) {
+        const status = await this.syncStatus();
+        if (status.state === 'synced') {
+            return true;
+        }
+        if (!status.synced) {
+            return false;
+        }
+        // XXX FolderNode.childExistsInSyncedVersion() should implement check in synced version
+        return false;
+    }
     listFolders() {
         return Object.keys(this.currentState.nodes).filter(name => !!this.currentState.nodes[name].isFolder);
     }
@@ -163,30 +229,12 @@ class FolderNode extends node_in_fs_1.NodeInFS {
             return;
         }
         else {
-            throw file_1.makeFileException(file_1.Code.notFound, name);
+            throw (0, file_1.makeFileException)(file_1.Code.notFound, name);
         }
     }
     hasChild(childName, throwIfMissing = false) {
         return !!this.getNodeInfo(childName, !throwIfMissing);
     }
-    /**
-     * @param objId
-     * @return either node (promise for node), or a deferred, which promise has
-     * been registered under a given id, and, therefore, has to be resolved with
-     * node.
-     */
-    getNodeOrArrangePromise(objId) {
-        const { node, nodePromise } = this.storage.nodes.getNodeOrPromise(objId);
-        if (node) {
-            return { nodeOrPromise: node };
-        }
-        if (nodePromise) {
-            return { nodeOrPromise: nodePromise };
-        }
-        const deferred = processes_1.defer();
-        this.storage.nodes.setPromise(objId, deferred.promise);
-        return { deferred };
-    }
     async getNode(type, name, undefOnMissing = false) {
         const childInfo = this.getNodeInfo(name, undefOnMissing);
         if (!childInfo) {
@@ -194,36 +242,38 @@ class FolderNode extends node_in_fs_1.NodeInFS {
         }
         if (type) {
             if ((type === 'file') && !childInfo.isFile) {
-                throw file_1.makeFileException(file_1.Code.notFile, childInfo.name);
+                throw (0, file_1.makeFileException)(file_1.Code.notFile, childInfo.name);
             }
             else if ((type === 'folder') && !childInfo.isFolder) {
-                throw file_1.makeFileException(file_1.Code.notDirectory, childInfo.name);
+                throw (0, file_1.makeFileException)(file_1.Code.notDirectory, childInfo.name);
             }
             else if ((type === 'link') && !childInfo.isLink) {
-                throw file_1.makeFileException(file_1.Code.notLink, childInfo.name);
+                throw (0, file_1.makeFileException)(file_1.Code.notLink, childInfo.name);
             }
         }
-        const { nodeOrPromise: child, deferred } = this.getNodeOrArrangePromise(childInfo.objId);
-        if (child) {
-            return child;
+        return this.getOrMakeChildNodeForInfo(childInfo);
+    }
+    async getOrMakeChildNodeForInfo(info) {
+        const { node, nodePromise } = this.storage.nodes.getNodeOrPromise(info.objId);
+        if (node) {
+            return node;
+        }
+        if (nodePromise) {
+            return nodePromise;
         }
+        const deferred = (0, deferred_1.defer)();
+        this.storage.nodes.setPromise(info.objId, deferred.promise);
         try {
             let node;
-            if (childInfo.isFile) {
-                node = await file_node_1.FileNode.makeForExisting(this.storage, this.objId, name, childInfo.objId, childInfo.key);
-            }
-            else if (childInfo.isFolder) {
-                const src = await this.storage.getObj(childInfo.objId);
-                // const f = new FolderNode(
-                // 	this.storage, childInfo.name, childInfo.objId, undefined,
-                // 	src.version, this.objId, childInfo.key, false);
-                // const { folderInfo, attrs } = await f.crypto.open(src);
-                // f.currentState = folderInfo;
-                // f.attrs = (attrs ? attrs : AttrsHolder.makeReadonlyForFolder(0));
-                node = await FolderNode.readNodeFromObjBytes(this.storage, childInfo.name, childInfo.objId, undefined, src, childInfo.key);
-            }
-            else if (childInfo.isLink) {
-                node = await link_node_1.LinkNode.makeForExisting(this.storage, this.objId, name, childInfo.objId, childInfo.key);
+            if (info.isFile) {
+                node = await file_node_1.FileNode.makeForExisting(this.storage, this.objId, info.name, info.objId, info.key);
+            }
+            else if (info.isFolder) {
+                const src = await this.storage.getObjSrc(info.objId);
+                node = await FolderNode.readNodeFromObjBytes(this.storage, info.name, info.objId, src, info.key);
+            }
+            else if (info.isLink) {
+                node = await link_node_1.LinkNode.makeForExisting(this.storage, this.objId, info.name, info.objId, info.key);
             }
             else {
                 throw new Error(`Unknown type of fs node`);
@@ -234,9 +284,9 @@ class FolderNode extends node_in_fs_1.NodeInFS {
         catch (exc) {
             deferred.reject(exc);
             if (exc.objNotFound) {
-                await this.fixMissingChildAndThrow(exc, childInfo);
+                await this.fixMissingChildAndThrow(exc, info);
             }
-            throw error_1.errWithCause(exc, `Cannot instantiate ${type} node '${this.name}/${childInfo.name}' from obj ${childInfo.objId}`);
+            throw (0, error_1.errWithCause)(exc, `Failed to instantiate fs node '${this.name}/${info.name}'`);
         }
     }
     getFolder(name, undefOnMissing = false) {
@@ -250,16 +300,21 @@ class FolderNode extends node_in_fs_1.NodeInFS {
     }
     async fixMissingChildAndThrow(exc, childInfo) {
         await this.doTransition(async (state, version) => {
+            const presentChild = state.nodes[childInfo.name];
+            if (!presentChild || (presentChild.objId !== childInfo.objId)) {
+                return [];
+            }
             delete state.nodes[childInfo.name];
             const event = {
                 type: 'entry-removal',
                 path: this.name,
+                src: 'local',
                 name: childInfo.name,
                 newVersion: version
             };
-            return event;
+            return { event, childObjId: childInfo.objId };
         }).catch(noop);
-        const fileExc = file_1.makeFileException(file_1.Code.notFound, childInfo.name, exc);
+        const fileExc = (0, file_1.makeFileException)(file_1.Code.notFound, childInfo.name, exc);
         fileExc.inconsistentStateOfFS = true;
         throw fileExc;
     }
@@ -278,11 +333,11 @@ class FolderNode extends node_in_fs_1.NodeInFS {
     async performTransition(change) {
         // start transition and prepare transition state
         // Note on copy: byte arrays are not cloned
-        const state = json_utils_1.copy(this.currentState);
+        const state = (0, json_utils_1.copy)(this.currentState);
         const version = this.version + 1;
         const attrs = this.attrs.copy();
         // do action within transition state
-        const event = await change(state, version);
+        const changeEvents = await change(state, version);
         // save transition state
         const encSub = await this.crypto.write(state, version, attrs, this.xattrs);
         await this.storage.saveObj(this.objId, version, encSub);
@@ -290,7 +345,15 @@ class FolderNode extends node_in_fs_1.NodeInFS {
         this.currentState = state;
         this.setCurrentVersion(version);
         this.attrs = attrs;
-        this.broadcastEvent(event);
+        if (Array.isArray(changeEvents)) {
+            for (const { event, childObjId } of changeEvents) {
+                this.broadcastEvent(event, false, childObjId);
+            }
+        }
+        else {
+            const { event, childObjId } = changeEvents;
+            this.broadcastEvent(event, false, childObjId);
+        }
     }
     /**
      * This function only creates folder node, but it doesn't insert it anywhere.
@@ -299,7 +362,7 @@ class FolderNode extends node_in_fs_1.NodeInFS {
     async makeAndSaveNewChildFolderNode(name, changes) {
         const key = await random.bytes(xsp_files_1.KEY_LENGTH);
         const childObjId = await this.storage.generateNewObjId();
-        const node = new FolderNode(this.storage, name, childObjId, undefined, 0, this.objId, key, true);
+        const node = new FolderNode(this.storage, name, childObjId, (0, xsp_files_1.idToHeaderNonce)(childObjId), 0, this.objId, key, true);
         await node.saveFirstVersion(changes).catch((exc) => {
             if (!exc.objExists) {
                 throw exc;
@@ -358,7 +421,7 @@ class FolderNode extends node_in_fs_1.NodeInFS {
             // do check for concurrent creation of a node
             if (this.getNodeInfo(name, true)) {
                 if (exclusive) {
-                    throw file_1.makeFileException(file_1.Code.alreadyExists, name);
+                    throw (0, file_1.makeFileException)(file_1.Code.alreadyExists, name);
                 }
                 else if (type === 'folder') {
                     return (await this.getNode('folder', name));
@@ -394,15 +457,11 @@ class FolderNode extends node_in_fs_1.NodeInFS {
                 const event = {
                     type: 'entry-addition',
                     path: this.name,
+                    src: 'local',
                     newVersion: version,
-                    entry: {
-                        name: node.name,
-                        isFile: (node.type === 'file'),
-                        isFolder: (node.type === 'folder'),
-                        isLink: (node.type === 'link')
-                    }
+                    entry: nodeToListingEntry(node)
                 };
-                return event;
+                return { event, childObjId: node.objId };
             });
             return node;
         });
@@ -426,15 +485,16 @@ class FolderNode extends node_in_fs_1.NodeInFS {
             const event = {
                 type: 'entry-removal',
                 path: this.name,
+                src: 'local',
                 name: f.name,
                 newVersion: version
             };
-            return event;
+            return { event, childObjId: f.objId };
         });
         // explicitly do not wait on a result of child's delete, cause if it fails
         // we just get traceable garbage, yet, the rest of a live/non-deleted tree
         // stays consistent
-        f.localDelete();
+        f.removeObj();
     }
     changeChildName(initName, newName) {
         return this.doTransition(async (state, version) => {
@@ -449,57 +509,59 @@ class FolderNode extends node_in_fs_1.NodeInFS {
             const event = {
                 type: 'entry-renaming',
                 path: this.name,
+                src: 'local',
                 newName,
                 oldName: initName,
                 newVersion: version
             };
-            return event;
+            return { event, childObjId: child.objId };
         });
     }
     async moveChildTo(childName, dst, nameInDst) {
         if (dst.hasChild(nameInDst)) {
-            throw file_1.makeFileException(file_1.Code.alreadyExists, nameInDst);
+            throw (0, file_1.makeFileException)(file_1.Code.alreadyExists, nameInDst);
         }
         if (dst === this) {
             // In this case we only need to change child's name
-            return this.changeChildName(childName, nameInDst);
+            await this.changeChildName(childName, nameInDst);
+        }
+        else {
+            const childJSON = this.getNodeInfo(childName);
+            // we have two transitions here, in this and in dst.
+            const moveLabel = getMoveLabel();
+            await dst.moveChildIn(nameInDst, childJSON, moveLabel);
+            await this.moveChildOut(childName, childJSON.objId, moveLabel);
         }
-        const childJSON = this.getNodeInfo(childName);
-        // we have two transitions here, in this and in dst.
-        await Promise.all([
-            await dst.moveChildIn(nameInDst, childJSON),
-            await this.moveChildOut(childName)
-        ]);
     }
-    async moveChildOut(name) {
+    async moveChildOut(name, childObjId, moveLabel) {
         await this.doTransition(async (state, version) => {
+            const child = state.nodes[name];
             delete state.nodes[name];
             const event = {
                 type: 'entry-removal',
                 path: this.name,
+                src: 'local',
                 name,
-                newVersion: version
+                newVersion: version,
+                moveLabel
             };
-            return event;
+            return { event, childObjId };
         });
     }
-    async moveChildIn(newName, child) {
-        child = json_utils_1.copy(child);
+    async moveChildIn(newName, child, moveLabel) {
+        child = (0, json_utils_1.copy)(child);
         await this.doTransition(async (state, version) => {
             child.name = newName;
             state.nodes[child.name] = child;
             const event = {
                 type: 'entry-addition',
                 path: this.name,
-                entry: {
-                    name: child.name,
-                    isFile: child.isFile,
-                    isFolder: child.isFolder,
-                    isLink: child.isLink
-                },
-                newVersion: version
+                src: 'local',
+                entry: nodeInfoToListingEntry(child),
+                newVersion: version,
+                moveLabel
             };
-            return event;
+            return { event, childObjId: child.objId };
         });
     }
     async getFolderInThisSubTree(path, createIfMissing = false, exclusiveCreate = false) {
@@ -512,7 +574,7 @@ class FolderNode extends node_in_fs_1.NodeInFS {
             // existing folder at this point
             if (path.length === 1) {
                 if (exclusiveCreate) {
-                    throw file_1.makeFileException(file_1.Code.alreadyExists, path[0]);
+                    throw (0, file_1.makeFileException)(file_1.Code.alreadyExists, path[0]);
                 }
                 else {
                     return f;
@@ -569,10 +631,7 @@ class FolderNode extends node_in_fs_1.NodeInFS {
         }
         return content;
     }
-    async delete(remoteEvent) {
-        if (remoteEvent) {
-            return super.delete(true);
-        }
+    async delete(src) {
         const childrenNodes = await this.getAllNodes();
         await this.storage.removeObj(this.objId);
         this.storage.nodes.delete(this);
@@ -581,14 +640,11 @@ class FolderNode extends node_in_fs_1.NodeInFS {
         const event = {
             type: 'removed',
             path: this.name,
-            isRemote: remoteEvent
+            src
         };
         this.broadcastEvent(event, true);
-        // explicitly do not wait on a result of child's delete, cause if it fails
-        // we just get traceable garbage, yet, the rest of a live/non-deleted tree
-        // stays consistent
         for (const node of childrenNodes) {
-            node.localDelete();
+            node.removeObj(src);
         }
     }
     getParamsForLink() {
@@ -607,76 +663,213 @@ class FolderNode extends node_in_fs_1.NodeInFS {
         };
         return linkParams;
     }
-    // XXX make default conflict resolution for folder
-    // async resolveConflict(remoteVersion: number): Promise<void> {
-    // 	// XXX we need to read remote version outside of doChange
-    // 	const src = await (this.storage as SyncedStorage).getSyncedObjVersion(
-    // 		this.objId, remoteVersion);
-    // 	const remInfo = await this.crypto.open(src);
-    // 	await this.doChange(true, async () => {
-    // 		// XXX this is a default conflict resolution
-    // 		// XXX drop all previous local versions(!)
-    // 	});
-    // }
-    async doOnExternalChange(expectedVersion) {
-        if (expectedVersion <= this.version) {
+    async upload(opts) {
+        // XXX temporary use of super's method
+        return super.upload(opts);
+        // const storage = this.syncedStorage();
+        // XXX
+        //  - use identifyChanges() to find changes, minding particular version,
+        //    ensuring that concurrent change won't mess things up.
+        //  - items not present in uploaded version, relative to latest sync,
+        //    i.e. removed, removal should be uploaded with
+        //    storage.uploadObjRemoval(objId);
+    }
+    async needUpload(localVersion) {
+        const toUpload = await super.needUpload(localVersion);
+        if (!toUpload) {
             return;
         }
-        const src = await this.storage.getObj(this.objId);
-        const newVersion = src.version;
-        if (newVersion <= this.version) {
-            return;
+        // XXX can put the following into private ensureAllChildrenUploaded(),
+        //     but it also need to get a consistent state, while current one can
+        //     be broken by simultaneous change in folder.
+        const storage = this.syncedStorage();
+        if (toUpload.localVersion === this.version) {
+            for (const { objId, name } of Object.values(this.currentState.nodes)) {
+                if ((await storage.status(objId)).neverUploaded()) {
+                    throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                        childNeverUploaded: true, childName: name
+                    });
+                }
+            }
+        }
+        else {
+            throw new Error(`Reading particular version is not implemented, yet`);
+        }
+        return toUpload;
+    }
+    async adoptRemoteFolderItem(itemName, opts) {
+        if (opts === null || opts === void 0 ? void 0 : opts.localVersion) {
+            if (this.version !== opts.localVersion) {
+                throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                    versionMismatch: true,
+                    message: `Given local version ${opts.localVersion} is not equal to current ${this.version}`
+                });
+            }
+        }
+        const { remote } = await this.syncStatus();
+        if (!remote) {
+            throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                versionMismatch: true,
+                message: `No remote versions`
+            });
+        }
+        if (opts === null || opts === void 0 ? void 0 : opts.remoteVersion) {
+            if (opts.remoteVersion !== remote.latest) {
+                throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                    versionMismatch: true,
+                    message: `Unknown remote version ${opts.remoteVersion}`
+                });
+            }
+        }
+        else if (!remote.latest) {
+            throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                remoteIsArchived: true
+            });
+        }
+        const storage = this.syncedStorage();
+        const srcOfRemote = await storage.getObjSrcOfRemoteVersion(this.objId, remote.latest);
+        const { folderInfo: { nodes: remoteNodes } } = await this.crypto.read(srcOfRemote);
+        const remoteChildNode = remoteNodes[itemName];
+        if (!remoteChildNode) {
+            throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                remoteFolderItemNotFound: true,
+                message: `Item '${itemName}' is not found in remote version`
+            });
+        }
+        const localNodeToRm = this.getNodeInfo(itemName, true);
+        if (!localNodeToRm) {
+            return await this.addRemoteChild(remoteChildNode);
         }
-        const { folderInfo, attrs } = await this.crypto.read(src);
-        const initState = this.currentState;
-        this.currentState = checkFolderInfo(folderInfo);
-        this.setCurrentVersion(newVersion);
-        if (attrs) {
-            this.attrs = attrs;
-        }
-        const addedEntries = Object.keys(this.currentState.nodes)
-            .filter(name => !initState.nodes[name]);
-        const removedEntries = Object.keys(initState.nodes)
-            .filter(name => !this.currentState.nodes[name]);
-        if ((addedEntries.length === 1) && (removedEntries.length === 1)) {
+        else if (localNodeToRm.objId === remoteChildNode.objId) {
+            return await this.setRemoteNodeInfo(remoteChildNode);
+        }
+        else {
+            return await this.replaceLocalChildWithRemote(localNodeToRm, remoteChildNode);
+        }
+    }
+    async addRemoteChild(remoteChildNode) {
+        let newVersion;
+        await this.doTransition(async (state, version) => {
+            newVersion = version;
+            state.nodes[remoteChildNode.name] = remoteChildNode;
             const event = {
-                type: 'entry-renaming',
+                type: 'entry-addition',
+                path: this.name,
+                src: 'sync',
+                entry: nodeInfoToListingEntry(remoteChildNode),
+                newVersion
+            };
+            return { event, childObjId: remoteChildNode.objId };
+        });
+        // XXX child should update sync info, and adopt change.
+        return newVersion;
+    }
+    async setRemoteNodeInfo(remoteChildNode) {
+        let newVersion;
+        await this.doTransition(async (state, version) => {
+            newVersion = version;
+            state.nodes[remoteChildNode.name] = remoteChildNode;
+            return [];
+        });
+        // XXX child should update sync info, and adopt change, cause changed key
+        //     requires changed cypher.
+        return newVersion;
+    }
+    async replaceLocalChildWithRemote(origChildNode, remoteChildNode) {
+        let newVersion;
+        await this.doTransition(async (state, version) => {
+            newVersion = version;
+            const presentNode = state.nodes[remoteChildNode.name];
+            state.nodes[remoteChildNode.name] = remoteChildNode;
+            const additionEvent = {
+                type: 'entry-addition',
                 path: this.name,
-                isRemote: true,
-                oldName: removedEntries[0],
-                newName: addedEntries[0],
+                src: 'sync',
+                entry: nodeInfoToListingEntry(remoteChildNode),
                 newVersion
             };
-            this.broadcastEvent(event);
+            const rmEvent = {
+                type: 'entry-removal',
+                path: this.name,
+                src: 'sync',
+                name: origChildNode.name
+            };
+            return [
+                { event: rmEvent, childObjId: origChildNode.objId },
+                { event: additionEvent, childObjId: remoteChildNode.objId }
+            ];
+        });
+        // XXX
+        //  remote child should update sync info, and adopt change. 
+        //  original child:
+        //  - if only local, should be removed,
+        //  - else should update sync info, and adopt both removal and change.
+        (await this.getOrMakeChildNodeForInfo(origChildNode)).removeObj('sync');
+        return newVersion;
+    }
+    async diffCurrentAndRemote(remoteVersion) {
+        var _a;
+        const { state, remote } = await this.syncStatus();
+        let isCurrentLocal;
+        if (state === 'behind') {
+            isCurrentLocal = false;
+        }
+        else if (state === 'conflicting') {
+            isCurrentLocal = true;
         }
         else {
-            addedEntries.forEach(name => {
-                const addedNode = this.currentState.nodes[name];
-                const event = {
-                    type: 'entry-addition',
-                    path: this.name,
-                    isRemote: true,
-                    entry: {
-                        name: addedNode.name,
-                        isFile: addedNode.isFile,
-                        isFolder: addedNode.isFolder,
-                        isLink: addedNode.isLink
-                    },
-                    newVersion
-                };
-                this.broadcastEvent(event);
-            });
-            removedEntries.forEach(name => {
-                const event = {
-                    type: 'entry-removal',
-                    path: this.name,
-                    isRemote: true,
-                    name,
-                    newVersion
-                };
-                this.broadcastEvent(event);
-            });
+            return;
+        }
+        if (remote.isArchived) {
+            return this.diffWithArchivedRemote(isCurrentLocal);
         }
+        else {
+            if (remoteVersion) {
+                if ((remoteVersion !== remote.latest)
+                    && !((_a = remote.archived) === null || _a === void 0 ? void 0 : _a.includes(remoteVersion))) {
+                    throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                        versionMismatch: true,
+                        message: `Unknown remote version ${remoteVersion}`
+                    });
+                }
+            }
+            else {
+                remoteVersion = remote.latest;
+            }
+            const storage = this.syncedStorage();
+            const srcOfRemote = await storage.getObjSrcOfRemoteVersion(this.objId, remote.latest);
+            const { folderInfo, attrs, xattrs } = await this.crypto.read(srcOfRemote);
+            return this.diffWithRemote(isCurrentLocal, remoteVersion, folderInfo, attrs, xattrs);
+        }
+    }
+    diffWithArchivedRemote(isCurrentLocal) {
+        return {
+            currentVersion: this.version,
+            isCurrentLocal,
+            isRemoteArchived: true,
+            ctime: {
+                current: new Date(this.attrs.ctime)
+            },
+            mtime: {
+                current: new Date(this.attrs.ctime)
+            }
+        };
+    }
+    diffWithRemote(isCurrentLocal, remoteVersion, folderInfo, attrs, xattrs) {
+        const { ctime, mtime } = diffAttrs(this.attrs, attrs);
+        const { inCurrent, inRemote, nameOverlaps } = diffNodes(this.currentState, folderInfo);
+        return {
+            currentVersion: this.version,
+            isCurrentLocal,
+            isRemoteArchived: false,
+            remoteVersion,
+            inCurrent,
+            inRemote,
+            nameOverlaps,
+            ctime,
+            mtime,
+            xattrs: diffXAttrs(this.xattrs, xattrs)
+        };
     }
 }
 exports.FolderNode = FolderNode;
@@ -688,6 +881,32 @@ function checkFolderInfo(folderJson) {
     // TODO throw if folderJson is not ok
     return folderJson;
 }
+function nodeInfoToListingEntry({ name, isFile, isFolder, isLink }) {
+    if (isFolder) {
+        return { name, isFolder };
+    }
+    else if (isFile) {
+        return { name, isFile };
+    }
+    else if (isLink) {
+        return { name, isLink };
+    }
+    else {
+        return { name };
+    }
+}
+function nodeToListingEntry({ name, type }) {
+    switch (type) {
+        case 'file':
+            return { name, isFolder: true };
+        case 'folder':
+            return { name, isFolder: true };
+        case 'link':
+            return { name, isLink: true };
+        default:
+            return { name };
+    }
+}
 function addToTransitionState(state, f, key) {
     const nodeInfo = {
         name: f.name,
@@ -708,4 +927,195 @@ function addToTransitionState(state, f, key) {
     }
     state.nodes[nodeInfo.name] = nodeInfo;
 }
+function diffAttrs(current, remote) {
+    return {
+        ctime: {
+            current: new Date(current.ctime),
+            remote: new Date(remote.ctime)
+        },
+        mtime: {
+            current: new Date(current.mtime),
+            remote: new Date(remote.mtime)
+        }
+    };
+}
+function diffNodes(current, remote) {
+    const inCurrent = getOnlyNotEqualNodes(current.nodes, remote.nodes);
+    const inRemote = getOnlyNotEqualNodes(remote.nodes, current.nodes);
+    const combined = combineCheckingNameOverlaps(inCurrent, inRemote);
+    return (combined ? combined : {});
+}
+function getOnlyNotEqualNodes(src, exclude) {
+    const collected = [];
+    for (const [name, nodeInSrc] of Object.entries(src)) {
+        const nodeInExclude = exclude[name];
+        if (!nodeInExclude
+            || !areNodesEqual(nodeInSrc, nodeInExclude)) {
+            collected.push(nodeInfoToListingEntry(nodeInSrc));
+        }
+    }
+    return ((collected.length > 0) ? collected : undefined);
+}
+function areNodesEqual(n1, n2) {
+    if (n1.name !== n2.name) {
+        return false;
+    }
+    if (n1.isFile && !n2.isFile) {
+        return false;
+    }
+    if (n1.isFolder && !n2.isFolder) {
+        return false;
+    }
+    if (n1.isLink && !n2.isLink) {
+        return false;
+    }
+    if (n1.objId !== n2.objId) {
+        return false;
+    }
+    if (!areBytesEqual(n1.key, n2.key)) {
+        return false;
+    }
+    return true;
+}
+function combineCheckingNameOverlaps(inCurrent, inRemote) {
+    if (inCurrent) {
+        if (inRemote) {
+            const nameOverlaps = [];
+            for (const { name: nameInCurrent } of inCurrent) {
+                if (inRemote.find(({ name }) => (name === nameInCurrent))) {
+                    nameOverlaps.push(nameInCurrent);
+                }
+            }
+            if (nameOverlaps.length > 0) {
+                return { inCurrent, inRemote, nameOverlaps };
+            }
+            else {
+                return { inCurrent, inRemote };
+            }
+        }
+        else {
+            return { inCurrent };
+        }
+    }
+    else {
+        if (inRemote) {
+            return { inRemote };
+        }
+        else {
+            return;
+        }
+    }
+}
+function diffXAttrs(current, remote) {
+    const haveCurrentXAttrs = (current && (current.list().length > 0));
+    const haveRemoteXAttrs = (remote && (remote.list().length > 0));
+    if (haveCurrentXAttrs && haveRemoteXAttrs) {
+        const inCurrent = getOnlyNotEqualXAttrs(current, remote);
+        const inRemote = getOnlyNotEqualXAttrs(remote, current);
+        return combineCheckingNameOverlaps(inCurrent, inRemote);
+    }
+    else if (haveCurrentXAttrs && !haveRemoteXAttrs) {
+        return { inCurrent: allXAttrsToDiff(current) };
+    }
+    else if (!haveCurrentXAttrs && haveRemoteXAttrs) {
+        return { inRemote: allXAttrsToDiff(remote) };
+    }
+    else {
+        return;
+    }
+}
+function allXAttrsToDiff(src) {
+    const collected = [];
+    for (const name of src.list()) {
+        const value = src.get(name);
+        if (value !== undefined) {
+            collected.push({ name, value });
+        }
+    }
+    return collected;
+}
+function getOnlyNotEqualXAttrs(src, exclude) {
+    const collected = [];
+    for (const name of src.list()) {
+        const valueInSrc = src.get(name);
+        if (valueInSrc === undefined) {
+            continue;
+        }
+        const valueInExclude = exclude.get(name);
+        if ((valueInExclude === undefined)
+            || !areXAttrValuesEqual(valueInSrc, valueInExclude)) {
+            collected.push({ name, value: valueInSrc });
+        }
+    }
+    return ((collected.length > 0) ? collected : undefined);
+}
+function areXAttrValuesEqual(v1, v2) {
+    if (Buffer.isBuffer(v1) || ArrayBuffer.isView(v1)) {
+        if (Buffer.isBuffer(v2) || ArrayBuffer.isView(v2)) {
+            return areBytesEqual(v1, v2);
+        }
+        {
+            return false;
+        }
+    }
+    else if (typeof v1 === 'string') {
+        if (typeof v2 === 'string') {
+            return (v1 === v2);
+        }
+        else {
+            return false;
+        }
+    }
+    else {
+        if (Buffer.isBuffer(v2) || ArrayBuffer.isView(v2)
+            || (typeof v2 === 'string')) {
+            return false;
+        }
+        else {
+            return (0, json_utils_1.deepEqual)(v1, v2);
+        }
+    }
+}
+function areBytesEqual(b1, b2) {
+    if (b1.length !== b2.length) {
+        return false;
+    }
+    for (let i = 0; i < b1.length; i += 1) {
+        if (b1[i] !== b2[i]) {
+            return false;
+        }
+    }
+    return true;
+}
+function identifyChanges(originalNodes, newNodes) {
+    const removedNodes = [];
+    const addedNodes = [];
+    const renamedNodes = [];
+    for (const [name, node] of Object.entries(originalNodes)) {
+        const newNode = newNodes[name];
+        if (newNode && (newNode.objId === node.objId)) {
+            continue;
+        }
+        removedNodes.push(node);
+    }
+    for (const [name, newNode] of Object.entries(newNodes)) {
+        const node = originalNodes[name];
+        if (node && (newNode.objId === node.objId)) {
+            continue;
+        }
+        const indInRm = removedNodes.findIndex(n => (n.objId === newNode.objId));
+        if (indInRm < 0) {
+            addedNodes.push(newNode);
+        }
+        else {
+            const oldNode = removedNodes.splice(indInRm, 1)[0];
+            renamedNodes.push({
+                oldName: oldNode.name,
+                newName: newNode.name,
+                objId: newNode.objId
+            });
+        }
+    }
+    return { addedNodes, removedNodes, renamedNodes };
+}
 Object.freeze(exports);