fix filename in jlite

dodo.py

@@ -1,4 +1,5 @@
 import json
+import os
 
 
 def task_bump_version_patch():
@@ -28,13 +29,49 @@ def task_build():
     }
 
 
+def update_jlite_json_quickbuild():
+    jlite_config_path = "../web/public/jlite/jupyter-lite.json"
+    # first read in existing jupyter-lite.jsonfile
+    with open(jlite_config_path, "r") as f:
+        jlite = json.load(f)
+
+    # then find name of file starting with `remoteEntry.` within
+    # the ./jupyteach_jupyterlite_contents/labextension/static directory
+    remoteEntry = [
+        f
+        for f in os.listdir("./jupyteach_jupyterlite_contents/labextension/static")
+        if f.startswith("remoteEntry.")
+    ][0]
+
+    # find the object within jlite['federated_extensions'] that has name == '@jupyteach/jupyterlite-contents'
+    ext = None
+    for e in jlite["jupyter-config-data"]["federated_extensions"]:
+        if e["name"] == "@jupyteach/jupyterlite-contents":
+            ext = e
+            break
+
+    if ext is None:
+        raise ValueError(
+            "Could not find @jupyteach/jupyterlite-contents in jupyter-lite.json"
+        )
+
+    # update the 'load' property of `ext` to match `static/{remoteEntry}`
+    ext["load"] = f"static/{remoteEntry}"
+
+    # now write out updated jupyter-lite-json file to jlite_config_path. Use indent=2
+    # to make it human readable
+    with open(jlite_config_path, "w") as f:
+        json.dump(jlite, f, indent=2)
+
+
 def task_devbuild():
     return {
         "actions": [
             "rm -rf _output",
             "yarn run build:prod",
             "jupyter lite build --force",
             "rsync -av --delete ./_output/ ../web/public/jlite/",
+            update_jlite_json_quickbuild,
         ],
     }
 
@@ -44,5 +81,6 @@ def task_quickbuild():
         "actions": [
             "yarn run build:prod",
             "rsync -av --delete ./jupyteach_jupyterlite_contents/labextension/static/ ../web/public/jlite/extensions/@jupyteach/jupyterlite-contents/static/",
+            update_jlite_json_quickbuild,
         ],
     }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyteach/jupyterlite-contents",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "A JupyterLite server extension.",
   "keywords": [
     "jupyter",
@@ -108,4 +108,4 @@
       ]
     }
   }
-}
+}

src/contents.ts

@@ -1,6 +1,5 @@
 import { Contents } from '@jupyterlite/contents';
 import { Contents as ServerContents } from '@jupyterlab/services';
