test: add simple test

Author: agoose77

packages/myst-compat/src/downgrade/version_2_1.spec.ts

@@ -0,0 +1,160 @@
+import { describe, expect, it } from 'vitest';
+import { downgrade } from './version_2_1.js';
+import type { Parent } from 'mdast';
+import { warn } from 'console';
+
+const SIMPLE_AST: Parent = {
+  type: 'root',
+  children: [
+    {
+      // @ts-expect-error: unknown type
+      type: 'block',
+      children: [
+        {
+          // @ts-expect-error: invalid child type
+          type: 'paragraph',
+          children: [
+            {
+              type: 'text',
+              value: 'This is an ',
+            },
+            {
+              type: 'emphasis',
+              children: [
+                {
+                  type: 'text',
+                  value: 'interesting',
+                },
+              ],
+            },
+            {
+              type: 'text',
+              value: ' file. See ',
+            },
+            {
+              type: 'link',
+              url: '#other',
+              children: [],
+              // @ts-expect-error: unknown field
+              urlSource: '#other',
+            },
+            {
+              type: 'text',
+              value: ' for more.',
+            },
+          ],
+        },
+        {
+          // @ts-expect-error: invalid child type
+          type: 'code',
+          lang: 'python',
+          value: 'Some code',
+        },
+      ],
+    },
+  ],
+};
+
+const SIMPLE_V2_AST_WITH_OUTPUT: Parent = {
+  type: 'root',
+  children: [
+    {
+      // @ts-expect-error: unknown type
+      type: 'block',
+      children: [
+        {
+          // @ts-expect-error: invalid child type
+          type: 'outputs',
+          id: 'abc123',
+          children: [
+            {
+              // @ts-expect-error: invalid child type
+              type: 'output',
+              children: [],
+              jupyter_data: {
+                output_type: 'display_data',
+                execution_count: 3,
+                metadata: {},
+                data: {
+                  'application/octet-stream': {
+                    content_type: 'application/octet-stream',
+                    hash: 'def456',
+                    path: '/my/path/def456.png',
+                  },
+                },
+              },
+            },
+          ],
+        },
+      ],
+    },
+  ],
+};
+
+const SIMPLE_V1_AST_WITH_OUTPUT: Parent = {
+  type: 'root',
+  children: [
+    {
+      // @ts-expect-error: unknown type
+      type: 'block',
+      children: [
+        {
+          // @ts-expect-error: invalid child type
+          type: 'output',
+          id: 'abc123',
+          // @ts-expect-error: invalid type
+          data: [
+            {
+              output_type: 'display_data',
+              execution_count: 3,
+              metadata: {},
+              data: {
+                'application/octet-stream': {
+                  content_type: 'application/octet-stream',
+                  hash: 'def456',
+                  path: '/my/path/def456.png',
+                },
+              },
+            },
+          ],
+          children: [],
+          _future_ast: {
+            type: 'outputs',
+            id: 'abc123',
+            children: [
+              {
+                type: 'output',
+		children: [],
+                jupyter_data: {
+                  output_type: 'display_data',
+                  execution_count: 3,
+                  metadata: {},
+                  data: {
+                    'application/octet-stream': {
+                      content_type: 'application/octet-stream',
+                      hash: 'def456',
+                      path: '/my/path/def456.png',
+                    },
+                  },
+                },
+              },
+            ],
+          },
+        },
+      ],
+    },
+  ],
+};
+
+describe('downgrade 2->1', () => {
+  it('leaves a simple AST unchanged', () => {
+    const ast = structuredClone(SIMPLE_AST);
+    downgrade(ast);
+    expect(ast).toStrictEqual(SIMPLE_AST);
+  });
+  it('downgrades a v2 AST with outputs', () => {
+    const ast = structuredClone(SIMPLE_V2_AST_WITH_OUTPUT);
+    downgrade(ast);
+    expect(ast).toStrictEqual(SIMPLE_V1_AST_WITH_OUTPUT);
+  });
+});

packages/myst-compat/src/downgrade/version_2_1.ts

@@ -2,6 +2,7 @@ import type { Parent } from 'mdast';
 import type { Outputs as Outputs2, Output as Output2 } from '../types/v2.js';
 import type { Output as Output1 } from '../types/v1.js';
 import { visit, SKIP } from 'unist-util-visit';
+import { squeeze } from '../utils.js';
 
 export function downgrade(ast: Parent) {
   visit(ast as any, 'outputs', (node: Outputs2, index: number | null, parent: Parent | null) => {
@@ -20,6 +21,9 @@ export function downgrade(ast: Parent) {
       id,
       _future_ast: structuredClone(node),
     };
+    // Drop any undefined members (assume all members are optional if undefined)
+    squeeze(nextOutput);
+
     if (parent) {
       parent.children[index!] = nextOutput as any;
     }

packages/myst-compat/src/utils.ts

@@ -0,0 +1,7 @@
+export function squeeze<T>(record: Record<string, T | unknown>) {
+  Object.keys(record).forEach((key) => {
+    if (record[key] === undefined) {
+      delete record[key];
+    }
+  });
+}