implement #5219 -- jupyter notebook cell ids: save our when exporting to ipynb (and importing from ipynb)

- this is mainly for compatibility with the jupyter ecosystem and
  tooling; not used internally at all.

Author: williamstein

src/packages/jupyter/ipynb/export-to-ipynb.ts

@@ -50,6 +50,7 @@ function cell_to_ipynb(id: string, opts: any) {
     cell_type: (left = cell.get("cell_type")) != null ? left : "code",
     source: diff_friendly((left1 = cell.get("input")) != null ? left1 : ""),
     metadata,
+    id,
   };
 
   // Handle any extra metadata (mostly user defined) that we don't handle in a special
@@ -87,7 +88,7 @@ function cell_to_ipynb(id: string, opts: any) {
       output,
       exec_count,
       opts.more_output != null ? opts.more_output[id] : undefined,
-      opts.blob_store
+      opts.blob_store,
     );
   } else if (obj.outputs == null && obj.cell_type === "code") {
     obj.outputs = []; // annoying requirement of ipynb file format.
@@ -130,7 +131,7 @@ function process_other_metadata(obj: any, other_metadata: any) {
 function process_attachments(
   obj: any,
   attachments: any,
-  blob_store: BlobStore | undefined
+  blob_store: BlobStore | undefined,
 ) {
   if (attachments == null || blob_store == null) {
     // don't have to or can't do anything (https://github.com/sagemathinc/cocalc/issues/4272)
@@ -155,7 +156,7 @@ function ipynb_outputs(
   output: any,
   exec_count: any,
   more_output: any,
-  blob_store: BlobStore | undefined
+  blob_store: BlobStore | undefined,
 ) {
   // If the last message has the more_output field, then there may be
   // more output messages stored, which are not in the cells object.
@@ -170,7 +171,7 @@ function ipynb_outputs(
         immutable.fromJS({
           text: "WARNING: Some output was deleted.\n",
           name: "stderr",
-        })
+        }),
       );
     } else {
       // Indeed, the last message has the more_output field.
@@ -204,7 +205,7 @@ function ipynb_outputs(
 function process_output_n(
   output_n: any,
   exec_count: any,
-  blob_store: BlobStore | undefined
+  blob_store: BlobStore | undefined,
 ) {
   if (output_n == null) {
     return;

src/packages/jupyter/ipynb/import-from-ipynb.ts

@@ -255,7 +255,11 @@ export class IPynbImporter {
     );
   };
 
-  _get_new_id = () => {
+  _get_new_id = (cell) => {
+    if (cell?.id && this._id_is_available(cell.id)) {
+      // attempt to use id in the ipynb file
+      return cell.id;
+    }
     if (this._new_id != null) {
       return this._new_id(this._id_is_available);
     } else {
@@ -333,7 +337,7 @@ export class IPynbImporter {
         ? this._existing_ids != null
           ? this._existing_ids[n]
           : undefined
-        : this._get_new_id();
+        : this._get_new_id(cell);
     const obj: any = {
       type: "cell",
       id,
@@ -344,12 +348,12 @@ export class IPynbImporter {
         cell.metadata != null && cell.metadata.cocalc != null
           ? cell.metadata.cocalc.outputs
           : undefined,
-        id
+        id,
       ),
       cell_type: this._get_cell_type(cell.cell_type),
       exec_count: this._get_exec_count(
         cell.execution_count,
-        cell.prompt_number
+        cell.prompt_number,
       ),
     };