@hot-updater/plugin-remote-config 0.0.0-stage → 1.0.0-rc.42

package/dist/server/routes.cjs

@@ -0,0 +1,157 @@
+const require_template = require("./template.cjs");
+const require_api = require("./api.cjs");
+const require_wire = require("../shared/wire.cjs");
+let _hot_updater_plugin_core = require("@hot-updater/plugin-core");
+//#region src/server/routes.ts
+/** Seconds a client waits before it resends a request the busy database refused. */
+const RETRY_AFTER_SECONDS = 5;
+/** A shared cache keeps a device's values five seconds, as it keeps a Release Catalog. */
+const FETCH_CACHE_CONTROL = "public, max-age=0, s-maxage=5";
+const MAX_CONTEXT_LENGTH = 128;
+var BadRequestError = class extends Error {};
+const json = (body, status, headers = {}) => Response.json(body, {
+	headers: {
+		"cache-control": "private, no-store",
+		...headers
+	},
+	status
+});
+const run = async (operation) => {
+	try {
+		return await operation();
+	} catch (error) {
+		if (error instanceof require_template.RemoteConfigValidationError) return json({
+			error: error.message,
+			issues: error.issues
+		}, 400);
+		if (error instanceof BadRequestError || error instanceof require_api.RemoteConfigInputError || error instanceof _hot_updater_plugin_core.DatabaseCursorError) return json({ error: error.message }, 400);
+		if ((0, _hot_updater_plugin_core.isDatabaseBusyError)(error)) {
+			console.warn("[hot-updater] Remote Config answered 503: the database is busy.", error);
+			return json({ error: "Service unavailable" }, 503, { "retry-after": String(RETRY_AFTER_SECONDS) });
+		}
+		throw error;
+	}
+};
+const readContext = (request) => {
+	const query = new URL(request.url).searchParams;
+	const read = (field) => {
+		const value = query.get(require_wire.REMOTE_CONFIG_QUERY[field]);
+		if (value === null || value.length === 0) return null;
+		if (value.length > MAX_CONTEXT_LENGTH) throw new BadRequestError(`${field} is too long.`);
+		return value;
+	};
+	const platform = read("platform");
+	if (platform !== null && platform !== "ios" && platform !== "android") throw new BadRequestError("platform must be \"ios\" or \"android\".");
+	return {
+		platform,
+		appVersion: read("appVersion"),
+		channel: read("channel"),
+		cohort: read("cohort"),
+		fingerprintHash: read("fingerprintHash")
+	};
+};
+const bodyHash = async (body) => {
+	const digest = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(body));
+	return [...new Uint8Array(digest)].map((byte) => byte.toString(16).padStart(2, "0")).join("");
+};
+const readJsonBody = async (request) => {
+	const body = await request.json().catch(() => null);
+	if (typeof body !== "object" || body === null || Array.isArray(body)) throw new BadRequestError("The request body must be a JSON object.");
+	return body;
+};
+const versionParam = (params) => {
+	const text = params.version ?? "";
+	if (!/^\d{1,15}$/u.test(text)) throw new BadRequestError("The version must be a positive integer.");
+	return Number(text);
+};
+const publishResponse = (result) => result.status === "published" ? json(result.version, 200) : json({
+	error: `Version ${result.currentVersion} was published since; reload the template and publish again.`,
+	currentVersion: result.currentVersion
+}, 409);
+/**
+* Remote Config's routes: the devices' `GET /remote-config` on
+* `handlers.client`, and template management on `handlers.admin`.
+*/
+const createRemoteConfigEndpoints = (api) => [
+	{
+		method: "GET",
+		path: `/${require_wire.REMOTE_CONFIG_PATH}`,
+		access: "client",
+		handler: (request) => run(async () => {
+			const body = JSON.stringify(await api.resolve(readContext(request)));
+			const etag = `"sha256:${await bodyHash(body)}"`;
+			const headers = {
+				"cache-control": FETCH_CACHE_CONTROL,
+				"content-type": "application/json",
+				etag,
+				vary: "Accept-Encoding"
+			};
+			if (request.headers.get("if-none-match") === etag) return new Response(null, {
+				headers,
+				status: 304
+			});
+			return new Response(body, {
+				headers,
+				status: 200
+			});
+		})
+	},
+	{
+		method: "GET",
+		path: `/${require_wire.REMOTE_CONFIG_PATH}/template`,
+		access: "admin",
+		handler: () => run(async () => json(await api.getActive(), 200))
+	},
+	{
+		method: "PUT",
+		path: `/${require_wire.REMOTE_CONFIG_PATH}/template`,
+		access: "admin",
+		handler: (request) => run(async () => {
+			const body = await readJsonBody(request);
+			return publishResponse(await api.publish({
+				template: body.template,
+				baseVersion: body.baseVersion,
+				...body.description === void 0 ? {} : { description: body.description }
+			}));
+		})
+	},
+	{
+		method: "GET",
+		path: `/${require_wire.REMOTE_CONFIG_PATH}/versions`,
+		access: "admin",
+		handler: (request) => run(async () => {
+			const query = new URL(request.url).searchParams;
+			const limit = query.get("limit");
+			const cursor = query.get("cursor");
+			return json(await api.listVersions({
+				...limit === null ? {} : { limit: Number(limit) },
+				...cursor === null ? {} : { cursor }
+			}), 200);
+		})
+	},
+	{
+		method: "GET",
+		path: `/${require_wire.REMOTE_CONFIG_PATH}/versions/:version`,
+		access: "admin",
+		handler: (_request, params) => run(async () => {
+			const version = await api.getVersion(versionParam(params));
+			return version === null ? json({ error: "Version not found" }, 404) : json(version, 200);
+		})
+	},
+	{
+		method: "POST",
+		path: `/${require_wire.REMOTE_CONFIG_PATH}/versions/:version/rollback`,
+		access: "admin",
+		handler: (request, params) => run(async () => {
+			const body = await readJsonBody(request);
+			const result = await api.rollback({
+				version: versionParam(params),
+				baseVersion: body.baseVersion,
+				...body.description === void 0 ? {} : { description: body.description }
+			});
+			return result.status === "not_found" ? json({ error: "Version not found" }, 404) : publishResponse(result);
+		})
+	}
+];
+//#endregion
+exports.createRemoteConfigEndpoints = createRemoteConfigEndpoints;

