@hot-updater/test-utils 1.0.0-rc.40 → 1.0.0-rc.41

package/dist/index.mjs

@@ -2797,6 +2797,21 @@ const createMeasuredDatabase = async (adapter, plugins, options = {}) => {
 };
 //#endregion
 //#region src/setupReadBudgetTestSuite.ts
+/** A published template: a greeting that beta devices get another value of. */
+const remoteConfigTemplate = (greeting) => ({
+	conditions: [{
+		name: "Beta",
+		rules: [{
+			type: "channel",
+			channels: ["beta"]
+		}]
+	}],
+	parameters: { greeting: {
+		valueType: "STRING",
+		defaultValue: { value: greeting },
+		conditionalValues: { Beta: { value: `${greeting}, tester` } }
+	} }
+});
 const DAY = 864e5;
 const HOUR = 36e5;
 /** The UTC midnight Insights events start at. */
@@ -2967,11 +2982,20 @@ const seed = async (database) => {
 	await api.insights.recordEvent(failureOf(1, 3));
 	await api.insights.recordEvent(failureOf(2, 5));
 	await api.insights.recordEvent(failureOf(3, 7, true));
+	for (const [baseVersion, greeting] of [
+		"Hi",
+		"Hello",
+		"Hey"
+	].entries()) await api.remoteConfig.publish({
+		template: remoteConfigTemplate(greeting),
+		baseVersion
+	});
 	const channel = (name) => core.findChannelByName(name).then((found) => found);
 	const productionId = (await channel("production")).id;
 	return {
 		core,
 		insights: api.insights,
+		remoteConfig: api.remoteConfig,
 		clientAuth: database.clientAuth,
 		apiKey,
 		productionId,
@@ -3024,6 +3048,33 @@ const READ_BUDGETS = [
 		},
 		check: (catalog) => expect(catalog?.releases).toHaveLength(4)
 	}),
