@powersync/service-core-tests 0.0.0-dev-20241219091224

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @powersync/service-core-tests
+
+## 0.0.0-dev-20241219091224
+
+### Minor Changes
+
+- 697d44b: Initial release of shared tests for different sync bucket storage providers
+
+### Patch Changes
+
+- Updated dependencies [697d44b]
+- Updated dependencies [697d44b]
+- Updated dependencies [a66be3b]
+  - @powersync/service-core@0.0.0-dev-20241219091224
+  - @powersync/service-sync-rules@0.0.0-dev-20241219091224

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,5 @@
+# PowerSync Service Core Tests
+
+A small helper package which exposes common unit tests and test utility functions.
+
+This package is used in various modules for their unit tests.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './test-utils/test-utils-index.js';
+export * as test_utils from './test-utils/test-utils-index.js';
+export * from './tests/tests-index.js';
+export * as register from './tests/tests-index.js';

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from './test-utils/test-utils-index.js';
+export * as test_utils from './test-utils/test-utils-index.js';
+export * from './tests/tests-index.js';
+export * as register from './tests/tests-index.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,OAAO,KAAK,UAAU,MAAM,kCAAkC,CAAC;AAE/D,cAAc,wBAAwB,CAAC;AACvC,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC"}

package/dist/test-utils/bucket-validation.d.ts

@@ -0,0 +1,42 @@
+import { utils } from '@powersync/service-core';
+/**
+ * Reduce a bucket to the final state as stored on the client.
+ *
+ * This keeps the final state for each row as a PUT operation.
+ *
+ * All other operations are replaced with a single CLEAR operation,
+ * summing their checksums, and using a 0 as an op_id.
+ *
+ * This is the function $r(B)$, as described in /docs/bucket-properties.md.
+ */
+export declare function reduceBucket(operations: utils.OplogEntry[]): utils.OplogEntry[];
+/**
+import { OplogEntry } from '@/util/protocol-types.js';
+import { reduceBucket } from '@/util/utils.js';
+import { expect } from 'vitest';
+
+/**
+ * Validate this property, as described in /docs/bucket-properties.md:
+ *
+ * $r(B_{[..id_n]}) = r(r(B_{[..id_i]}) \cup B_{[id_{i+1}..id_n]}) \;\forall\; i \in [1..n]$
+ *
+ * We test that a client syncing the entire bucket in one go (left side of the equation),
+ * ends up with the same result as another client syncing up to operation id_i, then sync
+ * the rest.
+ */
+export declare function validateBucket(bucket: utils.OplogEntry[]): void;
+/**
+ * Validate these properties for a bucket $B$ and its compacted version $B'$,:
+ * as described in /docs/bucket-properties.md:
+ *
+ * 1. $r(B) = r(B')$
+ * 2. $r(B_{[..c]}) = r(r(B_{[..c_i]}) \cup B'_{[c_i+1..c]}) \;\forall\; c_i \in B$
+ *
+ * The first one is that the result of syncing the original bucket is the same as
+ * syncing the compacted bucket.
+ *
+ * The second property is that result of syncing the entire original bucket, is the same
+ * as syncing any partial version of that (up to op $c_i$), and then continue syncing
+ * using the compacted bucket.
+ */
+export declare function validateCompactedBucket(bucket: utils.OplogEntry[], compacted: utils.OplogEntry[]): void;

package/dist/test-utils/bucket-validation.js

