allow opened_at to be nullable for workflows that the user has never opened

Author: Mary Hipp

invokeai/app/api/routers/workflows.py

@@ -105,6 +105,7 @@ async def list_workflows(
     categories: Optional[list[WorkflowCategory]] = Query(default=None, description="The categories of workflow to get"),
     tags: Optional[list[str]] = Query(default=None, description="The tags of workflow to get"),
     query: Optional[str] = Query(default=None, description="The text to query by (matches name and description)"),
+    is_recent: Optional[bool] = Query(default=None, description="Whether to include/exclude recent workflows"),
 ) -> PaginatedResults[WorkflowRecordListItemWithThumbnailDTO]:
     """Gets a page of workflows"""
     workflows_with_thumbnails: list[WorkflowRecordListItemWithThumbnailDTO] = []
@@ -116,6 +117,7 @@ async def list_workflows(
         query=query,
         categories=categories,
         tags=tags,
+        is_recent=is_recent,
     )
     for workflow in workflows.items:
         workflows_with_thumbnails.append(

invokeai/app/services/shared/sqlite/sqlite_util.py

@@ -20,6 +20,7 @@
 from invokeai.app.services.shared.sqlite_migrator.migrations.migration_15 import build_migration_15
 from invokeai.app.services.shared.sqlite_migrator.migrations.migration_16 import build_migration_16
 from invokeai.app.services.shared.sqlite_migrator.migrations.migration_17 import build_migration_17
+from invokeai.app.services.shared.sqlite_migrator.migrations.migration_18 import build_migration_18
 from invokeai.app.services.shared.sqlite_migrator.sqlite_migrator_impl import SqliteMigrator
 
 
@@ -57,6 +58,7 @@ def init_db(config: InvokeAIAppConfig, logger: Logger, image_files: ImageFileSto
     migrator.register_migration(build_migration_15())
     migrator.register_migration(build_migration_16())
     migrator.register_migration(build_migration_17())
+    migrator.register_migration(build_migration_18())
     migrator.run_migrations()
 
     return db

invokeai/app/services/shared/sqlite_migrator/migrations/migration_18.py

@@ -0,0 +1,34 @@
+import sqlite3
+
+from invokeai.app.services.shared.sqlite_migrator.sqlite_migrator_common import Migration
+
+
+class Migration18Callback:
+    def __call__(self, cursor: sqlite3.Cursor) -> None:
+        self._make_workflow_opened_at_nullable(cursor)
+
+    def _make_workflow_opened_at_nullable(self, cursor: sqlite3.Cursor) -> None:
+        """
+        - Makes the `opened_at` column on workflow library table nullable by adding a new column
+        and deprecating the old one.
+        """
+        # Rename existing column to deprecated
+        cursor.execute("ALTER TABLE workflow_library RENAME COLUMN opened_at TO opened_at_deprecated;")
+        # Add new nullable column
+        cursor.execute("ALTER TABLE workflow_library ADD COLUMN opened_at DATETIME;")
+
+
+def build_migration_18() -> Migration:
+    """
+    Build the migration from database version 17 to 18.
+
+    This migration does the following:
+        - Makes the `opened_at` column on workflow library table nullable.
+    """
+    migration_18 = Migration(
+        from_version=17,
+        to_version=18,
+        callback=Migration18Callback(),
+    )
+
+    return migration_18

invokeai/app/services/workflow_records/workflow_records_base.py

@@ -46,6 +46,7 @@ def get_many(
         per_page: Optional[int],
         query: Optional[str],
         tags: Optional[list[str]],
+        is_recent: Optional[bool],
     ) -> PaginatedResults[WorkflowRecordListItemDTO]:
         """Gets many workflows."""
         pass

invokeai/app/services/workflow_records/workflow_records_common.py

@@ -1,6 +1,6 @@
 import datetime
 from enum import Enum
-from typing import Any, Union
+from typing import Any, Optional, Union
 
 import semver
 from pydantic import BaseModel, ConfigDict, Field, JsonValue, TypeAdapter, field_validator
@@ -98,7 +98,7 @@ class WorkflowRecordDTOBase(BaseModel):
     name: str = Field(description="The name of the workflow.")
     created_at: Union[datetime.datetime, str] = Field(description="The created timestamp of the workflow.")
     updated_at: Union[datetime.datetime, str] = Field(description="The updated timestamp of the workflow.")
-    opened_at: Union[datetime.datetime, str] = Field(description="The opened timestamp of the workflow.")
+    opened_at: Optional[Union[datetime.datetime, str]] = Field(description="The opened timestamp of the workflow.")
 
 
 class WorkflowRecordDTO(WorkflowRecordDTOBase):

invokeai/app/services/workflow_records/workflow_records_sqlite.py

@@ -118,6 +118,7 @@ def get_many(
         per_page: Optional[int] = None,
         query: Optional[str] = None,
         tags: Optional[list[str]] = None,
+        is_recent: Optional[bool] = None,
     ) -> PaginatedResults[WorkflowRecordListItemDTO]:
         # sanitize!
         assert order_by in WorkflowRecordOrderBy
@@ -175,6 +176,11 @@ def get_many(
             conditions.append(tags_condition)
             params.extend(tags_params)
 
+        if is_recent:
+            conditions.append("opened_at IS NOT NULL")
+        elif is_recent is False:
+            conditions.append("opened_at IS NULL")
+
         # Ignore whitespace in the query
         stripped_query = query.strip() if query else None
         if stripped_query:
@@ -319,13 +325,13 @@ def _sync_default_workflows(self) -> None:
                 bytes_ = path.read_bytes()
                 workflow_from_file = WorkflowValidator.validate_json(bytes_)
 
-                assert workflow_from_file.id.startswith("default_"), (
-                    f'Invalid default workflow ID (must start with "default_"): {workflow_from_file.id}'
-                )
+                assert workflow_from_file.id.startswith(
+                    "default_"
+                ), f'Invalid default workflow ID (must start with "default_"): {workflow_from_file.id}'
 
-                assert workflow_from_file.meta.category is WorkflowCategory.Default, (
-                    f"Invalid default workflow category: {workflow_from_file.meta.category}"
-                )
+                assert (
+                    workflow_from_file.meta.category is WorkflowCategory.Default
+                ), f"Invalid default workflow category: {workflow_from_file.meta.category}"
 
                 workflows_from_file.append(workflow_from_file)
 

invokeai/frontend/web/src/features/nodes/components/sidePanel/workflow/WorkflowLibrary/WorkflowLibrarySideNav.tsx

@@ -153,6 +153,7 @@ const recentWorkflowsQueryArg = {
   per_page: 5,
   order_by: 'opened_at',
   direction: 'DESC',
+  is_recent: true,
 } satisfies Parameters<typeof useListWorkflowsQuery>[0];
 
 const RecentWorkflows = memo(() => {

invokeai/frontend/web/src/services/api/schema.ts

@@ -21157,7 +21157,7 @@ export type components = {
              * Opened At
              * @description The opened timestamp of the workflow.
              */
-            opened_at: string;
+            opened_at: string | null;
             /** @description The workflow. */
             workflow: components["schemas"]["Workflow"];
         };
@@ -21187,7 +21187,7 @@ export type components = {
              * Opened At
              * @description The opened timestamp of the workflow.
              */
-            opened_at: string;
+            opened_at: string | null;
             /**
              * Description
              * @description The description of the workflow.
@@ -21238,7 +21238,7 @@ export type components = {
              * Opened At
              * @description The opened timestamp of the workflow.
              */
-            opened_at: string;
+            opened_at: string | null;
             /** @description The workflow. */
             workflow: components["schemas"]["Workflow"];
             /**
@@ -24300,6 +24300,8 @@ export interface operations {
                 tags?: string[] | null;
                 /** @description The text to query by (matches name and description) */
                 query?: string | null;
+                /** @description Whether to include/exclude recent workflows */
+                is_recent?: boolean | null;
             };
             header?: never;
             path?: never;