@dxos/plugin-automation 0.8.3 → 0.8.4-main.1068cf700f

package/src/components/AutomationPanel/AutomationPanel.tsx

@@ -2,60 +2,72 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema } from 'effect';
-import React, { useState } from 'react';
-
-import { Filter, Obj } from '@dxos/echo';
-import {
-  FunctionType,
-  FunctionTrigger,
-  FunctionTriggerSchema,
-  type FunctionTriggerType,
-  ScriptType,
-  TriggerKind,
-} from '@dxos/functions';
+import * as Array from 'effect/Array';
+import * as EFn from 'effect/Function';
+import * as Match from 'effect/Match';
+import * as Schema from 'effect/Schema';
+import React, { useCallback, useMemo, useState } from 'react';
+
+import { Filter, Obj, Tag } from '@dxos/echo';
+import { Function, Script, Trigger } from '@dxos/functions';
+import { KEY_QUEUE_CURSOR } from '@dxos/functions-runtime';
+import { FunctionsServiceClient } from '@dxos/functions-runtime/edge';
+import { useTypeOptions } from '@dxos/plugin-space';
 import { type Client, useClient } from '@dxos/react-client';
-import { useQuery, type Space, getSpace } from '@dxos/react-client/echo';
+import { type Space, useObject, useQuery } from '@dxos/react-client/echo';
 import { Clipboard, IconButton, Input, Separator, useTranslation } from '@dxos/react-ui';
-import { ControlItem, controlItemClasses } from '@dxos/react-ui-form';
+import { Settings } from '@dxos/react-ui-form';
 import { List } from '@dxos/react-ui-list';
-import { ghostHover, mx } from '@dxos/react-ui-theme';
+import { Pipeline } from '@dxos/types';
+import { ghostHover, mx } from '@dxos/ui-theme';
+import { isNonNullable } from '@dxos/util';
 
-import { AUTOMATION_PLUGIN } from '../../meta';
+import { meta } from '../../meta';
 import { TriggerEditor, type TriggerEditorProps } from '../TriggerEditor';
 
