@oneuptime/common 11.3.25 → 11.3.28

package/build/dist/Server/Utils/Database/MigrationFailureLog.js

@@ -0,0 +1,174 @@
+import os from "os";
+import { DataSource } from "typeorm";
+import logger from "../Logger";
+import { AppVersion } from "../../EnvironmentConfig";
+/*
+ * Records migrations that FAILED to apply into the "MigrationFailure" table so
+ * the admin health page can explain WHY a migration is pending (what error,
+ * when it ran) instead of only showing that it is behind. Every write here is
+ * best-effort: a diagnostic log must never itself crash a boot / migrate Job or
+ * mask the real migration error, so all failures inside this module are
+ * swallowed (logged, not thrown).
+ */
+// Which runner a failed migration belongs to. Stored verbatim in the table.
+export var MigrationFailureType;
+(function (MigrationFailureType) {
+    MigrationFailureType["PostgresSchema"] = "PostgresSchema";
+    MigrationFailureType["DataMigration"] = "DataMigration";
+})(MigrationFailureType || (MigrationFailureType = {}));
+// Keep a single row bounded so a pathological error/stack can't bloat the table.
+const MAX_ERROR_MESSAGE_LENGTH = 10000;
+const MAX_ERROR_STACK_LENGTH = 20000;
+/*
+ * Best-effort credential scrub for the free-form error text we persist. DB /
+ * migration errors seldom carry secrets, but a connection error can echo a
+ * `scheme://user:pass@host` DSN and a failing DDL can quote a literal default,
+ * so we mask the obvious vectors before the text is stored and later shown.
+ */
+const CONNECTION_STRING_SECRET_PATTERN = /([a-z][a-z0-9+.-]*:\/\/[^:@\s/]+):[^\s/]+@/gi;
+const KEYWORD_SECRET_PATTERN = /(password|secret|token|api[_-]?key|apikey|credential|private[_-]?key|auth[_-]?token|access[_-]?key)(\s*[:=]\s*)('(?:[^']|'')*'|"[^"]*"|[^\s,)]+)/gi;
+export function scrubMigrationErrorText(text) {
+    if (!text) {
+        return text;
+    }
+    return text
+        .replace(CONNECTION_STRING_SECRET_PATTERN, (_match, prefix) => {
+        return `${prefix}:***REDACTED***@`;
+    })
+        .replace(KEYWORD_SECRET_PATTERN, (_match, keyword, separator) => {
+        return `${keyword}${separator}***REDACTED***`;
+    });
+}
+function toErrorMessage(error) {
+    if (error instanceof Error) {
+        return error.message || error.name || "Unknown error";
+    }
+    return String(error);
+}
+function toErrorStack(error) {
+    return error instanceof Error && error.stack ? error.stack : null;
+}
+/*
+ * Append one failed-attempt row using the provided (already-connected)
+ * DataSource. Raw SQL — not the Service layer — so it also works on a
+ * throwaway diagnostic connection and never depends on realtime/event wiring.
+ * Returns true if the row was written. If the "MigrationFailure" table does not
+ * exist yet (e.g. its own migration is still pending on a first rollout) the
+ * INSERT throws and is swallowed — the caller's real error is unaffected.
+ */
+export async function recordMigrationFailure(dataSource, input) {
+    try {
+        const message = scrubMigrationErrorText(toErrorMessage(input.error)).substring(0, MAX_ERROR_MESSAGE_LENGTH);
+        const rawStack = toErrorStack(input.error);
+        const stack = rawStack
+            ? scrubMigrationErrorText(rawStack).substring(0, MAX_ERROR_STACK_LENGTH)
+            : null;
+        await dataSource.query(`INSERT INTO "MigrationFailure"
+         ("migrationName", "migrationType", "errorMessage", "errorStack", "attemptedAt", "hostName", "appVersion", "version", "createdAt", "updatedAt")
+       VALUES ($1, $2, $3, $4, $5, $6, $7, 1, now(), now())`, [
+            input.migrationName,
+            input.migrationType,
+            message,
+            stack,
+            new Date(),
+            os.hostname(),
+            AppVersion,
+        ]);
+        return true;
+    }
+    catch (err) {
+        // Diagnostic write must never mask the real failure — log and move on.
+        logger.warn(`Could not record migration failure for "${input.migrationName}" (${input.migrationType}); continuing.`);
+        logger.warn(err);
+        return false;
+    }
+}
+// Trailing epoch in a migration class name — how TypeORM orders/identifies them.
+function parseMigrationTimestamp(name) {
+    const match = name.match(/(\d{10,})$/);
+    return match ? Number(match[1]) : 0;
+}
+/*
+ * The TypeORM schema runner (migrationsRun) applies migrations in ascending
+ * timestamp order and halts at the first failure, so the FIRST defined
+ * migration not yet in the `migrations` table is exactly the one that failed.
+ * We recompute it here from a throwaway connection because the app's own
+ * connect() has already failed (its DataSource is not usable) at the point a
+ * schema migration throws.
+ */
+export async function recordSchemaMigrationFailureBestEffort(dataSourceOptions, originalError) {
+    /*
+     * Only THIS process's own boot runs schema migrations (migrationsRun=true —
+     * the migrate Job and single-pod / dev boots). On runtime pods where a
+     * dedicated migrate Job owns migrations (migrationsRun=false), a connect()
+     * failure is a connectivity problem, never a failed migration — recording
+     * one here would misattribute an outage to a (legitimately) pending
+     * migration, so skip.
+     */
+    if (dataSourceOptions.migrationsRun !== true) {
+        return;
+    }
+    let diagnosticDataSource = null;
+    try {
+        diagnosticDataSource = new DataSource(Object.assign(Object.assign({}, dataSourceOptions), { 
+            // Never re-run migrations or sync schema on the diagnostic connection.
+            migrationsRun: false, synchronize: false, 
+            // Keep the probe short so a genuinely-down DB doesn't slow the failing boot.
+            extra: Object.assign(Object.assign({}, (dataSourceOptions.extra ||
+                {})), { connectionTimeoutMillis: 5000 }) }));
+        /*
+         * If this fails, the original error was a connectivity problem (not a bad
+         * migration) — there is nothing meaningful to attribute, so we skip.
+         */
+        await diagnosticDataSource.initialize();
+        const definedMigrationClasses = Array.isArray(dataSourceOptions.migrations)
+            ? dataSourceOptions.migrations
+            : [];
+        const definedNames = Array.from(new Set(definedMigrationClasses.map((MigrationClass) => {
+            return new MigrationClass().name;
+        }))).sort((a, b) => {
+            return parseMigrationTimestamp(a) - parseMigrationTimestamp(b);
+        });
+        let appliedNames = new Set();
+        try {
+            const rows = await diagnosticDataSource.query("SELECT name FROM migrations");
+            appliedNames = new Set(rows.map((row) => {
+                return row.name;
+            }));
+        }
+        catch (_a) {
+            // migrations table may not exist on a brand-new DB — treat as none applied.
+        }
+        const firstPending = definedNames.find((name) => {
+            return !appliedNames.has(name);
+        });
+        /*
+         * No pending schema migration means the connect() failure was not a pending
+         * migration failing (e.g. an entity-metadata error) — don't misattribute it.
+         */
+        if (!firstPending) {
+            return;
+        }
+        await recordMigrationFailure(diagnosticDataSource, {
+            migrationName: firstPending,
+            migrationType: MigrationFailureType.PostgresSchema,
+            error: originalError,
+        });
+    }
+    catch (err) {
+        // Best-effort diagnostics only — swallow everything.
+        logger.warn("Could not record Postgres schema migration failure.");
+        logger.warn(err);
+    }
+    finally {
+        try {
+            if (diagnosticDataSource && diagnosticDataSource.isInitialized) {
+                await diagnosticDataSource.destroy();
+            }
+        }
+        catch (destroyErr) {
+            logger.warn(destroyErr);
+        }
+    }
+}
+//# sourceMappingURL=MigrationFailureLog.js.map

