@powersync/web 0.0.0-dev-20251129133952 → 0.0.0-dev-20251201150812

package/lib/src/worker/sync/SharedSyncImplementation.js

@@ -89,14 +89,25 @@ export class SharedSyncImplementation extends BaseObserver {
     /**
      * Gets the last client port which we know is safe from unexpected closes.
      */
-    get lastWrappedPort() {
-        // Find the last port which is protected from close
-        for (let i = this.ports.length - 1; i >= 0; i--) {
-            if (this.ports[i].isProtectedFromClose && !this.ports[i].isClosing) {
-                return this.ports[i];
+    async getLastWrappedPort() {
+        // Find the last port which is not closing
+        return await this.portMutex.runExclusive(() => {
+            for (let i = this.ports.length - 1; i >= 0; i--) {
+                if (!this.ports[i].isClosing) {
+                    return this.ports[i];
+                }
             }
-        }
-        return;
+            return;
+        });
+    }
+    /**
+     * In some very rare cases a specific tab might not respond to requests.
+     * This returns a random port which is not closing.
+     */
+    async getRandomWrappedPort() {
+        return await this.portMutex.runExclusive(() => {
+            return this.ports[Math.floor(Math.random() * this.ports.length)];
+        });
     }
     async waitForStatus(status) {
         return this.withSyncImplementation(async (sync) => {
@@ -138,39 +149,45 @@ export class SharedSyncImplementation extends BaseObserver {
     async setParams(params) {
         await this.portMutex.runExclusive(async () => {
             this.collectActiveSubscriptions();
-            if (this.syncParams) {
-                // Cannot modify already existing sync implementation params
-                return;
-            }
-            // First time setting params
-            this.syncParams = params;
-            if (params.streamOptions?.flags?.broadcastLogs) {
-                this.logger = this.broadCastLogger;
+        });
+        if (this.syncParams) {
+            // Cannot modify already existing sync implementation params
+            return;
+        }
+        // First time setting params
+        this.syncParams = params;
+        if (params.streamOptions?.flags?.broadcastLogs) {
+            this.logger = this.broadCastLogger;
+        }
+        const lockedAdapter = new LockedAsyncDatabaseAdapter({
+            name: params.dbParams.dbFilename,
+            openConnection: async () => {
+                // Gets a connection from the clients when a new connection is requested.
+                const db = await this.openInternalDB();
+                db.registerListener({
+                    closing: () => {
+                        lockedAdapter.reOpenInternalDB();
+                    }
+                });
+                return db;
+            },
+            logger: this.logger,
+            reOpenOnConnectionClosed: true
+        });
+        this.distributedDB = lockedAdapter;
+        await lockedAdapter.init();
+        lockedAdapter.registerListener({
+            databaseReOpened: () => {
+                // We may have missed some table updates while the database was closed.
+                // We can poke the crud in case we missed any updates.
+                this.connectionManager.syncStreamImplementation?.triggerCrudUpload();
             }
-            const lockedAdapter = new LockedAsyncDatabaseAdapter({
-                name: params.dbParams.dbFilename,
-                openConnection: async () => {
-                    // Gets a connection from the clients when a new connection is requested.
-                    return await this.openInternalDB();
-                },
-                logger: this.logger,
-                reOpenOnConnectionClosed: true
-            });
-            this.distributedDB = lockedAdapter;
-            await lockedAdapter.init();
-            lockedAdapter.registerListener({
-                databaseReOpened: () => {
-                    // We may have missed some table updates while the database was closed.
-                    // We can poke the crud in case we missed any updates.
-                    this.connectionManager.syncStreamImplementation?.triggerCrudUpload();
-                }
-            });
-            self.onerror = (event) => {
-                // Share any uncaught events on the broadcast logger
-                this.logger.error('Uncaught exception in PowerSync shared sync worker', event);
-            };
-            this.iterateListeners((l) => l.initialized?.());
         });
+        self.onerror = (event) => {
+            // Share any uncaught events on the broadcast logger
+            this.logger.error('Uncaught exception in PowerSync shared sync worker', event);
+        };
+        this.iterateListeners((l) => l.initialized?.());
     }
     async dispose() {
         await this.waitForReady();
@@ -200,7 +217,6 @@ export class SharedSyncImplementation extends BaseObserver {
                 clientProvider: Comlink.wrap(port),
                 currentSubscriptions: [],
                 closeListeners: [],
-                isProtectedFromClose: false,
                 isClosing: false
             };
             this.ports.push(portProvider);
@@ -286,7 +302,7 @@ export class SharedSyncImplementation extends BaseObserver {
             adapter: new SqliteBucketStorage(this.distributedDB, this.logger),
             remote: new WebRemote({
                 invalidateCredentials: async () => {
-                    const lastPort = this.lastWrappedPort;
+                    const lastPort = await this.getLastWrappedPort();
                     if (!lastPort) {
                         throw new Error('No client port found to invalidate credentials');
                     }
@@ -299,7 +315,7 @@ export class SharedSyncImplementation extends BaseObserver {
                     }
                 },
                 fetchCredentials: async () => {
-                    const lastPort = this.lastWrappedPort;
+                    const lastPort = await this.getLastWrappedPort();
                     if (!lastPort) {
                         throw new Error('No client port found to fetch credentials');
                     }
@@ -324,7 +340,7 @@ export class SharedSyncImplementation extends BaseObserver {
                 }
             }, this.logger),
             uploadCrud: async () => {
-                const lastPort = this.lastWrappedPort;
+                const lastPort = await this.getLastWrappedPort();
                 if (!lastPort) {
                     throw new Error('No client port found to upload crud');
                 }
@@ -359,11 +375,15 @@ export class SharedSyncImplementation extends BaseObserver {
     async openInternalDB() {
         while (true) {
             try {
-                const lastClient = this.lastWrappedPort;
-                if (!lastClient) {
+                const client = await this.getRandomWrappedPort();
+                if (!client) {
                     // Should not really happen in practice
                     throw new Error(`Could not open DB connection since no client is connected.`);
                 }
+                // Fail-safe timeout for opening a database connection.
+                const timeout = setTimeout(() => {
+                    abortController.abort();
+                }, 10_000);
                 /**
                  * Handle cases where the client might close while opening a connection.
                  */
@@ -372,13 +392,13 @@ export class SharedSyncImplementation extends BaseObserver {
                     abortController.abort();
                 };
                 const removeCloseListener = () => {
-                    const index = lastClient.closeListeners.indexOf(closeListener);
+                    const index = client.closeListeners.indexOf(closeListener);
                     if (index >= 0) {
-                        lastClient.closeListeners.splice(index, 1);
+                        client.closeListeners.splice(index, 1);
                     }
                 };
-                lastClient.closeListeners.push(closeListener);
-                const workerPort = await withAbort(() => lastClient.clientProvider.getDBWorkerPort(), abortController.signal).catch((ex) => {
+                client.closeListeners.push(closeListener);
+                const workerPort = await withAbort(() => client.clientProvider.getDBWorkerPort(), abortController.signal).catch((ex) => {
                     removeCloseListener();
                     throw ex;
                 });
@@ -394,6 +414,7 @@ export class SharedSyncImplementation extends BaseObserver {
                     // We can remove the close listener here since we no longer need it past this point.
                     removeCloseListener();
                 });
+                clearTimeout(timeout);
                 const wrapped = new WorkerWrappedAsyncDatabaseConnection({
                     remote,
                     baseConnection: db,
@@ -402,15 +423,15 @@ export class SharedSyncImplementation extends BaseObserver {
                     // that and ensure pending requests are aborted when the tab is closed.
                     remoteCanCloseUnexpectedly: true
                 });
-                lastClient.closeListeners.push(async () => {
+                client.closeListeners.push(async () => {
                     this.logger.info('Aborting open connection because associated tab closed.');
                     /**
                      * Don't await this close operation. It might never resolve if the tab is closed.
-                     * We run the close operation first, before marking the remote as closed. This gives the database some chance
-                     * to close the connection.
+                     * We mark the remote as closed first, this will reject any pending requests.
+                     * We then call close. The close operation is configured to fire-and-forget, the main promise will reject immediately.
                      */
-                    wrapped.close().catch((ex) => this.logger.warn('error closing database connection', ex));
                     wrapped.markRemoteClosed();
+                    wrapped.close().catch((ex) => this.logger.warn('error closing database connection', ex));
                 });
                 return wrapped;
             }
@@ -428,18 +449,6 @@ export class SharedSyncImplementation extends BaseObserver {
         this.syncStatus = new SyncStatus(status);
         this.ports.forEach((p) => p.clientProvider.statusChanged(status));
     }
-    /**
-     * A function only used for unit tests which updates the internal
-     * sync stream client and all tab client's sync status
-     */
-    async _testUpdateAllStatuses(status) {
-        if (!this.connectionManager.syncStreamImplementation) {
-            throw new Error('Cannot update status without a sync stream implementation');
-        }
-        // Only assigning, don't call listeners for this test
-        this.connectionManager.syncStreamImplementation.syncStatus = new SyncStatus(status);
-        this.updateAllStatuses(status);
-    }
 }
 /**
  * Runs the action with an abort controller.

package/lib/src/worker/sync/SharedSyncImplementation.worker.js

@@ -7,5 +7,5 @@ logger.useDefaults();
 const sharedSyncImplementation = new SharedSyncImplementation();
 _self.onconnect = async function (event) {
     const port = event.ports[0];
-    await new WorkerClient(sharedSyncImplementation, port).initialize();
+    new WorkerClient(sharedSyncImplementation, port);
 };

package/lib/src/worker/sync/WorkerClient.d.ts

@@ -1,4 +1,4 @@
-import { ILogLevel, PowerSyncConnectionOptions, SubscribedStream, SyncStatusOptions } from '@powersync/common';
+import { ILogLevel, PowerSyncConnectionOptions, SubscribedStream } from '@powersync/common';
 import { SharedSyncImplementation, SharedSyncInitOptions, WrappedSyncPort } from './SharedSyncImplementation';
 /**
  * A client to the shared sync worker.
@@ -12,7 +12,6 @@ export declare class WorkerClient {
     private resolvedPort;
     protected resolvedPortPromise: Promise<WrappedSyncPort> | null;
     constructor(sync: SharedSyncImplementation, port: MessagePort);
-    initialize(): Promise<void>;
     private removePort;
     /**
      * Called by a client after obtaining a lock with a random name.
@@ -29,5 +28,4 @@ export declare class WorkerClient {
     connect(options?: PowerSyncConnectionOptions): Promise<void>;
     updateSubscriptions(subscriptions: SubscribedStream[]): void;
     disconnect(): Promise<void>;
-    _testUpdateAllStatuses(status: SyncStatusOptions): Promise<void>;
 }

package/lib/src/worker/sync/WorkerClient.js

@@ -16,8 +16,6 @@ export class WorkerClient {
         this.sync = sync;
         this.port = port;
         Comlink.expose(this, this.port);
-    }
-    async initialize() {
         /**
          * Adds an extra listener which can remove this port
          * from the list of monitored ports.
@@ -28,15 +26,6 @@ export class WorkerClient {
                 await this.removePort();
             }
         });
-        /**
-         * Keep a reference to the resolved port promise.
-         * The init timing is difficult to predict due to the async message passing.
-         * We only want to use a port if we are know it's been protected from being closed.
-         * The lock based close signal will be added asynchronously. We need to use the
-         * added port once the lock is configured.
-         */
-        this.resolvedPortPromise = this.sync.addPort(this.port);
-        this.resolvedPort = await this.resolvedPortPromise;
     }
     async removePort() {
         if (this.resolvedPort) {
@@ -58,19 +47,9 @@ export class WorkerClient {
      * it can consider the connection to be closed.
      */
     async addLockBasedCloseSignal(name) {
-        if (!this.resolvedPortPromise) {
-            // The init logic above is actually synchronous, so this should not happen.
-            this.sync.broadCastLogger.warn('addLockBasedCloseSignal called before port promise registered');
-        }
-        else {
-            const wrappedPort = await this.resolvedPortPromise;
-            /**
-             * The client registered a navigator lock. We now can guarantee detecting if the client has closed.
-             * E.g. before this point: It's possible some ports might have been created and closed before the
-             * lock based close signal is added. We should not trust those ports.
-             */
-            wrappedPort.isProtectedFromClose = true;
-        }
+        // Only add the port once the lock has been obtained on the client.
+        this.resolvedPort = await this.sync.addPort(this.port);
+        // Don't await this lock request
         getNavigatorLocks().request(name, async () => {
             await this.removePort();
         });
@@ -102,7 +81,4 @@ export class WorkerClient {
     disconnect() {
         return this.sync.disconnect();
     }
-    async _testUpdateAllStatuses(status) {
-        return this.sync._testUpdateAllStatuses(status);
-    }
 }