@powersync/lib-service-postgres 0.0.0-dev-20250116115804

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# @powersync/lib-service-postgres
+
+## 0.0.0-dev-20250116115804
+
+### Minor Changes
+
+- b07189d: Allow limiting IP ranges of outgoing connections
+
+### Patch Changes
+
+- Updated dependencies [b07189d]
+- Updated dependencies [b07189d]
+- Updated dependencies [b07189d]
+  - @powersync/service-types@0.0.0-dev-20250116115804
+  - @powersync/lib-services-framework@0.0.0-dev-20250116115804
+  - @powersync/service-jpgwire@0.0.0-dev-20250116115804
+
+## 0.1.0
+
+### Minor Changes
+
+- 9d9ff08: Initial release of Postgres bucket storage.
+
+### Patch Changes
+
+- Updated dependencies [9d9ff08]
+  - @powersync/lib-services-framework@0.4.0

package/LICENSE

@@ -0,0 +1,67 @@
+# Functional Source License, Version 1.1, Apache 2.0 Future License
+
+## Abbreviation
+
+FSL-1.1-Apache-2.0
+
+## Notice
+
+Copyright 2023-2024 Journey Mobile, Inc.
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under these Terms and Conditions, as indicated by our inclusion of these Terms and Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents, Redistribution and Trademark clauses below, we hereby grant you the right to use, copy, modify, create derivative works, publicly perform, publicly display and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use means making the Software available to others in a commercial product or service that:
+
+1. substitutes for the Software;
+2. substitutes for any other product or service we offer using the Software that exists as of the date we make the Software available; or
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+2. for non-commercial education;
+3. for non-commercial research; and
+4. in connection with professional services that you provide to a licensee using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our patents, the license grant above includes a license under our patents. If you make a claim against any party that the Software infringes or contributes to the infringement of any patent, then your patent license to the Software ends immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of the Software.
+If you redistribute any copies, modifications or derivatives of the Software, you must include a copy of or a link to these Terms and Conditions and not remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of the Software, you have no right under these Terms and Conditions to use our trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under the Apache License, Version 2.0 that is effective on the second anniversary of the date we make the Software available. On or after that date, you may use the Software under the Apache License, Version 2.0, in which case the following will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

package/README.md

@@ -0,0 +1,3 @@
+# PowerSync Service Postgres
+
+Library for common Postgres logic used in the PowerSync service.

package/dist/db/connection/AbstractPostgresConnection.d.ts

@@ -0,0 +1,29 @@
+import * as framework from '@powersync/lib-services-framework';
+import * as pgwire from '@powersync/service-jpgwire';
+import * as t from 'ts-codec';
+export type DecodedSQLQueryExecutor<T extends t.Codec<any, any>> = {
+    first: () => Promise<t.Decoded<T> | null>;
+    rows: () => Promise<t.Decoded<T>[]>;
+};
+export declare abstract class AbstractPostgresConnection<Listener extends framework.DisposableListener = framework.DisposableListener> extends framework.DisposableObserver<Listener> {
+    protected abstract baseConnection: pgwire.PgClient;
+    stream(...args: pgwire.Statement[]): AsyncIterableIterator<pgwire.PgChunk>;
+    query(script: string, options?: pgwire.PgSimpleQueryOptions): Promise<pgwire.PgResult>;
+    query(...args: pgwire.Statement[]): Promise<pgwire.PgResult>;
+    /**
+     * Template string helper which can be used to execute template SQL strings.
+     */
+    sql(strings: TemplateStringsArray, ...params: pgwire.StatementParam[]): {
+        execute: () => Promise<pgwire.PgResult>;
+        rows: <T>() => Promise<T[]>;
+        first: <T>() => Promise<T | null>;
+        decoded: <T extends t.Codec<any, any>>(codec: T) => DecodedSQLQueryExecutor<T>;
+    };
+    queryRows<T>(script: string, options?: pgwire.PgSimpleQueryOptions): Promise<T[]>;
+    queryRows<T>(...args: pgwire.Statement[] | [...pgwire.Statement[], pgwire.PgExtendedQueryOptions]): Promise<T[]>;
+    streamRows<T>(...args: pgwire.Statement[]): AsyncIterableIterator<T[]>;
+}
+/**
+ * Template string helper function which generates PGWire statements.
+ */
+export declare const sql: (strings: TemplateStringsArray, ...params: pgwire.StatementParam[]) => pgwire.Statement;

