@hot-updater/server 1.0.0-rc.16 → 1.0.0-rc.18

package/src/plugins/insights/testing/fixtures.ts

@@ -0,0 +1,30 @@
+import type { BundleEventRow } from "../eventRow";
+
+const fixtureId = (suffix: string): string =>
+  `00000000-0000-7000-8000-${suffix.padStart(12, "0")}`;
+
+/** An applied update from install `suffix`, received at `receivedAtMs`. */
+export const createBundleEventRowFixture = (
+  suffix: string,
+  receivedAtMs: number,
+): Extract<BundleEventRow, { type: "UPDATE_APPLIED" | "RECOVERED" }> => ({
+  id: fixtureId(suffix),
+  type: "UPDATE_APPLIED",
+  install_id: `install-${suffix}`,
+  user_id: null,
+  metadata: {
+    cohort: "0",
+    update_strategy: "appVersion",
+    fingerprint_hash: null,
+    sdk_version: null,
+  },
+  from_bundle_id: fixtureId(`${Number(suffix) + 1000}`),
+  from_release_id: null,
+  to_bundle_id: fixtureId(`${Number(suffix) + 2000}`),
+  to_release_id: null,
+  platform: "ios",
+  app_version: "1.0.0",
+  channel: "production",
+
+  received_at_ms: receivedAtMs,
+});

package/src/plugins/insights/testing/index.ts

@@ -0,0 +1,45 @@
+import { describe } from "vitest";
+
+import type { InsightsModel } from "../modelTypes";
+import { registerInsightsModelTests } from "./insightsModelTests";
+import { setupInsightsHttpTestSuite } from "./setupInsightsHttpTestSuite";
+import type { HttpTestClient } from "./types";
+
+export { createBundleEventRowFixture } from "./fixtures";
+export { setupInsightsHttpTestSuite } from "./setupInsightsHttpTestSuite";
+export { setupInsightsModelTestSuite } from "./setupInsightsModelTestSuite";
+export type {
+  DatabaseTestLifecycle,
+  DatabaseTestState,
+  HttpTestClient,
+  HttpTestRequest,
+} from "./types";
+
+/**
+ * The Insights plugin's tests, for `setupDatabaseTestSuite`'s `plugins`: its
+ * HTTP routes on the provider's server, which must run `insights()`, and
+ * with `createModel` its report contract on the provider's database, such as
+ * `(database) => createInsightsModel(createDatabasePluginApis(database,
+ * [insights()]).insights)`.
+ */
+export const insightsTestSuite = <TDatabase = unknown>(
+  options: {
+    readonly createModel?: (database: TDatabase) => InsightsModel;
+  } = {},
+) => ({
+  name: "Insights plugin",
+  register: (context: {
+    readonly getClient: () => HttpTestClient;
+    readonly getDatabase: () => TDatabase;
+  }): void => {
+    setupInsightsHttpTestSuite({ getClient: context.getClient });
+    const { createModel } = options;
+    if (createModel !== undefined) {
+      describe("Insights model", () => {
+        registerInsightsModelTests({
+          getDatabase: () => createModel(context.getDatabase()),
+        });
+      });
+    }
+  },
+});