@powersync/service-module-postgres-storage 0.0.0-dev-20250730153301 → 0.0.0-dev-20250804094552

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

@@ -1,11 +1,339 @@
-import { beforeAll, describe, it } from 'vitest';
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
 import { POSTGRES_REPORT_STORAGE_FACTORY } from './util.js';
+import { event_types } from '@powersync/service-types';
+
+function removeVolatileFields(sdks: event_types.SdkConnectDocument[]): Partial<event_types.SdkConnectDocument>[] {
+  return sdks.map((sdk) => {
+    const { id, disconnect_at, connect_at, jwt_exp, ...rest } = sdk;
+    return {
+      ...rest
+    };
+  });
+}
+
+describe('SDK reporting storage', async () => {
+  const factory = await POSTGRES_REPORT_STORAGE_FACTORY();
+  const now = new Date();
+  const nowAdd5minutes = new Date(
+    now.getFullYear(),
+    now.getMonth(),
+    now.getDate(),
+    now.getHours(),
+    now.getMinutes() + 5
+  );
+  const nowLess5minutes = new Date(
+    now.getFullYear(),
+    now.getMonth(),
+    now.getDate(),
+    now.getHours(),
+    now.getMinutes() - 5
+  );
+  const yesterday = new Date(now.getFullYear(), now.getMonth(), now.getDate() - 1);
+  const weekAgo = new Date(now.getFullYear(), now.getMonth(), now.getDate() - 7);
+  const monthAgo = new Date(now.getFullYear(), now.getMonth() - 1, now.getDate());
+  const user_one = {
+    user_id: 'user_one',
+    client_id: 'client_one',
+    connect_at: now.toISOString(),
+    sdk: 'powersync-dart/1.6.4',
+    user_agent: 'powersync-dart/1.6.4 Dart (flutter-web) Chrome/128 android',
+    jwt_exp: nowAdd5minutes.toISOString(),
+    id: '1'
+  };
+  const user_two = {
+    user_id: 'user_two',
+    client_id: 'client_two',
+    connect_at: nowLess5minutes.toISOString(),
+    sdk: 'powersync-js/1.21.1',
+    user_agent: 'powersync-js/1.21.0 powersync-web Chromium/138 linux',
+    jwt_exp: nowAdd5minutes.toISOString(),
+    id: '2'
+  };
+  const user_three = {
+    user_id: 'user_three',
+    client_id: 'client_three',
+    connect_at: yesterday.toISOString(),
+    sdk: 'powersync-js/1.21.2',
+    user_agent: 'powersync-js/1.21.0 powersync-web Firefox/141 linux',
+    disconnect_at: yesterday.toISOString(),
+    id: '3'
+  };
+
+  const user_four = {
+    user_id: 'user_four',
+    client_id: 'client_four',
+    connect_at: now.toISOString(),
+    sdk: 'powersync-js/1.21.4',
+    user_agent: 'powersync-js/1.21.0 powersync-web Firefox/141 linux',
+    jwt_exp: nowLess5minutes.toISOString(),
+    id: '4'
+  };
+
+  const user_week = {
+    user_id: 'user_week',
+    client_id: 'client_week',
+    connect_at: weekAgo.toISOString(),
+    sdk: 'powersync-js/1.24.5',
+    user_agent: 'powersync-js/1.21.0 powersync-web Firefox/141 linux',
+    disconnect_at: weekAgo.toISOString(),
+    id: 'week'
+  };
+
+  const user_month = {
+    user_id: 'user_month',
+    client_id: 'client_month',
+    connect_at: monthAgo.toISOString(),
+    sdk: 'powersync-js/1.23.6',
+    user_agent: 'powersync-js/1.23.0 powersync-web Firefox/141 linux',
+    disconnect_at: monthAgo.toISOString(),
+    id: 'month'
+  };
+
+  const user_expired = {
+    user_id: 'user_expired',
+    client_id: 'client_expired',
+    connect_at: monthAgo.toISOString(),
+    sdk: 'powersync-js/1.23.7',
+    user_agent: 'powersync-js/1.23.0 powersync-web Firefox/141 linux',
+    jwt_exp: monthAgo.toISOString(),
+    id: 'expired'
+  };
+
+  async function loadData() {
+    await factory.db.sql`
+      INSERT INTO
+        sdk_report_events (
+          user_id,
+          client_id,
+          connect_at,
+          sdk,
+          user_agent,
+          jwt_exp,
+          id,
+          disconnect_at
+        )
+      VALUES
+        (
+          ${{ type: 'varchar', value: user_one.user_id }},
+          ${{ type: 'varchar', value: user_one.client_id }},
+          ${{ type: 1184, value: user_one.connect_at }},
+          ${{ type: 'varchar', value: user_one.sdk }},
+          ${{ type: 'varchar', value: user_one.user_agent }},
+          ${{ type: 1184, value: user_one.jwt_exp }},
+          ${{ type: 'varchar', value: user_one.id }},
+          NULL
+        ),
+        (
+          ${{ type: 'varchar', value: user_two.user_id }},
+          ${{ type: 'varchar', value: user_two.client_id }},
+          ${{ type: 1184, value: user_two.connect_at }},
+          ${{ type: 'varchar', value: user_two.sdk }},
+          ${{ type: 'varchar', value: user_two.user_agent }},
+          ${{ type: 1184, value: user_two.jwt_exp }},
+          ${{ type: 'varchar', value: user_two.id }},
+          NULL
+        ),
+        (
+          ${{ type: 'varchar', value: user_four.user_id }},
+          ${{ type: 'varchar', value: user_four.client_id }},
+          ${{ type: 1184, value: user_four.connect_at }},
+          ${{ type: 'varchar', value: user_four.sdk }},
+          ${{ type: 'varchar', value: user_four.user_agent }},
+          ${{ type: 1184, value: user_four.jwt_exp }},
+          ${{ type: 'varchar', value: user_four.id }},
+          NULL
+        ),
+        (
+          ${{ type: 'varchar', value: user_three.user_id }},
+          ${{ type: 'varchar', value: user_three.client_id }},
+          ${{ type: 1184, value: user_three.connect_at }},
+          ${{ type: 'varchar', value: user_three.sdk }},
+          ${{ type: 'varchar', value: user_three.user_agent }},
+          NULL,
+          ${{ type: 'varchar', value: user_three.id }},
+          ${{ type: 1184, value: user_three.disconnect_at }}
+        ),
+        (
+          ${{ type: 'varchar', value: user_week.user_id }},
+          ${{ type: 'varchar', value: user_week.client_id }},
+          ${{ type: 1184, value: user_week.connect_at }},
+          ${{ type: 'varchar', value: user_week.sdk }},
+          ${{ type: 'varchar', value: user_week.user_agent }},
+          NULL,
+          ${{ type: 'varchar', value: user_week.id }},
+          ${{ type: 1184, value: user_week.disconnect_at }}
+        ),
+        (
+          ${{ type: 'varchar', value: user_month.user_id }},
+          ${{ type: 'varchar', value: user_month.client_id }},
+          ${{ type: 1184, value: user_month.connect_at }},
+          ${{ type: 'varchar', value: user_month.sdk }},
+          ${{ type: 'varchar', value: user_month.user_agent }},
+          NULL,
+          ${{ type: 'varchar', value: user_month.id }},
+          ${{ type: 1184, value: user_month.disconnect_at }}
+        ),
+        (
+          ${{ type: 'varchar', value: user_expired.user_id }},
+          ${{ type: 'varchar', value: user_expired.client_id }},
+          ${{ type: 1184, value: user_expired.connect_at }},
+          ${{ type: 'varchar', value: user_expired.sdk }},
+          ${{ type: 'varchar', value: user_expired.user_agent }},
+          ${{ type: 1184, value: user_expired.jwt_exp }},
+          ${{ type: 'varchar', value: user_expired.id }},
+          NULL
+        )
+    `.execute();
+  }
+
+  function deleteData() {
+    return factory.db.sql`TRUNCATE TABLE sdk_report_events`.execute();
+  }
 
-describe('SDK reporting storage', () => {
   beforeAll(async () => {
-    const { db } = await POSTGRES_REPORT_STORAGE_FACTORY();
+    await loadData();
+  });
+
+  afterAll(async () => {
+    await deleteData();
+  });
+  it('Should show connected users with start range', async () => {
+    const current = await factory.listCurrentConnections({
+      range: {
+        start_date: new Date(
+          now.getFullYear(),
+          now.getMonth(),
+          now.getDate(),
+          now.getHours(),
+          now.getMinutes() - 1
+        ).toISOString()
+      }
+    });
+    expect(current).toMatchSnapshot();
+  });
+  it('Should show connected users with start range and end range', async () => {
+    const current = await factory.listCurrentConnections({
+      range: {
+        end_date: nowLess5minutes.toISOString(),
+        start_date: new Date(
+          now.getFullYear(),
+          now.getMonth(),
+          now.getDate(),
+          now.getHours(),
+          now.getMinutes() - 6
+        ).toISOString()
+      }
+    });
+    expect(current).toMatchSnapshot();
+  });
+  it('Should show SDK scrape data for user over the past month', async () => {
+    const sdk = await factory.scrapeSdkData({
+      interval: 1,
+      timeframe: 'month'
+    });
+    expect(sdk).toMatchSnapshot();
   });
-  it('Should have tables declared', async () => {
-    const { db } = await POSTGRES_REPORT_STORAGE_FACTORY();
+  it('Should show SDK scrape data for user over the past week', async () => {
+    const sdk = await factory.scrapeSdkData({
+      interval: 1,
+      timeframe: 'week'
+    });
+    expect(sdk).toMatchSnapshot();
+  });
+  it('Should show SDK scrape data for user over the past day', async () => {
+    const sdk = await factory.scrapeSdkData({
+      interval: 1,
+      timeframe: 'day'
+    });
+    expect(sdk).toMatchSnapshot();
+  });
+
+  it('Should update a sdk event if its within a day', async () => {
+    const newConnectAt = new Date(
+      now.getFullYear(),
+      now.getMonth(),
+      now.getDate(),
+      now.getHours(),
+      now.getMinutes() + 20
+    );
+    const jwtExp = new Date(newConnectAt.getFullYear(), newConnectAt.getMonth(), newConnectAt.getDate() + 1);
+    await factory.reportSdkConnect({
+      sdk: user_one.sdk,
+      connect_at: newConnectAt,
+      jwt_exp: jwtExp,
+      client_id: user_one.client_id,
+      user_id: user_one.user_id,
+      user_agent: user_one.user_agent
+    });
+
+    const sdk = await factory.db
+      .sql`SELECT * FROM sdk_report_events WHERE user_id = ${{ type: 'varchar', value: user_one.user_id }}`.rows<event_types.SdkConnectDocument>();
+    expect(sdk).toHaveLength(1);
+    expect(new Date(sdk[0].connect_at).toISOString()).toEqual(newConnectAt.toISOString());
+    expect(new Date(sdk[0].jwt_exp!).toISOString()).toEqual(jwtExp.toISOString());
+    expect(sdk[0].disconnect_at).toBeNull();
+    const cleaned = removeVolatileFields(sdk);
+    expect(cleaned).toMatchSnapshot();
+  });
+
+  it('Should update a connected sdk event and make it disconnected', async () => {
+    const disconnectAt = new Date(
+      now.getFullYear(),
+      now.getMonth(),
+      now.getDate(),
+      now.getHours(),
+      now.getMinutes() + 20
+    );
+    const jwtExp = new Date(disconnectAt.getFullYear(), disconnectAt.getMonth(), disconnectAt.getDate() + 1);
+
+    await factory.reportSdkDisconnect({
+      disconnect_at: disconnectAt,
+      jwt_exp: jwtExp,
+      client_id: user_three.client_id,
+      user_id: user_three.user_id,
+      user_agent: user_three.user_agent,
+      connect_at: yesterday
+    });
+
+    const sdk = await factory.db
+      .sql`SELECT * FROM sdk_report_events WHERE user_id = ${{ type: 'varchar', value: user_three.user_id }}`.rows<event_types.SdkConnectDocument>();
+    expect(sdk).toHaveLength(1);
+    expect(new Date(sdk[0].disconnect_at!).toISOString()).toEqual(disconnectAt.toISOString());
+    const cleaned = removeVolatileFields(sdk);
+    expect(cleaned).toMatchSnapshot();
+  });
+
+  it('Should create a sdk event if its after a day', async () => {
+    const newConnectAt = new Date(now.getFullYear(), now.getMonth(), now.getDate() + 1, now.getHours());
+    const jwtExp = new Date(newConnectAt.getFullYear(), newConnectAt.getMonth(), newConnectAt.getDate() + 1);
+
+    await factory.reportSdkConnect({
+      sdk: user_week.sdk,
+      connect_at: newConnectAt,
+      jwt_exp: jwtExp,
+      client_id: user_week.client_id,
+      user_id: user_week.user_id,
+      user_agent: user_week.user_agent
+    });
+
+    const sdk = await factory.db
+      .sql`SELECT * FROM sdk_report_events WHERE user_id = ${{ type: 'varchar', value: user_week.user_id }}`.rows<event_types.SdkConnectDocument>();
+    expect(sdk).toHaveLength(2);
+    const cleaned = removeVolatileFields(sdk);
+    expect(cleaned).toMatchSnapshot();
+  });
+
+  it('Should delete rows older than specified range', async () => {
+    await deleteData();
+    await loadData();
+    await factory.deleteOldSdkData({
+      interval: 1,
+      timeframe: 'week'
+    });
+    const sdk = await factory.scrapeSdkData({
+      interval: 1,
+      timeframe: 'month'
+    });
+    expect(sdk).toMatchSnapshot();
   });
 });

package/test/src/util.ts

@@ -1,8 +1,6 @@
 import path from 'path';
 import { fileURLToPath } from 'url';
-import { normalizePostgresStorageConfig } from '../../src//types/types.js';
-import { PostgresMigrationAgent } from '../../src/migrations/PostgresMigrationAgent.js';
-import { postgresTestSetup } from '../../src/storage/PostgresTestStorageFactoryGenerator.js';
+import { normalizePostgresStorageConfig, PostgresMigrationAgent, postgresTestSetup } from '../../src/index.js';
 import { env } from './env.js';
 
 const __filename = fileURLToPath(import.meta.url);

package/dist/@types/migrations/scripts/1753871047719-sdk_report.d.ts

@@ -1,3 +0,0 @@
-import { migrations } from '@powersync/service-core';
-export declare const up: migrations.PowerSyncMigrationFunction;
-export declare const down: migrations.PowerSyncMigrationFunction;

package/dist/migrations/scripts/1753871047719-sdk_report.js

@@ -1,109 +0,0 @@
-var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
-    if (value !== null && value !== void 0) {
-        if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
-        var dispose, inner;
-        if (async) {
-            if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
-            dispose = value[Symbol.asyncDispose];
-        }
-        if (dispose === void 0) {
-            if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
-            dispose = value[Symbol.dispose];
-            if (async) inner = dispose;
-        }
-        if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
-        if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
-        env.stack.push({ value: value, dispose: dispose, async: async });
-    }
-    else if (async) {
-        env.stack.push({ async: true });
-    }
-    return value;
-};
-var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
-    return function (env) {
-        function fail(e) {
-            env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
-            env.hasError = true;
-        }
-        var r, s = 0;
-        function next() {
-            while (r = env.stack.pop()) {
-                try {
-                    if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
-                    if (r.dispose) {
-                        var result = r.dispose.call(r.value);
-                        if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
-                    }
-                    else s |= 1;
-                }
-                catch (e) {
-                    fail(e);
-                }
-            }
-            if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
-            if (env.hasError) throw env.error;
-        }
-        return next();
-    };
-})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-});
-import { openMigrationDB } from '../migration-utils.js';
-export const up = async (context) => {
-    const env_1 = { stack: [], error: void 0, hasError: false };
-    try {
-        const { service_context: { configuration } } = context;
-        const client = __addDisposableResource(env_1, openMigrationDB(configuration.storage), true);
-        await client.transaction(async (db) => {
-            await db.sql `
-      CREATE TABLE IF NOT EXISTS sdk_report_events (
-        id TEXT PRIMARY KEY,
-        user_agent TEXT NOT NULL,
-        client_id TEXT NOT NULL,
-        user_id TEXT NOT NULL,
-        sdk TEXT NOT NULL,
-        jwt_exp TIMESTAMP WITH TIME ZONE,
-        connect_at TIMESTAMP WITH TIME ZONE NOT NULL,
-        disconnect_at TIMESTAMP WITH TIME ZONE
-      )
-    `.execute();
-            await db.sql `
-      CREATE INDEX IF NOT EXISTS sdk_list_index ON sdk_report_events (connect_at, jwt_exp, disconnect_at)
-    `.execute();
-            await db.sql `CREATE INDEX IF NOT EXISTS sdk_user_id_index ON sdk_report_events (user_id)`.execute();
-            await db.sql `CREATE INDEX IF NOT EXISTS sdk_client_id_index ON sdk_report_events (client_id)`.execute();
-            await db.sql `CREATE INDEX IF NOT EXISTS sdk_index ON sdk_report_events (sdk)`.execute();
-        });
-    }
-    catch (e_1) {
-        env_1.error = e_1;
-        env_1.hasError = true;
-    }
-    finally {
-        const result_1 = __disposeResources(env_1);
-        if (result_1)
-            await result_1;
-    }
-};
-export const down = async (context) => {
-    const env_2 = { stack: [], error: void 0, hasError: false };
-    try {
-        const { service_context: { configuration } } = context;
-        const client = __addDisposableResource(env_2, openMigrationDB(configuration.storage), true);
-        client.lockConnection(async (db) => {
-            await db.sql `DROP TABLE IF EXISTS sdk_report_events`.execute();
-        });
-    }
-    catch (e_2) {
-        env_2.error = e_2;
-        env_2.hasError = true;
-    }
-    finally {
-        const result_2 = __disposeResources(env_2);
-        if (result_2)
-            await result_2;
-    }
-};
-//# sourceMappingURL=1753871047719-sdk_report.js.map

