@jupyter/docprovider 4.1.0 → 4.1.2

package/lib/ydrive.d.ts

@@ -16,6 +16,7 @@ declare namespace RtcContentProvider {
         trans: TranslationBundle;
         globalAwareness: Awareness | null;
         docmanagerSettings: ISettingRegistry.ISettings | null;
+        fileChanged?: ISignal<Contents.IDrive, Contents.IChangedArgs>;
     }
 }
 export declare class RtcContentProvider extends RestContentProvider implements IContentProvider {
@@ -56,7 +57,8 @@ export declare class RtcContentProvider extends RestContentProvider implements I
     private _trans;
     private _globalAwareness;
     private _providers;
-    private _ydriveFileChanged;
+    private _providerFileChanged;
+    private _driveFileChanged?;
     private _serverSettings;
     private _docmanagerSettings;
 }

package/lib/ydrive.js

@@ -17,7 +17,7 @@ export class RtcContentProvider extends RestContentProvider {
     constructor(options) {
         super(options);
         this._onCreate = (options, sharedModel) => {
-            var _a, _b, _c, _d, _e, _f;
+            var _a, _b, _c, _d, _e, _f, _g;
             if (typeof options.format !== 'string') {
                 return;
             }
@@ -47,13 +47,80 @@ export class RtcContentProvider extends RestContentProvider {
                     documents.push(options.path);
                     (_f = this._globalAwareness) === null || _f === void 0 ? void 0 : _f.setLocalStateField('documents', documents);
                 }
-                const key = `${options.format}:${options.contentType}:${options.path}`;
+                let path = options.path;
+                let key = `${options.format}:${options.contentType}:${path}`;
                 this._providers.set(key, provider);
+                const handlePathChange = (pathChange) => {
+                    var _a, _b;
+                    const oldPath = pathChange.oldValue;
+                    const newPath = pathChange.newValue;
+                    if (!oldPath || !newPath) {
+                        // This is expected when shared model initializes and the path is first populated
+                        console.debug('New or old path not given', pathChange);
+                        return;
+                    }
+                    const oldKey = `${options.format}:${options.contentType}:${oldPath}`;
+                    if (oldKey !== key) {
+                        console.error('The computed old provider key is different from the current key');
+                        return;
+                    }
+                    const newKey = `${options.format}:${options.contentType}:${newPath}`;
+                    // Check if the provider is still registered (it may have been disposed if document was closed)
+                    const provider = this._providers.get(oldKey);
+                    if (!provider) {
+                        console.warn(`Could not find a provider to update after rename ${oldKey}, ${newKey}`);
+                        return;
+                    }
+                    // Re-register the provider under the new key
+                    this._providers.set(newKey, provider);
+                    this._providers.delete(oldKey);
+                    // Update the provider key so that it can be disposed correctly when shared document closes
+                    key = newKey;
+                    path = newPath;
+                    // Update the documents field
+                    const state = ((_a = this._globalAwareness) === null || _a === void 0 ? void 0 : _a.getLocalState()) || {};
+                    const documents = state.documents || [];
+                    const oldPathIndex = documents.indexOf(oldPath);
+                    if (documents.includes(oldPath) && !documents.includes(newPath)) {
+                        documents.splice(oldPathIndex, 1);
+                        documents.push(newPath);
+                        (_b = this._globalAwareness) === null || _b === void 0 ? void 0 : _b.setLocalStateField('documents', documents);
+                    }
+                };
+                // The information about file being renamed can come from two places:
+                // - from the sharedModel via changed signal with documentChange
+                // - from the fileChanged signal of the drive
+                // Neither method is foolproof:
+                // - the shared model approach can be delayed as the change needs to be
+                //   reflected by the server and come back, in which case we get a race condition
+                // - the fileChanged signal is emitted with a larger delay for renames of collaborators
+                // Thus we need both.
+                const handleFileChangedSignal = (_, change) => {
+                    var _a, _b;
+                    if (change.type !== 'rename') {
+                        return;
+                    }
+                    const oldPath = (_a = change.oldValue) === null || _a === void 0 ? void 0 : _a.path;
+                    const newPath = (_b = change.newValue) === null || _b === void 0 ? void 0 : _b.path;
+                    if (oldPath !== path) {
+                        return;
+                    }
+                    handlePathChange({
+                        oldValue: oldPath,
+                        newValue: newPath,
+                        name: 'path'
+                    });
+                };
+                (_g = this._driveFileChanged) === null || _g === void 0 ? void 0 : _g.connect(handleFileChangedSignal);
                 sharedModel.changed.connect(async (_, change) => {
                     var _a;
                     if (!change.stateChange) {
                         return;
                     }
+                    const pathChanges = change.stateChange.filter(change => change.name === 'path');
+                    for (const pathChange of pathChanges) {
+                        handlePathChange(pathChange);
+                    }
                     const hashChanges = change.stateChange.filter(change => change.name === 'hash');
                     if (hashChanges.length === 0) {
                         return;
@@ -67,7 +134,7 @@ export class RtcContentProvider extends RestContentProvider {
                     // observers about this change so that they can store the new hash value.
                     const newPath = (_a = sharedModel.state.path) !== null && _a !== void 0 ? _a : options.path;
                     const model = await this.get(newPath, { content: false });
-                    this._ydriveFileChanged.emit({
+                    this._providerFileChanged.emit({
                         type: 'save',
                         newValue: { ...model, hash: hashChange.newValue },
                         // we do not have the old model because it was discarded when server made the change,
@@ -76,7 +143,7 @@ export class RtcContentProvider extends RestContentProvider {
                     });
                 });
                 sharedModel.disposed.connect(() => {
-                    var _a, _b;
+                    var _a, _b, _c;
                     const provider = this._providers.get(key);
                     if (provider) {
                         provider.dispose();
@@ -85,11 +152,13 @@ export class RtcContentProvider extends RestContentProvider {
                     // Remove the document path from the list of opened ones for this user.
                     const state = ((_a = this._globalAwareness) === null || _a === void 0 ? void 0 : _a.getLocalState()) || {};
                     const documents = state.documents || [];
-                    const index = documents.indexOf(options.path);
+                    const index = documents.indexOf(path);
                     if (index > -1) {
                         documents.splice(index, 1);
                     }
                     (_b = this._globalAwareness) === null || _b === void 0 ? void 0 : _b.setLocalStateField('documents', documents);
+                    // Disconnect signal
+                    (_c = this._driveFileChanged) === null || _c === void 0 ? void 0 : _c.disconnect(handleFileChangedSignal);
                 });
             }
             catch (error) {
@@ -99,7 +168,8 @@ export class RtcContentProvider extends RestContentProvider {
             }
         };
         this._saveCounter = 0;
-        this._ydriveFileChanged = new Signal(this);
+        // This is for emitting signals to be proxied to `Drive.fileChanged`
+        this._providerFileChanged = new Signal(this);
         this._user = options.user;
         this._trans = options.trans;
         this._globalAwareness = options.globalAwareness;
@@ -107,6 +177,7 @@ export class RtcContentProvider extends RestContentProvider {
         this.sharedModelFactory = new SharedModelFactory(this._onCreate);
         this._providers = new Map();
         this._docmanagerSettings = options.docmanagerSettings;
+        this._driveFileChanged = options.fileChanged;
     }
     get providers() {
         return this._providers;
@@ -215,6 +286,9 @@ export class RtcContentProvider extends RestContentProvider {
                 };
                 return this.get(localPath, fetchOptions);
             }
+            else {
+                console.warn(`Could not find a provider for ${localPath}, falling back to REST API save`);
+            }
         }
         return super.save(localPath, options);
     }
@@ -222,7 +296,7 @@ export class RtcContentProvider extends RestContentProvider {
      * A signal emitted when a file operation takes place.
      */
     get fileChanged() {
-        return this._ydriveFileChanged;
+        return this._providerFileChanged;
     }
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "4.1.0",
+  "version": "4.1.2",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter-collaboration",
   "bugs": {
@@ -41,7 +41,7 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/collaborative-drive": "^4.1.0",
+    "@jupyter/collaborative-drive": "^4.1.2",
     "@jupyter/ydoc": "^2.1.3 || ^3.0.0",
     "@jupyterlab/apputils": "^4.4.0",
     "@jupyterlab/cells": "^4.4.0",