package/dist/db/connection/AbstractPostgresConnection.js

@@ -0,0 +1,82 @@
+import * as framework from '@powersync/lib-services-framework';
+import * as pgwire from '@powersync/service-jpgwire';
+export class AbstractPostgresConnection extends framework.DisposableObserver {
+    stream(...args) {
+        return this.baseConnection.stream(...args);
+    }
+    query(...args) {
+        return this.baseConnection.query(...args);
+    }
+    /**
+     * Template string helper which can be used to execute template SQL strings.
+     */
+    sql(strings, ...params) {
+        const { statement, params: queryParams } = sql(strings, ...params);
+        const rows = () => this.queryRows({
+            statement,
+            params: queryParams
+        });
+        const first = async () => {
+            const [f] = await rows();
+            return f;
+        };
+        return {
+            execute: () => this.query({
+                statement,
+                params
+            }),
+            rows,
+            first,
+            decoded: (codec) => {
+                return {
+                    first: async () => {
+                        const result = await first();
+                        return result && codec.decode(result);
+                    },
+                    rows: async () => {
+                        const results = await rows();
+                        return results.map((r) => {
+                            return codec.decode(r);
+                        });
+                    }
+                };
+            }
+        };
+    }
+    async queryRows(...args) {
+        return pgwire.pgwireRows(await this.query(...args));
+    }
+    async *streamRows(...args) {
+        let columns = [];
+        for await (const chunk of this.stream(...args)) {
+            if (chunk.tag == 'RowDescription') {
+                columns = chunk.payload.map((c, index) => {
+                    return c.name;
+                });
+                continue;
+            }
+            if (!chunk.rows.length) {
+                continue;
+            }
+            yield chunk.rows.map((row) => {
+                let q = {};
+                for (const [index, c] of columns.entries()) {
+                    q[c] = row[index];
+                }
+                return q;
+            });
+        }
+    }
+}
+/**
+ * Template string helper function which generates PGWire statements.
+ */
+export const sql = (strings, ...params) => {
+    const paramPlaceholders = new Array(params.length).fill('').map((value, index) => `$${index + 1}`);
+    const joinedQueryStatement = strings.map((query, index) => `${query} ${paramPlaceholders[index] ?? ''}`).join(' ');
+    return {
+        statement: joinedQueryStatement,
+        params
+    };
+};
+//# sourceMappingURL=AbstractPostgresConnection.js.map