package/build/dist/Server/Utils/Database/MigrationFailureLog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MigrationFailureLog.js","sourceRoot":"","sources":["../../../../../Server/Utils/Database/MigrationFailureLog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,UAAU,EAAqB,MAAM,SAAS,CAAC;AACxD,OAAO,MAAM,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD;;;;;;;GAOG;AAEH,4EAA4E;AAC5E,MAAM,CAAN,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,yDAAiC,CAAA;IACjC,uDAA+B,CAAA;AACjC,CAAC,EAHW,oBAAoB,KAApB,oBAAoB,QAG/B;AAED,iFAAiF;AACjF,MAAM,wBAAwB,GAAW,KAAK,CAAC;AAC/C,MAAM,sBAAsB,GAAW,KAAK,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,gCAAgC,GACpC,8CAA8C,CAAC;AACjD,MAAM,sBAAsB,GAC1B,oJAAoJ,CAAC;AAEvJ,MAAM,UAAU,uBAAuB,CAAC,IAAY;IAClD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,IAAI;SACR,OAAO,CACN,gCAAgC,EAChC,CAAC,MAAc,EAAE,MAAc,EAAU,EAAE;QACzC,OAAO,GAAG,MAAM,kBAAkB,CAAC;IACrC,CAAC,CACF;SACA,OAAO,CACN,sBAAsB,EACtB,CAAC,MAAc,EAAE,OAAe,EAAE,SAAiB,EAAU,EAAE;QAC7D,OAAO,GAAG,OAAO,GAAG,SAAS,gBAAgB,CAAC;IAChD,CAAC,CACF,CAAC;AACN,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,IAAI,IAAI,eAAe,CAAC;IACxD,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IAClC,OAAO,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AACpE,CAAC;AAQD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,UAAsB,EACtB,KAA4B;IAE5B,IAAI,CAAC;QACH,MAAM,OAAO,GAAW,uBAAuB,CAC7C,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAC5B,CAAC,SAAS,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAAC;QAEzC,MAAM,QAAQ,GAAkB,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,KAAK,GAAkB,QAAQ;YACnC,CAAC,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,sBAAsB,CAAC;YACxE,CAAC,CAAC,IAAI,CAAC;QAET,MAAM,UAAU,CAAC,KAAK,CACpB;;4DAEsD,EACtD;YACE,KAAK,CAAC,aAAa;YACnB,KAAK,CAAC,aAAa;YACnB,OAAO;YACP,KAAK;YACL,IAAI,IAAI,EAAE;YACV,EAAE,CAAC,QAAQ,EAAE;YACb,UAAU;SACX,CACF,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,uEAAuE;QACvE,MAAM,CAAC,IAAI,CACT,2CAA2C,KAAK,CAAC,aAAa,MAAM,KAAK,CAAC,aAAa,gBAAgB,CACxG,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,iFAAiF;AACjF,SAAS,uBAAuB,CAAC,IAAY;IAC3C,MAAM,KAAK,GAA4B,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAChE,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,sCAAsC,CAC1D,iBAAoC,EACpC,aAAsB;IAEtB;;;;;;;OAOG;IACH,IACG,iBAAiD,CAAC,aAAa,KAAK,IAAI,EACzE,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,oBAAoB,GAAsB,IAAI,CAAC;IAEnD,IAAI,CAAC;QACH,oBAAoB,GAAG,IAAI,UAAU,CAAC,gCACjC,iBAAiB;YACpB,uEAAuE;YACvE,aAAa,EAAE,KAAK,EACpB,WAAW,EAAE,KAAK;YAClB,6EAA6E;YAC7E,KAAK,kCACA,CAAE,iBAAyD,CAAC,KAAK;gBAClE,EAAE,CAAC,KACL,uBAAuB,EAAE,IAAI,MAEX,CAAC,CAAC;QAExB;;;WAGG;QACH,MAAM,oBAAoB,CAAC,UAAU,EAAE,CAAC;QAExC,MAAM,uBAAuB,GAC3B,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC;YACzC,CAAC,CAAE,iBAAiB,CAAC,UAEjB;YACJ,CAAC,CAAC,EAAE,CAAC;QAET,MAAM,YAAY,GAAkB,KAAK,CAAC,IAAI,CAC5C,IAAI,GAAG,CACL,uBAAuB,CAAC,GAAG,CACzB,CAAC,cAA0C,EAAU,EAAE;YACrD,OAAO,IAAI,cAAc,EAAE,CAAC,IAAI,CAAC;QACnC,CAAC,CACF,CACF,CACF,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE;YACtC,OAAO,uBAAuB,CAAC,CAAC,CAAC,GAAG,uBAAuB,CAAC,CAAC,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,IAAI,YAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;QAC1C,IAAI,CAAC;YACH,MAAM,IAAI,GAA4B,MAAM,oBAAoB,CAAC,KAAK,CACpE,6BAA6B,CAC9B,CAAC;YACF,YAAY,GAAG,IAAI,GAAG,CACpB,IAAI,CAAC,GAAG,CAAC,CAAC,GAAqB,EAAU,EAAE;gBACzC,OAAO,GAAG,CAAC,IAAI,CAAC;YAClB,CAAC,CAAC,CACH,CAAC;QACJ,CAAC;QAAC,WAAM,CAAC;YACP,4EAA4E;QAC9E,CAAC;QAED,MAAM,YAAY,GAAuB,YAAY,CAAC,IAAI,CACxD,CAAC,IAAY,EAAW,EAAE;YACxB,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC,CACF,CAAC;QAEF;;;WAGG;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,MAAM,sBAAsB,CAAC,oBAAoB,EAAE;YACjD,aAAa,EAAE,YAAY;YAC3B,aAAa,EAAE,oBAAoB,CAAC,cAAc;YAClD,KAAK,EAAE,aAAa;SACrB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,qDAAqD;QACrD,MAAM,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC;QACnE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;YAAS,CAAC;QACT,IAAI,CAAC;YACH,IAAI,oBAAoB,IAAI,oBAAoB,CAAC,aAAa,EAAE,CAAC;gBAC/D,MAAM,oBAAoB,CAAC,OAAO,EAAE,CAAC;YACvC,CAAC;QACH,CAAC;QAAC,OAAO,UAAU,EAAE,CAAC;YACpB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;AACH,CAAC"}

