LCOV - code coverage report
Current view: top level - src/services - useNewUserService.ts Coverage Total Hit
Test: ComfyUI E2E Coverage Lines: 68.6 % 51 35
Test Date: 2026-11-17 04:17:53

            Line data    Source code
       1              : import { ref, shallowRef } from 'vue'
       2              : import { createSharedComposable } from '@vueuse/core'
       3              : import { useSettingStore } from '@/platform/settings/settingStore'
       4              : import { reportError } from '@comfyorg/telemetry/reportError'
       5              : 
       6         2355 : function hasV2DraftHistory(raw: string | null): boolean {
       7         2355 :   if (!raw) return false
       8           98 :   let parsed: unknown
       9           98 :   try {
      10           98 :     parsed = JSON.parse(raw)
      11              :   } catch {
      12            0 :     reportError(new Error('Workflow draft index is not valid JSON'), {
      13              :       surface: 'graph',
      14              :       errorType: 'error_parsing_workflow_draft_index',
      15              :       level: 'warning',
      16              :       context: { length: raw.length }
      17              :     })
      18            0 :     return false
      19              :   }
      20         2355 :   if (!parsed || typeof parsed !== 'object') return false
      21           98 :   const { order, entries } = parsed as { order?: unknown; entries?: unknown }
      22         2355 :   const orderLength = Array.isArray(order) ? order.length : 0
      23         2355 :   const entriesCount =
      24              :     entries && typeof entries === 'object' ? Object.keys(entries).length : 0
      25         2355 :   return orderLength > 0 || entriesCount > 0
      26              : }
      27              : 
      28         2355 : function _useNewUserService() {
      29         2355 :   const settingStore = useSettingStore()
      30         2355 :   const pendingCallbacks = shallowRef<Array<() => Promise<void>>>([])
      31         2355 :   const isNewUserDetermined = ref(false)
      32         2355 :   const isNewUserCached = ref<boolean | null>(null)
      33              : 
      34            0 :   function reset() {
      35            0 :     pendingCallbacks.value = []
      36            0 :     isNewUserDetermined.value = false
      37            0 :     isNewUserCached.value = null
      38              :   }
      39              : 
      40         2355 :   function checkIsNewUser(): boolean {
      41         2355 :     const isNewUserSettings =
      42              :       Object.keys(settingStore.settingValues).length === 0 ||
      43              :       !settingStore.get('Comfy.TutorialCompleted')
      44              : 
      45              :     // Legacy keys (pre-V1 and V1 persistence)
      46         2355 :     const hasNoLegacyWorkflow =
      47              :       !localStorage.getItem('workflow') &&
      48              :       !localStorage.getItem('Comfy.PreviousWorkflow')
      49              : 
      50              :     // V1 draft store keys
      51         2355 :     const hasNoV1Drafts =
      52              :       !localStorage.getItem('Comfy.Workflow.Drafts') &&
      53              :       !localStorage.getItem('Comfy.Workflow.DraftOrder')
      54              : 
      55              :     // V2 draft index key (scoped to personal workspace; cloud workspace id
      56              :     // comes from sessionStorage which may not be set yet at this point).
      57              :     // Check for actual draft history rather than key existence: an empty
      58              :     // index can be written for genuine new users during startup, so key
      59              :     // presence alone is not evidence of prior usage.
      60         2355 :     const hasNoV2DraftIndex = !hasV2DraftHistory(
      61              :       localStorage.getItem('Comfy.Workflow.DraftIndex.v2:personal')
      62              :     )
      63              : 
      64         2355 :     return (
      65              :       isNewUserSettings &&
      66              :       hasNoLegacyWorkflow &&
      67              :       hasNoV1Drafts &&
      68              :       hasNoV2DraftIndex
      69              :     )
      70              :   }
      71              : 
      72            0 :   async function registerInitCallback(callback: () => Promise<void>) {
      73            0 :     if (isNewUserDetermined.value) {
      74            0 :       if (isNewUserCached.value) {
      75            0 :         try {
      76            0 :           await callback()
      77              :         } catch (error) {
      78            0 :           console.error('New user initialization callback failed:', error)
      79              :         }
      80              :       }
      81              :     } else {
      82            0 :       pendingCallbacks.value = [...pendingCallbacks.value, callback]
      83              :     }
      84              :   }
      85              : 
      86         2355 :   async function initializeIfNewUser() {
      87         2355 :     if (isNewUserDetermined.value) return
      88              : 
      89         2355 :     isNewUserCached.value = checkIsNewUser()
      90         2355 :     isNewUserDetermined.value = true
      91              : 
      92         2355 :     if (!isNewUserCached.value) {
      93         2352 :       pendingCallbacks.value = []
      94         2352 :       return
      95              :     }
      96              : 
      97            3 :     await settingStore.set(
      98              :       'Comfy.InstalledVersion',
      99              :       __COMFYUI_FRONTEND_VERSION__
     100              :     )
     101              : 
     102            3 :     for (const callback of pendingCallbacks.value) {
     103            0 :       try {
     104            0 :         await callback()
     105              :       } catch (error) {
     106            0 :         console.error('New user initialization callback failed:', error)
     107              :       }
     108              :     }
     109              : 
     110            3 :     pendingCallbacks.value = []
     111              :   }
     112              : 
     113           26 :   function isNewUser(): boolean | null {
     114           26 :     return isNewUserDetermined.value ? isNewUserCached.value : null
     115              :   }
     116              : 
     117         2355 :   return {
     118              :     registerInitCallback,
     119              :     initializeIfNewUser,
     120              :     isNewUser,
     121              :     reset
     122              :   }
     123              : }
     124              : 
     125         2355 : export const useNewUserService = createSharedComposable(_useNewUserService)
        

Generated by: LCOV version 2.0-1