package/dist/db/connection/AbstractPostgresConnection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractPostgresConnection.js","sourceRoot":"","sources":["../../../src/db/connection/AbstractPostgresConnection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,mCAAmC,CAAC;AAC/D,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AAQrD,MAAM,OAAgB,0BAEpB,SAAQ,SAAS,CAAC,kBAA4B;IAG9C,MAAM,CAAC,GAAG,IAAwB;QAChC,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC7C,CAAC;IAID,KAAK,CAAC,GAAG,IAAW;QAClB,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,OAA6B,EAAE,GAAG,MAA+B;QACnE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,CAAC;QAEnE,MAAM,IAAI,GAAG,GAAoB,EAAE,CACjC,IAAI,CAAC,SAAS,CAAC;YACb,SAAS;YACT,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;QAEL,MAAM,KAAK,GAAG,KAAK,IAA0B,EAAE;YAC7C,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,EAAK,CAAC;YAC5B,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;QAEF,OAAO;YACL,OAAO,EAAE,GAAG,EAAE,CACZ,IAAI,CAAC,KAAK,CAAC;gBACT,SAAS;gBACT,MAAM;aACP,CAAC;YACJ,IAAI;YACJ,KAAK;YACL,OAAO,EAAE,CAA8B,KAAQ,EAA8B,EAAE;gBAC7E,OAAO;oBACL,KAAK,EAAE,KAAK,IAAI,EAAE;wBAChB,MAAM,MAAM,GAAG,MAAM,KAAK,EAAE,CAAC;wBAC7B,OAAO,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBACxC,CAAC;oBACD,IAAI,EAAE,KAAK,IAAI,EAAE;wBACf,MAAM,OAAO,GAAG,MAAM,IAAI,EAAE,CAAC;wBAC7B,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;4BACvB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;wBACzB,CAAC,CAAC,CAAC;oBACL,CAAC;iBACF,CAAC;YACJ,CAAC;SACF,CAAC;IACJ,CAAC;IAID,KAAK,CAAC,SAAS,CAAC,GAAG,IAAW;QAC5B,OAAO,MAAM,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,CAAC,UAAU,CAAI,GAAG,IAAwB;QAC9C,IAAI,OAAO,GAAmB,EAAE,CAAC;QAEjC,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;YAC/C,IAAI,KAAK,CAAC,GAAG,IAAI,gBAAgB,EAAE,CAAC;gBAClC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;oBACvC,OAAO,CAAC,CAAC,IAAe,CAAC;gBAC3B,CAAC,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YAED,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvB,SAAS;YACX,CAAC;YAED,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC3B,IAAI,CAAC,GAAe,EAAE,CAAC;gBACvB,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC3C,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;gBACpB,CAAC;gBACD,OAAO,CAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,OAA6B,EAAE,GAAG,MAA+B,EAAoB,EAAE;IACzG,MAAM,iBAAiB,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC;IACnG,MAAM,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,iBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnH,OAAO;QACL,SAAS,EAAE,oBAAoB;QAC/B,MAAM;KACP,CAAC;AACJ,CAAC,CAAC"}

package/dist/db/connection/ConnectionSlot.d.ts

@@ -0,0 +1,41 @@
+import * as framework from '@powersync/lib-services-framework';
+import * as pgwire from '@powersync/service-jpgwire';
+export interface NotificationListener extends framework.DisposableListener {
+    notification?: (payload: pgwire.PgNotification) => void;
+}
+export interface ConnectionSlotListener extends NotificationListener {
+    connectionAvailable?: () => void;
+    connectionError?: (exception: any) => void;
+    connectionCreated?: (connection: pgwire.PgConnection) => Promise<void>;
+}
+export type ConnectionLease = {
+    connection: pgwire.PgConnection;
+    release: () => void;
+};
+export type ConnectionSlotOptions = {
+    config: pgwire.NormalizedConnectionConfig;
+    notificationChannels?: string[];
+};
+export declare const MAX_CONNECTION_ATTEMPTS = 5;
+export declare class ConnectionSlot extends framework.DisposableObserver<ConnectionSlotListener> {
+    protected options: ConnectionSlotOptions;
+    isAvailable: boolean;
+    isPoking: boolean;
+    closed: boolean;
+    protected connection: pgwire.PgConnection | null;
+    protected connectingPromise: Promise<pgwire.PgConnection> | null;
+    constructor(options: ConnectionSlotOptions);
+    get isConnected(): boolean;
+    protected connect(): Promise<pgwire.PgConnection>;
+    [Symbol.asyncDispose](): Promise<void>;
+    protected configureConnectionNotifications(connection: pgwire.PgConnection): Promise<void>;
+    registerListener(listener: Partial<ConnectionSlotListener>): () => void;
+    protected handleNotification: (payload: pgwire.PgNotification) => void;
+    protected hasNotificationListener(): boolean;
+    /**
+     * Test the connection if it can be reached.
+     */
+    poke(): Promise<void>;
+    protected setAvailable(): void;
+    lock(): ConnectionLease | null;
+}

package/dist/db/connection/ConnectionSlot.js