+	budget({
+		api: "remote config fetch: 1 point read of the active template",
+		read: ({ remoteConfig }) => remoteConfig.resolve({
+			platform: "ios",
+			channel: "beta"
+		}),
+		adapter: reads(1, 1, 0, 0),
+		engine: {
+			calls: 1,
+			rows: 1
+		},
+		check: (resolved) => expect(resolved).toEqual({
+			version: 3,
+			values: { greeting: "Hey, tester" }
+		})
+	}),
+	budget({
+		api: "remote config versions page: limit rows from one query",
+		read: ({ remoteConfig }) => remoteConfig.listVersions({ limit: 2 }),
+		adapter: reads(0, 0, 1, 2),
+		engine: {
+			calls: 1,
+			rows: 2
+		},
+		returned: (page) => page.versions.length,
+		check: (page) => expect(page.versions.map(({ version }) => version)).toEqual([3, 2])
+	}),
 	budget({
 		api: "artifact resolution: 1 batch get of 2 bundles and 1 unique patch read",
 		read: ({ core }) => core.getArtifactInfo(createBundleFixture("106").id, createBundleFixture("105").id, 1),
@@ -3428,8 +3479,16 @@ const setupReadBudgetTestSuite = (options) => {
 		let seeded;
 		let writes = 0;
 		beforeAll(async () => {
-			const [{ insights }, { apiKeys }] = await Promise.all([import("@hot-updater/server/plugins/insights"), import("@hot-updater/server/plugins/api-keys")]);
-			const plugins = [insights(), apiKeys()];
+			const [{ insights }, { apiKeys }, { remoteConfig }] = await Promise.all([
+				import("@hot-updater/server/plugins/insights"),
+				import("@hot-updater/server/plugins/api-keys"),
+				import("@hot-updater/server/plugins/remote-config")
+			]);
+			const plugins = [
+				insights(),
+				apiKeys(),
+				remoteConfig()
+			];
 			created = await options.createAdapter({
 				tables: [...toolingTargetOf(plugins).schema.tables, SETTINGS_TABLE],
 				nativePageSize: NATIVE_PAGE_SIZE

package/dist/react-native.cjs

@@ -12,6 +12,7 @@ let _hot_updater_protocol = require("@hot-updater/protocol");
 * runtime.hooks.onAppReady(launch);
 * await runtime.settled();
 * expect(runtime.requests[0]?.json()).toEqual(expectedEvent);
+* runtime.api.someMethod(); // the API the plugin adds as hotUpdater.<id>
 * ```
 *
 * It sets plugins up with the plugin host from `@hot-updater/protocol`,
@@ -139,7 +140,7 @@ const setupClientPlugins = (plugins, options = {}) => {
 		},
 		now: () => options.now ? options.now() : Date.now()
 	});
-	host.configurePlugins(plugins, {
+	const apis = host.configurePlugins(plugins, {
 		baseURL,
 		requestHeaders: options.requestHeaders,
 		requestTimeout: options.requestTimeout,
@@ -151,6 +152,7 @@ const setupClientPlugins = (plugins, options = {}) => {
 		for (const settlement of host.dispatchPluginHook(name, payload)) track(settlement);
 	};
 	return {
+		apis,
 		hooks: {
 			onAppReady: call("onAppReady"),
 			onUpdateCheck: call("onUpdateCheck"),
@@ -171,8 +173,15 @@ const setupClientPlugins = (plugins, options = {}) => {
 		}
 	};
 };
-/** Sets one plugin up; see `setupClientPlugins`. */
-const setupClientPlugin = (plugin, options) => setupClientPlugins([plugin], options);
+/** Sets one plugin up; see `setupClientPlugins`. `api` is the plugin's API. */
+const setupClientPlugin = (plugin, options) => {
+	const runtime = setupClientPlugins([plugin], options);
+	const apis = runtime.apis;
+	return {
+		...runtime,
+		api: apis[plugin.id]
+	};
+};
 //#endregion
 exports.createTestStorage = createTestStorage;
 exports.setupClientPlugin = setupClientPlugin;

package/dist/react-native.d.cts

@@ -1,4 +1,4 @@
-import { AppReadyResult, BundleDownloadedInfo, HotUpdaterBaseURL, HotUpdaterClientPlugin, UpdateCheckResult, UpdateError, UpdateHttpResponse } from "@hot-updater/protocol";
+import { AppReadyResult, BundleDownloadedInfo, ClientPluginApi, ClientPluginApis, HotUpdaterBaseURL, HotUpdaterClientPlugin, UpdateCheckResult, UpdateError, UpdateHttpResponse } from "@hot-updater/protocol";
 //#region src/setupClientPlugins.d.ts
 /** A value the test fixes, or reads each time a plugin asks for it. */
 type TestValue<T> = T | (() => T);
@@ -77,7 +77,12 @@ interface ClientPluginTestHooks {
   onHttpResponse(response: UpdateHttpResponse): void;
 }
 /** One JavaScript runtime with the plugins set up, as after `HotUpdater.init`. */
-interface ClientPluginTestRuntime {
+interface ClientPluginTestRuntime<TApis = Readonly<Record<string, unknown>>> {
+  /**
+   * The plugins' APIs by plugin id, as the instance `HotUpdater.init`
+   * returns has them.
+   */
+  readonly apis: TApis;
   /**
    * Calls a hook on every plugin that returned it, as the SDK does: without
    * waiting for it, and with a throw or rejection recorded in `errors`
@@ -104,8 +109,10 @@ interface ClientPluginTestRuntime {
 /** A new device's empty plugin storage. */
 declare const createTestStorage: () => ClientPluginTestStorage;
 /** Sets plugins up as `HotUpdater.init({ plugins })` does, in a new runtime. */
-declare const setupClientPlugins: (plugins: readonly HotUpdaterClientPlugin[], options?: ClientPluginTestOptions) => ClientPluginTestRuntime;
-/** Sets one plugin up; see `setupClientPlugins`. */
-declare const setupClientPlugin: (plugin: HotUpdaterClientPlugin, options?: ClientPluginTestOptions) => ClientPluginTestRuntime;
+declare const setupClientPlugins: <const TPlugins extends readonly HotUpdaterClientPlugin[]>(plugins: TPlugins, options?: ClientPluginTestOptions) => ClientPluginTestRuntime<ClientPluginApis<TPlugins>>;
+/** Sets one plugin up; see `setupClientPlugins`. `api` is the plugin's API. */
+declare const setupClientPlugin: <const P extends HotUpdaterClientPlugin>(plugin: P, options?: ClientPluginTestOptions) => ClientPluginTestRuntime<ClientPluginApis<readonly [P]>> & {
+  readonly api: ClientPluginApi<P>;
+};
 //#endregion
 export { ClientPluginTestHooks, ClientPluginTestOptions, ClientPluginTestRequest, ClientPluginTestRuntime, ClientPluginTestStorage, createTestStorage, setupClientPlugin, setupClientPlugins };

package/dist/react-native.d.mts

@@ -1,4 +1,4 @@
-import { AppReadyResult, BundleDownloadedInfo, HotUpdaterBaseURL, HotUpdaterClientPlugin, UpdateCheckResult, UpdateError, UpdateHttpResponse } from "@hot-updater/protocol";
+import { AppReadyResult, BundleDownloadedInfo, ClientPluginApi, ClientPluginApis, HotUpdaterBaseURL, HotUpdaterClientPlugin, UpdateCheckResult, UpdateError, UpdateHttpResponse } from "@hot-updater/protocol";
 //#region src/setupClientPlugins.d.ts
 /** A value the test fixes, or reads each time a plugin asks for it. */
 type TestValue<T> = T | (() => T);
@@ -77,7 +77,12 @@ interface ClientPluginTestHooks {
   onHttpResponse(response: UpdateHttpResponse): void;
 }
 /** One JavaScript runtime with the plugins set up, as after `HotUpdater.init`. */
-interface ClientPluginTestRuntime {
+interface ClientPluginTestRuntime<TApis = Readonly<Record<string, unknown>>> {
+  /**
+   * The plugins' APIs by plugin id, as the instance `HotUpdater.init`
+   * returns has them.
+   */
+  readonly apis: TApis;
   /**
    * Calls a hook on every plugin that returned it, as the SDK does: without
    * waiting for it, and with a throw or rejection recorded in `errors`
@@ -104,8 +109,10 @@ interface ClientPluginTestRuntime {
 /** A new device's empty plugin storage. */
 declare const createTestStorage: () => ClientPluginTestStorage;
 /** Sets plugins up as `HotUpdater.init({ plugins })` does, in a new runtime. */
-declare const setupClientPlugins: (plugins: readonly HotUpdaterClientPlugin[], options?: ClientPluginTestOptions) => ClientPluginTestRuntime;
-/** Sets one plugin up; see `setupClientPlugins`. */
-declare const setupClientPlugin: (plugin: HotUpdaterClientPlugin, options?: ClientPluginTestOptions) => ClientPluginTestRuntime;
+declare const setupClientPlugins: <const TPlugins extends readonly HotUpdaterClientPlugin[]>(plugins: TPlugins, options?: ClientPluginTestOptions) => ClientPluginTestRuntime<ClientPluginApis<TPlugins>>;
+/** Sets one plugin up; see `setupClientPlugins`. `api` is the plugin's API. */
+declare const setupClientPlugin: <const P extends HotUpdaterClientPlugin>(plugin: P, options?: ClientPluginTestOptions) => ClientPluginTestRuntime<ClientPluginApis<readonly [P]>> & {
+  readonly api: ClientPluginApi<P>;
+};
 //#endregion
 export { ClientPluginTestHooks, ClientPluginTestOptions, ClientPluginTestRequest, ClientPluginTestRuntime, ClientPluginTestStorage, createTestStorage, setupClientPlugin, setupClientPlugins };

package/dist/react-native.mjs

@@ -11,6 +11,7 @@ import { createPluginHost, pluginStorageKey, resolveBaseURL } from "@hot-updater
 * runtime.hooks.onAppReady(launch);
 * await runtime.settled();
 * expect(runtime.requests[0]?.json()).toEqual(expectedEvent);
+* runtime.api.someMethod(); // the API the plugin adds as hotUpdater.<id>
 * ```
 *
 * It sets plugins up with the plugin host from `@hot-updater/protocol`,
@@ -138,7 +139,7 @@ const setupClientPlugins = (plugins, options = {}) => {
 		},
 		now: () => options.now ? options.now() : Date.now()
 	});
-	host.configurePlugins(plugins, {
+	const apis = host.configurePlugins(plugins, {
 		baseURL,
 		requestHeaders: options.requestHeaders,
 		requestTimeout: options.requestTimeout,
@@ -150,6 +151,7 @@ const setupClientPlugins = (plugins, options = {}) => {
 		for (const settlement of host.dispatchPluginHook(name, payload)) track(settlement);
 	};
 	return {
+		apis,
 		hooks: {
 			onAppReady: call("onAppReady"),
 			onUpdateCheck: call("onUpdateCheck"),
@@ -170,7 +172,14 @@ const setupClientPlugins = (plugins, options = {}) => {
 		}
 	};
 };
-/** Sets one plugin up; see `setupClientPlugins`. */
-const setupClientPlugin = (plugin, options) => setupClientPlugins([plugin], options);
+/** Sets one plugin up; see `setupClientPlugins`. `api` is the plugin's API. */
+const setupClientPlugin = (plugin, options) => {
+	const runtime = setupClientPlugins([plugin], options);
+	const apis = runtime.apis;
+	return {
+		...runtime,
+		api: apis[plugin.id]
+	};
+};
 //#endregion
 export { createTestStorage, setupClientPlugin, setupClientPlugins };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hot-updater/test-utils",
-  "version": "1.0.0-rc.40",
+  "version": "1.0.0-rc.41",
   "type": "module",
   "description": "Test utilities for Hot Updater packages",
   "sideEffects": false,
@@ -50,10 +50,10 @@
     "mysql2": "*",
     "pg": "*",
     "vitest": "^4.0.0",
-    "@hot-updater/plugin-insights": "^1.0.0-rc.40",
-    "@hot-updater/protocol": "^1.0.0-rc.40",
-    "@hot-updater/plugin-core": "^1.0.0-rc.40",
-    "@hot-updater/server": "^1.0.0-rc.40"
+    "@hot-updater/plugin-insights": "^1.0.0-rc.41",
+    "@hot-updater/protocol": "^1.0.0-rc.41",
+    "@hot-updater/plugin-core": "^1.0.0-rc.41",
+    "@hot-updater/server": "^1.0.0-rc.41"
   },
   "peerDependenciesMeta": {
     "@electric-sql/pglite": {
@@ -83,11 +83,11 @@
     "typescript": "npm:@typescript/typescript6@6.0.2",
     "vitest": "4.1.4",
     "workspace-tools": "^0.41.7",
-    "@hot-updater/plugin-insights": "1.0.0-rc.40",
-    "@hot-updater/protocol": "1.0.0-rc.40",
-    "@hot-updater/js": "1.0.0-rc.40",
-    "@hot-updater/plugin-core": "1.0.0-rc.40",
-    "@hot-updater/server": "1.0.0-rc.40"
+    "@hot-updater/plugin-insights": "1.0.0-rc.41",
+    "@hot-updater/protocol": "1.0.0-rc.41",
+    "@hot-updater/js": "1.0.0-rc.41",
+    "@hot-updater/plugin-core": "1.0.0-rc.41",
+    "@hot-updater/server": "1.0.0-rc.41"
   },
   "inlinedDependencies": {
     "@nodelib/fs.scandir": "2.1.5",