package/dist/server/routes.mjs

@@ -0,0 +1,157 @@
+import { RemoteConfigValidationError } from "./template.mjs";
+import { RemoteConfigInputError } from "./api.mjs";
+import { REMOTE_CONFIG_PATH, REMOTE_CONFIG_QUERY } from "../shared/wire.mjs";
+import { DatabaseCursorError, isDatabaseBusyError } from "@hot-updater/plugin-core";
+//#region src/server/routes.ts
+/** Seconds a client waits before it resends a request the busy database refused. */
+const RETRY_AFTER_SECONDS = 5;
+/** A shared cache keeps a device's values five seconds, as it keeps a Release Catalog. */
+const FETCH_CACHE_CONTROL = "public, max-age=0, s-maxage=5";
+const MAX_CONTEXT_LENGTH = 128;
+var BadRequestError = class extends Error {};
+const json = (body, status, headers = {}) => Response.json(body, {
+	headers: {
+		"cache-control": "private, no-store",
+		...headers
+	},
+	status
+});
+const run = async (operation) => {
+	try {
+		return await operation();
+	} catch (error) {
+		if (error instanceof RemoteConfigValidationError) return json({
+			error: error.message,
+			issues: error.issues
+		}, 400);
+		if (error instanceof BadRequestError || error instanceof RemoteConfigInputError || error instanceof DatabaseCursorError) return json({ error: error.message }, 400);
+		if (isDatabaseBusyError(error)) {
+			console.warn("[hot-updater] Remote Config answered 503: the database is busy.", error);
+			return json({ error: "Service unavailable" }, 503, { "retry-after": String(RETRY_AFTER_SECONDS) });
+		}
+		throw error;
+	}
+};
+const readContext = (request) => {
+	const query = new URL(request.url).searchParams;
+	const read = (field) => {
+		const value = query.get(REMOTE_CONFIG_QUERY[field]);
+		if (value === null || value.length === 0) return null;
+		if (value.length > MAX_CONTEXT_LENGTH) throw new BadRequestError(`${field} is too long.`);
+		return value;
+	};
+	const platform = read("platform");
+	if (platform !== null && platform !== "ios" && platform !== "android") throw new BadRequestError("platform must be \"ios\" or \"android\".");
+	return {
+		platform,
+		appVersion: read("appVersion"),
+		channel: read("channel"),
+		cohort: read("cohort"),
+		fingerprintHash: read("fingerprintHash")
+	};
+};
+const bodyHash = async (body) => {
+	const digest = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(body));
+	return [...new Uint8Array(digest)].map((byte) => byte.toString(16).padStart(2, "0")).join("");
+};
+const readJsonBody = async (request) => {
+	const body = await request.json().catch(() => null);
+	if (typeof body !== "object" || body === null || Array.isArray(body)) throw new BadRequestError("The request body must be a JSON object.");
+	return body;
+};
+const versionParam = (params) => {
+	const text = params.version ?? "";
+	if (!/^\d{1,15}$/u.test(text)) throw new BadRequestError("The version must be a positive integer.");
+	return Number(text);
+};
+const publishResponse = (result) => result.status === "published" ? json(result.version, 200) : json({
+	error: `Version ${result.currentVersion} was published since; reload the template and publish again.`,
+	currentVersion: result.currentVersion
+}, 409);
+/**
+* Remote Config's routes: the devices' `GET /remote-config` on
+* `handlers.client`, and template management on `handlers.admin`.
+*/
+const createRemoteConfigEndpoints = (api) => [
+	{
+		method: "GET",
+		path: `/${REMOTE_CONFIG_PATH}`,
+		access: "client",
+		handler: (request) => run(async () => {
+			const body = JSON.stringify(await api.resolve(readContext(request)));
+			const etag = `"sha256:${await bodyHash(body)}"`;
+			const headers = {
+				"cache-control": FETCH_CACHE_CONTROL,
+				"content-type": "application/json",
+				etag,
+				vary: "Accept-Encoding"
+			};
+			if (request.headers.get("if-none-match") === etag) return new Response(null, {
+				headers,
+				status: 304
+			});
+			return new Response(body, {
+				headers,
+				status: 200
+			});
+		})
+	},
+	{
+		method: "GET",
+		path: `/${REMOTE_CONFIG_PATH}/template`,
+		access: "admin",
+		handler: () => run(async () => json(await api.getActive(), 200))
+	},
+	{
+		method: "PUT",
+		path: `/${REMOTE_CONFIG_PATH}/template`,
+		access: "admin",
+		handler: (request) => run(async () => {
+			const body = await readJsonBody(request);
+			return publishResponse(await api.publish({
+				template: body.template,
+				baseVersion: body.baseVersion,
+				...body.description === void 0 ? {} : { description: body.description }
+			}));
+		})
+	},
+	{
+		method: "GET",
+		path: `/${REMOTE_CONFIG_PATH}/versions`,
+		access: "admin",
+		handler: (request) => run(async () => {
+			const query = new URL(request.url).searchParams;
+			const limit = query.get("limit");
+			const cursor = query.get("cursor");
+			return json(await api.listVersions({
+				...limit === null ? {} : { limit: Number(limit) },
+				...cursor === null ? {} : { cursor }
+			}), 200);
+		})
+	},
+	{
+		method: "GET",
+		path: `/${REMOTE_CONFIG_PATH}/versions/:version`,
+		access: "admin",
+		handler: (_request, params) => run(async () => {
+			const version = await api.getVersion(versionParam(params));
+			return version === null ? json({ error: "Version not found" }, 404) : json(version, 200);
+		})
+	},
+	{
+		method: "POST",
+		path: `/${REMOTE_CONFIG_PATH}/versions/:version/rollback`,
+		access: "admin",
+		handler: (request, params) => run(async () => {
+			const body = await readJsonBody(request);
+			const result = await api.rollback({
+				version: versionParam(params),
+				baseVersion: body.baseVersion,
+				...body.description === void 0 ? {} : { description: body.description }
+			});
+			return result.status === "not_found" ? json({ error: "Version not found" }, 404) : publishResponse(result);
+		})
+	}
+];
+//#endregion
+export { createRemoteConfigEndpoints };

