fix: docs: document UUID injection behavior in createTemporary() and createNewTemporary() (#9448)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

src/locales/en/main.json

@@ -178,7 +178,7 @@
     "uploadAlreadyInProgress": "Upload already in progress",
     "capture": "capture",
     "nodes": "Nodes",
-    "nodesCount": "{count} node | {count} nodes",
+    "nodesCount": "{count} nodes | {count} node | {count} nodes",
     "addNode": "Add a node...",
     "filterBy": "Filter by:",
     "filterByType": "Filter by {type}...",
@@ -222,7 +222,7 @@
     "failed": "Failed",
     "cancelled": "Cancelled",
     "job": "Job",
-    "asset": "{count} asset | {count} assets",
+    "asset": "{count} assets | {count} asset | {count} assets",
     "untitled": "Untitled",
     "emDash": "—",
     "enabling": "Enabling {id}",
@@ -3347,7 +3347,7 @@
     }
   },
   "errorOverlay": {
-    "errorCount": "{count} ERROR | {count} ERRORS",
+    "errorCount": "{count} ERRORS | {count} ERROR | {count} ERRORS",
     "seeErrors": "See Errors"
   },
   "help": {
@@ -3357,7 +3357,7 @@
   "progressToast": {
     "importingModels": "Importing Models",
     "downloadingModel": "Downloading model...",
-    "downloadsFailed": "{count} download failed | {count} downloads failed",
+    "downloadsFailed": "{count} downloads failed | {count} download failed | {count} downloads failed",
     "allDownloadsCompleted": "All downloads completed",
     "noImportsInQueue": "No {filter} in queue",
     "failed": "Failed",
@@ -3374,7 +3374,7 @@
     "exportingAssets": "Exporting Assets",
     "preparingExport": "Preparing export...",
     "exportError": "Export failed",
-    "exportFailed": "{count} export failed | {count} exports failed",
+    "exportFailed": "{count} export failed | {count} export failed | {count} exports failed",
     "allExportsCompleted": "All exports completed",
     "noExportsInQueue": "No {filter} exports in queue",
     "exportStarted": "Preparing ZIP download...",

src/platform/workflow/core/services/workflowService.test.ts

@@ -99,9 +99,7 @@ vi.mock('@/renderer/core/canvas/canvasStore', () => ({
 vi.mock('@/renderer/core/thumbnail/useWorkflowThumbnail', () => ({
   useWorkflowThumbnail: () => ({
     storeThumbnail: vi.fn(),
-    getThumbnail: vi.fn(),
-    clearThumbnail: vi.fn(),
-    moveWorkflowThumbnail: vi.fn()
+    getThumbnail: vi.fn()
   })
 }))
 
@@ -855,13 +853,12 @@ describe('useWorkflowService', () => {
 
       const existing = createSaveableWorkflow('workflows/test.app.json')
       vi.spyOn(workflowStore, 'getWorkflowByPath').mockReturnValue(existing)
-      vi.spyOn(workflowStore, 'removeWorkflowEntry').mockResolvedValue()
+      vi.spyOn(workflowStore, 'deleteWorkflow').mockResolvedValue()
       mockConfirm.mockResolvedValue(true)
 
       await service.saveWorkflow(workflow)
 
       expect(mockConfirm).toHaveBeenCalled()
-      expect(workflowStore.removeWorkflowEntry).toHaveBeenCalledWith(existing)
       expect(workflowStore.renameWorkflow).toHaveBeenCalledWith(
         workflow,
         'workflows/test.app.json'

src/platform/workflow/core/services/workflowService.ts

@@ -130,20 +130,11 @@ export const useWorkflowService = () => {
 
     if (existingWorkflow && !existingWorkflow.isTemporary) {
       if ((await confirmOverwrite(newPath)) !== true) return false
-    }
 
-    const needsOverwrite =
-      !!existingWorkflow && !existingWorkflow.isTemporary && !isSelfOverwrite
-
-    // Close and remove the old workflow entry before saving the new content.
-    // The file on disk is intentionally kept so that a save failure does not
-    // cause data loss.  The subsequent save with overwrite: true will
-    // atomically replace it.
-    if (needsOverwrite) {
-      if (workflowStore.isOpen(existingWorkflow)) {
-        await closeWorkflow(existingWorkflow, { warnIfUnsaved: false })
+      if (!isSelfOverwrite) {
+        const deleted = await deleteWorkflow(existingWorkflow, true)
+        if (!deleted) return false
       }
-      await workflowStore.removeWorkflowEntry(existingWorkflow)
     }
 
     workflow.changeTracker?.checkState()
@@ -152,19 +143,11 @@ export const useWorkflowService = () => {
       await saveWorkflow(workflow)
     } else if (workflow.isTemporary) {
       await renameWorkflow(workflow, newPath)
-      if (needsOverwrite) {
-        await workflowStore.saveWorkflow(workflow, { overwrite: true })
-      } else {
-        await workflowStore.saveWorkflow(workflow)
-      }
+      await workflowStore.saveWorkflow(workflow)
     } else {
       const tempWorkflow = workflowStore.saveAs(workflow, newPath)
       await openWorkflow(tempWorkflow)
-      if (needsOverwrite) {
-        await workflowStore.saveWorkflow(tempWorkflow, { overwrite: true })
-      } else {
-        await workflowStore.saveWorkflow(tempWorkflow)
-      }
+      await workflowStore.saveWorkflow(tempWorkflow)
     }
     return true
   }
@@ -191,12 +174,7 @@ export const useWorkflowService = () => {
             await workflowStore.saveWorkflow(workflow)
             return
           }
-          // Remove the old entry without deleting the file; the rename
-          // will atomically replace it, preventing data loss on failure.
-          if (workflowStore.isOpen(existing)) {
-            await closeWorkflow(existing, { warnIfUnsaved: false })
-          }
-          await workflowStore.removeWorkflowEntry(existing)
+          await deleteWorkflow(existing, true)
         }
         await renameWorkflow(workflow, expectedPath)
         toastStore.add({

src/platform/workflow/management/stores/comfyWorkflow.ts

@@ -151,16 +151,14 @@ export class ComfyWorkflow extends UserFile {
     super.unload()
   }
 
-  override async save({
-    overwrite
-  }: { force?: boolean; overwrite?: boolean } = {}) {
+  override async save() {
     const { useWorkflowDraftStore } =
       await import('@/platform/workflow/persistence/stores/workflowDraftStore')
     const draftStore = useWorkflowDraftStore()
     this.content = JSON.stringify(this.activeState)
     // Force save to ensure the content is updated in remote storage incase
     // the isModified state is screwed by changeTracker.
-    const ret = await super.save({ force: true, overwrite })
+    const ret = await super.save({ force: true })
     this.changeTracker?.reset()
     this.isModified = false
     draftStore.removeDraft(this.path)

src/platform/workflow/management/stores/workflowStore.ts

@@ -63,11 +63,7 @@ interface WorkflowStore {
   ) => ComfyWorkflow
   renameWorkflow: (workflow: ComfyWorkflow, newPath: string) => Promise<void>
   deleteWorkflow: (workflow: ComfyWorkflow) => Promise<void>
-  removeWorkflowEntry: (workflow: ComfyWorkflow) => Promise<void>
-  saveWorkflow: (
-    workflow: ComfyWorkflow,
-    options?: { overwrite?: boolean }
-  ) => Promise<void>
+  saveWorkflow: (workflow: ComfyWorkflow) => Promise<void>
 
   workflows: ComfyWorkflow[]
   bookmarkedWorkflows: ComfyWorkflow[]
@@ -259,6 +255,13 @@ export const useWorkflowStore = defineStore('workflow', () => {
     return workflow
   }
 
+  /**
+   * Ensures the workflow data has a stable `id` field for sharing.
+   * If the provided (or default) workflow data does not contain an `id`,
+   * a new UUID is generated and injected into the returned copy.
+   *
+   * @returns A deep copy of the workflow data with a guaranteed `id` field.
+   */
   const ensureWorkflowId = (
     workflowData?: ComfyWorkflowJSON
   ): ComfyWorkflowJSON => {
@@ -274,7 +277,11 @@ export const useWorkflowStore = defineStore('workflow', () => {
   }
 
   /**
-   * Helper to create a new temporary workflow
+   * Helper to create a new temporary workflow.
+   *
+   * Calls {@link ensureWorkflowId} to guarantee the workflow data contains
+   * a UUID `id` field. If the provided data has no `id`, one is generated
+   * and injected into the serialized content.
    */
   const createNewWorkflow = (
     path: string,
@@ -295,7 +302,13 @@ export const useWorkflowStore = defineStore('workflow', () => {
   }
 
   /**
-   * Create a temporary workflow, attempting to reuse an existing workflow if conditions match
+   * Create a temporary workflow, attempting to reuse an existing workflow
+   * if conditions match.
+   *
+   * Note: A UUID `id` field is injected into the workflow data via
+   * {@link ensureWorkflowId} if one is not already present. The serialized
+   * workflow content will always contain an `id` field, even if none was
+   * provided in the input.
    */
   const createTemporary = (path?: string, workflowData?: ComfyWorkflowJSON) => {
     const fullPath = getUnconflictedPath(
@@ -327,7 +340,13 @@ export const useWorkflowStore = defineStore('workflow', () => {
   }
 
   /**
-   * Create a new temporary workflow without attempting to reuse existing workflows
+   * Create a new temporary workflow without attempting to reuse existing
+   * workflows.
+   *
+   * Note: A UUID `id` field is injected into the workflow data via
+   * {@link ensureWorkflowId} if one is not already present. The serialized
+   * workflow content will always contain an `id` field, even if none was
+   * provided in the input.
    */
   const createNewTemporary = (
     path?: string,
@@ -543,32 +562,14 @@ export const useWorkflowStore = defineStore('workflow', () => {
     }
   }
 
-  /**
-   * Remove a workflow entry from the store without deleting the file on disk.
-   * Used during atomic overwrite to clear the old entry before saving the new
-   * content, so that the save can use overwrite: true to replace the file.
-   */
-  const removeWorkflowEntry = async (workflow: ComfyWorkflow) => {
-    useWorkflowDraftStore().removeDraft(workflow.path)
-    if (bookmarkStore.isBookmarked(workflow.path)) {
-      await bookmarkStore.setBookmarked(workflow.path, false)
-    }
-    clearThumbnail(workflow.key)
-    delete workflowLookup.value[workflow.path]
-  }
-
   /**
    * Save a workflow.
    * @param workflow The workflow to save.
-   * @param options.overwrite Force overwrite of existing file at the path.
    */
-  const saveWorkflow = async (
-    workflow: ComfyWorkflow,
-    options?: { overwrite?: boolean }
-  ) => {
+  const saveWorkflow = async (workflow: ComfyWorkflow) => {
     isBusy.value = true
     try {
-      await workflow.save({ overwrite: options?.overwrite })
+      await workflow.save()
       // Synchronously detach and re-attach to force refresh the tree objects
       // without an async gap that would cause the tab to disappear.
       const openIndex = detachWorkflow(workflow)
@@ -796,7 +797,6 @@ export const useWorkflowStore = defineStore('workflow', () => {
     createNewTemporary,
     renameWorkflow,
     deleteWorkflow,
-    removeWorkflowEntry,
     saveAs,
     saveWorkflow,
     reorderWorkflows,

src/stores/userFileStore.ts

@@ -140,14 +140,11 @@ export class UserFile {
    * Saves the file to the remote storage.
    * @param force Whether to force the save even if the file is not modified.
    */
-  async save({
-    force = false,
-    overwrite
-  }: { force?: boolean; overwrite?: boolean } = {}): Promise<UserFile> {
+  async save({ force = false }: { force?: boolean } = {}): Promise<UserFile> {
     if (this.isPersisted && !this.isModified && !force) return this
 
     const resp = await api.storeUserData(this.path, this.content, {
-      overwrite: overwrite ?? this.isPersisted,
+      overwrite: this.isPersisted,
       throwOnError: true,
       full_info: true
     })