Define databaseUrl under userDirectoryPath (#1537)

Adds a default databaseUrl pointing to userDirectoryPath which is under
basePath, which resolves the linked issue as this path is writable as we
do a writability check for basePath's parent.

Resolves #1532

┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-1537-Define-databaseUrl-under-userDirectoryPath-2ea6d73d36508178b476f31d4ee93a2c)
by [Unito](https://www.unito.io)

Author: benceruleanlu

src/main-process/comfyServer.ts

@@ -81,6 +81,20 @@ export class ComfyServer implements HasTelemetry {
     return `http://${this.serverArgs.listen}:${this.serverArgs.port}`;
   }
 
+  private resolveDatabasePath(userDirectoryPath: string): string {
+    if (process.platform === 'win32') {
+      return path.win32.resolve(userDirectoryPath, 'comfyui.db');
+    }
+
+    return path.resolve(userDirectoryPath, 'comfyui.db');
+  }
+
+  private get databaseUrl(): string {
+    const dbPath = this.resolveDatabasePath(this.userDirectoryPath);
+    const normalizedDbPath = process.platform === 'win32' ? dbPath.replaceAll('\\', '/') : dbPath;
+    return `sqlite:///${normalizedDbPath}`;
+  }
+
   /**
    * Core arguments to pass to the ComfyUI server to ensure electron app
    * works as expected.
@@ -92,6 +106,7 @@ export class ComfyServer implements HasTelemetry {
       'output-directory': this.outputDirectoryPath,
       'front-end-root': this.webRootPath,
       'base-directory': this.basePath,
+      'database-url': this.databaseUrl,
       'extra-model-paths-config': ComfyServerConfig.configPath,
       'log-stdout': '',
     };

tests/unit/main-process/comfyServer.test.ts

@@ -3,7 +3,7 @@ import log from 'electron-log/main';
 import { ChildProcess } from 'node:child_process';
 import { EventEmitter } from 'node:events';
 import path from 'node:path';
-import { test as baseTest, describe, expect, vi } from 'vitest';
+import { afterEach, test as baseTest, describe, expect, vi } from 'vitest';
 import waitOn from 'wait-on';
 
 import { ServerArgs } from '@/constants';
@@ -64,13 +64,7 @@ const test = baseTest.extend<TestContext>({
       transports: { file: { transforms: [] } },
     } as unknown as MainLogger & { default: MainLogger });
 
-    const server = new ComfyServer(
-      basePath,
-      mockServerArgs,
-      mockVirtualEnvironment as any,
-      mockAppWindow as any,
-      mockTelemetry as any
-    );
+    const server = new ComfyServer(basePath, mockServerArgs, mockVirtualEnvironment, mockAppWindow, mockTelemetry);
     await use(server);
   },
   runningServer: async ({ server, mockProcess }, use) => {
@@ -80,6 +74,10 @@ const test = baseTest.extend<TestContext>({
   },
 });
 
+afterEach(() => {
+  vi.unstubAllGlobals();
+});
+
 describe('buildLaunchArgs', () => {
   test('should convert basic arguments correctly', () => {
     const args = {
@@ -145,15 +143,63 @@ describe('baseUrl', () => {
 describe('coreLaunchArgs', () => {
   test('should return the correct core launch arguments', ({ server }) => {
     const args = server.coreLaunchArgs;
+    const databaseUrl = args['database-url'];
+    const normalizedUserDir = server.userDirectoryPath.replaceAll('\\', '/');
     expect(args).toEqual({
       'user-directory': server.userDirectoryPath,
       'input-directory': server.inputDirectoryPath,
       'output-directory': server.outputDirectoryPath,
       'front-end-root': server.webRootPath,
       'base-directory': basePath,
+      'database-url': databaseUrl,
       'extra-model-paths-config': expect.any(String),
       'log-stdout': '',
     });
+    expect(databaseUrl).toMatch(/^sqlite:\/\//);
+    expect(databaseUrl).toContain(normalizedUserDir);
+    expect(databaseUrl).toMatch(/\/comfyui\.db$/);
+  });
+
+  test('normalizes database URL path separators on win32', ({
+    mockServerArgs,
+    mockVirtualEnvironment,
+    mockAppWindow,
+    mockTelemetry,
+  }) => {
+    vi.stubGlobal('process', { ...process, platform: 'win32' });
+    const windowsBasePath = String.raw`C:\ComfyUI`;
+    const windowsServer = new ComfyServer(
+      windowsBasePath,
+      mockServerArgs,
+      mockVirtualEnvironment,
+      mockAppWindow,
+      mockTelemetry
+    );
+    const databaseUrl = windowsServer.coreLaunchArgs['database-url'];
+    const expectedPath = path.win32.resolve(windowsBasePath, 'user', 'comfyui.db').replaceAll('\\', '/');
+    expect(databaseUrl).toBe(`sqlite:///${expectedPath}`);
+    expect(databaseUrl).not.toContain('\\');
+  });
+});
+
+describe('launchArgs', () => {
+  test('should allow user override of database-url', ({ mockVirtualEnvironment, mockAppWindow, mockTelemetry }) => {
+    const customDatabaseUrl = 'sqlite:///override.db';
+    const serverArgs: ServerArgs = {
+      listen: 'localhost',
+      port: '8188',
+      'database-url': customDatabaseUrl,
+    };
+    const server = new ComfyServer(basePath, serverArgs, mockVirtualEnvironment, mockAppWindow, mockTelemetry);
+    const args = server.launchArgs;
+    const coreDatabaseUrl = server.coreLaunchArgs['database-url'];
+    expect(coreDatabaseUrl).not.toBe(customDatabaseUrl);
+    const databaseUrlIndices = args
+      .map((value, index) => (value === '--database-url' ? index : -1))
+      .filter((index) => index !== -1);
+    expect(databaseUrlIndices).toHaveLength(1);
+    expect(args[databaseUrlIndices[0] + 1]).toBe(customDatabaseUrl);
+    expect(args).not.toContain(coreDatabaseUrl);
   });
 });