Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions e2e/home.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,23 @@ test('Home in the sidebar returns to Home @windows @macos @linux', async () => {
await ctx.panel.waitForVisible(HOME_VIEW)
expect(await ctx.panel.isVisible('.chooser-view')).toBe(false)
})

test('Auto start on a Home card saves that build for the next start, and unticking sets None @windows @macos @linux', async () => {
const box = '[data-testid="home-build-auto-start"] [role="checkbox"]'
const saved = () => ctx.panel.evaluate("window.api.getSetting('autoLaunchOnStartup')")
const boxState = () =>
ctx.panel.evaluate(`document.querySelector('${box}')?.getAttribute('aria-checked')`)
await ctx.panel.waitForVisible(box)
const buildId = await ctx.panel.evaluate<string>(
`document.querySelector('[data-testid="home-build-auto-start"]').dataset.buildId`
)

expect(await ctx.panel.click(box)).toBe(true)
await expect.poll(saved).toBe(buildId)
await expect.poll(boxState).toBe('true')
expect(await ctx.panel.isVisible(HOME_VIEW)).toBe(true)

expect(await ctx.panel.click(box)).toBe(true)
await expect.poll(saved).toBe('none')
await expect.poll(boxState).toBe('false')
})
2 changes: 2 additions & 0 deletions locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@
"openComfyUIIn": "Open ComfyUI in {name}",
"opensIn": "Opens in {name}",
"allBuilds": "All builds",
"autoStart": "Auto start",
"autoStartHint": "Start this build when Comfy Desktop opens",
"buildRunning": "Running",
"buildStarting": "Starting",
"buildReady": "Ready",
Expand Down
2 changes: 2 additions & 0 deletions locales/zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@
"openComfyUIIn": "在 {name} 中打开 ComfyUI",
"opensIn": "在 {name} 中打开",
"allBuilds": "全部构建",
"autoStart": "自动启动",
"autoStartHint": "Comfy Desktop 打开时启动此构建",
"buildRunning": "运行中",
"buildStarting": "启动中",
"buildReady": "就绪",
Expand Down
195 changes: 195 additions & 0 deletions src/renderer/src/composables/useAutoStartBuild.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { effectScope, type EffectScope } from 'vue'
import { flushPromises } from '@vue/test-utils'

import { useAutoStartBuild } from './useAutoStartBuild'

let saved: unknown
let settingsChanged: (change: { key: string }) => void
const unsubscribe = vi.fn()
const getSetting = vi.fn(async (_key: string): Promise<unknown> => saved)
const setSetting = vi.fn(async (_key: string, value: unknown): Promise<void> => {
saved = value
})
let scope: EffectScope

beforeEach(() => {
vi.clearAllMocks()
saved = 'none'
;(window as unknown as { api: unknown }).api = {
getSetting,
setSetting,
onSettingsChanged: vi.fn((callback: (change: { key: string }) => void) => {
settingsChanged = callback
return unsubscribe
})
}
})

afterEach(() => {
scope?.stop()
})

async function start() {
scope = effectScope()
const autoStart = scope.run(() => useAutoStartBuild())!
await flushPromises()
return autoStart
}