-import { PathExt } from '@jupyterlab/coreutils';
 import { ApolloClient, gql } from '@apollo/client/core';
 
 const GET_NOTEBOOK_FRAGMENT = gql`
@@ -12,17 +11,6 @@ const GET_NOTEBOOK_FRAGMENT = gql`
   }
 `;
 
-interface IContentResponseType {
-  content: any;
-  name: string;
-  last_modified: string;
-  created: string;
-  size: number;
-  mimetype: string;
-  type: ServerContents.ContentType;
-  filepath: string;
-}
-
 interface IContentBlock {
   authorId: number;
   createdAt: string;
@@ -36,26 +24,30 @@ interface IContentBlock {
   updatedAt: string;
 }
 
-const extractNotebookIdAndKey = (
-  path: string
-): { id: number | undefined; key: string | undefined } => {
-  const basename = PathExt.basename(path);
-  const match = basename.match(/(\d+)\.ipynb/);
-  if (match) {
-    const id = +match[1];
-    return { id, key: `ContentBlock:${id}` };
-  }
-  return { id: undefined, key: undefined };
-};
-
 export type IModel = ServerContents.IModel;
 /**
  * A class to handle requests to /api/contents
  */
 export class JupyteachContents extends Contents {
-  requestId = 0;
-  responses: { [key: number]: IContentResponseType } = {};
   apolloClient: ApolloClient<Record<string, unknown>> | undefined = undefined;
+  contentBlockIDToFileName: { [key: number]: string } = {};
+  fileNameToContentBlockID: { [key: string]: number } = {};
+
+  getIdAndKey = (
+    {fileName, contentBlockId}: {fileName?: string, contentBlockId?: number},
+  ): { id: number | undefined; key: string | undefined } => {
+    if (contentBlockId) {
+      return {id: contentBlockId, key: `ContentBlock:${contentBlockId}`};
+    }
+    if (fileName) {
+      // Try to access blockID in `fileNameToContentBlockID`
+      const blockID = this.fileNameToContentBlockID[fileName];
+      if (blockID) {
+        return {id: blockID, key: `ContentBlock:${blockID}`};
+      }
+    }
+    return {id: undefined, key: undefined};
+  };
 
   /**
    * Save a file.
@@ -71,18 +63,21 @@ export class JupyteachContents extends Contents {
   ): Promise<IModel | null> {
     // call the superclass method
     console.debug('[contents.ts] save', { path, options });
-    const out = super.save(path, options);
-    const { id, key } = extractNotebookIdAndKey(path);
+    const { id, key } = this.getIdAndKey({fileName: options.name});
 
     if (this.apolloClient && id) {
       this.apolloClient.cache.modify({
         id: key,
         fields: {
-          nbContent: (_) => options.content
+          nbContent: _ => options.content
         }
-      })
-      console.debug('[contents.ts] save --  just called modify to update nbContent')
+      });
+      console.debug(
+        '[contents.ts] save --  just called modify to update nbContent'
+      );
     }
+
+    const out = super.save(path, options);
     return out;
   }
 
@@ -106,7 +101,7 @@ export class JupyteachContents extends Contents {
     options?: ServerContents.IFetchOptions | undefined
   ): Promise<ServerContents.IModel | null> {
     // Try this...
-    const { id, key } = extractNotebookIdAndKey(path);
+    console.debug('[contents.ts] get', { path, options });
     const url = new URL(window.location.href);
     const forceRefreshRaw = url.searchParams.get('forceRefresh');
     const haveRefreshArg = forceRefreshRaw !== null;
@@ -119,6 +114,11 @@ export class JupyteachContents extends Contents {
         return out;
       }
     }
+
+    const blockIdRaw = url.searchParams.get('contentBlockId');
+    const contentBlockId = blockIdRaw ? +blockIdRaw : undefined;
+    const { id, key } = this.getIdAndKey({contentBlockId});
+
     if (this.apolloClient && id) {
       // check to see if this is in the cache already -- should be !"])
       const nb = this.apolloClient.readFragment({
@@ -128,30 +128,33 @@ export class JupyteachContents extends Contents {
         IContentBlock,
         'properties' | 'createdAt' | 'id' | 'nbContent'
       > | null;
-      console.debug('[contents.ts] get inside if', {
-        path,
-        options,
-        nb,
-        client: this.apolloClient
-      });
       if (nb) {
-        return {
-          content: nb.nbContent,
+        const out = {
+          name: nb.properties.fileName,
+          path: nb.properties.fileName,
+          type: 'notebook' as const,
+          writable: true,
           created: nb.createdAt,
-          format: 'json',
           last_modified: nb.properties.lastModified,
           mimetype: 'application/x-ipynb+json',
-          name: nb.properties.fileName,
-          path: nb.properties.fileName,
-          size: JSON.stringify(nb.nbContent).length,
-          type: 'notebook',
-          writable: true
+          content: nb.nbContent,
+          format: 'json' as const,
+          size: JSON.stringify(nb.nbContent).length
         };
+        if (contentBlockId) {
+          this.contentBlockIDToFileName[contentBlockId] = nb.properties.fileName;
+          this.fileNameToContentBlockID[nb.properties.fileName] = contentBlockId;
+        }
+        console.debug('[contents.ts] get returning from Apollo cache', { out });
+        return out;
       }
     }
 
+    const out = await super.get(path, options);
+    console.debug('[contents.ts] get fallback response', { out });
+
     // otherwise, just fallback
-    return super.get(path, options);
+    return out;
   }
 
   async createCheckpoint(