@powersync/service-module-postgres-storage 0.10.7 → 0.10.9

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 report storage > Should create a connection event 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 report 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 report storage > Should update a connection event 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 report storage > Should update a connection event 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,233 @@
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import { POSTGRES_REPORT_STORAGE_FACTORY } from './util.js';
+import { event_types } from '@powersync/service-types';
+import { register, ReportUserData } from '@powersync/service-core-tests';
+import { PostgresReportStorage } from '../../src/storage/PostgresReportStorage.js';
+import { DateTimeValue } from '@powersync/service-sync-rules';
+
+const factory = await POSTGRES_REPORT_STORAGE_FACTORY();
+const userData = register.REPORT_TEST_USERS;
+const dates = register.REPORT_TEST_DATES;
+
+function removeVolatileFields(sdks: event_types.ClientConnection[]): Partial<event_types.ClientConnection>[] {
+  return sdks.map((sdk) => {
+    const { id, disconnected_at, connected_at, jwt_exp, ...rest } = sdk;
+    return {
+      ...rest
+    };
+  });
+}
+
+async function loadData(userData: ReportUserData, factory: PostgresReportStorage) {
+  await factory.db.sql`
+      INSERT INTO
+        connection_report_events (
+          user_id,
+          client_id,
+          connected_at,
+          sdk,
+          user_agent,
+          jwt_exp,
+          id,
+          disconnected_at
+        )
+      VALUES
+        (
+          ${{ type: 'varchar', value: userData.user_one.user_id }},
+          ${{ type: 'varchar', value: userData.user_one.client_id }},
+          ${{ type: 1184, value: userData.user_one.connected_at.toISOString() }},
+          ${{ type: 'varchar', value: userData.user_one.sdk }},
+          ${{ type: 'varchar', value: userData.user_one.user_agent }},
+          ${{ type: 1184, value: userData.user_one.jwt_exp.toISOString() }},
+          ${{ type: 'varchar', value: '1' }},
+          NULL
+        ),
+        (
+          ${{ type: 'varchar', value: userData.user_two.user_id }},
+          ${{ type: 'varchar', value: userData.user_two.client_id }},
+          ${{ type: 1184, value: userData.user_two.connected_at.toISOString() }},
+          ${{ type: 'varchar', value: userData.user_two.sdk }},
+          ${{ type: 'varchar', value: userData.user_two.user_agent }},
+          ${{ type: 1184, value: userData.user_two.jwt_exp.toISOString() }},
+          ${{ type: 'varchar', value: '2' }},
+          NULL
+        ),
+        (
+          ${{ type: 'varchar', value: userData.user_four.user_id }},
+          ${{ type: 'varchar', value: userData.user_four.client_id }},
+          ${{ type: 1184, value: userData.user_four.connected_at.toISOString() }},
+          ${{ type: 'varchar', value: userData.user_four.sdk }},
+          ${{ type: 'varchar', value: userData.user_four.user_agent }},
+          ${{ type: 1184, value: userData.user_four.jwt_exp.toISOString() }},
+          ${{ type: 'varchar', value: '4' }},
+          NULL
+        ),
+        (
+          ${{ type: 'varchar', value: userData.user_old.user_id }},
+          ${{ type: 'varchar', value: userData.user_old.client_id }},
+          ${{ type: 1184, value: userData.user_old.connected_at.toISOString() }},
+          ${{ type: 'varchar', value: userData.user_old.sdk }},
+          ${{ type: 'varchar', value: userData.user_old.user_agent }},
+          ${{ type: 1184, value: userData.user_old.jwt_exp.toISOString() }},
+          ${{ type: 'varchar', value: '5' }},
+          NULL
+        ),
+        (
+          ${{ type: 'varchar', value: userData.user_three.user_id }},
+          ${{ type: 'varchar', value: userData.user_three.client_id }},
+          ${{ type: 1184, value: userData.user_three.connected_at.toISOString() }},
+          ${{ type: 'varchar', value: userData.user_three.sdk }},
+          ${{ type: 'varchar', value: userData.user_three.user_agent }},
+          NULL,
+          ${{ type: 'varchar', value: '3' }},
+          ${{ type: 1184, value: userData.user_three.disconnected_at.toISOString() }}
+        ),
+        (
+          ${{ type: 'varchar', value: userData.user_week.user_id }},
+          ${{ type: 'varchar', value: userData.user_week.client_id }},
+          ${{ type: 1184, value: userData.user_week.connected_at.toISOString() }},
+          ${{ type: 'varchar', value: userData.user_week.sdk }},
+          ${{ type: 'varchar', value: userData.user_week.user_agent }},
+          NULL,
+          ${{ type: 'varchar', value: 'week' }},
+          ${{ type: 1184, value: userData.user_week.disconnected_at.toISOString() }}
+        ),
+        (
+          ${{ type: 'varchar', value: userData.user_month.user_id }},
+          ${{ type: 'varchar', value: userData.user_month.client_id }},
+          ${{ type: 1184, value: userData.user_month.connected_at.toISOString() }},
+          ${{ type: 'varchar', value: userData.user_month.sdk }},
+          ${{ type: 'varchar', value: userData.user_month.user_agent }},
+          NULL,
+          ${{ type: 'varchar', value: 'month' }},
+          ${{ type: 1184, value: userData.user_month.disconnected_at.toISOString() }}
+        ),
+        (
+          ${{ type: 'varchar', value: userData.user_expired.user_id }},
+          ${{ type: 'varchar', value: userData.user_expired.client_id }},
+          ${{ type: 1184, value: userData.user_expired.connected_at.toISOString() }},
+          ${{ type: 'varchar', value: userData.user_expired.sdk }},
+          ${{ type: 'varchar', value: userData.user_expired.user_agent }},
+          ${{ type: 1184, value: userData.user_expired.jwt_exp.toISOString() }},
+          ${{ type: 'varchar', value: 'expired' }},
+          NULL
+        )
+    `.execute();
+}
+
+async function deleteData(factory: PostgresReportStorage) {
+  await factory.db.sql`TRUNCATE TABLE connection_report_events`.execute();
+}
+
+beforeAll(async () => {
+  await loadData(userData, factory);
+});
+afterAll(async () => {
+  await deleteData(factory);
+});
+
+describe('Report storage tests', async () => {
+  await register.registerReportTests(factory);
+});
+
+describe('Connection report storage', async () => {
+  it('Should update a connection event 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 sdk = await factory.db
+      .sql`SELECT * FROM connection_report_events WHERE user_id = ${{ type: 'varchar', value: userData.user_one.user_id }} AND client_id = ${{ type: 'varchar', value: userData.user_one.client_id }}`.rows<event_types.ClientConnection>();
+    expect(sdk).toHaveLength(1);
+    expect(new Date((sdk[0].connected_at as unknown as DateTimeValue).iso8601Representation).toISOString()).toEqual(
+      newConnectAt.toISOString()
+    );
+    expect(new Date((sdk[0].jwt_exp! as unknown as DateTimeValue).iso8601Representation).toISOString()).toEqual(
+      jwtExp.toISOString()
+    );
+    expect(sdk[0].disconnected_at).toBeNull();
+    const cleaned = removeVolatileFields(sdk);
+    expect(cleaned).toMatchSnapshot();
+  });
+
+  it('Should update a connection event 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: dates.yesterday
+    });
+
+    const sdk = await factory.db
+      .sql`SELECT * FROM connection_report_events WHERE user_id = ${{ type: 'varchar', value: userData.user_three.user_id }}`.rows<event_types.ClientConnection>();
+    expect(sdk).toHaveLength(1);
+    console.log(sdk[0]);
+    expect(new Date((sdk[0].disconnected_at! as unknown as DateTimeValue).iso8601Representation).toISOString()).toEqual(
+      disconnectAt.toISOString()
+    );
+    const cleaned = removeVolatileFields(sdk);
+    expect(cleaned).toMatchSnapshot();
+  });
+
+  it('Should create a connection event 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 sdk = await factory.db
+      .sql`SELECT * FROM connection_report_events WHERE user_id = ${{ type: 'varchar', value: userData.user_week.user_id }}`.rows<event_types.ClientConnection>();
+    expect(sdk).toHaveLength(2);
+    const cleaned = removeVolatileFields(sdk);
+    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 sdk = await factory.getClientConnectionReports({
+      start: dates.monthAgo,
+      end: dates.now
+    });
+    expect(sdk).toMatchSnapshot();
+  });
+});