@@ -0,0 +1,115 @@
+import { utils } from '@powersync/service-core';
+import { expect } from 'vitest';
+/**
+ * Reduce a bucket to the final state as stored on the client.
+ *
+ * This keeps the final state for each row as a PUT operation.
+ *
+ * All other operations are replaced with a single CLEAR operation,
+ * summing their checksums, and using a 0 as an op_id.
+ *
+ * This is the function $r(B)$, as described in /docs/bucket-properties.md.
+ */
+export function reduceBucket(operations) {
+    let rowState = new Map();
+    let otherChecksum = 0;
+    for (let op of operations) {
+        const key = rowKey(op);
+        if (op.op == 'PUT') {
+            const existing = rowState.get(key);
+            if (existing) {
+                otherChecksum = utils.addChecksums(otherChecksum, existing.checksum);
+            }
+            rowState.set(key, op);
+        }
+        else if (op.op == 'REMOVE') {
+            const existing = rowState.get(key);
+            if (existing) {
+                otherChecksum = utils.addChecksums(otherChecksum, existing.checksum);
+            }
+            rowState.delete(key);
+            otherChecksum = utils.addChecksums(otherChecksum, op.checksum);
+        }
+        else if (op.op == 'CLEAR') {
+            rowState.clear();
+            otherChecksum = op.checksum;
+        }
+        else if (op.op == 'MOVE') {
+            otherChecksum = utils.addChecksums(otherChecksum, op.checksum);
+        }
+        else {
+            throw new Error(`Unknown operation ${op.op}`);
+        }
+    }
+    const puts = [...rowState.values()].sort((a, b) => {
+        return Number(BigInt(a.op_id) - BigInt(b.op_id));
+    });
+    let finalState = [
+        // Special operation to indiciate the checksum remainder
+        { op_id: '0', op: 'CLEAR', checksum: otherChecksum },
+        ...puts
+    ];
+    return finalState;
+}
+function rowKey(entry) {
+    return `${entry.object_type}/${entry.object_id}/${entry.subkey}`;
+}
+/**
+import { OplogEntry } from '@/util/protocol-types.js';
+import { reduceBucket } from '@/util/utils.js';
+import { expect } from 'vitest';
+
+/**
+ * Validate this property, as described in /docs/bucket-properties.md:
+ *
+ * $r(B_{[..id_n]}) = r(r(B_{[..id_i]}) \cup B_{[id_{i+1}..id_n]}) \;\forall\; i \in [1..n]$
+ *
+ * We test that a client syncing the entire bucket in one go (left side of the equation),
+ * ends up with the same result as another client syncing up to operation id_i, then sync
+ * the rest.
+ */
+export function validateBucket(bucket) {
+    const r1 = reduceBucket(bucket);
+    for (let i = 0; i <= bucket.length; i++) {
+        const r2 = reduceBucket(bucket.slice(0, i + 1));
+        const b3 = bucket.slice(i + 1);
+        const r3 = r2.concat(b3);
+        const r4 = reduceBucket(r3);
+        expect(r4).toEqual(r1);
+    }
+    // This is the same check, just implemented differently
+    validateCompactedBucket(bucket, bucket);
+}
+/**
+ * Validate these properties for a bucket $B$ and its compacted version $B'$,:
+ * as described in /docs/bucket-properties.md:
+ *
+ * 1. $r(B) = r(B')$
+ * 2. $r(B_{[..c]}) = r(r(B_{[..c_i]}) \cup B'_{[c_i+1..c]}) \;\forall\; c_i \in B$
+ *
+ * The first one is that the result of syncing the original bucket is the same as
+ * syncing the compacted bucket.
+ *
+ * The second property is that result of syncing the entire original bucket, is the same
+ * as syncing any partial version of that (up to op $c_i$), and then continue syncing
+ * using the compacted bucket.
+ */
+export function validateCompactedBucket(bucket, compacted) {
+    // r(B_{[..c]})
+    const r1 = reduceBucket(bucket);
+    // r(B) = r(B')
+    expect(reduceBucket(compacted)).toEqual(r1);
+    for (let i = 0; i < bucket.length; i++) {
+        // r(B_{[..c_i]})
+        const r2 = reduceBucket(bucket.slice(0, i + 1));
+        const c_i = BigInt(bucket[i].op_id);
+        // B'_{[c_i+1..c]}
+        const b3 = compacted.filter((op) => BigInt(op.op_id) > c_i);
+        // r(B_{[..c_i]}) \cup B'_{[c_i+1..c]}
+        const r3 = r2.concat(b3);
+        // r(r(B_{[..c_i]}) \cup B'_{[c_i+1..c]})
+        const r4 = reduceBucket(r3);
+        expect(r4).toEqual(r1);
+    }
+}
+//# sourceMappingURL=bucket-validation.js.map