@@ -0,0 +1,122 @@
+import * as framework from '@powersync/lib-services-framework';
+import * as pgwire from '@powersync/service-jpgwire';
+export const MAX_CONNECTION_ATTEMPTS = 5;
+export class ConnectionSlot extends framework.DisposableObserver {
+    constructor(options) {
+        super();
+        this.options = options;
+        this.handleNotification = (payload) => {
+            if (!this.options.notificationChannels?.includes(payload.channel)) {
+                return;
+            }
+            this.iterateListeners((l) => l.notification?.(payload));
+        };
+        this.isAvailable = false;
+        this.connection = null;
+        this.isPoking = false;
+        this.connectingPromise = null;
+        this.closed = false;
+    }
+    get isConnected() {
+        return !!this.connection;
+    }
+    async connect() {
+        this.connectingPromise = pgwire.connectPgWire(this.options.config, { type: 'standard' });
+        const connection = await this.connectingPromise;
+        this.connectingPromise = null;
+        await this.iterateAsyncListeners(async (l) => l.connectionCreated?.(connection));
+        if (this.hasNotificationListener()) {
+            await this.configureConnectionNotifications(connection);
+        }
+        return connection;
+    }
+    async [Symbol.asyncDispose]() {
+        this.closed = true;
+        const connection = this.connection ?? (await this.connectingPromise);
+        await connection?.end();
+        return super[Symbol.dispose]();
+    }
+    async configureConnectionNotifications(connection) {
+        if (connection.onnotification == this.handleNotification || this.closed == true) {
+            // Already configured
+            return;
+        }
+        connection.onnotification = this.handleNotification;
+        for (const channelName of this.options.notificationChannels ?? []) {
+            await connection.query({
+                statement: `LISTEN ${channelName}`
+            });
+        }
+    }
+    registerListener(listener) {
+        const dispose = super.registerListener(listener);
+        if (this.connection && this.hasNotificationListener()) {
+            this.configureConnectionNotifications(this.connection);
+        }
+        return () => {
+            dispose();
+            if (this.connection && !this.hasNotificationListener()) {
+                this.connection.onnotification = () => { };
+            }
+        };
+    }
+    hasNotificationListener() {
+        return !!Object.values(this.listeners).find((l) => !!l.notification);
+    }
+    /**
+     * Test the connection if it can be reached.
+     */
+    async poke() {
+        if (this.isPoking || (this.isConnected && this.isAvailable == false) || this.closed) {
+            return;
+        }
+        this.isPoking = true;
+        for (let retryCounter = 0; retryCounter <= MAX_CONNECTION_ATTEMPTS; retryCounter++) {
+            try {
+                const connection = this.connection ?? (await this.connect());
+                await connection.query({
+                    statement: 'SELECT 1'
+                });
+                if (!this.connection) {
+                    this.connection = connection;
+                    this.setAvailable();
+                }
+                else if (this.isAvailable) {
+                    this.iterateListeners((cb) => cb.connectionAvailable?.());
+                }
+                // Connection is alive and healthy
+                break;
+            }
+            catch (ex) {
+                // Should be valid for all cases
+                this.isAvailable = false;
+                if (this.connection) {
+                    this.connection.onnotification = () => { };
+                    this.connection.destroy();
+                    this.connection = null;
+                }
+                if (retryCounter >= MAX_CONNECTION_ATTEMPTS) {
+                    this.iterateListeners((cb) => cb.connectionError?.(ex));
+                }
+            }
+        }
+        this.isPoking = false;
+    }
+    setAvailable() {
+        this.isAvailable = true;
+        this.iterateListeners((l) => l.connectionAvailable?.());
+    }
+    lock() {
+        if (!this.isAvailable || !this.connection || this.closed) {
+            return null;
+        }
+        this.isAvailable = false;
+        return {
+            connection: this.connection,
+            release: () => {
+                this.setAvailable();
+            }
+        };
+    }
+}
+//# sourceMappingURL=ConnectionSlot.js.map