package/dist/server/schema.cjs

@@ -0,0 +1,46 @@
+let _hot_updater_plugin_core = require("@hot-updater/plugin-core");
+//#region src/server/schema.ts
+/**
+* Remote Config's tables: the active template in one row, which a device's
+* fetch reads by key, and every published version beside it.
+*/
+const remoteConfigSchema = {
+	/** One row, `id` `"active"`: the template devices receive and its version. */
+	remote_config_active: (0, _hot_updater_plugin_core.defineTable)({
+		id: {
+			type: "string",
+			maxLength: 16
+		},
+		version: { type: "integer" },
+		template: { type: "json" },
+		updated_at_ms: { type: "integer" }
+	}, { key: ["id"] }),
+	/** Each publish and rollback, kept so the Console can show and restore it. */
+	remote_config_versions: (0, _hot_updater_plugin_core.defineTable)({
+		version: { type: "integer" },
+		template: { type: "json" },
+		description: {
+			type: "string",
+			maxLength: 256,
+			required: false
+		},
+		/** `PUBLISH`, or `ROLLBACK` for a copy of `rollback_source`. */
+		update_type: {
+			type: "string",
+			maxLength: 16
+		},
+		rollback_source: {
+			type: "integer",
+			required: false
+		},
+		created_at_ms: { type: "integer" }
+	}, {
+		key: ["version"],
+		indexes: { byVersion: {
+			eq: [],
+			sort: ["version"]
+		} }
+	})
+};
+//#endregion
+exports.remoteConfigSchema = remoteConfigSchema;