package/dist/test-utils/bucket-validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bucket-validation.js","sourceRoot":"","sources":["../../src/test-utils/bucket-validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY,CAAC,UAA8B;IACzD,IAAI,QAAQ,GAAG,IAAI,GAAG,EAA4B,CAAC;IACnD,IAAI,aAAa,GAAG,CAAC,CAAC;IAEtB,KAAK,IAAI,EAAE,IAAI,UAAU,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACvB,IAAI,EAAE,CAAC,EAAE,IAAI,KAAK,EAAE,CAAC;YACnB,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,QAAQ,EAAE,CAAC;gBACb,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,QAAQ,CAAC,QAAkB,CAAC,CAAC;YACjF,CAAC;YACD,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACxB,CAAC;aAAM,IAAI,EAAE,CAAC,EAAE,IAAI,QAAQ,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,QAAQ,EAAE,CAAC;gBACb,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,QAAQ,CAAC,QAAkB,CAAC,CAAC;YACjF,CAAC;YACD,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC,QAAkB,CAAC,CAAC;QAC3E,CAAC;aAAM,IAAI,EAAE,CAAC,EAAE,IAAI,OAAO,EAAE,CAAC;YAC5B,QAAQ,CAAC,KAAK,EAAE,CAAC;YACjB,aAAa,GAAG,EAAE,CAAC,QAAkB,CAAC;QACxC,CAAC;aAAM,IAAI,EAAE,CAAC,EAAE,IAAI,MAAM,EAAE,CAAC;YAC3B,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC,QAAkB,CAAC,CAAC;QAC3E,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,qBAAqB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAChD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,IAAI,UAAU,GAAuB;QACnC,wDAAwD;QACxD,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE;QACpD,GAAG,IAAI;KACR,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,MAAM,CAAC,KAAuB;IACrC,OAAO,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;AACnE,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,cAAc,CAAC,MAA0B;IACvD,MAAM,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/B,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACzB,MAAM,EAAE,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;QAC5B,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IAED,uDAAuD;IACvD,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAA0B,EAAE,SAA6B;IAC/F,eAAe;IACf,MAAM,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IAChC,eAAe;IACf,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAE5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,iBAAiB;QACjB,MAAM,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACpC,kBAAkB;QAClB,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC;QAC5D,sCAAsC;QACtC,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACzB,yCAAyC;QACzC,MAAM,EAAE,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;QAC5B,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;AACH,CAAC"}

package/dist/test-utils/general-utils.d.ts

@@ -0,0 +1,31 @@
+import { storage, utils } from '@powersync/service-core';
+import * as bson from 'bson';
+export interface StorageOptions {
+    /**
+     * By default, collections are only cleared/
+     * Setting this to true will drop the collections completely.
+     */
+    dropAll?: boolean;
+    doNotClear?: boolean;
+}
+export type StorageFactory = (options?: StorageOptions) => Promise<storage.BucketStorageFactory>;
+export declare const ZERO_LSN = "0/0";
+export declare const PARSE_OPTIONS: storage.ParseSyncRulesOptions;
+export declare const BATCH_OPTIONS: storage.StartBatchOptions;
+export declare function testRules(content: string): storage.PersistedSyncRulesContent;
+export declare function makeTestTable(name: string, columns?: string[] | undefined): storage.SourceTable;
+export declare function getBatchData(batch: utils.SyncBucketData[] | storage.SyncBucketDataBatch[] | storage.SyncBucketDataBatch): {
+    op_id: string;
+    op: "PUT" | "REMOVE" | "MOVE" | "CLEAR";
+    object_id: string | undefined;
+    checksum: number | bigint;
+}[];
+export declare function getBatchMeta(batch: utils.SyncBucketData[] | storage.SyncBucketDataBatch[] | storage.SyncBucketDataBatch): {
+    has_more: boolean;
+    after: string;
+    next_after: string;
+} | null;
+/**
+ * Replica id in the old Postgres format, for backwards-compatible tests.
+ */
+export declare function rid(id: string): bson.UUID;

package/dist/test-utils/general-utils.js