package/dist/db/connection/ConnectionSlot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectionSlot.js","sourceRoot":"","sources":["../../../src/db/connection/ConnectionSlot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,mCAAmC,CAAC;AAC/D,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AAsBrD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC;AAEzC,MAAM,OAAO,cAAe,SAAQ,SAAS,CAAC,kBAA0C;IAStF,YAAsB,OAA8B;QAClD,KAAK,EAAE,CAAC;QADY,YAAO,GAAP,OAAO,CAAuB;QA2D1C,uBAAkB,GAAG,CAAC,OAA8B,EAAE,EAAE;YAChE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBAClE,OAAO;YACT,CAAC;YACD,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1D,CAAC,CAAC;QA9DA,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAES,KAAK,CAAC,OAAO;QACrB,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;QACzF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC;QAChD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;QACjF,IAAI,IAAI,CAAC,uBAAuB,EAAE,EAAE,CAAC;YACnC,MAAM,IAAI,CAAC,gCAAgC,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACrE,MAAM,UAAU,EAAE,GAAG,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACjC,CAAC;IAES,KAAK,CAAC,gCAAgC,CAAC,UAA+B;QAC9E,IAAI,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YAChF,qBAAqB;YACrB,OAAO;QACT,CAAC;QAED,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAEpD,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,oBAAoB,IAAI,EAAE,EAAE,CAAC;YAClE,MAAM,UAAU,CAAC,KAAK,CAAC;gBACrB,SAAS,EAAE,UAAU,WAAW,EAAE;aACnC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,gBAAgB,CAAC,QAAyC;QACxD,MAAM,OAAO,GAAG,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,uBAAuB,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,GAAG,EAAE;YACV,OAAO,EAAE,CAAC;YACV,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,CAAC;gBACvD,IAAI,CAAC,UAAU,CAAC,cAAc,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IASS,uBAAuB;QAC/B,OAAO,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACpF,OAAO;QACT,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,KAAK,IAAI,YAAY,GAAG,CAAC,EAAE,YAAY,IAAI,uBAAuB,EAAE,YAAY,EAAE,EAAE,CAAC;YACnF,IAAI,CAAC;gBACH,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBAE7D,MAAM,UAAU,CAAC,KAAK,CAAC;oBACrB,SAAS,EAAE,UAAU;iBACtB,CAAC,CAAC;gBAEH,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;oBACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;oBAC7B,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,CAAC;qBAAM,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC5B,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;gBAC5D,CAAC;gBAED,kCAAkC;gBAClC,MAAM;YACR,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACZ,gCAAgC;gBAChC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;gBACzB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;oBACpB,IAAI,CAAC,UAAU,CAAC,cAAc,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;oBAC1C,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;oBAC1B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;gBACzB,CAAC;gBACD,IAAI,YAAY,IAAI,uBAAuB,EAAE,CAAC;oBAC5C,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC1D,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAES,YAAY;QACpB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACzD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAEzB,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,OAAO,EAAE,GAAG,EAAE;gBACZ,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,CAAC;SACF,CAAC;IACJ,CAAC;CACF"}

package/dist/db/connection/DatabaseClient.d.ts

