@jupyterlite/services 0.8.0-alpha.0 → 0.8.0-alpha.2

package/src/contents/drive.ts

@@ -36,6 +36,104 @@ const N_CHECKPOINTS = 5;
 const encoder = new TextEncoder();
 const decoder = new TextDecoder('utf-8');
 
+/**
+ * Converts a contents model into JSON
+ *
+ * @param model the model to convert
+ * @returns the converted model
+ */
+function convertToJSON(model: Contents.IModel): Contents.IModel {
+  switch (model.format) {
+    case 'json': {
+      return model;
+    }
+    case 'text': {
+      return {
+        ...model,
+        content: JSON.parse(model.content),
+        format: 'json',
+      };
+    }
+    case 'base64': {
+      const binary = atob(model.content);
+      const bytes = Uint8Array.from(binary, (c) => c.charCodeAt(0));
+      const decoded = new TextDecoder('utf-8').decode(bytes);
+
+      return {
+        ...model,
+        content: JSON.parse(decoded),
+        format: 'json',
+      };
+    }
+  }
+
+  throw new Error(`Invalid format ${model.format}`);
+}
+
+/**
+ * Converts a contents model into Text
+ *
+ * @param model the model to convert
+ * @returns the converted model
+ */
+function convertToText(model: Contents.IModel): Contents.IModel {
+  switch (model.format) {
+    case 'json': {
+      return {
+        ...model,
+        content: JSON.stringify(model.content),
+        format: 'text',
+      };
+    }
+    case 'text': {
+      return model;
+    }
+    case 'base64': {
+      const binary = atob(model.content);
+      const bytes = Uint8Array.from(binary, (c) => c.charCodeAt(0));
+      const decoded = new TextDecoder('utf-8').decode(bytes);
+
+      return {
+        ...model,
+        content: decoded,
+        format: 'text',
+      };
+    }
+  }
+
+  throw new Error(`Invalid format ${model.format}`);
+}
+
+/**
+ * Converts a contents model into Base64
+ *
+ * @param model the model to convert
+ * @returns the converted model
+ */
+function convertToBase64(model: Contents.IModel): Contents.IModel {
+  switch (model.format) {
+    case 'json': {
+      return {
+        ...model,
+        content: btoa(JSON.stringify(model.content)),
+        format: 'base64',
+      };
+    }
+    case 'text': {
+      return {
+        ...model,
+        content: btoa(model.content),
+        format: 'base64',
+      };
+    }
+    case 'base64': {
+      return model;
+    }
+  }
+
+  throw new Error(`Invalid format ${model.format}`);
+}
+
 /**
  * A custom drive to store files in the browser storage.
  */