package/dist/server/schema.d.cts

@@ -0,0 +1,57 @@
+//#region src/server/schema.d.ts
+/**
+ * Remote Config's tables: the active template in one row, which a device's
+ * fetch reads by key, and every published version beside it.
+ */
+declare const remoteConfigSchema: {
+  /** One row, `id` `"active"`: the template devices receive and its version. */
+  readonly remote_config_active: import("@hot-updater/plugin-core").TableDefinition<{
+    readonly id: {
+      readonly type: "string";
+      readonly maxLength: 16;
+    };
+    readonly version: {
+      readonly type: "integer";
+    };
+    readonly template: {
+      readonly type: "json";
+    };
+    readonly updated_at_ms: {
+      readonly type: "integer";
+    };
+  }, {}, {}, readonly ["id"]>;
+  /** Each publish and rollback, kept so the Console can show and restore it. */
+  readonly remote_config_versions: import("@hot-updater/plugin-core").TableDefinition<{
+    readonly version: {
+      readonly type: "integer";
+    };
+    readonly template: {
+      readonly type: "json";
+    };
+    readonly description: {
+      readonly type: "string";
+      readonly maxLength: 256;
+      readonly required: false;
+    };
+    /** `PUBLISH`, or `ROLLBACK` for a copy of `rollback_source`. */
+    readonly update_type: {
+      readonly type: "string";
+      readonly maxLength: 16;
+    };
+    readonly rollback_source: {
+      readonly type: "integer";
+      readonly required: false;
+    };
+    readonly created_at_ms: {
+      readonly type: "integer";
+    };
+  }, {}, {
+    readonly byVersion: {
+      readonly eq: readonly [];
+      readonly sort: readonly ["version"];
+    };
+  }, readonly ["version"]>;
+};
+type RemoteConfigSchema = typeof remoteConfigSchema;
+//#endregion
+export { RemoteConfigSchema, remoteConfigSchema };