@@ -0,0 +1,81 @@
+import { storage, utils } from '@powersync/service-core';
+import { SqlSyncRules } from '@powersync/service-sync-rules';
+import * as bson from 'bson';
+export const ZERO_LSN = '0/0';
+export const PARSE_OPTIONS = {
+    defaultSchema: 'public'
+};
+export const BATCH_OPTIONS = {
+    ...PARSE_OPTIONS,
+    zeroLSN: ZERO_LSN,
+    storeCurrentData: true
+};
+export function testRules(content) {
+    return {
+        id: 1,
+        sync_rules_content: content,
+        slot_name: 'test',
+        parsed(options) {
+            return {
+                id: 1,
+                sync_rules: SqlSyncRules.fromYaml(content, options),
+                slot_name: 'test'
+            };
+        },
+        lock() {
+            throw new Error('Not implemented');
+        }
+    };
+}
+export function makeTestTable(name, columns) {
+    const relId = utils.hashData('table', name, (columns ?? ['id']).join(','));
+    const id = new bson.ObjectId('6544e3899293153fa7b38331');
+    return new storage.SourceTable(id, storage.SourceTable.DEFAULT_TAG, relId, 'public', name, (columns ?? ['id']).map((column) => ({ name: column, type: 'VARCHAR', typeId: 25 })), true);
+}
+export function getBatchData(batch) {
+    const first = getFirst(batch);
+    if (first == null) {
+        return [];
+    }
+    return first.data.map((d) => {
+        return {
+            op_id: d.op_id,
+            op: d.op,
+            object_id: d.object_id,
+            checksum: d.checksum
+        };
+    });
+}
+export function getBatchMeta(batch) {
+    const first = getFirst(batch);
+    if (first == null) {
+        return null;
+    }
+    return {
+        has_more: first.has_more,
+        after: first.after,
+        next_after: first.next_after
+    };
+}
+function getFirst(batch) {
+    if (!Array.isArray(batch)) {
+        return batch.batch;
+    }
+    if (batch.length == 0) {
+        return null;
+    }
+    let first = batch[0];
+    if (first.batch != null) {
+        return first.batch;
+    }
+    else {
+        return first;
+    }
+}
+/**
+ * Replica id in the old Postgres format, for backwards-compatible tests.
+ */
+export function rid(id) {
+    return utils.getUuidReplicaIdentityBson({ id: id }, [{ name: 'id', type: 'VARCHAR', typeId: 25 }]);
+}
+//# sourceMappingURL=general-utils.js.map

package/dist/test-utils/general-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"general-utils.js","sourceRoot":"","sources":["../../src/test-utils/general-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAa7B,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,CAAC;AAE9B,MAAM,CAAC,MAAM,aAAa,GAAkC;IAC1D,aAAa,EAAE,QAAQ;CACxB,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAA8B;IACtD,GAAG,aAAa;IAChB,OAAO,EAAE,QAAQ;IACjB,gBAAgB,EAAE,IAAI;CACvB,CAAC;AAEF,MAAM,UAAU,SAAS,CAAC,OAAe;IACvC,OAAO;QACL,EAAE,EAAE,CAAC;QACL,kBAAkB,EAAE,OAAO;QAC3B,SAAS,EAAE,MAAM;QACjB,MAAM,CAAC,OAAO;YACZ,OAAO;gBACL,EAAE,EAAE,CAAC;gBACL,UAAU,EAAE,YAAY,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBACnD,SAAS,EAAE,MAAM;aAClB,CAAC;QACJ,CAAC;QACD,IAAI;YACF,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,OAA8B;IACxE,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3E,MAAM,EAAE,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IACzD,OAAO,IAAI,OAAO,CAAC,WAAW,CAC5B,EAAE,EACF,OAAO,CAAC,WAAW,CAAC,WAAW,EAC/B,KAAK,EACL,QAAQ,EACR,IAAI,EACJ,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EACpF,IAAI,CACL,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,KAA2F;IAE3F,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9B,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC1B,OAAO;YACL,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,EAAE,EAAE,CAAC,CAAC,EAAE;YACR,SAAS,EAAE,CAAC,CAAC,SAAS;YACtB,QAAQ,EAAE,CAAC,CAAC,QAAQ;SACrB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,KAA2F;IAE3F,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9B,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO;QACL,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,UAAU,EAAE,KAAK,CAAC,UAAU;KAC7B,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CACf,KAA2F;IAE3F,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACrB,IAAK,KAAqC,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;QACzD,OAAQ,KAAqC,CAAC,KAAK,CAAC;IACtD,CAAC;SAAM,CAAC;QACN,OAAO,KAA6B,CAAC;IACvC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,GAAG,CAAC,EAAU;IAC5B,OAAO,KAAK,CAAC,0BAA0B,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;AACrG,CAAC"}

package/dist/test-utils/stream_utils.d.ts

@@ -0,0 +1,6 @@
+import { utils } from '@powersync/service-core';
+export declare function putOp(table: string, data: Record<string, any>): Partial<utils.OplogEntry>;
+export declare function removeOp(table: string, id: string): Partial<utils.OplogEntry>;
+export declare function compareIds(a: utils.OplogEntry, b: utils.OplogEntry): number;
+export declare function oneFromAsync<T>(source: Iterable<T> | AsyncIterable<T>): Promise<T>;
+export declare function fromAsync<T>(source: Iterable<T> | AsyncIterable<T>): Promise<T[]>;