@@ -258,27 +356,7 @@ export class BrowserStorageDrive implements Contents.IDrive {
     const type = options?.type ?? 'notebook';
     const created = new Date().toISOString();
 
-    let dirname = PathExt.dirname(path);
-    const basename = PathExt.basename(path);
-    const extname = PathExt.extname(path);
-    const item = await this.get(dirname).catch(() => null);
-
-    // handle the case of "Save As", where the path points to the new file
-    // to create, e.g. subfolder/example-copy.ipynb
-    let name = '';
-    if (path && !extname && item) {
-      // directory
-      dirname = `${path}/`;
-      name = '';
-    } else if (dirname && basename) {
-      // file in a subfolder
-      dirname = `${dirname}/`;
-      name = basename;
-    } else {
-      // file at the top level
-      dirname = '';
-      name = path;
-    }
+    let name: string | undefined = undefined;
 
     let file: IModel;
     switch (type) {
@@ -287,7 +365,7 @@ export class BrowserStorageDrive implements Contents.IDrive {
         name = `Untitled Folder${counter || ''}`;
         file = {
           name,
-          path: `${dirname}${name}`,
+          path: PathExt.join(path, name),
           last_modified: created,
           created,
           format: 'json',
@@ -304,7 +382,7 @@ export class BrowserStorageDrive implements Contents.IDrive {
         name = name || `Untitled${counter || ''}.ipynb`;
         file = {
           name,
-          path: `${dirname}${name}`,
+          path: PathExt.join(path, name),
           last_modified: created,
           created,
           format: 'json',
@@ -317,15 +395,20 @@ export class BrowserStorageDrive implements Contents.IDrive {
         break;
       }
       default: {
-        let ext = options?.ext ?? '.txt';
-        if (!ext.startsWith('.')) {
+        let ext = options?.ext;
+        if (ext && !ext.startsWith('.')) {
           ext = `.${ext}`;
         }
         const counter = await this._incrementCounter('file');
-        const mimetype = FILE.getType(ext) || MIME.OCTET_STREAM;
+        const mimetype = ext
+          ? FILE.getType(ext) || MIME.OCTET_STREAM
+          : MIME.OCTET_STREAM;
 
         let format: Contents.FileFormat;
-        if (FILE.hasFormat(ext, 'text') || mimetype.indexOf('text') !== -1) {
+        if (!ext) {
+          format = 'base64';
+          ext = '';
+        } else if (FILE.hasFormat(ext, 'text') || mimetype.indexOf('text') !== -1) {
           format = 'text';
         } else if (ext.indexOf('json') !== -1 || ext.indexOf('ipynb') !== -1) {
           format = 'json';
@@ -336,7 +419,7 @@ export class BrowserStorageDrive implements Contents.IDrive {
         name = name || `untitled${counter || ''}${ext}`;
         file = {
           name,
-          path: `${dirname}${name}`,
+          path: PathExt.join(path, name),
           last_modified: created,
           created,
           format,
@@ -440,16 +523,36 @@ export class BrowserStorageDrive implements Contents.IDrive {
     const item = await storage.getItem(path);
     const serverItem = await this._getServerContents(path, options);
 
-    const model = (item || serverItem) as IModel | null;
+    let model = (item || serverItem) as IModel | null;
 
     if (!model) {
       throw Error(`Could not find content with path ${path}`);
     }
 
-    if (!options?.content) {
+    if (options?.content) {
+      // Fix model format if the requested format does not match
+      const requestedFormat = options?.format;
+      if (requestedFormat && model.format !== requestedFormat) {
+        switch (requestedFormat) {
+          case 'json': {
+            model = convertToJSON(model);
+            break;
+          }
+          case 'text': {
+            model = convertToText(model);
+            break;
+          }
+          case 'base64': {
+            model = convertToBase64(model);
+            break;
+          }
+        }
+      }
+    } else {
       return {
-        size: 0,
         ...model,
+        size: 0,
+        format: options?.format ?? model.format,
         content: null,
       };
     }
@@ -574,7 +677,9 @@ export class BrowserStorageDrive implements Contents.IDrive {
     path = decodeURIComponent(path);
 
     // process the file if coming from an upload
-    const ext = PathExt.extname(options.name ?? '');
+    const name = options.name ? options.name : PathExt.basename(path) ?? undefined;
+    const ext = name ? PathExt.extname(name) ?? undefined : undefined;
+    const mimetype = ext ? FILE.getType(ext) || MIME.OCTET_STREAM : MIME.OCTET_STREAM;
     const chunk = options.chunk;
 
     // retrieve the content if it is a later chunk or the last one
@@ -582,74 +687,79 @@ export class BrowserStorageDrive implements Contents.IDrive {
     const appendChunk = chunk ? chunk > 1 || chunk === -1 : false;
     item = await this.get(path, { content: appendChunk }).catch(() => null);
 
-    if (!item) {
-      item = await this.newUntitled({ path, ext, type: 'file' });
-    }
+    const now = new Date().toISOString();
 
-    if (!item) {
-      throw Error(`Could not find file with path ${path}`);
+    let type = options.type || 'file';
+
+    // The Contents API treats Notebooks as a special case.
+    if (ext && ext.toLowerCase() === '.ipynb') {
+      type = 'notebook';
     }
 
-    // keep a reference to the original content
-    const originalContent = item.content;
+    const format = options?.format || 'base64';
+    const content = options?.content || '';
 
-    const modified = new Date().toISOString();
-    // override with the new values
-    item = {
-      ...item,
-      ...options,
-      last_modified: modified,
-    };
+    // keep a reference to the original content
+    const originalContent = item?.content;
+
+    if (item) {
+      item = {
+        ...item,
+        last_modified: now,
+        format,
+        mimetype,
+        content,
+        writable: true,
+        type,
+      };
+    } else {
+      item = {
+        name,
+        path,
+        last_modified: now,
+        created: now,
+        format,
+        mimetype,
+        content,
+        writable: true,
+        type,
+      };
+    }
 
-    if (options.content && options.format === 'base64') {
-      const lastChunk = chunk ? chunk === -1 : true;
+    // Handle multichunks uploads
+    if (chunk) {
+      const lastChunk = chunk === -1;
 
       const contentBinaryString = this._handleUploadChunk(
-        options.content,
+        content,
         originalContent,
         appendChunk,
       );
 
-      if (ext === '.ipynb') {
-        const content = lastChunk
-          ? JSON.parse(decoder.decode(this._binaryStringToBytes(contentBinaryString)))
-          : contentBinaryString;
-        item = {
-          ...item,
-          content,
-          format: 'json',
-          type: 'notebook',
-          size: contentBinaryString.length,
-        };
-      } else if (FILE.hasFormat(ext, 'json')) {
+      if (item.format === 'json') {
         const content = lastChunk
           ? JSON.parse(decoder.decode(this._binaryStringToBytes(contentBinaryString)))
           : contentBinaryString;
         item = {
           ...item,
           content,
-          format: 'json',
-          type: 'file',
           size: contentBinaryString.length,
         };
-      } else if (FILE.hasFormat(ext, 'text')) {
+      } else if (item.format === 'text') {
         const content = lastChunk
           ? decoder.decode(this._binaryStringToBytes(contentBinaryString))
           : contentBinaryString;
         item = {
           ...item,
           content,
-          format: 'text',
-          type: 'file',
           size: contentBinaryString.length,
         };
       } else {
+        // item.format is base64
         const content = lastChunk ? btoa(contentBinaryString) : contentBinaryString;
         item = {
           ...item,
           content,
-          format: 'base64',
-          type: 'file',
           size: contentBinaryString.length,
         };
       }
@@ -657,7 +767,7 @@ export class BrowserStorageDrive implements Contents.IDrive {
 
     // fixup content sizes if necessary
     if (item.content) {
-      switch (options.format) {
+      switch (item.format) {
         case 'json': {
           item = { ...item, size: encoder.encode(JSON.stringify(item.content)).length };
           break;
@@ -666,8 +776,9 @@ export class BrowserStorageDrive implements Contents.IDrive {
           item = { ...item, size: encoder.encode(item.content).length };
           break;
         }
-        // base64 save was already handled above
         case 'base64': {
+          const padding = (item.content.match(/=+$/) || [''])[0].length;
+          item = { ...item, size: (item.content.length * 3) / 4 - padding };
           break;
         }
         default: {
@@ -970,7 +1081,7 @@ export class BrowserStorageDrive implements Contents.IDrive {
   };
 
   /**
-   * retrieve the contents for this path from `__index__.json` in the appropriate
+   * retrieve the contents for this path from the contents index file in the appropriate
    * folder.
    *
    * @param newLocalPath - The new file path.
@@ -981,11 +1092,18 @@ export class BrowserStorageDrive implements Contents.IDrive {
     const content = this._serverContents.get(path) || new Map();
 
     if (!this._serverContents.has(path)) {
+      // Check if contents are indexed by looking for the filename in PageConfig
+      const contentsAllJsonFile = PageConfig.getOption('contentsAllJsonFile');
+      if (!contentsAllJsonFile) {
+        this._serverContents.set(path, content);
+        return content;
+      }
+
       const apiURL = URLExt.join(
         PageConfig.getBaseUrl(),
         'api/contents',
         path,
-        'all.json',
+        contentsAllJsonFile,
       );
 
       try {

package/src/contents/drivecontents.ts

@@ -2,7 +2,7 @@ import { PathExt } from '@jupyterlab/coreutils';
 import type { Contents } from '@jupyterlab/services';
 import type { TDriveMethod, TDriveRequest, TDriveResponse } from './drivefs';
 import { BLOCK_SIZE } from './drivefs';
-import { DIR_MODE, FILE_MODE } from './emscripten';
+import { isDirMode, DIR_MODE, FILE_MODE } from './emscripten';
 
 export interface IDriveContentsProcessor {
   /**
@@ -168,7 +168,7 @@ export class DriveContentsProcessor implements IDriveContentsProcessor {
         ok: true,
         mode: model.type === 'directory' ? DIR_MODE : FILE_MODE,
       };
-    } catch (e) {
+    } catch {
       response = { ok: false };
     }
 
@@ -176,12 +176,18 @@ export class DriveContentsProcessor implements IDriveContentsProcessor {
   }
 
   async mknod(request: TDriveRequest<'mknod'>): Promise<TDriveResponse<'mknod'>> {
-    const model = await this.contentsManager.newUntitled({
-      path: PathExt.dirname(request.path),
-      type: request.data.mode === DIR_MODE ? 'directory' : 'file',
-      ext: PathExt.extname(request.path),
-    });
-    await this.contentsManager.rename(model.path, request.path);
+    // Contents API does not permit creating folders with given name. We can only create untitled folder then rename.
+    if (isDirMode(request.data.mode)) {
+      const model = await this.contentsManager.newUntitled({
+        path: PathExt.dirname(request.path),
+        type: 'directory',
+        ext: PathExt.extname(request.path),
+      });
+      await this.contentsManager.rename(model.path, request.path);
+      return null;
+    }
+
+    await this.contentsManager.save(request.path, { type: 'file' });
     return null;
   }
 
@@ -211,7 +217,7 @@ export class DriveContentsProcessor implements IDriveContentsProcessor {
     let model: Contents.IModel;
     try {
       model = await this.contentsManager.get(request.path, { content: true });
-    } catch (e) {
+    } catch {
       return null;
     }
 

package/src/contents/drivefs.ts

@@ -168,7 +168,7 @@ export class DriveFSEmscriptenStreamOps implements IEmscriptenStreamOps {
       try {
         const file = this.fs.API.get(path);
         stream.file = file;
-      } catch (e) {
+      } catch {
         // If we're opening a file for writing and the file does not exist, create it! Otherwise, throw the proper error
         // We need to do this because the current thread is thinking a file exist (isFile returns true)
         // whilst it was actually deleted in the main thread
@@ -342,7 +342,7 @@ export class DriveFSEmscriptenNodeOps implements IEmscriptenNodeOps {
             let file;
             try {
               file = this.fs.API.get(path);
-            } catch (e) {
+            } catch {
               // TODO: Should do anything here? Should we create the file?
               break;
             }

package/src/contents/emscripten.ts

@@ -13,13 +13,27 @@
  * Ideally, much more of these would be taken from `@types/emscripten`.
  */
 
-type EmscriptenFS = typeof FS;
+type EmscriptenFS = typeof globalThis extends { FS: infer T } ? T : Record<string, any>;
+
+// Those constants are standard that is very unlikely to change
+// https://github.com/bminor/glibc/blob/04e750e75b73957cf1c791535a3f4319534a52fc/bits/stat.h#L66
+const S_IFMT = 0o170000;
+const S_IFDIR = 0o040000;
+const S_IFREG = 0o100000;
 
 export const DIR_MODE = 16895; // 040777
 export const FILE_MODE = 33206; // 100666
 export const SEEK_CUR = 1;
 export const SEEK_END = 2;
 
+export function isDirMode(mode: number): boolean {
+  return (mode & S_IFMT) === S_IFDIR;
+}
+
+export function isFileMode(mode: number): boolean {
+  return (mode & S_IFMT) === S_IFREG;
+}
+
 export interface IStats {
   dev: number;
   ino?: number;

package/src/kernel/base.ts

@@ -243,8 +243,7 @@ export abstract class BaseKernel implements IKernel {
       | KernelMessage.IHeader<KernelMessage.MessageType>
       | undefined = undefined,
   ): void {
-    const parentHeaderValue =
-      typeof parentHeader !== 'undefined' ? parentHeader : this._parentHeader;
+    const parentHeaderValue = parentHeader ?? this._parentHeader;
     const message = KernelMessage.createMessage<KernelMessage.IStreamMsg>({
       channel: 'iopub',
       msgType: 'stream',
@@ -269,8 +268,7 @@ export abstract class BaseKernel implements IKernel {
       | undefined = undefined,
   ): void {
     // Make sure metadata is always set
-    const parentHeaderValue =
-      typeof parentHeader !== 'undefined' ? parentHeader : this._parentHeader;
+    const parentHeaderValue = parentHeader ?? this._parentHeader;
     content.metadata = content.metadata ?? {};
 
     const message = KernelMessage.createMessage<KernelMessage.IDisplayDataMsg>({
@@ -296,8 +294,7 @@ export abstract class BaseKernel implements IKernel {
       | KernelMessage.IHeader<KernelMessage.MessageType>
       | undefined = undefined,
   ): void {
-    const parentHeaderValue =
-      typeof parentHeader !== 'undefined' ? parentHeader : this._parentHeader;
+    const parentHeaderValue = parentHeader ?? this._parentHeader;
     const message = KernelMessage.createMessage<KernelMessage.IInputRequestMsg>({
       channel: 'stdin',
       msgType: 'input_request',
@@ -321,8 +318,7 @@ export abstract class BaseKernel implements IKernel {
       | KernelMessage.IHeader<KernelMessage.MessageType>
       | undefined = undefined,
   ): void {
-    const parentHeaderValue =
-      typeof parentHeader !== 'undefined' ? parentHeader : this._parentHeader;
+    const parentHeaderValue = parentHeader ?? this._parentHeader;
     const message = KernelMessage.createMessage<KernelMessage.IExecuteResultMsg>({
       channel: 'iopub',
       msgType: 'execute_result',
@@ -346,8 +342,7 @@ export abstract class BaseKernel implements IKernel {
       | KernelMessage.IHeader<KernelMessage.MessageType>
       | undefined = undefined,
   ): void {
-    const parentHeaderValue =
-      typeof parentHeader !== 'undefined' ? parentHeader : this._parentHeader;
+    const parentHeaderValue = parentHeader ?? this._parentHeader;
     const message = KernelMessage.createMessage<KernelMessage.IErrorMsg>({
       channel: 'iopub',
       msgType: 'error',
@@ -371,8 +366,7 @@ export abstract class BaseKernel implements IKernel {
       | KernelMessage.IHeader<KernelMessage.MessageType>
       | undefined = undefined,
   ): void {
-    const parentHeaderValue =
-      typeof parentHeader !== 'undefined' ? parentHeader : this._parentHeader;
+    const parentHeaderValue = parentHeader ?? this._parentHeader;
     const message = KernelMessage.createMessage<KernelMessage.IUpdateDisplayDataMsg>({
       channel: 'iopub',
       msgType: 'update_display_data',
@@ -396,8 +390,7 @@ export abstract class BaseKernel implements IKernel {
       | KernelMessage.IHeader<KernelMessage.MessageType>
       | undefined = undefined,
   ): void {
-    const parentHeaderValue =
-      typeof parentHeader !== 'undefined' ? parentHeader : this._parentHeader;
+    const parentHeaderValue = parentHeader ?? this._parentHeader;
     const message = KernelMessage.createMessage<KernelMessage.IClearOutputMsg>({
       channel: 'iopub',
       msgType: 'clear_output',
@@ -423,8 +416,7 @@ export abstract class BaseKernel implements IKernel {
       | KernelMessage.IHeader<KernelMessage.MessageType>
       | undefined = undefined,
   ): void {
-    const parentHeaderValue =
-      typeof parentHeader !== 'undefined' ? parentHeader : this._parentHeader;
+    const parentHeaderValue = parentHeader ?? this._parentHeader;
     const message = KernelMessage.createMessage<any>({
       channel: 'iopub',
       msgType: type,

package/src/nbconvert/exporters.ts

@@ -55,8 +55,31 @@ export class NotebookExporter extends BaseExporter {
    * @param path The path to the notebook
    */
   async export(model: Contents.IModel, path: string): Promise<void> {
+    let content = '';
+    switch (model.format) {
+      case 'base64': {
+        const decoded = atob(model.content);
+        try {
+          // If it contains JSON, format it nicely
+          const parsed = JSON.parse(decoded);
+          content = JSON.stringify(parsed, null, 2);
+        } catch {
+          // If it's not JSON, just use decoded text
+          content = decoded;
+        }
+        break;
+      }
+      case 'json': {
+        content = JSON.stringify(model.content, null, 2);
+        break;
+      }
+      case 'text': {
+        content = model.content;
+        break;
+      }
+    }
+
     const mime = model.mimetype ?? 'application/json';
-    const content = JSON.stringify(model.content, null, 2);
     this.triggerDownload(content, mime, path);
   }
 }

package/src/session/client.ts

@@ -157,6 +157,30 @@ export class LiteSessionClient implements ISessionAPIClient {
     if (running) {
       return running;
     }
+
+    // Check if we should reuse an existing kernel (kernel.id takes precedence over name).
+    // Note: The Session.ISessionOptions type doesn't include kernel.id, but at runtime
+    // it may be passed (e.g., from SessionContext._changeKernel when sharing a kernel).
+    const requestedKernelId = (options.kernel as { id?: string } | undefined)?.id;
+    if (requestedKernelId) {
+      const existingSession = this._sessions.find(
+        (session) => session.kernel?.id === requestedKernelId,
+      );
+      if (existingSession) {
+        // Create a new session that shares the existing kernel
+        const id = UUID.uuid4();
+        const session: Session.IModel = {
+          id,
+          path,
+          name: name ?? path,
+          type: 'notebook',
+          kernel: existingSession.kernel,
+        };
+        this._sessions.push(session);
+        return session;
+      }
+    }
+
     const kernelName = options.kernel?.name ?? '';
     const id = UUID.uuid4();
     const nameOrPath = options.name ?? options.path;