-const grid = 'grid grid-cols-[40px_1fr_32px] min-bs-[2.5rem]';
+const grid = 'grid grid-cols-[40px_1fr_32px_32px] min-bs-[2.5rem]';
 
 export type AutomationPanelProps = {
   space: Space;
-  object?: Obj.Any;
-  initialTrigger?: FunctionTriggerType;
+  object?: Obj.Unknown;
+  initialTrigger?: Trigger.Trigger;
   onDone?: () => void;
 };
 
 // TODO(burdon): Factor out common layout with ViewEditor.
 export const AutomationPanel = ({ space, object, initialTrigger, onDone }: AutomationPanelProps) => {
-  const { t } = useTranslation(AUTOMATION_PLUGIN);
+  const { t } = useTranslation(meta.id);
   const client = useClient();
-  const triggers = useQuery(space, Filter.type(FunctionTrigger));
-  const functions = useQuery(space, Filter.type(FunctionType));
-  const scripts = useQuery(space, Filter.type(ScriptType));
+  const functionsServiceClient = useMemo(() => FunctionsServiceClient.fromClient(client), [client]);
+  const functions = useQuery(space.db, Filter.type(Function.Function));
+  const triggers = useQuery(space.db, Filter.type(Trigger.Trigger));
+  const filteredTriggers = useMemo(() => {
+    return object ? triggers.filter(triggerMatch(object)) : triggers;
+  }, [object, triggers]);
+  const tags = useQuery(space.db, Filter.type(Tag.Tag));
+  const types = useTypeOptions({
+    space,
+    annotation: {
+      location: ['database', 'runtime'],
+      kind: ['user'],
+      registered: ['registered'],
+    },
+  });
 
-  const [trigger, setTrigger] = useState<FunctionTriggerType | undefined>(initialTrigger);
-  const [selected, setSelected] = useState<FunctionTrigger>();
+  const [trigger, setTrigger] = useState<Trigger.Trigger | undefined>(initialTrigger);
+  const [selected, setSelected] = useState<Trigger.Trigger>();
 
-  const handleSelect = (trigger: FunctionTrigger) => {
-    const { id: _, ...values } = trigger;
-    setTrigger(values);
+  const handleSelect = (trigger: Trigger.Trigger) => {
+    setTrigger(trigger);
     setSelected(trigger);
   };
 
   const handleAdd = () => {
-    setTrigger(Obj.make(FunctionTriggerSchema, {}));
+    setTrigger(Trigger.make({}));
     setSelected(undefined);
   };
 
-  const handleDelete = (trigger: FunctionTrigger) => {
+  const handleDelete = (trigger: Trigger.Trigger) => {
     space.db.remove(trigger);
     setTrigger(undefined);
     setSelected(undefined);
@@ -63,9 +75,11 @@ export const AutomationPanel = ({ space, object, initialTrigger, onDone }: Autom
 
   const handleSave: TriggerEditorProps['onSave'] = (trigger) => {
     if (selected) {
-      Object.assign(selected, trigger);
+      Obj.change(selected, (mutable) => {
+        Object.assign(mutable, trigger);
+      });
     } else {
-      space.db.add(Obj.make(FunctionTrigger, trigger));
+      space.db.add(Trigger.make(trigger));
     }
 
     setTrigger(undefined);
@@ -78,94 +92,226 @@ export const AutomationPanel = ({ space, object, initialTrigger, onDone }: Autom
     onDone?.();
   };
 
+  const handleForceRunTrigger = async (trigger: Trigger.Trigger) => {
+    await functionsServiceClient.forceRunCronTrigger(space.id, trigger.id);
+  };
+
+  const handleResetCursor = async (trigger: Trigger.Trigger) => {
+    Obj.change(trigger, (t) => {
+      Obj.deleteKeys(t, KEY_QUEUE_CURSOR);
+    });
+    await space.db.flush({ indexes: true });
+  };
+
   if (trigger) {
     return (
-      <ControlItem title={t('trigger editor title')}>
-        <TriggerEditor space={space} trigger={trigger} onSave={handleSave} onCancel={handleCancel} />
-      </ControlItem>
+      <Settings.Item title={t('trigger editor title')}>
+        <TriggerEditor
+          db={space.db}
+          trigger={trigger}
+          readonlySpec={Boolean(object)}
+          tags={tags}
+          types={types}
+          onSave={handleSave}
+          onCancel={handleCancel}
+        />
+      </Settings.Item>
     );
   }
 
   return (
-    <div className={controlItemClasses}>
-      {triggers.length > 0 && (
-        <List.Root<FunctionTrigger> items={triggers} isItem={Schema.is(FunctionTrigger)} getId={(field) => field.id}>
-          {({ items: triggers }) => (
-            <div role='list' className='flex flex-col w-full'>
-              {triggers?.map((trigger) => {
-                const copyAction = getCopyAction(client, trigger);
-                return (
-                  <List.Item<FunctionTrigger>
-                    key={trigger.id}
-                    item={trigger}
-                    classNames={mx(grid, ghostHover, 'items-center', 'px-2')}
-                  >
-                    <Input.Root>
-                      <Input.Switch
-                        checked={trigger.enabled}
-                        onCheckedChange={(checked) => (trigger.enabled = checked)}
-                      />
-                    </Input.Root>
-
-                    <div className={'flex'}>
-                      <List.ItemTitle
-                        classNames='px-1 cursor-pointer w-0 shrink truncate'
-                        onClick={() => handleSelect(trigger)}
-                      >
-                        {getFunctionName(scripts, functions, trigger) ?? '∅'}
-                      </List.ItemTitle>
-
-                      {/* TODO: a better way to expose copy action */}
-                      {copyAction && (
-                        <Clipboard.IconButton
-                          label={t(copyAction.translationKey)}
-                          value={copyAction.contentProvider()}
-                        />
-                      )}
-                    </div>
-
-                    <List.ItemDeleteButton onClick={() => handleDelete(trigger)} />
-                  </List.Item>
-                );
-              })}
+    <Settings.Container>
+      {filteredTriggers.length > 0 && (
+        <List.Root<Trigger.Trigger>
+          items={filteredTriggers}
+          isItem={Schema.is(Trigger.Trigger)}
+          getId={(field) => field.id}
+        >
+          {({ items: filteredTriggers }) => (
+            <div role='list' className='flex flex-col is-full'>
+              {filteredTriggers?.map((trigger) => (
+                <TriggerListItem
+                  key={trigger.id}
+                  trigger={trigger}
+                  functions={functions}
+                  onSelect={handleSelect}
+                  onDelete={handleDelete}
+                  onResetCursor={handleResetCursor}
+                  onForceRun={handleForceRunTrigger}
+                />
+              ))}
             </div>
           )}
         </List.Root>
       )}
-      {triggers.length > 0 && <Separator classNames='mlb-4' />}
+
+      {filteredTriggers.length > 0 && <Separator classNames='mlb-4' />}
       <IconButton icon='ph--plus--regular' label={t('new trigger label')} onClick={handleAdd} />
-    </div>
+    </Settings.Container>
+  );
+};
+
+const TriggerListItem = ({
+  trigger,
+  functions,
+  onSelect,
+  onDelete,
+  onResetCursor,
+  onForceRun,
+}: {
+  trigger: Trigger.Trigger;
+  functions: Function.Function[];
+  onSelect?: (trigger: Trigger.Trigger) => void;
+  onDelete?: (trigger: Trigger.Trigger) => void;
+  onResetCursor?: (trigger: Trigger.Trigger) => void;
+  onForceRun?: (trigger: Trigger.Trigger) => void;
+}) => {
+  const client = useClient();
+  const copyAction = getCopyAction(client, trigger);
+  const { t } = useTranslation(meta.id);
+  const cursor = Obj.getKeys(trigger, KEY_QUEUE_CURSOR).at(0)?.id;
+  const [snapshot, updateTrigger] = useObject(trigger);
+
+  const enabled = snapshot.enabled ?? false;
+  const onEnabledChange = (checked: boolean) => {
+    updateTrigger((trigger) => {
+      trigger.enabled = checked;
+    });
+  };
+
+  const handleSelect = useCallback(() => {
+    onSelect?.(trigger);
+  }, [onSelect, trigger]);
+
+  const handleDelete = useCallback(() => {
+    onDelete?.(trigger);
+  }, [onDelete, trigger]);
+
+  const handleResetCursor = useCallback(() => {
+    onResetCursor?.(trigger);
+  }, [onResetCursor, trigger]);
+
+  const handleForceRun = useCallback(() => {
+    onForceRun?.(trigger);
+  }, [onForceRun, trigger]);
+
+  return (
+    <List.Item<Obj.Snapshot<Trigger.Trigger>>
+      key={trigger.id}
+      item={snapshot}
+      classNames={mx(grid, ghostHover, 'items-center', 'pli-2')}
+    >
+      <Input.Root>
+        <Input.Switch checked={enabled} onCheckedChange={onEnabledChange} />
+      </Input.Root>
+
+      <div className={'flex'}>
+        <List.ItemTitle classNames='pli-1 cursor-pointer is-0 shrink truncate' onClick={handleSelect}>
+          {getFunctionName(functions, trigger) ?? '∅'}
+          {cursor && <div className='text-xs text-description truncate ml-4'>Position: {cursor}</div>}
+        </List.ItemTitle>
+
+        {copyAction && (
+          <Clipboard.IconButton label={t(copyAction.translationKey)} value={copyAction.contentProvider()} />
+        )}
+      </div>
+
+      {trigger.spec?.kind === 'timer' && onForceRun && (
+        <List.ItemButton
+          autoHide={false}
+          disabled={!enabled || trigger.spec?.kind !== 'timer'}
+          icon='ph--play--regular'
+          label='Force run'
+          onClick={handleForceRun}
+        />
+      )}
+      {trigger.spec?.kind === 'queue' && onResetCursor && (
+        <List.ItemButton
+          autoHide={false}
+          disabled={!cursor}
+          icon='ph--arrow-clockwise--regular'
+          label='Reset cursor'
+          onClick={handleResetCursor}
+        />
+      )}
+
+      {onDelete && <List.ItemDeleteButton onClick={handleDelete} />}
+    </List.Item>
   );
 };
 
-const getCopyAction = (client: Client, trigger: FunctionTrigger | undefined) => {
-  if (trigger?.spec?.kind === TriggerKind.Email) {
-    return { translationKey: 'trigger copy email', contentProvider: () => `${getSpace(trigger)!.id}@dxos.network` };
+const getCopyAction = (client: Client, trigger: Trigger.Trigger | undefined) => {
+  if (trigger?.spec?.kind === 'email') {
+    return {
+      translationKey: 'trigger copy email' as const,
+      contentProvider: () => `${Obj.getDatabase(trigger)!.spaceId}@dxos.network`,
+    };
   }
 
-  if (trigger?.spec?.kind === TriggerKind.Webhook) {
-    return { translationKey: 'trigger copy url', contentProvider: () => getWebhookUrl(client, trigger) };
+  if (trigger?.spec?.kind === 'webhook') {
+    return {
+      translationKey: 'trigger copy url' as const,
+      contentProvider: () => getWebhookUrl(client, trigger!),
+    };
   }
 
   return undefined;
 };
 
-const getWebhookUrl = (client: Client, trigger: FunctionTrigger) => {
-  const spaceId = getSpace(trigger)!.id;
+const getWebhookUrl = (client: Client, trigger: Trigger.Trigger) => {
+  const spaceId = Obj.getDatabase(trigger)!.spaceId;
   const edgeUrl = new URL(client.config.values.runtime!.services!.edge!.url!);
   const isSecure = edgeUrl.protocol.startsWith('https') || edgeUrl.protocol.startsWith('wss');
   edgeUrl.protocol = isSecure ? 'https' : 'http';
   return new URL(`/webhook/${spaceId}:${trigger.id}`, edgeUrl).toString();
 };
 
-const getFunctionName = (scripts: ScriptType[], functions: FunctionType[], trigger: FunctionTriggerType) => {
+const getFunctionName = (functions: Function.Function[], trigger: Trigger.Trigger) => {
   // TODO(wittjosiah): Truncation should be done in the UI.
   //   Warning that the List component is currently a can of worms.
   const shortId = trigger.function && `${trigger.function.dxn.toString().slice(0, 16)}…`;
   const functionObject = functions.find((fn) => fn === trigger.function?.target);
-  if (!functionObject) {
-    return shortId;
+  return functionObject?.name ?? shortId;
+};
+
+const scriptMatch = (script: Script.Script) => (trigger: Trigger.Trigger) => {
+  const fn = trigger.function?.target;
+  if (!Obj.instanceOf(Function.Function, fn)) {
+    return false;
   }
 
-  return scripts.find((s) => functionObject.source?.target?.id === s.id)?.name ?? shortId;
+  return fn.source?.target === script;
 };
+
+const projectMatch = (project: Pipeline.Pipeline) => {
+  const viewQueries = EFn.pipe(
+    project.columns,
+    Array.map((column) => column.view.target),
+    Array.filter(isNonNullable),
+    Array.map((view) => Obj.getSnapshot(view).query.ast),
+    Array.map((ast) => JSON.stringify(ast)),
+  );
+
+  return (trigger: Trigger.Trigger) => {
+    const spec = Obj.getSnapshot(trigger).spec;
+    if (spec?.kind !== 'subscription') {
+      return false;
+    }
+
+    // TODO(wittjosiah): Implement better way of comparing query ASTs.
+    return viewQueries.some((query) => JSON.stringify(spec.query) === query);
+  };
+};
+
+const triggerMatch = Match.type<Obj.Unknown>().pipe(
+  Match.withReturnType<(trigger: Trigger.Trigger) => boolean>(),
+  Match.when(
+    (obj) => Obj.instanceOf(Script.Script, obj),
+    (obj) => scriptMatch(obj),
+  ),
+  Match.when(
+    (obj) => Obj.instanceOf(Pipeline.Pipeline, obj),
+    (obj) => projectMatch(obj),
+  ),
+  Match.orElse((_obj) => () => true),
+);

package/src/components/AutomationSettings.tsx

@@ -0,0 +1,30 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { useTranslation } from '@dxos/react-ui';
+import { Settings } from '@dxos/react-ui-form';
+
+import { meta } from '../meta';
+
+import { AutomationPanel, type AutomationPanelProps } from './AutomationPanel';
+import { TriggersSettings } from './TriggerSettings';
+
+export const AutomationSettings = (props: AutomationPanelProps) => {
+  const { t } = useTranslation(meta.id);
+  return (
+    <Settings.Root>
+      <Settings.Section
+        title={t('automation verbose label', { ns: meta.id })}
+        description={t('automation description', { ns: meta.id })}
+      >
+        <AutomationPanel {...props} />
+        <TriggersSettings db={props.space.db} />
+      </Settings.Section>
+    </Settings.Root>
+  );
+};
+
+export default AutomationSettings;

package/src/components/FunctionsContainer.tsx

@@ -6,25 +6,30 @@ import React from 'react';
 
 import { type Space } from '@dxos/react-client/echo';
 import { useTranslation } from '@dxos/react-ui';
-import { ControlPage, ControlSection } from '@dxos/react-ui-form';
-import { StackItem } from '@dxos/react-ui-stack';
+import { Settings } from '@dxos/react-ui-form';
+
+import { meta } from '../meta';
 
 import { FunctionsPanel } from './FunctionsPanel';
-import { AUTOMATION_PLUGIN } from '../meta';
+import { FunctionsRegistry } from './FunctionsRegistry';
 
 export const FunctionsContainer = ({ space }: { space: Space }) => {
-  const { t } = useTranslation(AUTOMATION_PLUGIN);
+  const { t } = useTranslation(meta.id);
   return (
-    <StackItem.Content classNames='block overflow-y-auto'>
-      <ControlPage>
-        <ControlSection
-          title={t('functions verbose label', { ns: AUTOMATION_PLUGIN })}
-          description={t('functions description', { ns: AUTOMATION_PLUGIN })}
-        >
-          <FunctionsPanel space={space} />
-        </ControlSection>
-      </ControlPage>
-    </StackItem.Content>
+    <Settings.Root>
+      <Settings.Section
+        title={t('functions verbose label', { ns: meta.id })}
+        description={t('functions description', { ns: meta.id })}
+      >
+        <FunctionsPanel space={space} />
+      </Settings.Section>
+      <Settings.Section
+        title={t('functions registry verbose label', { ns: meta.id })}
+        description={t('functions registry description', { ns: meta.id })}
+      >
+        <FunctionsRegistry space={space} />
+      </Settings.Section>
+    </Settings.Root>
   );
 };
 

package/src/components/FunctionsPanel/FunctionsPanel.tsx

@@ -2,30 +2,31 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 import React, { useCallback, useMemo } from 'react';
 
-import { createIntent, LayoutAction, useIntentDispatcher } from '@dxos/app-framework';
-import { FunctionType, ScriptType } from '@dxos/functions';
-import { Filter, fullyQualifiedId, useQuery, type Space } from '@dxos/react-client/echo';
-import { Button, useTranslation } from '@dxos/react-ui';
-import { controlItemClasses } from '@dxos/react-ui-form';
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { LayoutOperation } from '@dxos/app-toolkit';
+import { Obj } from '@dxos/echo';
+import { Function, Script } from '@dxos/functions';
+import { SpaceOperation } from '@dxos/plugin-space/types';
+import { Filter, type Space, useQuery } from '@dxos/react-client/echo';
+import { Button, IconButton, useTranslation } from '@dxos/react-ui';
+import { Settings } from '@dxos/react-ui-form';
 import { List } from '@dxos/react-ui-list';
-import { ghostHover, mx } from '@dxos/react-ui-theme';
+import { ghostHover, mx } from '@dxos/ui-theme';
 
-import { AUTOMATION_PLUGIN } from '../../meta';
-
-const grid = 'grid grid-cols-[1fr_auto] min-bs-[2.5rem]';
+import { meta } from '../../meta';
 
 export type FunctionsPanelProps = {
   space: Space;
 };
 
 export const FunctionsPanel = ({ space }: FunctionsPanelProps) => {
-  const { t } = useTranslation(AUTOMATION_PLUGIN);
-  const functions = useQuery(space, Filter.type(FunctionType));
-  const scripts = useQuery(space, Filter.type(ScriptType));
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
+  const { t } = useTranslation(meta.id);
+  const functions = useQuery(space.db, Filter.type(Function.Function));
+  const scripts = useQuery(space.db, Filter.type(Script.Script));
+  const { invokePromise } = useOperationInvoker();
 
   const functionToScriptMap = useMemo(
     () =>
@@ -40,13 +41,13 @@ export const FunctionsPanel = ({ space }: FunctionsPanelProps) => {
           }
           return map;
         },
-        {} as Record<string, ScriptType>,
+        {} as Record<string, Script.Script>,
       ),
     [functions, scripts],
   );
 
   const getScriptName = useCallback(
-    (func: FunctionType) => {
+    (func: Function.Function) => {
       const script = functionToScriptMap[func.id];
       return script?.name;
     },
@@ -54,26 +55,34 @@ export const FunctionsPanel = ({ space }: FunctionsPanelProps) => {
   );
 
   const handleGoToScript = useCallback(
-    (func: FunctionType) => {
+    (func: Function.Function) => {
       const script = functionToScriptMap[func.id];
       if (script) {
-        void dispatch(createIntent(LayoutAction.Open, { part: 'main', subject: [fullyQualifiedId(script)] }));
+        void invokePromise(LayoutOperation.Open, { subject: [Obj.getDXN(script).toString()] });
       }
     },
-    [functionToScriptMap, dispatch],
+    [functionToScriptMap, invokePromise],
+  );
+
+  const handleDelete = useCallback(
+    (func: Function.Function) => invokePromise(SpaceOperation.RemoveObjects, { objects: [func] }),
+    [invokePromise],
   );
 
   return (
-    <div role='none' className={mx(controlItemClasses)}>
+    <Settings.Container>
       {functions.length > 0 && (
-        <List.Root<FunctionType> items={functions} isItem={Schema.is(FunctionType)} getId={(func) => func.id}>
+        <List.Root<Function.Function> items={functions} isItem={Schema.is(Function.Function)} getId={(func) => func.id}>
           {({ items }) => (
-            <div role='list' className='flex flex-col w-full'>
+            <div role='list' className='flex flex-col is-full'>
               {items?.map((func) => (
-                <List.Item<FunctionType>
+                <List.Item<Function.Function>
                   key={func.id}
                   item={func}
-                  classNames={mx(grid, ghostHover, 'items-center', 'pli-2', 'min-bs-[3rem]')}
+                  classNames={mx(
+                    'grid grid-cols-[1fr_auto] min-bs-[2.5rem] min-bs-[3rem] pli-2 items-center',
+                    ghostHover,
+                  )}
                 >
                   <div className='flex flex-col truncate'>
                     <List.ItemTitle classNames='truncate'>{func.name}</List.ItemTitle>
@@ -84,6 +93,12 @@ export const FunctionsPanel = ({ space }: FunctionsPanelProps) => {
                   {functionToScriptMap[func.id] && (
                     <Button onClick={() => handleGoToScript(func)}>{t('go to function source button label')}</Button>
                   )}
+                  <IconButton
+                    iconOnly
+                    icon='ph--trash--regular'
+                    label={t('delete function button label')}
+                    onClick={() => handleDelete(func)}
+                  />
                 </List.Item>
               ))}
             </div>
@@ -91,7 +106,7 @@ export const FunctionsPanel = ({ space }: FunctionsPanelProps) => {
         </List.Root>
       )}
 
-      {functions.length === 0 && <div className='text-center plb-4 text-gray-500'>{t('no functions found')}</div>}
-    </div>
+      {functions.length === 0 && <div className='text-center plb-4 text-description'>{t('no functions found')}</div>}
+    </Settings.Container>
   );
 };