package/dist/test-utils/stream_utils.js

@@ -0,0 +1,37 @@
+import { JSONBig } from '@powersync/service-jsonbig';
+export function putOp(table, data) {
+    return {
+        op: 'PUT',
+        object_type: table,
+        object_id: data.id,
+        data: JSONBig.stringify(data)
+    };
+}
+export function removeOp(table, id) {
+    return {
+        op: 'REMOVE',
+        object_type: table,
+        object_id: id
+    };
+}
+export function compareIds(a, b) {
+    return a.object_id.localeCompare(b.object_id);
+}
+export async function oneFromAsync(source) {
+    const items = [];
+    for await (const item of source) {
+        items.push(item);
+    }
+    if (items.length != 1) {
+        throw new Error(`One item expected, got: ${items.length}`);
+    }
+    return items[0];
+}
+export async function fromAsync(source) {
+    const items = [];
+    for await (const item of source) {
+        items.push(item);
+    }
+    return items;
+}
+//# sourceMappingURL=stream_utils.js.map

package/dist/test-utils/stream_utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream_utils.js","sourceRoot":"","sources":["../../src/test-utils/stream_utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAErD,MAAM,UAAU,KAAK,CAAC,KAAa,EAAE,IAAyB;IAC5D,OAAO;QACL,EAAE,EAAE,KAAK;QACT,WAAW,EAAE,KAAK;QAClB,SAAS,EAAE,IAAI,CAAC,EAAE;QAClB,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;KAC9B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAa,EAAE,EAAU;IAChD,OAAO;QACL,EAAE,EAAE,QAAQ;QACZ,WAAW,EAAE,KAAK;QAClB,SAAS,EAAE,EAAE;KACd,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,CAAmB,EAAE,CAAmB;IACjE,OAAO,CAAC,CAAC,SAAU,CAAC,aAAa,CAAC,CAAC,CAAC,SAAU,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAI,MAAsC;IAC1E,MAAM,KAAK,GAAQ,EAAE,CAAC;IACtB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,2BAA2B,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAAI,MAAsC;IACvE,MAAM,KAAK,GAAQ,EAAE,CAAC;IACtB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/test-utils/test-utils-index.d.ts

@@ -0,0 +1,3 @@
+export * from './bucket-validation.js';
+export * from './general-utils.js';
+export * from './stream_utils.js';

package/dist/test-utils/test-utils-index.js

@@ -0,0 +1,4 @@
+export * from './bucket-validation.js';
+export * from './general-utils.js';
+export * from './stream_utils.js';
+//# sourceMappingURL=test-utils-index.js.map

package/dist/test-utils/test-utils-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils-index.js","sourceRoot":"","sources":["../../src/test-utils/test-utils-index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC"}

package/dist/tests/register-bucket-validation-tests.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This tests the reduceBucket function.
+ * While this function is not used directly in the service implementation,
+ * it is an important part of validating consistency in other tests.
+ * @example
+ * ```TypeScript
+ * describe('bucket validation', registerBucketValidationTests);
+ * ```
+ */
+export declare function registerBucketValidationTests(): void;

package/dist/tests/register-bucket-validation-tests.js