@@ -0,0 +1,62 @@
+import * as lib_postgres from '@powersync/lib-service-postgres';
+import * as pgwire from '@powersync/service-jpgwire';
+import { DeferredPromise } from 'p-defer';
+import { AbstractPostgresConnection } from './AbstractPostgresConnection.js';
+import { ConnectionLease, ConnectionSlot, NotificationListener } from './ConnectionSlot.js';
+import { WrappedConnection } from './WrappedConnection.js';
+export type DatabaseClientOptions = {
+    config: lib_postgres.NormalizedBasePostgresConnectionConfig;
+    /**
+     * Optional schema which will be used as the default search path
+     */
+    schema?: string;
+    /**
+     * Notification channels to listen to.
+     */
+    notificationChannels?: string[];
+};
+export type DatabaseClientListener = NotificationListener & {
+    connectionCreated?: (connection: pgwire.PgConnection) => Promise<void>;
+};
+export declare const TRANSACTION_CONNECTION_COUNT = 5;
+/**
+ * This provides access to Postgres via the PGWire library.
+ * A connection pool is used for individual query executions while
+ * a custom pool of connections is available for transactions or other operations
+ * which require being executed on the same connection.
+ */
+export declare class DatabaseClient extends AbstractPostgresConnection<DatabaseClientListener> {
+    protected options: DatabaseClientOptions;
+    closed: boolean;
+    protected pool: pgwire.PgClient;
+    protected connections: ConnectionSlot[];
+    protected initialized: Promise<void>;
+    protected queue: DeferredPromise<ConnectionLease>[];
+    constructor(options: DatabaseClientOptions);
+    protected get baseConnection(): pgwire.PgClient;
+    protected get schemaStatement(): {
+        statement: string;
+    } | undefined;
+    registerListener(listener: Partial<DatabaseClientListener>): () => void;
+    query(script: string, options?: pgwire.PgSimpleQueryOptions): Promise<pgwire.PgResult>;
+    query(...args: pgwire.Statement[]): Promise<pgwire.PgResult>;
+    stream(...args: pgwire.Statement[]): AsyncIterableIterator<pgwire.PgChunk>;
+    lockConnection<T>(callback: (db: WrappedConnection) => Promise<T>): Promise<T>;
+    transaction<T>(tx: (db: WrappedConnection) => Promise<T>): Promise<T>;
+    /**
+     * Use the `powersync` schema as the default when resolving table names
+     */
+    protected setSchema(client: pgwire.PgClient): Promise<void>;
+    protected initialize(): Promise<void>;
+    protected requestConnection(): Promise<ConnectionLease>;
+    protected pokeSlots(): void;
+    protected leaseConnectionSlot(): ConnectionLease | null;
+    protected processConnectionQueue(): void;
+    /**
+     * Reports connection errors which might occur from bad configuration or
+     * a server which is no longer available.
+     * This fails all pending requests.
+     */
+    protected handleConnectionError(exception: any): void;
+    [Symbol.asyncDispose](): Promise<void>;
+}

package/dist/db/connection/DatabaseClient.js

