@dxos/plugin-script 0.8.4-main.e098934 → 0.8.4-main.ead640a

package/src/notebook/eval.ts

@@ -0,0 +1,105 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { trim } from '@dxos/util';
+
+/**
+ * Evaluate the script (with dependencies as arguments).
+ */
+export const evalScript = (code: string, deps: Record<string, any> = {}) => {
+  // Create a sandboxed environment that blocks access to window and document.
+  const sandbox = {
+    ...deps,
+
+    // Block access to global objects.
+    console: undefined,
+    document: undefined,
+    global: undefined,
+    globalThis: undefined,
+    self: undefined,
+    window: undefined,
+
+    // Allow some safe globals.
+    Array,
+    Boolean,
+    Date,
+    Error,
+    JSON,
+    Map,
+    Math,
+    Number,
+    Object,
+    Promise,
+    RegExp,
+    Set,
+    String,
+
+    // Functions.
+    isFinite,
+    isNaN,
+    parseFloat,
+    parseInt,
+
+    // Note: undefined and null are not included as they are keywords, not variables.
+  };
+
+  // Create function with all sandbox keys as parameters.
+  const sandboxKeys = Object.keys(sandbox);
+  const sandboxValues = Object.values(sandbox);
+
+  // eslint-disable-next-line @typescript-eslint/no-implied-eval
+  const fn = new Function(
+    ...sandboxKeys,
+    trim`
+      'use strict';
+      return ${code};
+    `,
+  );
+
+  return fn(...sandboxValues);
+};
+
+/**
+ * Globals.
+ */
+export const builtIns = new Set([
+  // Types.
+  'Array',
+  'Date',
+  'Error',
+  'JSON',
+  'Map',
+  'Math',
+  'Number',
+  'Object',
+  'Promise',
+  'RegExp',
+  'Set',
+  'String',
+
+  // Functions.
+  'isFinite',
+  'isNaN',
+  'parseFloat',
+  'parseInt',
+]);
+
+/**
+ * Default system definitions.
+ */
+export const systemDefinitions = trim`
+  interface Array<T> { length: number; [n: number]: T; }
+  interface Boolean {}
+  interface Function {}
+  interface IArguments {}
+  interface Number {}
+  interface Object {}
+  interface RegExp {}
+  interface String { length: number; }
+
+  interface CallableFunction extends Function {}
+  interface NewableFunction extends Function {}
+
+  declare var console: { log(...args: any[]): void };
+`;

package/src/notebook/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './notebook';

package/src/notebook/notebook.test.ts

@@ -0,0 +1,70 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, test } from 'vitest';
+
+import { createNotebook } from '../testing';
+
+import { ComputeGraph } from './notebook';
+
+describe('notebook', () => {
+  test('parse dependency graph', () => {
+    const notebook = createNotebook();
+    const computer = new ComputeGraph(notebook);
+    const result = computer.parse();
+
+    const getId = (i: number) => notebook.cells[i].id;
+
+    // Check dependencies.
+    expect(result.dependencyGraph).toMatchObject({
+      [getId(0)]: [getId(1), getId(2)],
+      [getId(3)]: [getId(1)],
+      [getId(4)]: [getId(0), getId(3)],
+    });
+
+    // Compute values.
+    const values = computer.evaluate();
+    expect(values).toEqual({
+      [getId(0)]: 300,
+      [getId(2)]: 200,
+      [getId(3)]: 200,
+      [getId(4)]: 500,
+    });
+  });
+
+  test('evalScript blocks access to window and document', () => {
+    const notebook = createNotebook();
+    // Replace one of the cells with code that tries to access window/document.
+    if (notebook.cells[2].script?.target) {
+      notebook.cells[2].script.target.content = 'b = typeof window';
+    }
+
+    const computer = new ComputeGraph(notebook);
+    computer.parse();
+    const values = computer.evaluate();
+
+    // Should evaluate to 'undefined' since window is blocked.
+    expect(values[notebook.cells[2].id]).toBe('undefined');
+
+    // Test document access.
+    if (notebook.cells[2].script?.target) {
+      notebook.cells[2].script.target.content = 'b = typeof document';
+    }
+    computer.parse();
+    const values2 = computer.evaluate();
+
+    // Should evaluate to 'undefined' since document is blocked.
+    expect(values2[notebook.cells[2].id]).toBe('undefined');
+
+    // Test that safe globals still work.
+    if (notebook.cells[2].script?.target) {
+      notebook.cells[2].script.target.content = 'b = Math.max(100, 200)';
+    }
+    computer.parse();
+    const values3 = computer.evaluate();
+
+    // Should evaluate correctly.
+    expect(values3[notebook.cells[2].id]).toBe(200);
+  });
+});

package/src/notebook/notebook.ts

