@powersync/service-module-mongodb-storage 0.12.7 → 0.12.9

package/src/storage/storage-index.ts

@@ -7,8 +7,9 @@ export * from './implementation/MongoPersistedSyncRulesContent.js';
 export * from './implementation/MongoStorageProvider.js';
 export * from './implementation/MongoSyncBucketStorage.js';
 export * from './implementation/MongoSyncRulesLock.js';
-export * from './implementation/MongoTestStorageFactoryGenerator.js';
 export * from './implementation/OperationBatch.js';
 export * from './implementation/PersistedBatch.js';
-export * from './implementation/util.js';
+export * from '../utils/util.js';
 export * from './MongoBucketStorage.js';
+export * from './MongoReportStorage.js';
+export * as test_utils from '../utils/test-utils.js';

package/src/utils/test-utils.ts

@@ -0,0 +1,57 @@
+import { mongo } from '@powersync/lib-service-mongodb';
+import { PowerSyncMongo } from '../storage/implementation/db.js';
+import { TestStorageOptions } from '@powersync/service-core';
+import { MongoReportStorage } from '../storage/MongoReportStorage.js';
+import { MongoBucketStorage } from '../storage/MongoBucketStorage.js';
+import { MongoSyncBucketStorageOptions } from '../storage/implementation/MongoSyncBucketStorage.js';
+
+export type MongoTestStorageOptions = {
+  url: string;
+  isCI: boolean;
+  internalOptions?: MongoSyncBucketStorageOptions;
+};
+
+export function mongoTestStorageFactoryGenerator(factoryOptions: MongoTestStorageOptions) {
+  return async (options?: TestStorageOptions) => {
+    const db = connectMongoForTests(factoryOptions.url, factoryOptions.isCI);
+
+    // None of the tests insert data into this collection, so it was never created
+    if (!(await db.db.listCollections({ name: db.bucket_parameters.collectionName }).hasNext())) {
+      await db.db.createCollection('bucket_parameters');
+    }
+
+    // Full migrations are not currently run for tests, so we manually create this
+    await db.createCheckpointEventsCollection();
+
+    if (!options?.doNotClear) {
+      await db.clear();
+    }
+
+    return new MongoBucketStorage(db, { slot_name_prefix: 'test_' }, factoryOptions.internalOptions);
+  };
+}
+
+export function mongoTestReportStorageFactoryGenerator(factoryOptions: MongoTestStorageOptions) {
+  return async (options?: TestStorageOptions) => {
+    const db = connectMongoForTests(factoryOptions.url, factoryOptions.isCI);
+
+    await db.createConnectionReportingCollection();
+
+    if (!options?.doNotClear) {
+      await db.clear();
+    }
+
+    return new MongoReportStorage(db);
+  };
+}
+
+export const connectMongoForTests = (url: string, isCI: boolean) => {
+  // Short timeout for tests, to fail fast when the server is not available.
+  // Slightly longer timeouts for CI, to avoid arbitrary test failures
+  const client = new mongo.MongoClient(url, {
+    connectTimeoutMS: isCI ? 15_000 : 5_000,
+    socketTimeoutMS: isCI ? 15_000 : 5_000,
+    serverSelectionTimeoutMS: isCI ? 15_000 : 2_500
+  });
+  return new PowerSyncMongo(client);
+};

package/src/{storage/implementation → utils}/util.ts

@@ -3,11 +3,9 @@ import * as crypto from 'crypto';
 import * as uuid from 'uuid';
 
 import { mongo } from '@powersync/lib-service-mongodb';
-import { BucketChecksum, PartialChecksum, PartialOrFullChecksum, storage, utils } from '@powersync/service-core';
-
-import { PowerSyncMongo } from './db.js';
-import { BucketDataDocument } from './models.js';
+import { storage, utils } from '@powersync/service-core';
 import { ServiceAssertionError } from '@powersync/lib-services-framework';
