@dxos/plugin-sheet 0.6.12-staging.e11e696 → 0.6.12

package/src/{graph/functions → components/ComputeGraph}/edge-function.ts

@@ -3,6 +3,7 @@
 //
 
 import { effect } from '@preact/signals-core';
+import { CellError, ErrorType, FunctionArgumentType } from 'hyperformula';
 import { type InterpreterState } from 'hyperformula/typings/interpreter/InterpreterState';
 import { type ProcedureAst } from 'hyperformula/typings/parser';
 
@@ -12,20 +13,17 @@ import { getUserFunctionUrlInMetadata } from '@dxos/plugin-script/edge';
 import { FunctionType } from '@dxos/plugin-script/types';
 import { nonNullable } from '@dxos/util';
 
-import { CellError, ErrorType, FunctionArgumentType } from '#hyperformula';
-import { type AsyncFunction, AsyncFunctionPlugin } from './async-function';
+import { type AsyncFunction, FunctionPluginAsync } from './async-function';
 
-export const EDGE_FUNCTION_NAME = 'DX';
-
-const FUNCTION_TTL = 10_000;
+const EDGE_FUNCTION_TTL = 10_000;
 
 /**
- * A hyperformula function plugin for calling remote (EDGE) functions.
+ * A hyperformula function plugin for calling EDGE functions.
  *
  * https://hyperformula.handsontable.com/guide/custom-functions.html#add-a-simple-custom-function
  */