package/dist/migrations/scripts/1753871047719-sdk_report.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"1753871047719-sdk_report.js","sourceRoot":"","sources":["../../../src/migrations/scripts/1753871047719-sdk_report.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,CAAC,MAAM,EAAE,GAA0C,KAAK,EAAE,OAAO,EAAE,EAAE;;;QACzE,MAAM,EACJ,eAAe,EAAE,EAAE,aAAa,EAAE,EACnC,GAAG,OAAO,CAAC;QACZ,MAAY,MAAM,kCAAG,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,OAAA,CAAC;QAE5D,MAAM,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YACpC,MAAM,EAAE,CAAC,GAAG,CAAA;;;;;;;;;;;KAWX,CAAC,OAAO,EAAE,CAAC;YAEZ,MAAM,EAAE,CAAC,GAAG,CAAA;;KAEX,CAAC,OAAO,EAAE,CAAC;YAEZ,MAAM,EAAE,CAAC,GAAG,CAAA,6EAA6E,CAAC,OAAO,EAAE,CAAC;YAEpG,MAAM,EAAE,CAAC,GAAG,CAAA,iFAAiF,CAAC,OAAO,EAAE,CAAC;YAExG,MAAM,EAAE,CAAC,GAAG,CAAA,iEAAiE,CAAC,OAAO,EAAE,CAAC;QAC1F,CAAC,CAAC,CAAC;;;;;;;;;;;CACJ,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAA0C,KAAK,EAAE,OAAO,EAAE,EAAE;;;QAC3E,MAAM,EACJ,eAAe,EAAE,EAAE,aAAa,EAAE,EACnC,GAAG,OAAO,CAAC;QACZ,MAAY,MAAM,kCAAG,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,OAAA,CAAC;QAC5D,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YACjC,MAAM,EAAE,CAAC,GAAG,CAAA,wCAAwC,CAAC,OAAO,EAAE,CAAC;QACjE,CAAC,CAAC,CAAC;;;;;;;;;;;CACJ,CAAC"}