+import { BucketDataDocument } from '../storage/implementation/models.js';
 
 export function idPrefixFilter<T>(prefix: Partial<T>, rest: (keyof T)[]): mongo.Condition<T> {
   let filter = {
@@ -41,7 +39,7 @@ export function generateSlotName(prefix: string, sync_rules_id: number) {
  * However, that makes `has_more` detection very difficult, since the cursor is always closed
  * after the first batch. Instead, we do a workaround to only fetch a single batch below.
  *
- * For this to be effective, set batchSize = limit in the find command.
+ * For this to be effective, set batchSize = limit + 1 in the find command.
  */
 export async function readSingleBatch<T>(cursor: mongo.AbstractCursor<T>): Promise<{ data: T[]; hasMore: boolean }> {
   try {
@@ -105,20 +103,6 @@ export function replicaIdToSubkey(table: bson.ObjectId, id: storage.ReplicaId):
   }
 }
 
-/**
- * Helper for unit tests
- */
-export const connectMongoForTests = (url: string, isCI: boolean) => {
-  // Short timeout for tests, to fail fast when the server is not available.
-  // Slightly longer timeouts for CI, to avoid arbitrary test failures
-  const client = new mongo.MongoClient(url, {
-    connectTimeoutMS: isCI ? 15_000 : 5_000,
-    socketTimeoutMS: isCI ? 15_000 : 5_000,
-    serverSelectionTimeoutMS: isCI ? 15_000 : 2_500
-  });
-  return new PowerSyncMongo(client);
-};
-
 export function setSessionSnapshotTime(session: mongo.ClientSession, time: bson.Timestamp) {
   // This is a workaround for the lack of direct support for snapshot reads in the MongoDB driver.
   if (!session.snapshotEnabled) {

package/src/utils/utils-index.ts

@@ -0,0 +1,2 @@
+export * as test_utils from './test-utils.js';
+export * from './util.js';

package/test/src/__snapshots__/connection-report-storage.test.ts.snap

@@ -0,0 +1,215 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Connection reporting storage > Should create a connection report if its after a day 1`] = `
+[
+  {
+    "client_id": "client_week",
+    "sdk": "powersync-js/1.24.5",
+    "user_agent": "powersync-js/1.21.0 powersync-web Firefox/141 linux",
+    "user_id": "user_week",
+  },
+  {
+    "client_id": "client_week",
+    "sdk": "powersync-js/1.24.5",
+    "user_agent": "powersync-js/1.21.0 powersync-web Firefox/141 linux",
+    "user_id": "user_week",
+  },
+]
+`;
+
+exports[`Connection reporting storage > Should delete rows older than specified range 1`] = `
+{
+  "sdks": [
+    {
+      "clients": 1,
+      "sdk": "powersync-dart/1.6.4",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.1",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.2",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.4",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.24.5",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "unknown",
+      "users": 1,
+    },
+  ],
+  "users": 5,
+}
+`;
+
+exports[`Connection reporting storage > Should update a connected connection report and make it disconnected 1`] = `
+[
+  {
+    "client_id": "client_three",
+    "sdk": "powersync-js/1.21.2",
+    "user_agent": "powersync-js/1.21.0 powersync-web Firefox/141 linux",
+    "user_id": "user_three",
+  },
+]
+`;
+
+exports[`Connection reporting storage > Should update a connection report if its within a day 1`] = `
+[
+  {
+    "client_id": "client_one",
+    "sdk": "powersync-dart/1.6.4",
+    "user_agent": "powersync-dart/1.6.4 Dart (flutter-web) Chrome/128 android",
+    "user_id": "user_one",
+  },
+]
+`;
+
+exports[`Report storage tests > Should show connection report data for user over the past day 1`] = `
+{
+  "sdks": [
+    {
+      "clients": 1,
+      "sdk": "powersync-dart/1.6.4",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.1",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.4",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "unknown",
+      "users": 1,
+    },
+  ],
+  "users": 3,
+}
+`;
+
+exports[`Report storage tests > Should show connection report data for user over the past month 1`] = `
+{
+  "sdks": [
+    {
+      "clients": 1,
+      "sdk": "powersync-dart/1.6.4",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.1",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.2",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.4",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.23.6",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.23.7",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.24.5",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "unknown",
+      "users": 1,
+    },
+  ],
+  "users": 7,
+}
+`;
+
+exports[`Report storage tests > Should show connection report data for user over the past week 1`] = `
+{
+  "sdks": [
+    {
+      "clients": 1,
+      "sdk": "powersync-dart/1.6.4",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.1",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.2",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.4",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.24.5",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "unknown",
+      "users": 1,
+    },
+  ],
+  "users": 5,
+}
+`;
+
+exports[`Report storage tests > Should show currently connected users 1`] = `
+{
+  "sdks": [
+    {
+      "clients": 1,
+      "sdk": "powersync-dart/1.6.4",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "powersync-js/1.21.1",
+      "users": 1,
+    },
+    {
+      "clients": 1,
+      "sdk": "unknown",
+      "users": 1,
+    },
+  ],
+  "users": 2,
+}
+`;

package/test/src/connection-report-storage.test.ts

@@ -0,0 +1,133 @@
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import { INITIALIZED_MONGO_REPORT_STORAGE_FACTORY } from './util.js';
+import { register, ReportUserData } from '@powersync/service-core-tests';
+import { event_types } from '@powersync/service-types';
+import { MongoReportStorage } from '@module/storage/MongoReportStorage.js';
+
+const userData = register.REPORT_TEST_USERS;
+const dates = register.REPORT_TEST_DATES;
+const factory = await INITIALIZED_MONGO_REPORT_STORAGE_FACTORY();
+
+function removeVolatileFields(
+  connections: event_types.ClientConnection[]
+): Partial<event_types.ClientConnection & { _id: string }>[] {
+  return connections.map((sdk: Partial<event_types.ClientConnection & { _id: string }>) => {
+    const { _id, disconnected_at, connected_at, jwt_exp, ...rest } = sdk;
+    return {
+      ...rest
+    };
+  });
+}
+
+async function loadData(data: ReportUserData, factory: MongoReportStorage) {
+  await factory.db.connection_report_events.insertMany(Object.values(data));
+}
+
+async function deleteData(factory: MongoReportStorage) {
+  await factory.db.connection_report_events.deleteMany();
+}
+
+beforeAll(async () => {
+  await loadData(userData, factory);
+});
+afterAll(async () => {
+  await deleteData(factory);
+});
+
+describe('Report storage tests', async () => {
+  await register.registerReportTests(factory);
+});
+
+describe('Connection reporting storage', async () => {
+  it('Should create a connection report if its after a day', async () => {
+    const newConnectAt = new Date(
+      dates.now.getFullYear(),
+      dates.now.getMonth(),
+      dates.now.getDate() + 1,
+      dates.now.getHours()
+    );
+    const jwtExp = new Date(newConnectAt.getFullYear(), newConnectAt.getMonth(), newConnectAt.getDate() + 1);
+
+    await factory.reportClientConnection({
+      sdk: userData.user_week.sdk,
+      connected_at: newConnectAt,
+      jwt_exp: jwtExp,
+      client_id: userData.user_week.client_id,
+      user_id: userData.user_week.user_id,
+      user_agent: userData.user_week.user_agent
+    });
+
+    const connection = await factory.db.connection_report_events.find({ user_id: userData.user_week.user_id }).toArray();
+    expect(connection).toHaveLength(2);
+    const cleaned = removeVolatileFields(connection);
+    expect(cleaned).toMatchSnapshot();
+  });
+
+  it('Should update a connection report if its within a day', async () => {
+    const newConnectAt = new Date(
+      dates.now.getFullYear(),
+      dates.now.getMonth(),
+      dates.now.getDate(),
+      dates.now.getHours(),
+      dates.now.getMinutes() + 20
+    );
+    const jwtExp = new Date(newConnectAt.getFullYear(), newConnectAt.getMonth(), newConnectAt.getDate() + 1);
+    await factory.reportClientConnection({
+      sdk: userData.user_one.sdk,
+      connected_at: newConnectAt,
+      jwt_exp: jwtExp,
+      client_id: userData.user_one.client_id,
+      user_id: userData.user_one.user_id,
+      user_agent: userData.user_one.user_agent
+    });
+
+    const connection = await factory.db.connection_report_events
+      .find({ user_id: userData.user_one.user_id, client_id: userData.user_one.client_id })
+      .toArray();
+    expect(connection).toHaveLength(1);
+    expect(new Date(connection[0].connected_at)).toEqual(newConnectAt);
+    expect(new Date(connection[0].jwt_exp!)).toEqual(jwtExp);
+    expect(connection[0].disconnected_at).toBeUndefined();
+    const cleaned = removeVolatileFields(connection);
+    expect(cleaned).toMatchSnapshot();
+  });
+
+  it('Should update a connected connection report and make it disconnected', async () => {
+    const disconnectAt = new Date(
+      dates.now.getFullYear(),
+      dates.now.getMonth(),
+      dates.now.getDate(),
+      dates.now.getHours(),
+      dates.now.getMinutes() + 20
+    );
+    const jwtExp = new Date(disconnectAt.getFullYear(), disconnectAt.getMonth(), disconnectAt.getDate() + 1);
+
+    await factory.reportClientDisconnection({
+      disconnected_at: disconnectAt,
+      jwt_exp: jwtExp,
+      client_id: userData.user_three.client_id,
+      user_id: userData.user_three.user_id,
+      user_agent: userData.user_three.user_agent,
+      connected_at: userData.user_three.connected_at
+    });
+
+    const connection = await factory.db.connection_report_events.find({ user_id: userData.user_three.user_id }).toArray();
+    expect(connection).toHaveLength(1);
+    expect(new Date(connection[0].disconnected_at!)).toEqual(disconnectAt);
+    const cleaned = removeVolatileFields(connection);
+    expect(cleaned).toMatchSnapshot();
+  });
+
+  it('Should delete rows older than specified range', async () => {
+    await deleteData(factory);
+    await loadData(userData, factory);
+    await factory.deleteOldConnectionData({
+      date: dates.weekAgo
+    });
+    const connection = await factory.getClientConnectionReports({
+      start: dates.monthAgo,
+      end: dates.now
+    });
+    expect(connection).toMatchSnapshot();
+  });
+});

package/test/src/storage.test.ts

@@ -2,8 +2,7 @@ import { register } from '@powersync/service-core-tests';
 import { describe } from 'vitest';
 import { INITIALIZED_MONGO_STORAGE_FACTORY } from './util.js';
 import { env } from './env.js';
-import { MongoTestStorageFactoryGenerator } from '@module/storage/implementation/MongoTestStorageFactoryGenerator.js';
-import { MongoChecksumOptions } from '@module/storage/implementation/MongoChecksums.js';
+import { mongoTestStorageFactoryGenerator } from '@module/utils/test-utils.js';
 
 describe('Mongo Sync Bucket Storage - Parameters', () =>
   register.registerDataStorageParameterTests(INITIALIZED_MONGO_STORAGE_FACTORY));
@@ -18,7 +17,7 @@ describe('Sync Bucket Validation', register.registerBucketValidationTests);
 
 describe('Mongo Sync Bucket Storage - split operations', () =>
   register.registerDataStorageDataTests(
-    MongoTestStorageFactoryGenerator({
+    mongoTestStorageFactoryGenerator({
       url: env.MONGO_TEST_URL,
       isCI: env.CI,
       internalOptions: {
@@ -32,7 +31,7 @@ describe('Mongo Sync Bucket Storage - split operations', () =>
 
 describe('Mongo Sync Bucket Storage - split buckets', () =>
   register.registerDataStorageDataTests(
-    MongoTestStorageFactoryGenerator({
+    mongoTestStorageFactoryGenerator({
       url: env.MONGO_TEST_URL,
       isCI: env.CI,
       internalOptions: {
@@ -43,50 +42,3 @@ describe('Mongo Sync Bucket Storage - split buckets', () =>
       }
     })
   ));
-
-describe('Mongo Sync Bucket Storage - checksum calculations', () => {
-  // This test tests 4 buckets x 4 operations in each.
-  // We specifically use operationBatchLimit that does not have factors in common with 4,
-  // as well some that do.
-  const params: MongoChecksumOptions[] = [
-    {
-      bucketBatchLimit: 100,
-      operationBatchLimit: 3
-    },
-
-    {
-      bucketBatchLimit: 10,
-      operationBatchLimit: 7
-    },
-
-    {
-      bucketBatchLimit: 3,
-      operationBatchLimit: 1
-    },
-    {
-      bucketBatchLimit: 1,
-      operationBatchLimit: 3
-    },
-    {
-      bucketBatchLimit: 2,
-      operationBatchLimit: 4
-    },
-    {
-      bucketBatchLimit: 4,
-      operationBatchLimit: 12
-    }
-  ];
-  for (let options of params) {
-    describe(`${options.bucketBatchLimit}|${options.operationBatchLimit}`, () => {
-      register.testChecksumBatching(
-        MongoTestStorageFactoryGenerator({
-          url: env.MONGO_TEST_URL,
-          isCI: env.CI,
-          internalOptions: {
-            checksumOptions: options
-          }
-        })
-      );
-    });
-  }
-});

package/test/src/storage_compacting.test.ts

@@ -97,10 +97,25 @@ bucket_definitions:
       await populate(bucketStorage);
       const { checkpoint } = await bucketStorage.getCheckpoint();
 
-      await bucketStorage.populatePersistentChecksumCache({
+      // Default is to small small numbers - should be a no-op
+      const result0 = await bucketStorage.populatePersistentChecksumCache({
+        maxOpId: checkpoint
+      });
+      expect(result0.buckets).toEqual(0);
+
+      // This should cache the checksums for the two buckets
+      const result1 = await bucketStorage.populatePersistentChecksumCache({
+        maxOpId: checkpoint,
+        minBucketChanges: 1
+      });
+      expect(result1.buckets).toEqual(2);
+
+      // This should be a no-op, as the checksums are already cached
+      const result2 = await bucketStorage.populatePersistentChecksumCache({
         maxOpId: checkpoint,
-        signal: new AbortController().signal
+        minBucketChanges: 1
       });
+      expect(result2.buckets).toEqual(0);
 
       const checksumAfter = await bucketStorage.getChecksums(checkpoint, ['by_user2["u1"]', 'by_user2["u2"]']);
       expect(checksumAfter.get('by_user2["u1"]')).toEqual({

package/test/src/util.ts

@@ -1,8 +1,12 @@
 import { env } from './env.js';
+import { mongoTestReportStorageFactoryGenerator, mongoTestStorageFactoryGenerator } from '@module/utils/test-utils.js';
 
-import { MongoTestStorageFactoryGenerator } from '@module/storage/implementation/MongoTestStorageFactoryGenerator.js';
+export const INITIALIZED_MONGO_STORAGE_FACTORY = mongoTestStorageFactoryGenerator({
+  url: env.MONGO_TEST_URL,
+  isCI: env.CI
+});
 
-export const INITIALIZED_MONGO_STORAGE_FACTORY = MongoTestStorageFactoryGenerator({
+export const INITIALIZED_MONGO_REPORT_STORAGE_FACTORY = mongoTestReportStorageFactoryGenerator({
   url: env.MONGO_TEST_URL,
   isCI: env.CI
 });