Add persisted call-saved-workflows node stub

Stacked on top of origin PR invoke-ai#9018 (shared/private workflows and boards) for multiuser workflow visibility semantics.

Author: JPPhoto

invokeai/app/invocations/call_saved_workflows.py

@@ -0,0 +1,26 @@
+from invokeai.app.invocations.baseinvocation import BaseInvocation, Classification, invocation
+from invokeai.app.invocations.fields import InputField
+from invokeai.app.invocations.primitives import IntegerOutput
+from invokeai.app.services.shared.invocation_context import InvocationContext
+
+
+@invocation(
+    "call_saved_workflows",
+    title="Call Saved Workflows",
+    tags=["workflow", "saved", "library"],
+    category="workflow",
+    version="1.0.0",
+    use_cache=False,
+    classification=Classification.Beta,
+)
+class CallSavedWorkflowsInvocation(BaseInvocation):
+    """Displays and later executes against the saved workflow library."""
+
+    workflow_id: str = InputField(
+        default="",
+        description="The selected saved workflow ID, managed by the workflow editor UI.",
+        ui_hidden=True,
+    )
+
+    def invoke(self, context: InvocationContext) -> IntegerOutput:
+        return IntegerOutput(value=0)

invokeai/frontend/web/src/features/nodes/components/flow/nodes/Invocation/CallSavedWorkflowsNode.tsx

@@ -0,0 +1,123 @@
+import type { SystemStyleObject } from '@invoke-ai/ui-library';
+import { Badge, Flex, Spinner, Text } from '@invoke-ai/ui-library';
+import { EMPTY_ARRAY } from 'app/store/constants';
+import { IAINoContentFallback } from 'common/components/IAIImageFallback';
+import { memo, useMemo } from 'react';
+import { useListWorkflowsInfiniteInfiniteQuery } from 'services/api/endpoints/workflows';
+import type { S } from 'services/api/types';
+
+import InvocationNodeHeader from './InvocationNodeHeader';
+
+type Props = {
+  nodeId: string;
+  isOpen: boolean;
+};
+
+const bodySx: SystemStyleObject = {
+  flexDirection: 'column',
+  w: 'full',
+  h: 'full',
+  py: 2,
+  gap: 2,
+  borderBottomRadius: 'base',
+  '&[data-is-open="false"]': {
+    display: 'none',
+  },
+};
+
+const queryArg = {
+  page: 0,
+  per_page: 50,
+  order_by: 'name',
+  direction: 'ASC',
+  categories: ['user', 'default'],
+  query: '',
+  tags: [],
+  has_been_opened: undefined,
+  is_public: undefined,
+} satisfies Parameters<typeof useListWorkflowsInfiniteInfiniteQuery>[0];
+
+const queryOptions = {
+  selectFromResult: ({ data, ...rest }) => ({
+    items: data?.pages.flatMap(({ items }) => items) ?? EMPTY_ARRAY,
+    ...rest,
+  }),
+} satisfies Parameters<typeof useListWorkflowsInfiniteInfiniteQuery>[1];
+
+const CallSavedWorkflowsNode = ({ nodeId, isOpen }: Props) => {
+  const { items, isLoading, isFetching } = useListWorkflowsInfiniteInfiniteQuery(queryArg, queryOptions);
+
+  return (
+    <>
+      <InvocationNodeHeader nodeId={nodeId} isOpen={isOpen} />
+      <Flex layerStyle="nodeBody" sx={bodySx} data-is-open={isOpen}>
+        <Flex flexDir="column" px={2} gap={2} w="full">
+          <Flex alignItems="center" justifyContent="space-between">
+            <Text fontSize="sm" fontWeight="semibold">
+              Saved Workflows
+            </Text>
+            <Badge variant="subtle">{items.length}</Badge>
+          </Flex>
+          {isLoading ? <LoadingState /> : <WorkflowItems items={items} isFetching={isFetching} />}
+        </Flex>
+      </Flex>
+    </>
+  );
+};
+
+export default memo(CallSavedWorkflowsNode);
+
+const LoadingState = memo(() => {
+  return (
+    <Flex alignItems="center" justifyContent="center" minH={24}>
+      <Spinner size="sm" />
+    </Flex>
+  );
+});
+LoadingState.displayName = 'LoadingState';
+
+const WorkflowItems = memo(
+  ({ items, isFetching }: { items: S['WorkflowRecordListItemWithThumbnailDTO'][]; isFetching: boolean }) => {
+    const visibleItems = useMemo(() => items.slice(0, 8), [items]);
+
+    if (visibleItems.length === 0) {
+      return <IAINoContentFallback icon={null} label="No saved workflows" fontSize="sm" py={4} />;
+    }
+
+    return (
+      <Flex flexDir="column" gap={1}>
+        {visibleItems.map((workflow) => (
+          <Flex
+            key={workflow.workflow_id}
+            alignItems="center"
+            justifyContent="space-between"
+            gap={2}
+            borderRadius="base"
+            bg="base.800"
+            px={2}
+            py={1.5}
+          >
+            <Text fontSize="sm" noOfLines={1}>
+              {workflow.name}
+            </Text>
+            <Flex alignItems="center" gap={1} flexShrink={0}>
+              {workflow.category === 'default' && <Badge variant="subtle">Default</Badge>}
+              {workflow.is_public && workflow.category !== 'default' && <Badge variant="subtle">Shared</Badge>}
+            </Flex>
+          </Flex>
+        ))}
+        {items.length > visibleItems.length && (
+          <Text variant="subtext" fontSize="xs">
+            Showing {visibleItems.length} of {items.length} workflows
+          </Text>
+        )}
+        {isFetching && (
+          <Text variant="subtext" fontSize="xs">
+            Updating...
+          </Text>
+        )}
+      </Flex>
+    );
+  }
+);
+WorkflowItems.displayName = 'WorkflowItems';