@@ -0,0 +1,209 @@
+import * as lib_postgres from '@powersync/lib-service-postgres';
+import * as pgwire from '@powersync/service-jpgwire';
+import pDefer from 'p-defer';
+import { AbstractPostgresConnection, sql } from './AbstractPostgresConnection.js';
+import { ConnectionSlot } from './ConnectionSlot.js';
+import { WrappedConnection } from './WrappedConnection.js';
+export const TRANSACTION_CONNECTION_COUNT = 5;
+/**
+ * This provides access to Postgres via the PGWire library.
+ * A connection pool is used for individual query executions while
+ * a custom pool of connections is available for transactions or other operations
+ * which require being executed on the same connection.
+ */
+export class DatabaseClient extends AbstractPostgresConnection {
+    constructor(options) {
+        super();
+        this.options = options;
+        this.closed = false;
+        this.pool = pgwire.connectPgWirePool(options.config);
+        this.connections = Array.from({ length: TRANSACTION_CONNECTION_COUNT }, () => {
+            const slot = new ConnectionSlot({ config: options.config, notificationChannels: options.notificationChannels });
+            slot.registerListener({
+                connectionAvailable: () => this.processConnectionQueue(),
+                connectionError: (ex) => this.handleConnectionError(ex),
+                connectionCreated: (connection) => this.iterateAsyncListeners(async (l) => l.connectionCreated?.(connection))
+            });
+            return slot;
+        });
+        this.queue = [];
+        this.initialized = this.initialize();
+    }
+    get baseConnection() {
+        return this.pool;
+    }
+    get schemaStatement() {
+        const { schema } = this.options;
+        if (!schema) {
+            return;
+        }
+        return {
+            statement: `SET search_path TO ${schema};`
+        };
+    }
+    registerListener(listener) {
+        let disposeNotification = null;
+        if ('notification' in listener) {
+            // Pass this on to the first connection slot
+            // It will only actively listen on the connection once a listener has been registered
+            disposeNotification = this.connections[0].registerListener({
+                notification: listener.notification
+            });
+            this.pokeSlots();
+            delete listener['notification'];
+        }
+        const superDispose = super.registerListener(listener);
+        return () => {
+            disposeNotification?.();
+            superDispose();
+        };
+    }
+    async query(...args) {
+        await this.initialized;
+        /**
+         * There is no direct way to set the default schema with pgwire.
+         * This hack uses multiple statements in order to always ensure the
+         * appropriate connection (in the pool) uses the correct schema.
+         */
+        const { schemaStatement } = this;
+        if (typeof args[0] == 'object' && schemaStatement) {
+            args.unshift(schemaStatement);
+        }
+        else if (typeof args[0] == 'string' && schemaStatement) {
+            args[0] = `${schemaStatement.statement}; ${args[0]}`;
+        }
+        // Retry pool queries. Note that we can't retry queries in a transaction
+        // since a failed query will end the transaction.
+        return lib_postgres.retriedQuery(this.pool, ...args);
+    }
+    async *stream(...args) {
+        await this.initialized;
+        const { schemaStatement } = this;
+        if (schemaStatement) {
+            args.unshift(schemaStatement);
+        }
+        yield* super.stream(...args);
+    }
+    async lockConnection(callback) {
+        const { connection, release } = await this.requestConnection();
+        await this.setSchema(connection);
+        try {
+            return await callback(new WrappedConnection(connection));
+        }
+        finally {
+            release();
+        }
+    }
+    async transaction(tx) {
+        return this.lockConnection(async (db) => {
+            try {
+                await db.query(sql `BEGIN`);
+                const result = await tx(db);
+                await db.query(sql `COMMIT`);
+                return result;
+            }
+            catch (ex) {
+                await db.query(sql `ROLLBACK`);
+                throw ex;
+            }
+        });
+    }
+    /**
+     * Use the `powersync` schema as the default when resolving table names
+     */
+    async setSchema(client) {
+        const { schemaStatement } = this;
+        if (!schemaStatement) {
+            return;
+        }
+        await client.query(schemaStatement);
+    }
+    async initialize() {
+        const { schema } = this.options;
+        if (schema) {
+            // First check if it exists
+            const exists = await this.pool.query(sql `
+        SELECT
+          schema_name
+        FROM
+          information_schema.schemata
+        WHERE
+          schema_name = ${{ type: 'varchar', value: schema }};
+      `);
+            if (exists.rows.length) {
+                return;
+            }
+            // Create the schema if it doesn't exist
+            await this.pool.query({ statement: `CREATE SCHEMA IF NOT EXISTS ${this.options.schema}` });
+        }
+    }
+    async requestConnection() {
+        if (this.closed) {
+            throw new Error('Database client is closed');
+        }
+        await this.initialized;
+        // Queue the operation
+        const deferred = pDefer();
+        this.queue.push(deferred);
+        this.pokeSlots();
+        return deferred.promise;
+    }
+    pokeSlots() {
+        // Poke the slots to check if they are alive
+        for (const slot of this.connections) {
+            // No need to await this. Errors are reported asynchronously
+            slot.poke();
+        }
+    }
+    leaseConnectionSlot() {
+        const availableSlots = this.connections.filter((s) => s.isAvailable);
+        for (const slot of availableSlots) {
+            const lease = slot.lock();
+            if (lease) {
+                return lease;
+            }
+            // Possibly some contention detected, keep trying
+        }
+        return null;
+    }
+    processConnectionQueue() {
+        if (this.closed && this.queue.length) {
+            for (const q of this.queue) {
+                q.reject(new Error('Database has closed while waiting for a connection'));
+            }
+            this.queue = [];
+        }
+        if (this.queue.length) {
+            const lease = this.leaseConnectionSlot();
+            if (lease) {
+                const deferred = this.queue.shift();
+                deferred.resolve(lease);
+            }
+        }
+    }
+    /**
+     * Reports connection errors which might occur from bad configuration or
+     * a server which is no longer available.
+     * This fails all pending requests.
+     */
+    handleConnectionError(exception) {
+        for (const q of this.queue) {
+            q.reject(exception);
+        }
+        this.queue = [];
+    }
+    async [Symbol.asyncDispose]() {
+        await this.initialized;
+        this.closed = true;
+        for (const c of this.connections) {
+            await c[Symbol.asyncDispose]();
+        }
+        await this.pool.end();
+        // Reject all remaining items
+        for (const q of this.queue) {
+            q.reject(new Error(`Database is disposed`));
+        }
+        this.queue = [];
+    }
+}
+//# sourceMappingURL=DatabaseClient.js.map