@@ -0,0 +1,183 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Signal, signal } from '@preact/signals-core';
+
+import { log } from '@dxos/log';
+
+import { type Notebook } from '../types';
+
+import { evalScript } from './eval';
+import { type ParsedExpression, VirtualTypeScriptParser } from './vfs-parser';
+
+/**
+ * Compute graph that evaluates the notebook cells.
+ */
+export class ComputeGraph {
+  private readonly _parser = new VirtualTypeScriptParser();
+
+  private _expressions = signal<Record<string, ParsedExpression>>({});
+  private _values = signal<Record<string, any>>({});
+
+  constructor(private readonly _notebook: Notebook.Notebook) {}
+
+  /**
+   * Parsed expressions by cell ID.
+   */
+  get expressions(): Signal<Record<string, ParsedExpression>> {
+    return this._expressions;
+  }
+
+  /**
+   * Computed values by cell ID.
+   */
+  get values(): Signal<Record<string, any>> {
+    return this._values;
+  }
+
+  /**
+   * Compute values.
+   */
+  evaluate() {
+    // Parse expressions.
+    const { expressions, dependencyGraph } = this.parse();
+    this._values.value = {};
+
+    // Create a map of cell IDs to expressions for easy lookup.
+    const cellExpressions = new Map<string, ParsedExpression>();
+    Object.entries(expressions).forEach(([id, expr]) => {
+      cellExpressions.set(id, expr);
+    });
+
+    // Topological sort to determine evaluation order.
+    const evaluationOrder = this.topologicalSort(Object.keys(expressions), dependencyGraph);
+
+    // Values by reference name.
+    const valuesByName: Record<string, any> = {};
+    const valuesByCellId: Record<string, any> = {};
+
+    // Evaluate cells in dependency order.
+    for (const cellId of evaluationOrder) {
+      const expr = cellExpressions.get(cellId);
+      if (!expr) {
+        log.error('no expression for cell', { cellId });
+        continue;
+      }
+
+      const cellSource = this._notebook.cells.find((cell) => cell.id === cellId)?.script?.target?.content;
+      if (!cellSource) {
+        log.error('no source for cell', { cellId });
+        continue;
+      }
+
+      try {
+        // For assignments or declarations, evaluate and store the value.
+        if (expr.name && expr.value !== undefined) {
+          // If the parser extracted a literal value, use it directly.
+          valuesByName[expr.name] = expr.value;
+          valuesByCellId[cellId] = expr.value;
+        } else if (expr.name) {
+          // For non-literal assignments, we need to evaluate the expression.
+          // The parser identifies it's an assignment, so we can extract the RHS.
+          const equalIndex = cellSource.indexOf('=');
+          if (equalIndex !== -1) {
+            // Find the actual assignment operator (not in strings or other contexts).
+            let rhs = cellSource.substring(equalIndex + 1).trim();
+
+            // Handle semicolon at the end.
+            if (rhs.endsWith(';')) {
+              rhs = rhs.slice(0, -1).trim();
+            }
+
+            const result = evalScript(rhs, valuesByName);
+            valuesByName[expr.name] = result;
+            if (typeof result !== 'function') {
+              valuesByCellId[cellId] = result;
+            }
+          }
+        } else {
+          // For expressions without assignment, just evaluate.
+          const result = evalScript(cellSource, valuesByName);
+          valuesByCellId[cellId] = result;
+        }
+      } catch (error) {
+        log.error('error evaluating cell', { cellId, error });
+      }
+    }
+
+    this._values.value = valuesByCellId;
+    return valuesByCellId;
+  }
+
+  /**
+   * Parse expressions.
+   */
+  parse() {
+    const expressions = this._notebook.cells
+      .filter((cell) => cell.type === 'script')
+      .reduce<Record<string, ParsedExpression>>((acc, cell) => {
+        const text = cell.script?.target?.content.trim();
+        if (text) {
+          const parsed = this._parser.parseExpression(text);
+          acc[cell.id] = parsed;
+        }
+
+        return acc;
+      }, {});
+
+    // Build dependency graph.
+    const dependencyGraph = this.buildDependencyGraph(expressions);
+    this._expressions.value = expressions;
+    return { expressions, dependencyGraph };
+  }
+
+  private topologicalSort(nodes: string[], dependencies: Record<string, string[]>): string[] {
+    const visited = new Set<string>();
+    const result: string[] = [];
+
+    const visit = (node: string) => {
+      if (visited.has(node)) {
+        return;
+      }
+
+      visited.add(node);
+
+      // Visit dependencies first.
+      const deps = dependencies[node] || [];
+      deps.forEach((dep) => visit(dep));
+      result.push(node);
+    };
+
+    // Visit all nodes.
+    nodes.forEach((node) => visit(node));
+    return result;
+  }
+
+  private buildDependencyGraph(expressions: Record<string, ParsedExpression>): Record<string, string[]> {
+    // Create a map of variable names to their cell IDs.
+    const nameToCellId = new Map<string, string>();
+    Object.entries(expressions).forEach(([id, expr]) => {
+      if (expr.name) {
+        nameToCellId.set(expr.name, id);
+      }
+    });
+
+    // Build the dependency graph using cell IDs.
+    const graph: Record<string, string[]> = {};
+    Object.entries(expressions).forEach(([id, expr]) => {
+      if (expr.references && expr.references.length > 0) {
+        // Map variable references to cell IDs.
+        const dependencyCellIds = expr.references
+          .map((ref) => nameToCellId.get(ref))
+          .filter((cellId): cellId is string => cellId !== undefined && cellId !== id);
+
+        if (dependencyCellIds.length > 0) {
+          graph[id] = dependencyCellIds;
+        }
+      }
+    });
+
+    return graph;
+  }
+}