invokeai/frontend/web/src/features/nodes/components/flow/nodes/Invocation/InvocationNodeWrapper.tsx

@@ -9,14 +9,17 @@ import { selectNodes } from 'features/nodes/store/selectors';
 import type { InvocationNodeData } from 'features/nodes/types/invocation';
 import { memo, useMemo } from 'react';
 
+import CallSavedWorkflowsNode from './CallSavedWorkflowsNode';
 import { InvocationNodeContextProvider } from './context';
+import { getInvocationNodeBodyComponentKey } from './getInvocationNodeBodyComponent';
 import InvocationNodeUnknownFallback from './InvocationNodeUnknownFallback';
 
 const InvocationNodeWrapper = (props: NodeProps<Node<InvocationNodeData>>) => {
   const { data, selected } = props;
   const { id: nodeId, type, isOpen, label } = data;
   const templates = useStore($templates);
   const hasTemplate = useMemo(() => Boolean(templates[type]), [templates, type]);
+  const bodyComponentKey = useMemo(() => getInvocationNodeBodyComponentKey(type), [type]);
   const selectNodeExists = useMemo(
     () => createSelector(selectNodes, (nodes) => Boolean(nodes.find((n) => n.id === nodeId))),
     [nodeId]
@@ -40,7 +43,11 @@ const InvocationNodeWrapper = (props: NodeProps<Node<InvocationNodeData>>) => {
   return (
     <InvocationNodeContextProvider nodeId={nodeId}>
       <NodeWrapper nodeId={nodeId} selected={selected}>
-        <InvocationNode nodeId={nodeId} isOpen={isOpen} />
+        {bodyComponentKey === 'call_saved_workflows' ? (
+          <CallSavedWorkflowsNode nodeId={nodeId} isOpen={isOpen} />
+        ) : (
+          <InvocationNode nodeId={nodeId} isOpen={isOpen} />
+        )}
       </NodeWrapper>
     </InvocationNodeContextProvider>
   );

invokeai/frontend/web/src/features/nodes/components/flow/nodes/Invocation/getInvocationNodeBodyComponent.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, it } from 'vitest';
+
+import { getInvocationNodeBodyComponentKey } from './getInvocationNodeBodyComponent';
+
+describe('getInvocationNodeBodyComponentKey', () => {
+  it('returns the specialized renderer for call_saved_workflows nodes', () => {
+    expect(getInvocationNodeBodyComponentKey('call_saved_workflows')).toBe('call_saved_workflows');
+  });
+
+  it('falls back to the default renderer for other invocation nodes', () => {
+    expect(getInvocationNodeBodyComponentKey('add')).toBe('default');
+  });
+});

invokeai/frontend/web/src/features/nodes/components/flow/nodes/Invocation/getInvocationNodeBodyComponent.ts

@@ -0,0 +1,9 @@
+export type InvocationNodeBodyComponentKey = 'default' | 'call_saved_workflows';
+
+export const getInvocationNodeBodyComponentKey = (type: string): InvocationNodeBodyComponentKey => {
+  if (type === 'call_saved_workflows') {
+    return 'call_saved_workflows';
+  }
+
+  return 'default';
+};

invokeai/frontend/web/src/features/nodes/store/util/testUtils.ts

@@ -72,6 +72,49 @@ export const add: InvocationTemplate = {
   classification: 'stable',
 };
 
+export const call_saved_workflows: InvocationTemplate = {
+  title: 'Call Saved Workflows',
+  type: 'call_saved_workflows',
+  version: '1.0.0',
+  tags: ['workflow', 'saved', 'library'],
+  description: 'Displays and later executes against the saved workflow library.',
+  outputType: 'integer_output',
+  inputs: {
+    workflow_id: {
+      name: 'workflow_id',
+      title: 'Workflow Id',
+      required: false,
+      description: 'The selected saved workflow ID, managed by the workflow editor UI.',
+      fieldKind: 'input',
+      input: 'any',
+      ui_hidden: true,
+      type: {
+        name: 'StringField',
+        cardinality: 'SINGLE',
+        batch: false,
+      },
+      default: '',
+    },
+  },
+  outputs: {
+    value: {
+      fieldKind: 'output',
+      name: 'value',
+      title: 'Value',
+      description: 'The output integer',
+      type: {
+        name: 'IntegerField',
+        cardinality: 'SINGLE',
+        batch: false,
+      },
+      ui_hidden: false,
+    },
+  },
+  useCache: false,
+  nodePack: 'invokeai',
+  classification: 'beta',
+};
+
 export const sub: InvocationTemplate = {
   title: 'Subtract Integers',
   type: 'sub',
@@ -530,6 +573,7 @@ const iterate: InvocationTemplate = {
 
 export const templates: Templates = {
   add,
+  call_saved_workflows,
   sub,
   collect,
   iterate,
@@ -547,6 +591,63 @@ export const schema = {
   },
   components: {
     schemas: {
+      CallSavedWorkflowsInvocation: {
+        properties: {
+          id: {
+            type: 'string',
+            title: 'Id',
+            description: 'The id of this instance of an invocation. Must be unique among all instances of invocations.',
+            field_kind: 'node_attribute',
+          },
+          is_intermediate: {
+            type: 'boolean',
+            title: 'Is Intermediate',
+            description: 'Whether or not this is an intermediate invocation.',
+            default: false,
+            field_kind: 'node_attribute',
+            ui_type: 'IsIntermediate',
+          },
+          use_cache: {
+            type: 'boolean',
+            title: 'Use Cache',
+            description: 'Whether or not to use the cache',
+            default: false,
+            field_kind: 'node_attribute',
+          },
+          workflow_id: {
+            type: 'string',
+            title: 'Workflow Id',
+            description: 'The selected saved workflow ID, managed by the workflow editor UI.',
+            default: '',
+            field_kind: 'input',
+            input: 'any',
+            orig_default: '',
+            orig_required: false,
+            ui_hidden: true,
+          },
+          type: {
+            type: 'string',
+            enum: ['call_saved_workflows'],
+            const: 'call_saved_workflows',
+            title: 'type',
+            default: 'call_saved_workflows',
+            field_kind: 'node_attribute',
+          },
+        },
+        type: 'object',
+        required: ['type', 'id'],
+        title: 'Call Saved Workflows',
+        description: 'Displays and later executes against the saved workflow library.',
+        category: 'workflow',
+        classification: 'beta',
+        node_pack: 'invokeai',
+        tags: ['workflow', 'saved', 'library'],
+        version: '1.0.0',
+        output: {
+          $ref: '#/components/schemas/IntegerOutput',
+        },
+        class: 'invocation',
+      },
       AddInvocation: {
         properties: {
           id: {

invokeai/frontend/web/src/features/nodes/util/schema/parseSchema.test.ts

@@ -1,5 +1,5 @@
 import { omit, pick } from 'es-toolkit/compat';
-import { schema, templates } from 'features/nodes/store/util/testUtils';
+import { call_saved_workflows, schema, templates } from 'features/nodes/store/util/testUtils';
 import { parseSchema } from 'features/nodes/util/schema/parseSchema';
 import { describe, expect, it } from 'vitest';
 
@@ -18,4 +18,8 @@ describe('parseSchema', () => {
     const parsed = parseSchema(schema, ['add']);
     expect(stripUndefinedDeep(parsed)).toEqual(stripUndefinedDeep(pick(templates, 'add')));
   });
+  it('should parse the call_saved_workflows node template', () => {
+    const parsed = parseSchema(schema);
+    expect(stripUndefinedDeep(parsed.call_saved_workflows)).toEqual(stripUndefinedDeep(call_saved_workflows));
+  });
 });

tests/app/invocations/test_call_saved_workflows.py

@@ -0,0 +1,29 @@
+from unittest.mock import Mock
+
+from invokeai.app.services.shared.invocation_context import InvocationContext
+
+
+def test_call_saved_workflows_invocation_contract():
+    from invokeai.app.invocations.call_saved_workflows import CallSavedWorkflowsInvocation
+    from invokeai.app.invocations.primitives import IntegerOutput
+
+    invocation = CallSavedWorkflowsInvocation(id="test-node")
+
+    assert invocation.get_type() == "call_saved_workflows"
+    assert invocation.workflow_id == ""
+
+    output = invocation.invoke(Mock(InvocationContext))
+
+    assert isinstance(output, IntegerOutput)
+    assert output.value == 0
+
+
+def test_call_saved_workflows_invocation_schema_hides_editor_managed_fields():
+    from invokeai.app.invocations.call_saved_workflows import CallSavedWorkflowsInvocation
+
+    schema = CallSavedWorkflowsInvocation.model_json_schema()
+    workflow_id = schema["properties"]["workflow_id"]
+
+    assert workflow_id["default"] == ""
+    assert workflow_id["ui_hidden"] is True
+    assert workflow_id["input"] == "any"

tests/conftest.py

@@ -23,6 +23,7 @@
 from invokeai.app.services.invocation_stats.invocation_stats_default import InvocationStatsService
 from invokeai.app.services.invoker import Invoker
 from invokeai.app.services.users.users_default import UserService
+from invokeai.app.services.workflow_records.workflow_records_sqlite import SqliteWorkflowRecordsStorage
 from invokeai.backend.util.logging import InvokeAILogger
 from tests.backend.model_manager.model_manager_fixtures import *  # noqa: F403
 from tests.fixtures.sqlite_database import create_mock_sqlite_database  # noqa: F401
@@ -57,7 +58,7 @@ def mock_services() -> InvocationServices:
         session_processor=None,  # type: ignore
         session_queue=None,  # type: ignore
         urls=None,  # type: ignore
-        workflow_records=None,  # type: ignore
+        workflow_records=SqliteWorkflowRecordsStorage(db=db),
         tensors=None,  # type: ignore
         conditioning=None,  # type: ignore
         style_preset_records=None,  # type: ignore