@hot-updater/plugin-insights 1.0.0-rc.27 → 1.0.0-rc.28

package/dist/client/errorDetails.cjs

@@ -0,0 +1,34 @@
+let _hot_updater_protocol = require("@hot-updater/protocol");
+//#region src/client/errorDetails.ts
+/** Bound the JSON wire size without rewriting the error text or splitting Unicode. */
+const boundedText = (text, maxBytes) => {
+	if ((0, _hot_updater_protocol.getUtf8ByteLength)(JSON.stringify(text)) <= maxBytes) return text;
+	let result = "";
+	let bytes = 2 + (0, _hot_updater_protocol.getUtf8ByteLength)("…");
+	for (const character of text) {
+		bytes += (0, _hot_updater_protocol.getUtf8ByteLength)(JSON.stringify(character)) - 2;
+		if (bytes > maxBytes) break;
+		result += character;
+	}
+	return `${result}…`;
+};
+/** Error properties are not enumerable, so JSON.stringify(error) would lose them. */
+const readErrorDetails = (error) => {
+	if (error == null) return {};
+	const object = typeof error === "object" ? error : null;
+	let message;
+	if (object && "message" in object && typeof object.message === "string") message = object.message;
+	else if (typeof error === "string") message = error;
+	else try {
+		message = JSON.stringify(error) ?? String(error);
+	} catch {
+		message = String(error);
+	}
+	const stack = object && "stack" in object && typeof object.stack === "string" ? object.stack : void 0;
+	return {
+		...message ? { errorMessage: boundedText(message, 2048) } : {},
+		...stack ? { errorStack: boundedText(stack, 4096) } : {}
+	};
+};
+//#endregion
+exports.readErrorDetails = readErrorDetails;

package/dist/client/errorDetails.mjs

@@ -0,0 +1,34 @@
+import { getUtf8ByteLength } from "@hot-updater/protocol";
+//#region src/client/errorDetails.ts
+/** Bound the JSON wire size without rewriting the error text or splitting Unicode. */
+const boundedText = (text, maxBytes) => {
+	if (getUtf8ByteLength(JSON.stringify(text)) <= maxBytes) return text;
+	let result = "";
+	let bytes = 2 + getUtf8ByteLength("…");
+	for (const character of text) {
+		bytes += getUtf8ByteLength(JSON.stringify(character)) - 2;
+		if (bytes > maxBytes) break;
+		result += character;
+	}
+	return `${result}…`;
+};
+/** Error properties are not enumerable, so JSON.stringify(error) would lose them. */
+const readErrorDetails = (error) => {
+	if (error == null) return {};
+	const object = typeof error === "object" ? error : null;
+	let message;
+	if (object && "message" in object && typeof object.message === "string") message = object.message;
+	else if (typeof error === "string") message = error;
+	else try {
+		message = JSON.stringify(error) ?? String(error);
+	} catch {
+		message = String(error);
+	}
+	const stack = object && "stack" in object && typeof object.stack === "string" ? object.stack : void 0;
+	return {
+		...message ? { errorMessage: boundedText(message, 2048) } : {},
+		...stack ? { errorStack: boundedText(stack, 4096) } : {}
+	};
+};
+//#endregion
+export { readErrorDetails };

package/dist/client/index.cjs

@@ -1,4 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_errorDetails = require("./errorDetails.cjs");
 const require_eventId = require("./eventId.cjs");
 const require_sender = require("./sender.cjs");
 const require_state = require("./state.cjs");