package/src/notebook/vfs-parser.test.ts

@@ -0,0 +1,149 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, test } from 'vitest';
+
+import { NotebookVirtualParser, VirtualTypeScriptParser } from './vfs-parser';
+
+describe('vfs-parser', () => {
+  test('parse simple assignments', () => {
+    const parser = new VirtualTypeScriptParser();
+
+    const tests = [
+      {
+        input: 'const a = 1',
+        expected: {
+          name: 'a',
+          type: 'variable',
+        },
+      },
+      {
+        input: 'a = 1',
+        expected: {
+          name: 'a',
+          type: 'variable',
+        },
+      },
+    ];
+
+    tests.forEach(({ input, expected }) => {
+      const result = parser.parseExpression(input);
+      expect(result, input).toMatchObject(expected);
+    });
+  });
+
+  test('parse variable with references', () => {
+    const parser = new VirtualTypeScriptParser();
+
+    const tests = [
+      {
+        input: 'const y = x * 2',
+        expected: {
+          name: 'y',
+          type: 'variable',
+          references: ['x'],
+        },
+      },
+      {
+        input: 'y = x * 2',
+        expected: {
+          name: 'y',
+          type: 'variable',
+          references: ['x'],
+        },
+      },
+    ];
+
+    tests.forEach(({ input, expected }) => {
+      const result = parser.parseExpression(input);
+      expect(result, input).toMatchObject(expected);
+    });
+  });
+
+  test('parse simple expression with references', () => {
+    const parser = new VirtualTypeScriptParser();
+
+    const result = parser.parseExpression('(a + b) * c');
+    expect(result).toMatchObject({
+      references: ['a', 'b', 'c'],
+    });
+  });
+
+  test('parse single expression', () => {
+    const parser = new VirtualTypeScriptParser();
+
+    const result = parser.parseExpression('const add = (a: number, b: number): number => a + b;');
+    expect(result).toMatchObject({
+      name: 'add',
+      type: 'function',
+      valueType: expect.stringContaining('(a: number, b: number) => number'),
+      returnType: 'number',
+      parameters: [
+        { name: 'a', type: 'number' },
+        { name: 'b', type: 'number' },
+      ],
+    });
+  });
+
+  test('analyze multiple files', () => {
+    const parser = new VirtualTypeScriptParser();
+
+    const files = [
+      {
+        filename: '/test.ts',
+        content: 'export const PI = 3.14159;\nexport function square(x: number): number { return x * x; }',
+      },
+    ];
+
+    const results = parser.analyzeFiles(files);
+    expect(results).toHaveLength(2);
+    expect(results[0]).toMatchObject({
+      name: 'PI',
+      type: 'variable',
+      valueType: '3.14159',
+    });
+    expect(results[1]).toMatchObject({
+      name: 'square',
+      type: 'function',
+      returnType: 'number',
+      parameters: [{ name: 'x', type: 'number' }],
+    });
+  });
+
+  test('notebook cell analysis', () => {
+    const parser = new NotebookVirtualParser();
+
+    const cells = [
+      { id: 'cell1', code: 'const x: number = 10;' },
+      { id: 'cell2', code: 'const y = x * 2;' },
+      { id: 'cell3', code: 'console.log(y);' },
+    ];
+
+    const analysis = parser.analyzeNotebook(cells);
+
+    // Cell 1 exports x.
+    const cell1 = analysis.get('cell1');
+    expect(cell1?.exports).toHaveLength(1);
+    expect(cell1?.exports[0]).toMatchObject({
+      name: 'x',
+      type: 'variable',
+      valueType: 'number',
+    });
+    expect(cell1?.imports).toHaveLength(0);
+
+    // Cell 2 imports x and exports y.
+    const cell2 = analysis.get('cell2');
+    expect(cell2?.exports).toHaveLength(1);
+    expect(cell2?.exports[0]).toMatchObject({
+      name: 'y',
+      type: 'variable',
+    });
+    expect(cell2?.imports).toContain('x');
+
+    // Cell 3 imports y.
+    const cell3 = analysis.get('cell3');
+    expect(cell3?.exports).toHaveLength(0);
+    expect(cell3?.imports).toContain('y');
+  });
+});