@@ -0,0 +1,139 @@
+import { expect, test } from 'vitest';
+import * as test_utils from '../test-utils/test-utils-index.js';
+/**
+ * This tests the reduceBucket function.
+ * While this function is not used directly in the service implementation,
+ * it is an important part of validating consistency in other tests.
+ * @example
+ * ```TypeScript
+ * describe('bucket validation', registerBucketValidationTests);
+ * ```
+ */
+export function registerBucketValidationTests() {
+    const ops1 = [
+        {
+            op_id: '1',
+            op: 'PUT',
+            object_type: 'test',
+            object_id: 't1',
+            checksum: 2634521662,
+            subkey: '6544e3899293153fa7b38331/117ab485-4b42-58a2-ab32-0053a22c3423',
+            data: '{"id":"t1"}'
+        },
+        {
+            op_id: '2',
+            op: 'PUT',
+            object_type: 'test',
+            object_id: 't2',
+            checksum: 4243212114,
+            subkey: '6544e3899293153fa7b38331/ec27c691-b47a-5d92-927a-9944feb89eee',
+            data: '{"id":"t2"}'
+        },
+        {
+            op_id: '3',
+            op: 'REMOVE',
+            object_type: 'test',
+            object_id: 't1',
+            checksum: 4228978084,
+            subkey: '6544e3899293153fa7b38331/117ab485-4b42-58a2-ab32-0053a22c3423',
+            data: null
+        },
+        {
+            op_id: '4',
+            op: 'PUT',
+            object_type: 'test',
+            object_id: 't2',
+            checksum: 4243212114,
+            subkey: '6544e3899293153fa7b38331/ec27c691-b47a-5d92-927a-9944feb89eee',
+            data: '{"id":"t2"}'
+        }
+    ];
+    test('reduce 1', () => {
+        expect(test_utils.reduceBucket(ops1)).toEqual([
+            {
+                checksum: -1778190028,
+                op: 'CLEAR',
+                op_id: '0'
+            },
+            {
+                checksum: 4243212114,
+                data: '{"id":"t2"}',
+                object_id: 't2',
+                object_type: 'test',
+                op: 'PUT',
+                op_id: '4',
+                subkey: '6544e3899293153fa7b38331/ec27c691-b47a-5d92-927a-9944feb89eee'
+            }
+        ]);
+        expect(test_utils.reduceBucket(test_utils.reduceBucket(ops1))).toEqual([
+            {
+                checksum: -1778190028,
+                op: 'CLEAR',
+                op_id: '0'
+            },
+            {
+                checksum: 4243212114,
+                data: '{"id":"t2"}',
+                object_id: 't2',
+                object_type: 'test',
+                op: 'PUT',
+                op_id: '4',
+                subkey: '6544e3899293153fa7b38331/ec27c691-b47a-5d92-927a-9944feb89eee'
+            }
+        ]);
+        test_utils.validateBucket(ops1);
+    });
+    test('reduce 2', () => {
+        const bucket = [
+            ...ops1,
+            {
+                checksum: 93784613,
+                op: 'CLEAR',
+                op_id: '5'
+            },
+            {
+                checksum: 5133378,
+                data: '{"id":"t3"}',
+                object_id: 't3',
+                object_type: 'test',
+                op: 'PUT',
+                op_id: '11',
+                subkey: '6544e3899293153fa7b38333/ec27c691-b47a-5d92-927a-9944feb89eee'
+            }
+        ];
+        expect(test_utils.reduceBucket(bucket)).toEqual([
+            {
+                checksum: 93784613,
+                op: 'CLEAR',
+                op_id: '0'
+            },
+            {
+                checksum: 5133378,
+                data: '{"id":"t3"}',
+                object_id: 't3',
+                object_type: 'test',
+                op: 'PUT',
+                op_id: '11',
+                subkey: '6544e3899293153fa7b38333/ec27c691-b47a-5d92-927a-9944feb89eee'
+            }
+        ]);
+        expect(test_utils.reduceBucket(test_utils.reduceBucket(bucket))).toEqual([
+            {
+                checksum: 93784613,
+                op: 'CLEAR',
+                op_id: '0'
+            },
+            {
+                checksum: 5133378,
+                data: '{"id":"t3"}',
+                object_id: 't3',
+                object_type: 'test',
+                op: 'PUT',
+                op_id: '11',
+                subkey: '6544e3899293153fa7b38333/ec27c691-b47a-5d92-927a-9944feb89eee'
+            }
+        ]);
+        test_utils.validateBucket(bucket);
+    });
+}
+//# sourceMappingURL=register-bucket-validation-tests.js.map