package/build/dist/Server/Utils/IncomingCallPhoneNumber.js

@@ -0,0 +1,30 @@
+import { AppApiHostname } from "../EnvironmentConfig";
+import ClusterKeyAuthorization from "../Middleware/ClusterKeyAuthorization";
+import logger from "./Logger";
+import Protocol from "../../Types/API/Protocol";
+import Route from "../../Types/API/Route";
+import URL from "../../Types/API/URL";
+import API from "../../Utils/API";
+/*
+ * Releases a provisioned incoming-call number on the call provider by delegating
+ * to the notification app's internal endpoint (the Common layer cannot reach the
+ * provider directly). Best-effort: failures are logged but never thrown, so a
+ * provider/network issue during cleanup does not block the parent delete.
+ */
+export default async function releaseIncomingCallPhoneNumber(data) {
+    try {
+        await API.post({
+            url: new URL(Protocol.HTTP, AppApiHostname, new Route("/api/notification/phone-number/internal/release")),
+            data: {
+                projectCallSMSConfigId: data.projectCallSMSConfigId.toString(),
+                callProviderPhoneNumberId: data.callProviderPhoneNumberId,
+            },
+            headers: Object.assign({}, ClusterKeyAuthorization.getClusterKeyHeaders()),
+        });
+    }
+    catch (err) {
+        logger.error("Failed to release incoming-call phone number on the provider during cleanup:");
+        logger.error(err);
+    }
+}
+//# sourceMappingURL=IncomingCallPhoneNumber.js.map

package/build/dist/Server/Utils/IncomingCallPhoneNumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncomingCallPhoneNumber.js","sourceRoot":"","sources":["../../../../Server/Utils/IncomingCallPhoneNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,uBAAuB,MAAM,uCAAuC,CAAC;AAC5E,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,QAAQ,MAAM,0BAA0B,CAAC;AAChD,OAAO,KAAK,MAAM,uBAAuB,CAAC;AAC1C,OAAO,GAAG,MAAM,qBAAqB,CAAC;AACtC,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAGlC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,8BAA8B,CAAC,IAG5D;IACC,IAAI,CAAC;QACH,MAAM,GAAG,CAAC,IAAI,CAAC;YACb,GAAG,EAAE,IAAI,GAAG,CACV,QAAQ,CAAC,IAAI,EACb,cAAc,EACd,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAC7D;YACD,IAAI,EAAE;gBACJ,sBAAsB,EAAE,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE;gBAC9D,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;aAC1D;YACD,OAAO,oBACF,uBAAuB,CAAC,oBAAoB,EAAE,CAClD;SACF,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,KAAK,CACV,8EAA8E,CAC/E,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC;AACH,CAAC"}