Line data Source code
1 : import { useRoute, useRouter } from 'vue-router'
2 :
3 : import { isCloud } from '@/platform/distribution/types'
4 : import {
5 : clearPreservedQuery,
6 : getPreservedQueryParam,
7 : hydratePreservedQuery,
8 : mergePreservedQueryIntoQuery
9 : } from '@/platform/navigation/preservedQueryManager'
10 : import { PRESERVED_QUERY_NAMESPACES } from '@/platform/navigation/preservedQueryNamespaces'
11 : import { reportError } from '@comfyorg/telemetry/reportError'
12 : import { useWorkflowService } from '@/platform/workflow/core/services/workflowService'
13 : import {
14 : ComfyWorkflow,
15 : useWorkflowStore
16 : } from '@/platform/workflow/management/stores/workflowStore'
17 :
18 2355 : const WORKFLOWS_NAMESPACE = PRESERVED_QUERY_NAMESPACES.WORKFLOWS
19 2355 : const DEPLOYMENT_NAMESPACE = PRESERVED_QUERY_NAMESPACES.DEPLOYMENT
20 :
21 0 : function isFolderName(value: unknown): value is string {
22 0 : return (
23 : typeof value === 'string' &&
24 : value !== '' &&
25 : !value.includes('/') &&
26 : !value.includes('\\') &&
27 : !value.includes('..') &&
28 : !value.includes(',')
29 : )
30 : }
31 :
32 : /**
33 : * Opens the saved workflows of the folder a link names:
34 : * `?workflows=<folder>` opens every `.json` directly in `workflows/<folder>/`
35 : * as a tab, in natural name order, with the first in front. A tab already
36 : * open is reused and keeps its place, so the folder's tabs may sit among
37 : * tabs that were open before. A folder name that is not one path segment, a
38 : * repeated or bare param (which the preserved-query tracker stashes joined
39 : * with `,`), or a folder with no workflows, opens nothing. If the first
40 : * workflow fails to open, the tabs are left as they were. The param survives
41 : * the sign-in and onboarding redirects through the preserved-query stash. It
42 : * is then dropped, stash included, except while a Cloud deployment link (in
43 : * the URL or its own stash) is still to pick, since that pick reloads the page
44 : * and the boot after it opens the folder again.
45 : */
46 2355 : export function useFolderWorkflowsUrlLoader() {
47 2355 : const route = useRoute()
48 2355 : const router = useRouter()
49 2355 : const workflowStore = useWorkflowStore()
50 :
51 0 : function workflowsIn(folder: string): ComfyWorkflow[] {
52 0 : const prefix = `${ComfyWorkflow.basePath}${folder}/`
53 : const inFolder = workflowStore.persistedWorkflows.filter(({ path }) => {
54 0 : if (!path.startsWith(prefix)) return false
55 0 : const name = path.slice(prefix.length)
56 0 : return name.endsWith('.json') && !name.includes('/')
57 : })
58 0 : return inFolder.sort((a, b) =>
59 : a.fullFilename.localeCompare(b.fullFilename, undefined, {
60 : numeric: true,
61 : sensitivity: 'base'
62 : })
63 : )
64 : }
65 :
66 0 : async function openInFront(folder: string): Promise<boolean> {
67 0 : try {
68 0 : await workflowStore.loadWorkflows()
69 0 : const workflows = workflowsIn(folder)
70 0 : if (workflows.length === 0) return false
71 : const opened = await useWorkflowService().openWorkflow(workflows[0])
72 0 : if (!opened) return false
73 0 : workflowStore.openWorkflowsInBackground({
74 : right: workflows.map((workflow) => workflow.path)
75 : })
76 0 : return true
77 : } catch (error) {
78 0 : reportError(error, {
79 : surface: 'graph',
80 : errorType: 'error_opening_link_folder_workflows'
81 : })
82 0 : return false
83 : }
84 : }
85 :
86 2355 : function linkQuery() {
87 2355 : hydratePreservedQuery(WORKFLOWS_NAMESPACE)
88 2355 : return (
89 : mergePreservedQueryIntoQuery(WORKFLOWS_NAMESPACE, route.query) ??
90 : route.query
91 : )
92 : }
93 :
94 : function deploymentLinkPending(): boolean {
95 : return (
96 : 'deployment' in route.query ||
97 : getPreservedQueryParam(DEPLOYMENT_NAMESPACE, 'deployment') !== undefined
98 : )
99 : }
100 :
101 0 : function dropParam() {
102 : if (isCloud && deploymentLinkPending()) return
103 0 : clearPreservedQuery(WORKFLOWS_NAMESPACE)
104 0 : if (!('workflows' in route.query)) return
105 0 : const query = { ...route.query }
106 0 : delete query.workflows
107 0 : void router.replace({ query })
108 : }
109 :
110 : /**
111 : * Opens the linked folder's workflows. Resolves true when one of them is
112 : * now the active workflow.
113 : */
114 2355 : async function openFolderWorkflowsFromUrl(): Promise<boolean> {
115 2355 : const query = linkQuery()
116 2355 : if (!('workflows' in query)) return false
117 0 : const folder = query.workflows
118 2355 : const opened = isFolderName(folder) && (await openInFront(folder))
119 0 : dropParam()
120 0 : return opened
121 : }
122 :
123 2355 : return { openFolderWorkflowsFromUrl }
124 : }
|