package/dist/tests/register-bucket-validation-tests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register-bucket-validation-tests.js","sourceRoot":"","sources":["../../src/tests/register-bucket-validation-tests.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,KAAK,UAAU,MAAM,mCAAmC,CAAC;AAEhE;;;;;;;;GAQG;AACH,MAAM,UAAU,6BAA6B;IAC3C,MAAM,IAAI,GAAiB;QACzB;YACE,KAAK,EAAE,GAAG;YACV,EAAE,EAAE,KAAK;YACT,WAAW,EAAE,MAAM;YACnB,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,+DAA+D;YACvE,IAAI,EAAE,aAAa;SACpB;QACD;YACE,KAAK,EAAE,GAAG;YACV,EAAE,EAAE,KAAK;YACT,WAAW,EAAE,MAAM;YACnB,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,+DAA+D;YACvE,IAAI,EAAE,aAAa;SACpB;QACD;YACE,KAAK,EAAE,GAAG;YACV,EAAE,EAAE,QAAQ;YACZ,WAAW,EAAE,MAAM;YACnB,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,+DAA+D;YACvE,IAAI,EAAE,IAAI;SACX;QACD;YACE,KAAK,EAAE,GAAG;YACV,EAAE,EAAE,KAAK;YACT,WAAW,EAAE,MAAM;YACnB,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,+DAA+D;YACvE,IAAI,EAAE,aAAa;SACpB;KACF,CAAC;IAEF,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE;QACpB,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;YAC5C;gBACE,QAAQ,EAAE,CAAC,UAAU;gBACrB,EAAE,EAAE,OAAO;gBACX,KAAK,EAAE,GAAG;aACX;YACD;gBACE,QAAQ,EAAE,UAAU;gBACpB,IAAI,EAAE,aAAa;gBACnB,SAAS,EAAE,IAAI;gBACf,WAAW,EAAE,MAAM;gBACnB,EAAE,EAAE,KAAK;gBACT,KAAK,EAAE,GAAG;gBACV,MAAM,EAAE,+DAA+D;aACxE;SACF,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACrE;gBACE,QAAQ,EAAE,CAAC,UAAU;gBACrB,EAAE,EAAE,OAAO;gBACX,KAAK,EAAE,GAAG;aACX;YACD;gBACE,QAAQ,EAAE,UAAU;gBACpB,IAAI,EAAE,aAAa;gBACnB,SAAS,EAAE,IAAI;gBACf,WAAW,EAAE,MAAM;gBACnB,EAAE,EAAE,KAAK;gBACT,KAAK,EAAE,GAAG;gBACV,MAAM,EAAE,+DAA+D;aACxE;SACF,CAAC,CAAC;QAEH,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE;QACpB,MAAM,MAAM,GAAiB;YAC3B,GAAG,IAAI;YAEP;gBACE,QAAQ,EAAE,QAAQ;gBAClB,EAAE,EAAE,OAAO;gBACX,KAAK,EAAE,GAAG;aACX;YACD;gBACE,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,aAAa;gBACnB,SAAS,EAAE,IAAI;gBACf,WAAW,EAAE,MAAM;gBACnB,EAAE,EAAE,KAAK;gBACT,KAAK,EAAE,IAAI;gBACX,MAAM,EAAE,+DAA+D;aACxE;SACF,CAAC;QAEF,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YAC9C;gBACE,QAAQ,EAAE,QAAQ;gBAClB,EAAE,EAAE,OAAO;gBACX,KAAK,EAAE,GAAG;aACX;YACD;gBACE,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,aAAa;gBACnB,SAAS,EAAE,IAAI;gBACf,WAAW,EAAE,MAAM;gBACnB,EAAE,EAAE,KAAK;gBACT,KAAK,EAAE,IAAI;gBACX,MAAM,EAAE,+DAA+D;aACxE;SACF,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACvE;gBACE,QAAQ,EAAE,QAAQ;gBAClB,EAAE,EAAE,OAAO;gBACX,KAAK,EAAE,GAAG;aACX;YACD;gBACE,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,aAAa;gBACnB,SAAS,EAAE,IAAI;gBACf,WAAW,EAAE,MAAM;gBACnB,EAAE,EAAE,KAAK;gBACT,KAAK,EAAE,IAAI;gBACX,MAAM,EAAE,+DAA+D;aACxE;SACF,CAAC,CAAC;QAEH,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/tests/register-compacting-tests.d.ts

@@ -0,0 +1,14 @@
+import { storage } from '@powersync/service-core';
+import * as test_utils from '../test-utils/test-utils-index.js';
+/**
+ * @example
+ * ```TypeScript
+ * // Test with the default options - large batch sizes
+ * describe('compacting buckets - default options', () => registerCompactTests(() => new MongoStorageFactory(), {}));
+ *
+ *  // Also test with the miniumum batch sizes, forcing usage of multiple batches internally
+ * describe('compacting buckets - batched', () =>
+ * compactTests(() => new MongoStorageFactory(), { clearBatchLimit: 2, moveBatchLimit: 1, moveBatchQueryLimit: 1 }));
+ * ```
+ */
+export declare function registerCompactTests<CompactOptions extends storage.CompactOptions = storage.CompactOptions>(generateStorageFactory: test_utils.StorageFactory, compactOptions: CompactOptions): void;