describe('useAutoStartBuild', () => {
it('reads the Auto-launch on startup setting and ticks only the build it names', async () => {
saved = 'build-a'
const autoStart = await start()

expect(getSetting).toHaveBeenCalledWith('autoLaunchOnStartup')
expect(autoStart.startsOnOpen('build-a')).toBe(true)
expect(autoStart.startsOnOpen('build-b')).toBe(false)
})

it('ticks no build for None or Last used build', async () => {
const autoStart = await start()
expect(autoStart.startsOnOpen('build-a')).toBe(false)

saved = 'last'
settingsChanged({ key: 'autoLaunchOnStartup' })
await flushPromises()

expect(autoStart.startsOnOpen('build-a')).toBe(false)
})

it('moves the tick to a newly ticked build and saves its id in the same setting', async () => {
saved = 'build-a'
const autoStart = await start()

await autoStart.setStartsOnOpen('build-b', true)

expect(setSetting).toHaveBeenCalledWith('autoLaunchOnStartup', 'build-b')
expect(autoStart.startsOnOpen('build-b')).toBe(true)
expect(autoStart.startsOnOpen('build-a')).toBe(false)
})

it('replaces Last used build with the build that is ticked', async () => {
saved = 'last'
const autoStart = await start()

await autoStart.setStartsOnOpen('build-a', true)

expect(setSetting).toHaveBeenCalledWith('autoLaunchOnStartup', 'build-a')
})

it('sets None when the ticked build is unticked', async () => {
saved = 'build-a'
const autoStart = await start()

await autoStart.setStartsOnOpen('build-a', false)

expect(setSetting).toHaveBeenCalledWith('autoLaunchOnStartup', 'none')
expect(autoStart.startsOnOpen('build-a')).toBe(false)
})

it('writes nothing when a build is already in the state asked for', async () => {
saved = 'build-a'
const autoStart = await start()

await autoStart.setStartsOnOpen('build-a', true)
await autoStart.setStartsOnOpen('build-b', false)

expect(setSetting).not.toHaveBeenCalled()
})

it('follows a change made in Settings without a restart, and ignores other settings', async () => {
saved = 'build-a'
const autoStart = await start()
getSetting.mockClear()

saved = 'build-b'
settingsChanged({ key: 'hideCloudFromPicker' })
await flushPromises()
expect(getSetting).not.toHaveBeenCalled()
expect(autoStart.startsOnOpen('build-a')).toBe(true)

settingsChanged({ key: 'autoLaunchOnStartup' })
await flushPromises()
expect(autoStart.startsOnOpen('build-b')).toBe(true)
expect(autoStart.startsOnOpen('build-a')).toBe(false)
})

it('keeps a tick made while the first read is still on its way', async () => {
let answer: (value: unknown) => void = () => {}
getSetting.mockImplementationOnce(
() =>
new Promise((resolve) => {
answer = resolve
})
)
scope = effectScope()
const autoStart = scope.run(() => useAutoStartBuild())!

await autoStart.setStartsOnOpen('build-b', true)
answer('build-a')
await flushPromises()

expect(autoStart.startsOnOpen('build-b')).toBe(true)
expect(autoStart.startsOnOpen('build-a')).toBe(false)
})

it('shows the saved choice again when saving fails', async () => {
saved = 'build-a'
const autoStart = await start()
setSetting.mockRejectedValueOnce(new Error('settings.json is unreadable'))

await autoStart.setStartsOnOpen('build-b', true)

expect(autoStart.startsOnOpen('build-a')).toBe(true)
expect(autoStart.startsOnOpen('build-b')).toBe(false)
})

it('shows the saved choice again when saving and reading it back both fail, so a second tick saves again', async () => {
saved = 'build-a'
const autoStart = await start()
setSetting.mockRejectedValueOnce(new Error('settings.json is unreadable'))
getSetting.mockRejectedValueOnce(new Error('settings.json is unreadable'))

await autoStart.setStartsOnOpen('build-b', true)

expect(autoStart.startsOnOpen('build-a')).toBe(true)
expect(autoStart.startsOnOpen('build-b')).toBe(false)

await autoStart.setStartsOnOpen('build-b', true)

expect(setSetting).toHaveBeenCalledTimes(2)
expect(setSetting).toHaveBeenLastCalledWith('autoLaunchOnStartup', 'build-b')
expect(autoStart.startsOnOpen('build-b')).toBe(true)
})

it('keeps a newer tick when the read after a failed save also fails', async () => {
saved = 'build-a'
const autoStart = await start()
let failRead: (error: Error) => void = () => {}
setSetting.mockRejectedValueOnce(new Error('settings.json is unreadable'))
getSetting.mockImplementationOnce(
() =>
new Promise((_resolve, reject) => {
failRead = reject
})
)

const failedSave = autoStart.setStartsOnOpen('build-b', true)
await flushPromises()
await autoStart.setStartsOnOpen('build-c', true)
failRead(new Error('settings.json is unreadable'))
await failedSave

expect(autoStart.startsOnOpen('build-c')).toBe(true)
expect(autoStart.startsOnOpen('build-a')).toBe(false)
})

it('stops listening for setting changes when its page goes away', async () => {
await start()

scope.stop()

expect(unsubscribe).toHaveBeenCalledTimes(1)
})
})
47 changes: 47 additions & 0 deletions src/renderer/src/composables/useAutoStartBuild.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import { onScopeDispose, ref } from 'vue'

const AUTO_START_SETTING = 'autoLaunchOnStartup'
const AUTO_START_NONE = 'none'

export function useAutoStartBuild() {
const autoStartValue = ref<unknown>(undefined)
let confirmedValue: unknown = undefined
let revision = 0

async function read(): Promise<void> {
const seen = ++revision
try {
const value = await window.api.getSetting(AUTO_START_SETTING)
if (seen !== revision) return
confirmedValue = value
autoStartValue.value = value
} catch {
if (seen === revision) autoStartValue.value = confirmedValue
}
}

const unsubscribe = window.api.onSettingsChanged(({ key }) => {
if (key === AUTO_START_SETTING) void read()
})
onScopeDispose(unsubscribe)
void read()

function startsOnOpen(buildId: string): boolean {
return autoStartValue.value === buildId
}

async function setStartsOnOpen(buildId: string, on: boolean): Promise<void> {
if (on === startsOnOpen(buildId)) return
const next = on ? buildId : AUTO_START_NONE
revision++
autoStartValue.value = next
try {
await window.api.setSetting(AUTO_START_SETTING, next)
confirmedValue = next
} catch {
await read()
Comment thread
vqt123 marked this conversation as resolved.
Resolved
}
}

return { startsOnOpen, setStartsOnOpen }
}
Loading
Loading