@@ -140,11 +141,13 @@ const insights = (options = {}) => {
 	const onUpdateError = (error) => {
 		if (error.stage === "check" && error.reason === "network") return;
 		const targetBundleId = error.targetBundleId ?? error.bundleId;
-		const failureKey = [
+		const details = require_errorDetails.readErrorDetails(error.cause);
+		const failureKey = JSON.stringify([
 			error.stage,
 			error.reason,
-			targetBundleId
-		].join(" ");
+			targetBundleId,
+			details.errorMessage ?? null
+		]);
 		const event = createEvent({
 			type: "UPDATE_FAILED",
 			channel: error.channel,
@@ -156,6 +159,7 @@ const insights = (options = {}) => {
 			metadata: { failure: {
 				stage: error.stage,
 				reason: error.reason,
+				...details,
 				...error.resource === void 0 ? {} : { resource: error.resource },
 				...error.httpStatus === void 0 ? {} : { httpStatus: error.httpStatus },
 				...error.transport === void 0 ? {} : { transport: error.transport },

package/dist/client/index.mjs

@@ -1,3 +1,4 @@
+import { readErrorDetails } from "./errorDetails.mjs";
 import { createKeyedUUIDv7, createUUIDv7 } from "./eventId.mjs";
 import { createInsightsEventSender } from "./sender.mjs";
 import { createInsightsState, utcDay, utcDayStart } from "./state.mjs";
@@ -139,11 +140,13 @@ const insights = (options = {}) => {
 	const onUpdateError = (error) => {
 		if (error.stage === "check" && error.reason === "network") return;
 		const targetBundleId = error.targetBundleId ?? error.bundleId;
-		const failureKey = [
+		const details = readErrorDetails(error.cause);
+		const failureKey = JSON.stringify([
 			error.stage,
 			error.reason,
-			targetBundleId
-		].join(" ");
+			targetBundleId,
+			details.errorMessage ?? null
+		]);
 		const event = createEvent({
 			type: "UPDATE_FAILED",
 			channel: error.channel,
@@ -155,6 +158,7 @@ const insights = (options = {}) => {
 			metadata: { failure: {
 				stage: error.stage,
 				reason: error.reason,
+				...details,
 				...error.resource === void 0 ? {} : { resource: error.resource },
 				...error.httpStatus === void 0 ? {} : { httpStatus: error.httpStatus },
 				...error.transport === void 0 ? {} : { transport: error.transport },

package/dist/server/domain.d.cts

@@ -14,6 +14,9 @@ type BundleEventFailureInput = {
   readonly transport?: NonNullable<BundleEventFailure["transport"]>;
   /** The storage origin's error code, such as `ExpiredToken`. */
   readonly originCode?: string;
+  /** Original client error text, bounded to fit the event payload. */
+  readonly errorMessage?: string;
+  readonly errorStack?: string;
   /** Android's `ApplicationExitInfo` reason for the process before this one. */
   readonly previousProcessExit?: string;
 };
@@ -78,6 +81,8 @@ type CreateBundleEventRequest = (Movement & {
 });
 type ActiveInstallationWindow = "24h" | "7d" | "30d";
 type EventHistoryRow = {
+  readonly toReleaseId?: string;
+  readonly sdkVersion?: string;
   readonly id: string;
   readonly installId: string;
   readonly type: "UPDATE_DOWNLOADED" | "UPDATE_APPLIED" | "RECOVERED" | "UPDATE_FAILED" | "UNCHANGED";

package/dist/server/domain.d.mts

@@ -14,6 +14,9 @@ type BundleEventFailureInput = {
   readonly transport?: NonNullable<BundleEventFailure["transport"]>;
   /** The storage origin's error code, such as `ExpiredToken`. */
   readonly originCode?: string;
+  /** Original client error text, bounded to fit the event payload. */
+  readonly errorMessage?: string;
+  readonly errorStack?: string;
   /** Android's `ApplicationExitInfo` reason for the process before this one. */
   readonly previousProcessExit?: string;
 };
@@ -78,6 +81,8 @@ type CreateBundleEventRequest = (Movement & {
 });
 type ActiveInstallationWindow = "24h" | "7d" | "30d";
 type EventHistoryRow = {
+  readonly toReleaseId?: string;
+  readonly sdkVersion?: string;
   readonly id: string;
   readonly installId: string;
   readonly type: "UPDATE_DOWNLOADED" | "UPDATE_APPLIED" | "RECOVERED" | "UPDATE_FAILED" | "UNCHANGED";

package/dist/server/eventInput.cjs

@@ -83,6 +83,8 @@ function readFailure(value) {
 	const failure = isRecord(value) ? value : {};
 	const httpStatus = failure.httpStatus;
 	const originCode = readCode(failure.originCode);
+	const errorMessage = typeof failure.errorMessage === "string" && failure.errorMessage.length <= 2048 ? failure.errorMessage : void 0;
+	const errorStack = typeof failure.errorStack === "string" && failure.errorStack.length <= 4096 ? failure.errorStack : void 0;
 	const previousProcessExit = readCode(failure.previousProcessExit);
 	return {
 		stage: oneOf(STAGES, failure.stage),
@@ -91,6 +93,8 @@ function readFailure(value) {
 		...Number.isSafeInteger(httpStatus) && httpStatus >= 100 && httpStatus <= 599 ? { httpStatus } : {},
 		...failure.transport == null ? {} : { transport: oneOf(TRANSPORTS, failure.transport) },
 		...originCode === void 0 ? {} : { originCode },
+		...errorMessage === void 0 ? {} : { errorMessage },
+		...errorStack === void 0 ? {} : { errorStack },
 		...previousProcessExit === void 0 ? {} : { previousProcessExit }
 	};
 }
@@ -261,6 +265,8 @@ function createBundleEventRow(input) {
 					failure: {
 						stage: failure.stage,
 						reason: failure.reason,
+						...failure.errorMessage === void 0 ? {} : { error_message: failure.errorMessage },
+						...failure.errorStack === void 0 ? {} : { error_stack: failure.errorStack },
 						...failure.resource === void 0 ? {} : { resource: failure.resource },
 						...failure.httpStatus === void 0 ? {} : { http_status: failure.httpStatus },
 						...failure.transport === void 0 ? {} : { transport: failure.transport },

package/dist/server/eventInput.mjs

@@ -83,6 +83,8 @@ function readFailure(value) {
 	const failure = isRecord(value) ? value : {};
 	const httpStatus = failure.httpStatus;
 	const originCode = readCode(failure.originCode);
+	const errorMessage = typeof failure.errorMessage === "string" && failure.errorMessage.length <= 2048 ? failure.errorMessage : void 0;
+	const errorStack = typeof failure.errorStack === "string" && failure.errorStack.length <= 4096 ? failure.errorStack : void 0;
 	const previousProcessExit = readCode(failure.previousProcessExit);
 	return {
 		stage: oneOf(STAGES, failure.stage),
@@ -91,6 +93,8 @@ function readFailure(value) {
 		...Number.isSafeInteger(httpStatus) && httpStatus >= 100 && httpStatus <= 599 ? { httpStatus } : {},
 		...failure.transport == null ? {} : { transport: oneOf(TRANSPORTS, failure.transport) },
 		...originCode === void 0 ? {} : { originCode },
+		...errorMessage === void 0 ? {} : { errorMessage },
+		...errorStack === void 0 ? {} : { errorStack },
 		...previousProcessExit === void 0 ? {} : { previousProcessExit }
 	};
 }
@@ -261,6 +265,8 @@ function createBundleEventRow(input) {
 					failure: {
 						stage: failure.stage,
 						reason: failure.reason,
+						...failure.errorMessage === void 0 ? {} : { error_message: failure.errorMessage },
+						...failure.errorStack === void 0 ? {} : { error_stack: failure.errorStack },
 						...failure.resource === void 0 ? {} : { resource: failure.resource },
 						...failure.httpStatus === void 0 ? {} : { http_status: failure.httpStatus },
 						...failure.transport === void 0 ? {} : { transport: failure.transport },

package/dist/server/eventRow.cjs

@@ -3,7 +3,7 @@ let _hot_updater_plugin_core = require("@hot-updater/plugin-core");
 const isOptional = (value, key, valid) => !Object.hasOwn(value, key) || valid(value[key]);
 const isString = (value) => typeof value === "string";
 /** An `UPDATE_FAILED` report's stored failure: a stage and a reason, and what else the client knew. */
-const isDatabaseBundleEventFailure = (value) => (0, _hot_updater_plugin_core.isDatabaseJsonObject)(value) && isString(value.stage) && isString(value.reason) && isOptional(value, "resource", isString) && isOptional(value, "http_status", (status) => Number.isSafeInteger(status)) && isOptional(value, "transport", isString) && isOptional(value, "origin_code", isString) && isOptional(value, "previous_process_exit", isString);
+const isDatabaseBundleEventFailure = (value) => (0, _hot_updater_plugin_core.isDatabaseJsonObject)(value) && isString(value.stage) && isString(value.reason) && isOptional(value, "resource", isString) && isOptional(value, "http_status", (status) => Number.isSafeInteger(status)) && isOptional(value, "transport", isString) && isOptional(value, "origin_code", isString) && isOptional(value, "error_message", isString) && isOptional(value, "error_stack", isString) && isOptional(value, "previous_process_exit", isString);
 const isDatabaseBundleEventMetadata = (value) => (0, _hot_updater_plugin_core.isDatabaseJsonObject)(value) && typeof value.cohort === "string" && (value.update_strategy === null || value.update_strategy === "fingerprint" || value.update_strategy === "appVersion") && (value.fingerprint_hash === null || typeof value.fingerprint_hash === "string") && (value.sdk_version === null || typeof value.sdk_version === "string") && isOptional(value, "failure", isDatabaseBundleEventFailure) && isOptional(value, "delivery", isString) && isOptional(value, "patch_fallback", (flag) => typeof flag === "boolean") && isOptional(value, "previous_process_exit", isString);
 const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 const isIdentity = (value) => typeof value === "string" && value.length > 0 && value.length <= 255;

package/dist/server/eventRow.d.cts

@@ -14,6 +14,8 @@ type BundleEventFailure = DatabaseJsonObject & {
   readonly transport?: "timeout" | "dns" | "tls" | "connection" | "offline" | "cancelled" | "unknown";
   /** The storage origin's error code, such as `ExpiredToken`. */
   readonly origin_code?: string;
+  readonly error_message?: string;
+  readonly error_stack?: string;
   /** Android's `ApplicationExitInfo` reason for the process before this one. */
   readonly previous_process_exit?: string;
 };

package/dist/server/eventRow.d.mts

@@ -14,6 +14,8 @@ type BundleEventFailure = DatabaseJsonObject & {
   readonly transport?: "timeout" | "dns" | "tls" | "connection" | "offline" | "cancelled" | "unknown";
   /** The storage origin's error code, such as `ExpiredToken`. */
   readonly origin_code?: string;
+  readonly error_message?: string;
+  readonly error_stack?: string;
   /** Android's `ApplicationExitInfo` reason for the process before this one. */
   readonly previous_process_exit?: string;
 };

package/dist/server/eventRow.mjs

@@ -3,7 +3,7 @@ import { DatabaseAdapterInputError, isDatabaseJsonObject } from "@hot-updater/pl
 const isOptional = (value, key, valid) => !Object.hasOwn(value, key) || valid(value[key]);
 const isString = (value) => typeof value === "string";
 /** An `UPDATE_FAILED` report's stored failure: a stage and a reason, and what else the client knew. */
-const isDatabaseBundleEventFailure = (value) => isDatabaseJsonObject(value) && isString(value.stage) && isString(value.reason) && isOptional(value, "resource", isString) && isOptional(value, "http_status", (status) => Number.isSafeInteger(status)) && isOptional(value, "transport", isString) && isOptional(value, "origin_code", isString) && isOptional(value, "previous_process_exit", isString);
+const isDatabaseBundleEventFailure = (value) => isDatabaseJsonObject(value) && isString(value.stage) && isString(value.reason) && isOptional(value, "resource", isString) && isOptional(value, "http_status", (status) => Number.isSafeInteger(status)) && isOptional(value, "transport", isString) && isOptional(value, "origin_code", isString) && isOptional(value, "error_message", isString) && isOptional(value, "error_stack", isString) && isOptional(value, "previous_process_exit", isString);
 const isDatabaseBundleEventMetadata = (value) => isDatabaseJsonObject(value) && typeof value.cohort === "string" && (value.update_strategy === null || value.update_strategy === "fingerprint" || value.update_strategy === "appVersion") && (value.fingerprint_hash === null || typeof value.fingerprint_hash === "string") && (value.sdk_version === null || typeof value.sdk_version === "string") && isOptional(value, "failure", isDatabaseBundleEventFailure) && isOptional(value, "delivery", isString) && isOptional(value, "patch_fallback", (flag) => typeof flag === "boolean") && isOptional(value, "previous_process_exit", isString);
 const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 const isIdentity = (value) => typeof value === "string" && value.length > 0 && value.length <= 255;

package/dist/server/provider.cjs

@@ -147,6 +147,8 @@ const assertEventRows = (rows, input) => {
 const toFailure = (failure) => ({
 	stage: failure.stage,
 	reason: failure.reason,
+	...failure.error_message === void 0 ? {} : { errorMessage: failure.error_message },
+	...failure.error_stack === void 0 ? {} : { errorStack: failure.error_stack },
 	...failure.resource === void 0 ? {} : { resource: failure.resource },
 	...failure.http_status === void 0 ? {} : { httpStatus: failure.http_status },
 	...failure.transport === void 0 ? {} : { transport: failure.transport },
@@ -161,6 +163,8 @@ const eventDetails = ({ type, metadata }) => ({
 	...type === "RECOVERED" && metadata.previous_process_exit !== void 0 ? { previousProcessExit: metadata.previous_process_exit } : {}
 });
 const toEventHistoryRow = (row) => ({
+	...row.to_release_id == null ? {} : { toReleaseId: row.to_release_id },
+	...row.metadata.sdk_version == null ? {} : { sdkVersion: row.metadata.sdk_version },
 	appVersion: row.app_version,
 	channel: row.channel,
 	cohort: row.metadata.cohort,

package/dist/server/provider.mjs

@@ -147,6 +147,8 @@ const assertEventRows = (rows, input) => {
 const toFailure = (failure) => ({
 	stage: failure.stage,
 	reason: failure.reason,
+	...failure.error_message === void 0 ? {} : { errorMessage: failure.error_message },
+	...failure.error_stack === void 0 ? {} : { errorStack: failure.error_stack },
 	...failure.resource === void 0 ? {} : { resource: failure.resource },
 	...failure.http_status === void 0 ? {} : { httpStatus: failure.http_status },
 	...failure.transport === void 0 ? {} : { transport: failure.transport },
@@ -161,6 +163,8 @@ const eventDetails = ({ type, metadata }) => ({
 	...type === "RECOVERED" && metadata.previous_process_exit !== void 0 ? { previousProcessExit: metadata.previous_process_exit } : {}
 });
 const toEventHistoryRow = (row) => ({
+	...row.to_release_id == null ? {} : { toReleaseId: row.to_release_id },
+	...row.metadata.sdk_version == null ? {} : { sdkVersion: row.metadata.sdk_version },
 	appVersion: row.app_version,
 	channel: row.channel,
 	cohort: row.metadata.cohort,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hot-updater/plugin-insights",
   "type": "module",
-  "version": "1.0.0-rc.27",
+  "version": "1.0.0-rc.28",
   "description": "Hot Updater's Insights plugin: launch, download, and update failure events, for the server and the React Native app",
   "exports": {
     "./client": {