-export class EdgeFunctionPlugin extends AsyncFunctionPlugin {
-  dx(ast: ProcedureAst, state: InterpreterState) {
+export class EdgeFunctionPlugin extends FunctionPluginAsync {
+  edge(ast: ProcedureAst, state: InterpreterState) {
     const handler =
       (subscribe = false): AsyncFunction =>
       async (binding: string, ...args: any) => {
@@ -49,7 +47,7 @@ export class EdgeFunctionPlugin extends AsyncFunctionPlugin {
 
             // TODO(wittjosiah): `ttl` should be 0 to force a recalculation when a new version is deployed.
             //  This needs a ttl to prevent a binding change from causing the function not to be found.
-            this.runAsyncFunction(ast, state, handler(false), { ttl: FUNCTION_TTL });
+            this.runAsyncFunction(ast, state, handler(false), { ttl: EDGE_FUNCTION_TTL });
           });
 
           this.context.createSubscription(ast.procedureName, unsubscribe);
@@ -61,22 +59,22 @@ export class EdgeFunctionPlugin extends AsyncFunctionPlugin {
           headers: { 'Content-Type': 'application/json' },
           body: JSON.stringify({ args: args.filter(nonNullable) }),
         });
-
         return await result.text();
       };
 
-    return this.runAsyncFunction(ast, state, handler(true), { ttl: FUNCTION_TTL });
+    return this.runAsyncFunction(ast, state, handler(true), { ttl: EDGE_FUNCTION_TTL });
   }
 }
 
 EdgeFunctionPlugin.implementedFunctions = {
-  [EDGE_FUNCTION_NAME]: {
-    method: 'dx',
+  EDGE: {
+    method: 'edge',
     parameters: [
       // Binding
       { argumentType: FunctionArgumentType.STRING },
 
-      // Remote function arguments (currently supporting up to 8).
+      // Remote function arguments (currently supporting up to 9).
+      { argumentType: FunctionArgumentType.ANY, optionalArg: true },
       { argumentType: FunctionArgumentType.ANY, optionalArg: true },
       { argumentType: FunctionArgumentType.ANY, optionalArg: true },
       { argumentType: FunctionArgumentType.ANY, optionalArg: true },
@@ -92,9 +90,9 @@ EdgeFunctionPlugin.implementedFunctions = {
 
 export const EdgeFunctionPluginTranslations = {
   enGB: {
-    [EDGE_FUNCTION_NAME]: 'Remote function',
+    EDGE: 'EDGE',
   },
   enUS: {
-    [EDGE_FUNCTION_NAME]: 'Remote function',
+    EDGE: 'EDGE',
   },
 };

package/src/components/ComputeGraph/graph-context.tsx

@@ -0,0 +1,50 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { createContext, type PropsWithChildren, useContext, useEffect } from 'react';
+
+import { type Space } from '@dxos/react-client/echo';
+
+import { type FunctionContextOptions } from './async-function';
+import { CustomPlugin, CustomPluginTranslations } from './custom';
+import { EdgeFunctionPlugin, EdgeFunctionPluginTranslations } from './edge-function';
+import { createComputeGraph, type ComputeGraph } from './graph';
+
+export type ComputeGraphContextType = {
+  graphs: Record<string, ComputeGraph>;
+  setGraph: (key: string, graph: ComputeGraph) => void;
+};
+
+export const ComputeGraphContext = createContext<ComputeGraphContextType>({ graphs: {}, setGraph: () => {} });
+
+export const ComputeGraphContextProvider = ({
+  children,
+  graphs,
+  setGraph,
+}: PropsWithChildren<ComputeGraphContextType>) => {
+  return <ComputeGraphContext.Provider value={{ graphs, setGraph }}>{children}</ComputeGraphContext.Provider>;
+};
+
+export const useComputeGraph = (space: Space, options?: Partial<FunctionContextOptions>): ComputeGraph => {
+  const { graphs, setGraph } = useContext(ComputeGraphContext);
+  const graph =
+    graphs[space.id] ??
+    createComputeGraph(
+      [
+        { plugin: EdgeFunctionPlugin, translations: EdgeFunctionPluginTranslations },
+        // TODO(wittjosiah): Remove. Needed for current test sheet generated data.
+        { plugin: CustomPlugin, translations: CustomPluginTranslations },
+      ],
+      space,
+      options,
+    );
+
+  useEffect(() => {
+    if (!graphs[space.id]) {
+      setGraph(space.id, graph);
+    }
+  }, [space]);
+
+  return graph;
+};

package/src/components/ComputeGraph/graph.browser.test.ts

@@ -0,0 +1,50 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { expect } from 'chai';
+import { describe, test } from 'vitest';
+
+import { Trigger } from '@dxos/async';
+
+import { CustomPlugin, CustomPluginTranslations } from './custom';
+import { createComputeGraph } from './graph';
+import { addressFromA1Notation, SheetModel } from '../../model';
+import { type CellScalarValue, createSheet } from '../../types';
+
+/**
+ * VITEST_ENV=chrome p vitest --watch
+ * NOTE: Browser test required for hyperformula due to raw translation files.
+ */
+describe('compute graph', () => {
+  const createModel = async () => {
+    const graph = createComputeGraph([{ plugin: CustomPlugin, translations: CustomPluginTranslations }]);
+    const sheet = createSheet();
+    const model = new SheetModel(graph, sheet, undefined, { rows: 5, columns: 5 });
+    graph.update.on(() => model.update.emit());
+    return { graph, model };
+  };
+
+  test('async function', async () => {
+    const { graph, model } = await createModel();
+
+    // Triggers function.
+    model.setValue(addressFromA1Notation('A1'), '=TEST()');
+
+    const trigger = new Trigger<CellScalarValue>();
+    model.update.on(() => {
+      const value = model.getValue(addressFromA1Notation('A1'));
+      trigger.wake(value);
+    });
+
+    // Get initial value (i.e., null).
+    const v1 = model.getValue(addressFromA1Notation('A1'));
+    expect(v1).to.be.null;
+    expect(graph.context.info.invocations.TEST).to.eq(undefined);
+
+    // Wait until async update triggered.
+    const v2 = await trigger.wait();
+    expect(v2).not.to.be.null;
+    expect(graph.context.info.invocations.TEST).to.eq(1);
+  });
+});

package/src/components/ComputeGraph/graph.ts

@@ -0,0 +1,62 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type FunctionPluginDefinition, HyperFormula } from 'hyperformula';
+import { type FunctionTranslationsPackage } from 'hyperformula/typings/interpreter';
+
+import { Event } from '@dxos/async';
+import { type Space } from '@dxos/client/echo';
+import { PublicKey } from '@dxos/keys';
+import { log } from '@dxos/log';
+
+import { FunctionContext, type FunctionContextOptions } from './async-function';
+
+/**
+ * Create root graph for space.
+ */
+export const createComputeGraph = (
+  // TODO(wittjosiah): Factor out this type to make these easier to define.
+  functionPlugins: { plugin: FunctionPluginDefinition; translations: FunctionTranslationsPackage }[] = [],
+  space?: Space,
+  options?: Partial<FunctionContextOptions>,
+): ComputeGraph => {
+  functionPlugins.forEach(({ plugin, translations }) => {
+    HyperFormula.registerFunctionPlugin(plugin, translations);
+  });
+
+  const hf = HyperFormula.buildEmpty({ licenseKey: 'gpl-v3' });
+  return new ComputeGraph(hf, space, options);
+};
+
+/**
+ * Per-space compute and dependency graph.
+ */
+// TODO(burdon): Create instance for each space.
+export class ComputeGraph {
+  public readonly id = `graph-${PublicKey.random().truncate()}`;
+  public readonly update = new Event();
+
+  // The context is passed to all functions.
+  public readonly context = new FunctionContext(
+    this.hf,
+    this._space,
+    () => {
+      this.refresh();
+    },
+    this._options,
+  );
+
+  constructor(
+    public readonly hf: HyperFormula,
+    private readonly _space?: Space,
+    private readonly _options?: Partial<FunctionContextOptions>,
+  ) {
+    this.hf.updateConfig({ context: this.context });
+  }
+
+  refresh() {
+    log('refresh', { id: this.id });
+    this.update.emit();
+  }
+}

package/src/components/ComputeGraph/index.ts

@@ -2,4 +2,6 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './ComputeGraphContextProvider';
+export * from './async-function';
+export * from './custom';
+export * from './graph';

package/src/components/Sheet/Sheet.stories.tsx

@@ -4,34 +4,31 @@
 
 import '@dxos-theme';
 
-import React, { useState } from 'react';
+import { type Decorator } from '@storybook/react';
+import React, { useContext, useEffect, useState } from 'react';
 
+import { Client } from '@dxos/client';
+import { type EchoReactiveObject } from '@dxos/echo-schema';
 import { log } from '@dxos/log';
-import { useSpace } from '@dxos/react-client/echo';
-import { withClientProvider } from '@dxos/react-client/testing';
+import { getSpace, type Space } from '@dxos/react-client/echo';
 import { Button } from '@dxos/react-ui';
 import { mx } from '@dxos/react-ui-theme';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
+import { withTheme, withLayout } from '@dxos/storybook-utils';
 
 import { Sheet } from './Sheet';
 import { type SizeMap } from './grid';
 import { useSheetContext } from './sheet-context';
-import { addressToIndex, rangeToIndex } from '../../defs';
-import { type ComputeGraph } from '../../graph';
-import { testFunctionPlugins } from '../../graph/testing';
-import { useComputeGraph } from '../../hooks';
-import { createTestCells, useTestSheet, withComputeGraphDecorator } from '../../testing';
-import { SheetType, ValueTypeEnum } from '../../types';
+import { createTestSheet, testSheetName } from '../../testing';
+import { ValueTypeEnum, SheetType } from '../../types';
+import { type ComputeGraph, createComputeGraph } from '../ComputeGraph';
+// TODO(wittjosiah): Refactor. This is not exported from ./components due to depending on ECHO.
+import { ComputeGraphContext, ComputeGraphContextProvider, useComputeGraph } from '../ComputeGraph/graph-context';
 import { Toolbar, type ToolbarActionHandler } from '../Toolbar';
 
 // TODO(burdon): Allow toolbar to access sheet context; provide state for current cursor/range.
-const SheetWithToolbar = ({ graph, debug }: { graph: ComputeGraph; debug?: boolean }) => {
+const SheetWithToolbar = ({ debug, space }: { debug?: boolean; space: Space }) => {
   const { model, cursor, range } = useSheetContext();
 
-  const handleRefresh = () => {
-    // graph?.refresh(); // TODO(burdon): ???
-  };
-
   // TODO(burdon): Factor out.
   const handleAction: ToolbarActionHandler = ({ type }) => {
     log.info('action', { type, cursor, range });
@@ -39,7 +36,7 @@ const SheetWithToolbar = ({ graph, debug }: { graph: ComputeGraph; debug?: boole
       return;
     }
 
-    const idx = range ? rangeToIndex(model.sheet, range) : addressToIndex(model.sheet, cursor);
+    const idx = range ? model.rangeToIndex(range) : model.addressToIndex(cursor);
     model.sheet.formatting[idx] ??= {};
     const format = model.sheet.formatting[idx];
 
@@ -78,12 +75,14 @@ const SheetWithToolbar = ({ graph, debug }: { graph: ComputeGraph; debug?: boole
         format.precision = 2;
         break;
       }
-      case 'comment': {
-        break;
-      }
     }
   };
 
+  const graph = useComputeGraph(space);
+  const handleRefresh = () => {
+    graph.refresh();
+  };
+
   return (
     <div className='flex flex-col overflow-hidden'>
       <Toolbar.Root onAction={handleAction}>
@@ -100,43 +99,56 @@ const SheetWithToolbar = ({ graph, debug }: { graph: ComputeGraph; debug?: boole
   );
 };
 
+const withGraphDecorator: Decorator = (Story) => {
+  const [graphs, setGraphs] = useState<Record<string, ComputeGraph>>({});
+
+  const setGraph = (key: string, graph: ComputeGraph) => {
+    if (!graph.hf.doesSheetExist(testSheetName)) {
+      const sheetName = graph.hf.addSheet(testSheetName);
+      const sheet = graph.hf.getSheetId(sheetName)!;
+      graph.hf.setCellContents({ sheet, col: 0, row: 0 }, Math.random());
+    }
+
+    setGraphs((graphs) => ({ ...graphs, [key]: graph }));
+  };
+
+  return (
+    <ComputeGraphContextProvider graphs={graphs} setGraph={setGraph}>
+      <Story />
+    </ComputeGraphContextProvider>
+  );
+};
+
 export default {
   title: 'plugin-sheet/Sheet',
   component: Sheet,
-  decorators: [
-    withClientProvider({ types: [SheetType], createIdentity: true }),
-    withComputeGraphDecorator({ plugins: testFunctionPlugins }),
-    withTheme,
-    withLayout({ fullscreen: true, tooltips: true, classNames: 'inset-4' }),
-  ],
+  decorators: [withTheme, withLayout({ fullscreen: true, tooltips: true, classNames: 'inset-4' }), withGraphDecorator],
 };
 
 export const Default = () => {
   const [debug, setDebug] = useState(false);
-  const space = useSpace();
-  const graph = useComputeGraph(space);
-  const sheet = useTestSheet(space, graph, { cells: createTestCells() });
-  if (!graph || !sheet) {
+  const sheet = useTestSheet();
+  const space = getSpace(sheet);
+  if (!sheet || !space) {
     return null;
   }
 
   return (
-    <Sheet.Root graph={graph} sheet={sheet} onInfo={() => setDebug((debug) => !debug)}>
-      <SheetWithToolbar graph={graph} debug={debug} />
+    <Sheet.Root sheet={sheet} space={space} onInfo={() => setDebug((debug) => !debug)}>
+      <SheetWithToolbar debug={debug} space={space} />
     </Sheet.Root>
   );
 };
 
 export const Debug = () => {
-  const space = useSpace();
-  const graph = useComputeGraph(space);
-  const sheet = useTestSheet(space, graph, { cells: createTestCells() });
-  if (!graph || !sheet) {
+  const sheet = useTestSheet();
+  const space = getSpace(sheet);
+  if (!sheet || !space) {
     return null;
   }
 
   return (
-    <Sheet.Root graph={graph} sheet={sheet}>
+    <Sheet.Root sheet={sheet} space={space}>
       <Sheet.Main />
       <Sheet.Debug />
     </Sheet.Root>
@@ -145,15 +157,14 @@ export const Debug = () => {
 
 export const Rows = () => {
   const [rowSizes, setRowSizes] = useState<SizeMap>({});
-  const space = useSpace();
-  const graph = useComputeGraph(space);
-  const sheet = useTestSheet(space, graph);
-  if (!graph || !sheet) {
+  const sheet = useTestSheet();
+  const space = getSpace(sheet);
+  if (!sheet || !space) {
     return null;
   }
 
   return (
-    <Sheet.Root graph={graph} sheet={sheet}>
+    <Sheet.Root sheet={sheet} space={space}>
       <Sheet.Rows
         rows={sheet.rows}
         sizes={rowSizes}
@@ -165,15 +176,14 @@ export const Rows = () => {
 
 export const Columns = () => {
   const [columnSizes, setColumnSizes] = useState<SizeMap>({});
-  const space = useSpace();
-  const graph = useComputeGraph(space);
-  const sheet = useTestSheet(space, graph);
-  if (!graph || !sheet) {
+  const sheet = useTestSheet();
+  const space = getSpace(sheet);
+  if (!sheet || !space) {
     return null;
   }
 
   return (
-    <Sheet.Root graph={graph} sheet={sheet}>
+    <Sheet.Root sheet={sheet} space={space}>
       <Sheet.Columns
         columns={sheet.columns}
         sizes={columnSizes}
@@ -184,19 +194,18 @@ export const Columns = () => {
 };
 
 export const Main = () => {
-  const space = useSpace();
-  const graph = useComputeGraph(space);
-  const sheet = useTestSheet(space, graph, { cells: createTestCells() });
-  if (!graph || !sheet) {
+  const sheet = useTestSheet();
+  const space = getSpace(sheet);
+  if (!sheet || !space) {
     return null;
   }
 
   return (
-    <Sheet.Root graph={graph} sheet={sheet}>
+    <Sheet.Root sheet={sheet} space={space}>
       <Sheet.Grid
         size={{
           numRows: 50,
-          numCols: 26,
+          numColumns: 26,
         }}
         rows={sheet.rows}
         columns={sheet.columns}
@@ -249,3 +258,30 @@ export const GridLayout = () => {
 const Cell = ({ className, label }: { className?: string; label: string }) => (
   <div className={mx('flex items-center justify-center border', className)}>{label}</div>
 );
+
+const useTestSheet = () => {
+  const { graphs, setGraph } = useContext(ComputeGraphContext);
+  const [sheet, setSheet] = useState<EchoReactiveObject<SheetType>>();
+  useEffect(() => {
+    const t = setTimeout(async () => {
+      const client = new Client();
+      await client.initialize();
+      await client.halo.createIdentity();
+      const space = await client.spaces.create();
+      client.addTypes([SheetType]);
+
+      const graph = graphs[space.id] ?? createComputeGraph();
+      if (!graphs[space.id]) {
+        setGraph(space.id, graph);
+      }
+
+      const sheet = await createTestSheet({ graph });
+      space.db.add(sheet);
+      setSheet(sheet);
+    });
+
+    return () => clearTimeout(t);
+  }, []);
+
+  return sheet;
+};