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

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

@@ -1,4 +1,4 @@
-import { AbortOperation, BaseObserver, ConnectionManager, createLogger, SqliteBucketStorage, SyncStatus } from '@powersync/common';
+import { AbortOperation, BaseObserver, ConnectionManager, SqliteBucketStorage, SyncStatus, createLogger } from '@powersync/common';
 import { Mutex } from 'async-mutex';
 import * as Comlink from 'comlink';
 import { WebRemote } from '../../db/sync/WebRemote';
@@ -35,7 +35,6 @@ export class SharedSyncImplementation extends BaseObserver {
     statusListener;
     fetchCredentialsController;
     uploadDataController;
-    dbAdapter;
     syncParams;
     logger;
     lastConnectOptions;
@@ -44,10 +43,10 @@ export class SharedSyncImplementation extends BaseObserver {
     connectionManager;
     syncStatus;
     broadCastLogger;
+    distributedDB;
     constructor() {
         super();
         this.ports = [];
-        this.dbAdapter = null;
         this.syncParams = null;
         this.logger = createLogger('shared-sync');
         this.lastConnectOptions = undefined;
@@ -60,26 +59,23 @@ export class SharedSyncImplementation extends BaseObserver {
                 }
             });
         });
+        // Should be configured once we get params
+        this.distributedDB = null;
         this.syncStatus = new SyncStatus({});
         this.broadCastLogger = new BroadcastLogger(this.ports);
         this.connectionManager = new ConnectionManager({
             createSyncImplementation: async () => {
-                return this.portMutex.runExclusive(async () => {
-                    await this.waitForReady();
-                    if (!this.dbAdapter) {
-                        await this.openInternalDB();
+                await this.waitForReady();
+                const sync = this.generateStreamingImplementation();
+                const onDispose = sync.registerListener({
+                    statusChanged: (status) => {
+                        this.updateAllStatuses(status.toJSON());
                     }
-                    const sync = this.generateStreamingImplementation();
-                    const onDispose = sync.registerListener({
-                        statusChanged: (status) => {
-                            this.updateAllStatuses(status.toJSON());
-                        }
-                    });
-                    return {
-                        sync,
-                        onDispose
-                    };
                 });
+                return {
+                    sync,
+                    onDispose
+                };
             },
             logger: this.logger
         });
@@ -90,6 +86,18 @@ export class SharedSyncImplementation extends BaseObserver {
     get isConnected() {
         return this.connectionManager.syncStreamImplementation?.isConnected ?? false;
     }
+    /**
+     * 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];
+            }
+        }
+        return;
+    }
     async waitForStatus(status) {
         return this.withSyncImplementation(async (sync) => {
             return sync.waitForStatus(status);
@@ -132,10 +140,6 @@ export class SharedSyncImplementation extends BaseObserver {
             this.collectActiveSubscriptions();
             if (this.syncParams) {
                 // Cannot modify already existing sync implementation params
-                // But we can ask for a DB adapter, if required, at this point.
-                if (!this.dbAdapter) {
-                    await this.openInternalDB();
-                }
                 return;
             }
             // First time setting params
@@ -143,13 +147,28 @@ export class SharedSyncImplementation extends BaseObserver {
             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.
+                    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);
             };
-            if (!this.dbAdapter) {
-                await this.openInternalDB();
-            }
             this.iterateListeners((l) => l.initialized?.());
         });
     }
@@ -180,7 +199,9 @@ export class SharedSyncImplementation extends BaseObserver {
                 port,
                 clientProvider: Comlink.wrap(port),
                 currentSubscriptions: [],
-                closeListeners: []
+                closeListeners: [],
+                isProtectedFromClose: false,
+                isClosing: false
             };
             this.ports.push(portProvider);
             // Give the newly connected client the latest status
@@ -196,14 +217,16 @@ export class SharedSyncImplementation extends BaseObserver {
      * clients.
      */
     async removePort(port) {
+        // Ports might be removed faster than we can process them.
+        port.isClosing = true;
         // Remove the port within a mutex context.
         // Warns if the port is not found. This should not happen in practice.
         // We return early if the port is not found.
-        const { trackedPort, shouldReconnect } = await this.portMutex.runExclusive(async () => {
+        return await this.portMutex.runExclusive(async () => {
             const index = this.ports.findIndex((p) => p == port);
             if (index < 0) {
                 this.logger.warn(`Could not remove port ${port} since it is not present in active ports.`);
-                return {};
+                return () => { };
             }
             const trackedPort = this.ports[index];
             // Remove from the list of active ports
@@ -217,35 +240,13 @@ export class SharedSyncImplementation extends BaseObserver {
                     abortController.controller.abort(new AbortOperation('Closing pending requests after client port is removed'));
                 }
             });
-            const shouldReconnect = !!this.connectionManager.syncStreamImplementation && this.ports.length > 0;
-            return {
-                shouldReconnect,
-                trackedPort
-            };
-        });
-        if (!trackedPort) {
-            // We could not find the port to remove
-            return () => { };
-        }
-        for (const closeListener of trackedPort.closeListeners) {
-            await closeListener();
-        }
-        if (this.dbAdapter && this.dbAdapter == trackedPort.db) {
-            // Unconditionally close the connection because the database it's writing to has just been closed.
-            // The connection has been closed previously, this might throw. We should be able to ignore it.
-            await this.connectionManager
-                .disconnect()
-                .catch((ex) => this.logger.warn('Error while disconnecting. Will attempt to reconnect.', ex));
-            // Clearing the adapter will result in a new one being opened in connect
-            this.dbAdapter = null;
-            if (shouldReconnect) {
-                await this.connectionManager.connect(CONNECTOR_PLACEHOLDER, this.lastConnectOptions ?? {});
+            // Close the worker wrapped database connection, we can't accurately rely on this connection
+            for (const closeListener of trackedPort.closeListeners) {
+                await closeListener();
             }
-        }
-        // Re-index subscriptions, the subscriptions of the removed port would no longer be considered.
-        this.collectActiveSubscriptions();
-        // Release proxy
-        return () => trackedPort.clientProvider[Comlink.releaseProxy]();
+            this.collectActiveSubscriptions();
+            return () => trackedPort.clientProvider[Comlink.releaseProxy]();
+        });
     }
     triggerCrudUpload() {
         this.withSyncImplementation(async (sync) => {
@@ -282,10 +283,13 @@ export class SharedSyncImplementation extends BaseObserver {
         const syncParams = this.syncParams;
         // Create a new StreamingSyncImplementation for each connect call. This is usually done is all SDKs.
         return new WebStreamingSyncImplementation({
-            adapter: new SqliteBucketStorage(this.dbAdapter, this.logger),
+            adapter: new SqliteBucketStorage(this.distributedDB, this.logger),
             remote: new WebRemote({
                 invalidateCredentials: async () => {
-                    const lastPort = this.ports[this.ports.length - 1];
+                    const lastPort = this.lastWrappedPort;
+                    if (!lastPort) {
+                        throw new Error('No client port found to invalidate credentials');
+                    }
                     try {
                         this.logger.log('calling the last port client provider to invalidate credentials');
                         lastPort.clientProvider.invalidateCredentials();
@@ -295,7 +299,10 @@ export class SharedSyncImplementation extends BaseObserver {
                     }
                 },
                 fetchCredentials: async () => {
-                    const lastPort = this.ports[this.ports.length - 1];
+                    const lastPort = this.lastWrappedPort;
+                    if (!lastPort) {
+                        throw new Error('No client port found to fetch credentials');
+                    }
                     return new Promise(async (resolve, reject) => {
                         const abortController = new AbortController();
                         this.fetchCredentialsController = {
@@ -317,7 +324,10 @@ export class SharedSyncImplementation extends BaseObserver {
                 }
             }, this.logger),
             uploadCrud: async () => {
-                const lastPort = this.ports[this.ports.length - 1];
+                const lastPort = this.lastWrappedPort;
+                if (!lastPort) {
+                    throw new Error('No client port found to upload crud');
+                }
                 return new Promise(async (resolve, reject) => {
                     const abortController = new AbortController();
                     this.uploadDataController = {
@@ -343,19 +353,47 @@ export class SharedSyncImplementation extends BaseObserver {
             logger: this.logger
         });
     }
+    /**
+     * Opens a worker wrapped database connection. Using the last connected client port.
+     */
     async openInternalDB() {
-        const lastClient = this.ports[this.ports.length - 1];
-        if (!lastClient) {
-            // Should not really happen in practice
-            throw new Error(`Could not open DB connection since no client is connected.`);
-        }
-        const workerPort = await lastClient.clientProvider.getDBWorkerPort();
-        const remote = Comlink.wrap(workerPort);
-        const identifier = this.syncParams.dbParams.dbFilename;
-        const db = await remote(this.syncParams.dbParams);
-        const locked = new LockedAsyncDatabaseAdapter({
-            name: identifier,
-            openConnection: async () => {
+        while (true) {
+            try {
+                const lastClient = this.lastWrappedPort;
+                if (!lastClient) {
+                    // Should not really happen in practice
+                    throw new Error(`Could not open DB connection since no client is connected.`);
+                }
+                /**
+                 * Handle cases where the client might close while opening a connection.
+                 */
+                const abortController = new AbortController();
+                const closeListener = () => {
+                    abortController.abort();
+                };
+                const removeCloseListener = () => {
+                    const index = lastClient.closeListeners.indexOf(closeListener);
+                    if (index >= 0) {
+                        lastClient.closeListeners.splice(index, 1);
+                    }
+                };
+                lastClient.closeListeners.push(closeListener);
+                const workerPort = await withAbort(() => lastClient.clientProvider.getDBWorkerPort(), abortController.signal).catch((ex) => {
+                    removeCloseListener();
+                    throw ex;
+                });
+                const remote = Comlink.wrap(workerPort);
+                const identifier = this.syncParams.dbParams.dbFilename;
+                /**
+                 * The open could fail if the tab is closed while we're busy opening the database.
+                 * This operation is typically executed inside an exclusive portMutex lock.
+                 * We typically execute the closeListeners using the portMutex in a different context.
+                 * We can't rely on the closeListeners to abort the operation if the tab is closed.
+                 */
+                const db = await withAbort(() => remote(this.syncParams.dbParams), abortController.signal).finally(() => {
+                    // We can remove the close listener here since we no longer need it past this point.
+                    removeCloseListener();
+                });
                 const wrapped = new WorkerWrappedAsyncDatabaseConnection({
                     remote,
                     baseConnection: db,
@@ -366,15 +404,21 @@ export class SharedSyncImplementation extends BaseObserver {
                 });
                 lastClient.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.
+                     */
                     wrapped.close().catch((ex) => this.logger.warn('error closing database connection', ex));
                     wrapped.markRemoteClosed();
                 });
                 return wrapped;
-            },
-            logger: this.logger
-        });
-        await locked.init();
-        this.dbAdapter = lastClient.db = locked;
+            }
+            catch (ex) {
+                this.logger.warn('Error opening internal DB', ex);
+                await new Promise((resolve) => setTimeout(resolve, 1000));
+            }
+        }
     }
     /**
      * A method to update the all shared statuses for each
@@ -397,3 +441,26 @@ export class SharedSyncImplementation extends BaseObserver {
         this.updateAllStatuses(status);
     }
 }
+/**
+ * Runs the action with an abort controller.
+ */
+function withAbort(action, signal) {
+    return new Promise((resolve, reject) => {
+        if (signal.aborted) {
+            reject(new AbortOperation('Operation aborted by abort controller'));
+            return;
+        }
+        function handleAbort() {
+            signal.removeEventListener('abort', handleAbort);
+            reject(new AbortOperation('Operation aborted by abort controller'));
+        }
+        signal.addEventListener('abort', handleAbort, { once: true });
+        function completePromise(action) {
+            signal.removeEventListener('abort', handleAbort);
+            action();
+        }
+        action()
+            .then((data) => completePromise(() => resolve(data)))
+            .catch((e) => completePromise(() => reject(e)));
+    });
+}

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

@@ -1,5 +1,5 @@
-import { SharedSyncImplementation, SharedSyncInitOptions } from './SharedSyncImplementation';
 import { ILogLevel, PowerSyncConnectionOptions, SubscribedStream, SyncStatusOptions } from '@powersync/common';
+import { SharedSyncImplementation, SharedSyncInitOptions, WrappedSyncPort } from './SharedSyncImplementation';
 /**
  * A client to the shared sync worker.
  *
@@ -10,6 +10,7 @@ export declare class WorkerClient {
     private readonly sync;
     private readonly port;
     private resolvedPort;
+    protected resolvedPortPromise: Promise<WrappedSyncPort> | null;
     constructor(sync: SharedSyncImplementation, port: MessagePort);
     initialize(): Promise<void>;
     private removePort;
@@ -19,7 +20,7 @@ export declare class WorkerClient {
      * When the client tab is closed, its lock will be returned. So when the shared worker attempts to acquire the lock,
      * it can consider the connection to be closed.
      */
-    addLockBasedCloseSignal(name: string): void;
+    addLockBasedCloseSignal(name: string): Promise<void>;
     setLogLevel(level: ILogLevel): void;
     triggerCrudUpload(): void;
     setParams(params: SharedSyncInitOptions, subscriptions: SubscribedStream[]): Promise<void>;

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

@@ -1,6 +1,6 @@
 import * as Comlink from 'comlink';
-import { SharedSyncClientEvent } from './SharedSyncImplementation';
 import { getNavigatorLocks } from '../../shared/navigator';
+import { SharedSyncClientEvent } from './SharedSyncImplementation';
 /**
  * A client to the shared sync worker.
  *
@@ -11,9 +11,11 @@ export class WorkerClient {
     sync;
     port;
     resolvedPort = null;
+    resolvedPortPromise = null;
     constructor(sync, port) {
         this.sync = sync;
         this.port = port;
+        Comlink.expose(this, this.port);
     }
     async initialize() {
         /**
@@ -26,8 +28,15 @@ export class WorkerClient {
                 await this.removePort();
             }
         });
-        this.resolvedPort = await this.sync.addPort(this.port);
-        Comlink.expose(this, this.port);
+        /**
+         * 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) {
@@ -48,7 +57,20 @@ export class WorkerClient {
      * When the client tab is closed, its lock will be returned. So when the shared worker attempts to acquire the lock,
      * it can consider the connection to be closed.
      */
-    addLockBasedCloseSignal(name) {
+    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;
+        }
         getNavigatorLocks().request(name, async () => {
             await this.removePort();
         });