feat: add options to web

Author: DominicGBauer

packages/common/src/client/sync/stream/AbstractStreamingSyncImplementation.ts

@@ -91,6 +91,7 @@ export interface PowerSyncConnectionOptions {
    */
   crudUploadThrottleMs?: number;
 }
+export type PowerSyncConnectionRequiredOptions = Required<Omit<PowerSyncConnectionOptions, 'retryDelayMs' | 'crudUploadThrottleMs'>>;
 
 export interface StreamingSyncImplementation extends BaseObserver<StreamingSyncImplementationListener>, Disposable {
   /**
@@ -439,7 +440,7 @@ The next upload iteration will be delayed.`);
       type: LockType.SYNC,
       signal,
       callback: async () => {
-        const resolvedOptions: Required<Omit<PowerSyncConnectionOptions, 'retryDelayMs' |  'crudUploadThrottleMs'>> = {
+        const resolvedOptions: Required<PowerSyncConnectionRequiredOptions> = {
           ...DEFAULT_STREAM_CONNECTION_OPTIONS,
           ...(options ?? {})
         };

packages/web/src/db/PowerSyncDatabase.ts

@@ -164,11 +164,20 @@ export class PowerSyncDatabase extends AbstractPowerSyncDatabase {
     return getNavigatorLocks().request(`lock-${this.database.name}`, cb);
   }
 
-  protected generateSyncStreamImplementation(connector: PowerSyncBackendConnector): StreamingSyncImplementation {
+  protected generateSyncStreamImplementation(
+    connector: PowerSyncBackendConnector,
+    // This is used to pass in options on connection instead of only during db creation
+    options?: {
+      retryDelayMs?: number;
+      crudUploadThrottleMs?: number;
+    }
+  ): StreamingSyncImplementation {
     const remote = new WebRemote(connector);
 
     const syncOptions: WebStreamingSyncImplementationOptions = {
       ...(this.options as {}),
+      retryDelayMs: options?.retryDelayMs || this.options.retryDelay,
+      crudUploadThrottleMs: options?.crudUploadThrottleMs || this.options.crudUploadThrottleMs,
       flags: this.resolvedFlags,
       adapter: this.bucketStorageAdapter,
       remote,

packages/web/tests/src/db/PowersyncDatabase.test.ts

@@ -0,0 +1,100 @@
+import { describe, it, expect, beforeEach, vi } from 'vitest'
+import { PowerSyncDatabase, SharedWebStreamingSyncImplementation, WebStreamingSyncImplementation } from '../../../src'
+import { SSRStreamingSyncImplementation } from '../../../src/db/sync/SSRWebStreamingSyncImplementation'
+import { testSchema } from '../../utils/testDb'
+
+
+vi.mock('../../../src/db/sync/WebStreamingSyncImplementation')
+vi.mock('../../../src/db/sync/SharedWebStreamingSyncImplementation')
+vi.mock('../../../src/db/sync/SSRWebStreamingSyncImplementation')
+
+describe('PowerSyncDatabase - generateSyncStreamImplementation', () => {
+  const mockConnector = {
+    uploadData: vi.fn(),
+    fetchCredentials: vi.fn()
+  }
+
+  beforeEach(() => {
+    vi.resetAllMocks()
+  })
+
+  it('uses SSRStreamingSyncImplementation when ssrMode is true', async () => {
+    // This is to prevent a false positive from the unhandled rejection
+    // of using SSR in this test.
+    const handler = (event: PromiseRejectionEvent) => {
+      event.preventDefault()
+    }
+    window.addEventListener('unhandledrejection', handler)
+
+    const db = new PowerSyncDatabase({
+      schema: testSchema,
+      database: {
+        dbFilename: 'test.db'
+      },
+      flags: {
+        ssrMode: true,
+      },
+      retryDelay: 1000,
+      crudUploadThrottleMs: 2000
+    })
+
+    db['generateSyncStreamImplementation'](mockConnector)
+    expect(SSRStreamingSyncImplementation).toHaveBeenCalled()
+
+    await setTimeout(() => window.removeEventListener('unhandledrejection', handler), 1)
+  })
+
+  it('uses SharedWebStreamingSyncImplementation when enableMultiTabs is true', () => {
+    const db = new PowerSyncDatabase({
+      schema: testSchema,
+      database: { dbFilename: 'test.db' },
+      flags: { enableMultiTabs: true }
+    })
+    db['generateSyncStreamImplementation'](mockConnector)
+    expect(SharedWebStreamingSyncImplementation).toHaveBeenCalled()
+  })
+
+  it('handles option overrides', () => {
+    const db = new PowerSyncDatabase({
+      schema: testSchema,
+      database: {
+        dbFilename: 'test.db'
+      },
+      flags: {
+        ssrMode: false,
+        enableMultiTabs: false,
+      },
+      crudUploadThrottleMs: 1000
+    })
+
+    db['generateSyncStreamImplementation'](mockConnector, { crudUploadThrottleMs: 20000, retryDelayMs: 50000 })
+    expect(WebStreamingSyncImplementation).toHaveBeenCalledWith(
+      expect.objectContaining({
+        retryDelayMs: 50000,
+        crudUploadThrottleMs: 20000
+      })
+    )
+  })
+
+  it('handles partial option overrides', () => {
+    const db = new PowerSyncDatabase({
+      schema: testSchema,
+      database: {
+        dbFilename: 'test.db'
+      },
+      flags: {
+        ssrMode: false,
+        enableMultiTabs: false,
+      },
+      retryDelay: 1000,
+      crudUploadThrottleMs: 2000
+    })
+
+    db['generateSyncStreamImplementation'](mockConnector, { retryDelayMs: 50000 })
+    expect(WebStreamingSyncImplementation).toHaveBeenCalledWith(
+      expect.objectContaining({
+        retryDelayMs: 50000,
+      })
+    )
+  })
+})