@dxos/app-graph 0.7.1 → 0.7.2-staging.6d26b2a

package/src/graph.ts

@@ -8,7 +8,7 @@ import { asyncTimeout, Trigger } from '@dxos/async';
 import { type ReactiveObject, create } from '@dxos/echo-schema';
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
-import { nonNullable } from '@dxos/util';
+import { type MakeOptional, nonNullable, pick } from '@dxos/util';
 
 import { type Relation, type Node, type NodeArg, type NodeFilter, isActionLike, actionGroupSymbol } from './node';
 
@@ -66,8 +66,7 @@ export type GraphTraversalOptions = {
 };
 
 export type GraphParams = {
-  // TODO(wittjosiah): Make data optional instead of omitting.
-  nodes?: Omit<Node, 'data'>[];
+  nodes?: MakeOptional<Node, 'data' | 'cacheable'>[];
   edges?: Record<string, string[]>;
   onInitialNode?: Graph['_onInitialNode'];
   onInitialNodes?: Graph['_onInitialNodes'];
@@ -96,15 +95,26 @@ export class Graph {
   readonly _edges: Record<string, ReactiveObject<{ inbound: string[]; outbound: string[] }>> = {};
 
   constructor({ nodes, edges, onInitialNode, onInitialNodes, onRemoveNode }: GraphParams = {}) {
-    this._nodes[ROOT_ID] = this._constructNode({ id: ROOT_ID, type: ROOT_TYPE, properties: {}, data: null });
+    this._onInitialNode = onInitialNode;
+    this._onInitialNodes = onInitialNodes;
+    this._onRemoveNode = onRemoveNode;
+
+    this._nodes[ROOT_ID] = this._constructNode({
+      id: ROOT_ID,
+      type: ROOT_TYPE,
+      cacheable: [],
+      properties: {},
+      data: null,
+    });
     if (nodes) {
       nodes.forEach((node) => {
+        const cacheable = Object.keys(node.properties ?? {});
         if (node.type === ACTION_TYPE) {
-          this._addNode({ ...node, data: () => log.warn('Pickled action invocation') });
+          this._addNode({ cacheable, data: () => log.warn('Pickled action invocation'), ...node });
         } else if (node.type === ACTION_GROUP_TYPE) {
-          this._addNode({ ...node, data: actionGroupSymbol });
+          this._addNode({ cacheable, data: actionGroupSymbol, ...node });
         } else {
-          this._addNode(node);
+          this._addNode({ cacheable, ...node });
         }
       });
     }
@@ -118,10 +128,6 @@ export class Graph {
         this._sortEdges(source, 'outbound', edges);
       });
     }
-
-    this._onInitialNode = onInitialNode;
-    this._onInitialNodes = onInitialNodes;
-    this._onRemoveNode = onRemoveNode;
   }
 
   static from(pickle: string, options: Omit<GraphParams, 'nodes' | 'edges'> = {}) {
@@ -167,17 +173,23 @@ export class Graph {
   }
 
   pickle() {
-    const nodes = Object.values(this._nodes).map((node) => {
-      return {
-        id: node.id,
-        type: node.type,
-        properties: node.properties,
-      };
-    });
+    const nodes = Object.values(this._nodes)
+      .filter((node) => !!node.cacheable)
+      .map((node) => {
+        return {
+          id: node.id,
+          type: node.type,
+          properties: pick(node.properties, node.cacheable!),
+        };
+      });
+
+    const cacheable = new Set(nodes.map((node) => node.id));
 
     const edges = Object.fromEntries(
       Object.entries(this._edges)
-        .map(([id, { outbound }]): [string, string[]] => [id, outbound])
+        .filter(([id]) => cacheable.has(id))
+        .map(([id, { outbound }]): [string, string[]] => [id, outbound.filter((nodeId) => cacheable.has(nodeId))])
+        // TODO(wittjosiah): Why sort?
         .toSorted(([a], [b]) => a.localeCompare(b)),
     );
 
@@ -440,7 +452,7 @@ export class Graph {
 
   private _removeNode(id: string, edges = false) {
     untracked(() => {
-      const node = this.findNode(id);
+      const node = this.findNode(id, false);
       if (!node) {
         return;
       }

package/src/node.ts

@@ -20,6 +20,13 @@ export type Node<TData = any, TProperties extends Record<string, any> = Record<s
    */
   type: string;
 
+  /**
+   * Keys in of the properties which should be cached.
+   * If defined, the node will be included in the cache.
+   * If undefined, the node will not be included in the cache.
+   */
+  cacheable?: string[];
+
   /**
    * Properties of the node relevant to displaying the node.
    */
@@ -47,7 +54,7 @@ export const isGraphNode = (data: unknown): data is Node =>
 
 export type NodeArg<TData, TProperties extends Record<string, any> = Record<string, any>> = MakeOptional<
   Node<TData, TProperties>,
-  'data' | 'properties'
+  'data' | 'properties' | 'cacheable'
 > & {
   /** Will automatically add nodes with an edge from this node to each. */
   nodes?: NodeArg<unknown>[];

package/src/stories/EchoGraph.stories.tsx

@@ -10,7 +10,7 @@ import React, { useEffect, useState } from 'react';
 import {
   create,
   type Echo,
-  type EchoReactiveObject,
+  type ReactiveEchoObject,
   type FilterSource,
   type Space,
   SpaceState,
@@ -54,7 +54,7 @@ const actionWeights = {
 };
 
 // TODO(wittjosiah): Factor out.
-const memoizeQuery = <T extends EchoReactiveObject<any>>(
+const memoizeQuery = <T extends ReactiveEchoObject<any>>(
   spaceOrEcho?: Space | Echo,
   filter?: FilterSource<T>,
   options?: QueryOptions,