package/test/src/util.ts

@@ -1,12 +1,8 @@
 import path from 'path';
 import { fileURLToPath } from 'url';
-import { normalizePostgresStorageConfig } from '../../src//types/types.js';
-import { PostgresMigrationAgent } from '../../src/migrations/PostgresMigrationAgent.js';
-import {
-  postgresTestSetup,
-  PostgresTestStorageFactoryGenerator
-} from '../../src/storage/PostgresTestStorageFactoryGenerator.js';
+import { normalizePostgresStorageConfig, PostgresMigrationAgent } from '../../src/index.js';
 import { env } from './env.js';
+import { postgresTestSetup } from '../../src/utils/test-utils.js';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -37,3 +33,4 @@ export const POSTGRES_STORAGE_SETUP = postgresTestSetup({
 });
 
 export const POSTGRES_STORAGE_FACTORY = POSTGRES_STORAGE_SETUP.factory;
+export const POSTGRES_REPORT_STORAGE_FACTORY = POSTGRES_STORAGE_SETUP.reportFactory;

package/dist/storage/PostgresTestStorageFactoryGenerator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PostgresTestStorageFactoryGenerator.js","sourceRoot":"","sources":["../../src/storage/PostgresTestStorageFactoryGenerator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAiE,MAAM,yBAAyB,CAAC;AACnH,OAAO,EAAE,sBAAsB,EAAE,MAAM,yCAAyC,CAAC;AACjF,OAAO,EAAE,8BAA8B,EAAgC,MAAM,mBAAmB,CAAC;AACjG,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAWjF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,cAA0C,EAAE,EAAE;IAC9E,MAAM,WAAW,GAAG;QAClB,IAAI,EAAE,YAAqB;QAC3B,GAAG,EAAE,cAAc,CAAC,GAAG;QACvB,OAAO,EAAE,SAAkB;KAC5B,CAAC;IAEF,MAAM,uBAAuB,GAAG,8BAA8B,CAAC,WAAW,CAAC,CAAC;IAE5E,MAAM,OAAO,GAAG,KAAK,EAAE,SAAyC,EAAE,EAAE;;;YAClE,MAAY,gBAAgB,kCAA8B,IAAI,SAAS,CAAC,gBAAgB,EAAE,OAAA,CAAC;YAC3F,MAAY,cAAc,kCAAG,cAAc,CAAC,cAAc;gBACxD,CAAC,CAAC,cAAc,CAAC,cAAc,CAAC,WAAW,CAAC;gBAC5C,CAAC,CAAC,IAAI,sBAAsB,CAAC,WAAW,CAAC,OAAA,CAAC;YAC5C,gBAAgB,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;YAExD,MAAM,kBAAkB,GAAG,EAAE,aAAa,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,EAA+B,CAAC;YAEpG,MAAM,gBAAgB,CAAC,OAAO,CAAC;gBAC7B,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI;gBAC9C,gBAAgB,EAAE;oBAChB,eAAe,EAAE,kBAAkB;iBACpC;aACF,CAAC,CAAC;YAEH,IAAI,SAAS,IAAI,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC;gBACnD,MAAM,gBAAgB,CAAC,OAAO,CAAC;oBAC7B,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;oBAC5C,gBAAgB,EAAE;wBAChB,eAAe,EAAE,kBAAkB;qBACpC;iBACF,CAAC,CAAC;YACL,CAAC;;;;;;;;;;;KACF,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,KAAK,EAAE,OAA4B,EAAE,EAAE;YAC9C,IAAI,CAAC;gBACH,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;oBACzB,MAAM,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;gBACnD,CAAC;gBAED,OAAO,IAAI,4BAA4B,CAAC;oBACtC,MAAM,EAAE,uBAAuB;oBAC/B,gBAAgB,EAAE,OAAO;iBAC1B,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACZ,iFAAiF;gBACjF,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;gBAC5B,MAAM,EAAE,CAAC;YACX,CAAC;QACH,CAAC;QACD,OAAO;KACR,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,cAA0C,EAAE,EAAE;IAChG,OAAO,iBAAiB,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC;AACnD,CAAC,CAAC"}