package/dist/server/schema.d.mts

@@ -0,0 +1,57 @@
+//#region src/server/schema.d.ts
+/**
+ * Remote Config's tables: the active template in one row, which a device's
+ * fetch reads by key, and every published version beside it.
+ */
+declare const remoteConfigSchema: {
+  /** One row, `id` `"active"`: the template devices receive and its version. */
+  readonly remote_config_active: import("@hot-updater/plugin-core").TableDefinition<{
+    readonly id: {
+      readonly type: "string";
+      readonly maxLength: 16;
+    };
+    readonly version: {
+      readonly type: "integer";
+    };
+    readonly template: {
+      readonly type: "json";
+    };
+    readonly updated_at_ms: {
+      readonly type: "integer";
+    };
+  }, {}, {}, readonly ["id"]>;
+  /** Each publish and rollback, kept so the Console can show and restore it. */
+  readonly remote_config_versions: import("@hot-updater/plugin-core").TableDefinition<{
+    readonly version: {
+      readonly type: "integer";
+    };
+    readonly template: {
+      readonly type: "json";
+    };
+    readonly description: {
+      readonly type: "string";
+      readonly maxLength: 256;
+      readonly required: false;
+    };
+    /** `PUBLISH`, or `ROLLBACK` for a copy of `rollback_source`. */
+    readonly update_type: {
+      readonly type: "string";
+      readonly maxLength: 16;
+    };
+    readonly rollback_source: {
+      readonly type: "integer";
+      readonly required: false;
+    };
+    readonly created_at_ms: {
+      readonly type: "integer";
+    };
+  }, {}, {
+    readonly byVersion: {
+      readonly eq: readonly [];
+      readonly sort: readonly ["version"];
+    };
+  }, readonly ["version"]>;
+};
+type RemoteConfigSchema = typeof remoteConfigSchema;
+//#endregion
+export { RemoteConfigSchema, remoteConfigSchema };

package/dist/server/schema.mjs

@@ -0,0 +1,46 @@
+import { defineTable } from "@hot-updater/plugin-core";
+//#region src/server/schema.ts
+/**
+* Remote Config's tables: the active template in one row, which a device's
+* fetch reads by key, and every published version beside it.
+*/
+const remoteConfigSchema = {
+	/** One row, `id` `"active"`: the template devices receive and its version. */
+	remote_config_active: defineTable({
+		id: {
+			type: "string",
+			maxLength: 16
+		},
+		version: { type: "integer" },
+		template: { type: "json" },
+		updated_at_ms: { type: "integer" }
+	}, { key: ["id"] }),
+	/** Each publish and rollback, kept so the Console can show and restore it. */
+	remote_config_versions: defineTable({
+		version: { type: "integer" },
+		template: { type: "json" },
+		description: {
+			type: "string",
+			maxLength: 256,
+			required: false
+		},
+		/** `PUBLISH`, or `ROLLBACK` for a copy of `rollback_source`. */
+		update_type: {
+			type: "string",
+			maxLength: 16
+		},
+		rollback_source: {
+			type: "integer",
+			required: false
+		},
+		created_at_ms: { type: "integer" }
+	}, {
+		key: ["version"],
+		indexes: { byVersion: {
+			eq: [],
+			sort: ["version"]
+		} }
+	})
+};
+//#endregion
+export { remoteConfigSchema };