package/src/migrations/scripts/1753871047719-sdk_report.ts

@@ -1,45 +0,0 @@
-import { migrations } from '@powersync/service-core';
-
-import { openMigrationDB } from '../migration-utils.js';
-
-export const up: migrations.PowerSyncMigrationFunction = async (context) => {
-  const {
-    service_context: { configuration }
-  } = context;
-  await using client = openMigrationDB(configuration.storage);
-
-  await client.transaction(async (db) => {
-    await db.sql`
-      CREATE TABLE IF NOT EXISTS sdk_report_events (
-        id TEXT PRIMARY KEY,
-        user_agent TEXT NOT NULL,
-        client_id TEXT NOT NULL,
-        user_id TEXT NOT NULL,
-        sdk TEXT NOT NULL,
-        jwt_exp TIMESTAMP WITH TIME ZONE,
-        connect_at TIMESTAMP WITH TIME ZONE NOT NULL,
-        disconnect_at TIMESTAMP WITH TIME ZONE
-      )
-    `.execute();
-
-    await db.sql`
-      CREATE INDEX IF NOT EXISTS sdk_list_index ON sdk_report_events (connect_at, jwt_exp, disconnect_at)
-    `.execute();
-
-    await db.sql`CREATE INDEX IF NOT EXISTS sdk_user_id_index ON sdk_report_events (user_id)`.execute();
-
-    await db.sql`CREATE INDEX IF NOT EXISTS sdk_client_id_index ON sdk_report_events (client_id)`.execute();
-
-    await db.sql`CREATE INDEX IF NOT EXISTS sdk_index ON sdk_report_events (sdk)`.execute();
-  });
-};
-
-export const down: migrations.PowerSyncMigrationFunction = async (context) => {
-  const {
-    service_context: { configuration }
-  } = context;
-  await using client = openMigrationDB(configuration.storage);
-  client.lockConnection(async (db) => {
-    await db.sql`DROP TABLE IF EXISTS sdk_report_events`.execute();
-  });
-};