@bigbertha/sdk 0.2.1 → 0.4.0

package/README.md

@@ -90,12 +90,15 @@ Options: `release`, `url`, `uploadKey`, `keepMaps`.
 
 ```ts
 import { init } from "@bigbertha/sdk/node"
-init() // reads BERTHA_KEY, BERTHA_URL, BERTHA_RELEASE and NODE_ENV
+init() // reads BERTHA_KEY, BERTHA_URL, BERTHA_RELEASE, BERTHA_COMMIT and NODE_ENV
 ```
 
 `init` reports uncaught exceptions and unhandled rejections, flushes, then exits as Node
 would (`handlers: false` turns that off). It also sends a heartbeat every 20 minutes so
-bertha can tell "no errors" from "not running" (`heartbeat: false`).
+bertha can tell "no errors" from "not running" (`heartbeat: false`). The heartbeat names
+the commit the process runs, from `commit`, `BERTHA_COMMIT` or the host's own variable
+(Heroku's `HEROKU_SLUG_COMMIT` with dyno metadata on, Render, Railway, Vercel, GitHub
+Actions), so a release that no `bertha deploy` recorded still points at its code.
 
 Code that Node runs as-is needs no source maps: the SDK reads the lines around each
 frame in your own files from disk and sends them with the event (`contextLines: false`

package/dist/cli.js

@@ -1,6 +1,7 @@
 // bertha deploy | bertha sourcemaps upload <dir>
 import { parseArgs } from "node:util";
 import { detectRelease, lastCommit, processDirectory, reason } from "./build/index.js";
+import { envCommit } from "./core/env.js";
 import { VERSION } from "./core/version.js";
 const HELP = `bertha ${VERSION}
 
@@ -50,7 +51,9 @@ export async function main(argv, out = console.log) {
         if (!release)
             return out("No release found. Pass --release or set BERTHA_RELEASE."), 1;
         const body = { release, environment: v.env ?? "production" };
-        const commit = lastCommit();
+        // Without a checkout (a host's build step), the host still names the commit.
+        const sha = envCommit();
+        const commit = lastCommit() ?? (sha ? { sha, message: "", author: "" } : undefined);
         if (commit)
             body.commit = commit;
         try {

package/dist/core/env.d.ts

@@ -1,2 +1,6 @@
 export declare function env(name: string): string | undefined;
+/** Where hosts and CI put the commit a process was built from, most specific first. */
+export declare const COMMIT_ENV: string[];
+/** The commit the environment names, if it looks like one. */
+export declare function envCommit(): string | undefined;
 export declare function firstEnv(...names: string[]): string | undefined;

package/dist/core/env.js

@@ -8,6 +8,28 @@ export function env(name) {
         return undefined;
     }
 }
+/** Where hosts and CI put the commit a process was built from, most specific first. */
+export const COMMIT_ENV = [
+    "BERTHA_COMMIT",
+    "HEROKU_BUILD_COMMIT",
+    "HEROKU_SLUG_COMMIT",
+    "SOURCE_VERSION",
+    "RENDER_GIT_COMMIT",
+    "RAILWAY_GIT_COMMIT_SHA",
+    "VERCEL_GIT_COMMIT_SHA",
+    "CF_PAGES_COMMIT_SHA",
+    "GITHUB_SHA",
+    "COMMIT_SHA",
+];
+/** The commit the environment names, if it looks like one. */
+export function envCommit() {
+    for (const n of COMMIT_ENV) {
+        const v = env(n)?.trim();
+        if (v && /^[0-9a-f]{7,64}$/i.test(v))
+            return v.toLowerCase();
+    }
+    return undefined;
+}
 export function firstEnv(...names) {
     for (const n of names) {
         const v = env(n);

package/dist/core/stack.js

@@ -12,7 +12,8 @@ export function parseStack(stack) {
         if (!m)
             continue;
         const [, fn, rawFile, ln, col] = m;
-        let file = rawFile;
+        // `at async /app/x.js:1:2`, an unnamed async frame, has no parentheses to split on.
+        let file = fn ? rawFile : rawFile.replace(/^async /, "");
         // `at eval (eval at f (file.js:1:2), <anonymous>:1:1)`: keep the outer file.
         const evalAt = /\(eval at .*?\((.+?):\d+:\d+\)/.exec(line);
         if (evalAt)

package/dist/core/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.2.1";
+export declare const VERSION = "0.4.0";

package/dist/core/version.js

@@ -1 +1 @@
-export const VERSION = "0.2.1";
+export const VERSION = "0.4.0";

package/dist/generated/ingest.d.ts

@@ -128,6 +128,11 @@ export type IngestFrameContext = {
 export type IngestHeartbeat = {
     environment?: string;
     release?: string;
+    /**
+     * The commit sha the process was built from, when the host says (Heroku, Render,
+     * Vercel…). Fills in the release's commit if no deploy from CI gave one.
+     */
+    commit?: string;
 };
 export type IngestLevel = "fatal" | "error" | "warning";
 export type IngestRequest = {

package/dist/node/index.d.ts

@@ -9,13 +9,21 @@ export interface NodeOptions extends Partial<Options> {
     heartbeat?: boolean;
     /** Send the source lines around each frame in your code, read from disk. On by default. */
     contextLines?: boolean;
+    /**
+     * The commit this process runs, so an agent can read the code that failed. Read from
+     * BERTHA_COMMIT or the host's own variable (Heroku, Render, Railway, Vercel, GitHub
+     * Actions) unless given; sent with the heartbeat.
+     */
+    commit?: string;
 }
 export declare const HEARTBEAT_MS: number;
 /** V8 keeps 10 frames, which a framework's own calls can use up before reaching yours. */
 export declare const STACK_FRAMES = 50;
-/** Reads BERTHA_KEY, BERTHA_URL, BERTHA_RELEASE and NODE_ENV unless given. */
+/** Reads BERTHA_KEY, BERTHA_URL, BERTHA_RELEASE, BERTHA_COMMIT and NODE_ENV unless given. */
 export declare function init(options?: NodeOptions): Client | undefined;
-export declare function sendHeartbeat(o: Pick<Options, "url" | "key" | "release" | "environment">): Promise<boolean>;
+export declare function sendHeartbeat(o: Pick<Options, "url" | "key" | "release" | "environment"> & {
+    commit?: string;
+}): Promise<boolean>;
 /**
  * Wraps a request handler (Node http, Express, Fastify, Hono…): errors it throws
  * or rejects with are reported with the request, then rethrown.

package/dist/node/index.js

@@ -4,7 +4,7 @@
 import { arch, platform } from "node:os";
 import { gzipSync } from "node:zlib";
 import { Client } from "../core/client.js";
-import { firstEnv } from "../core/env.js";
+import { envCommit, firstEnv } from "../core/env.js";
 import { getClient, setClient } from "../core/hub.js";
 import { endpoint, fetchTransport } from "../core/transport.js";
 import { VERSION } from "../core/version.js";
@@ -17,7 +17,7 @@ const V8_DEFAULT_FRAMES = 10;
 const EXIT_FLUSH_MS = 2000;
 let handlersInstalled = false;
 let heartbeat;
-/** Reads BERTHA_KEY, BERTHA_URL, BERTHA_RELEASE and NODE_ENV unless given. */
+/** Reads BERTHA_KEY, BERTHA_URL, BERTHA_RELEASE, BERTHA_COMMIT and NODE_ENV unless given. */
 export function init(options = {}) {
     const key = options.key ?? firstEnv("BERTHA_KEY", "NEXT_PUBLIC_BERTHA_KEY");
     const url = options.url ?? firstEnv("BERTHA_URL", "NEXT_PUBLIC_BERTHA_URL");
@@ -45,7 +45,7 @@ export function init(options = {}) {
     }
     if (options.heartbeat !== false) {
         clearInterval(heartbeat);
-        const beat = () => void sendHeartbeat(opts);
+        const beat = () => void sendHeartbeat({ ...opts, commit: options.commit ?? envCommit() });
         beat();
         heartbeat = setInterval(beat, HEARTBEAT_MS);
         heartbeat.unref();
@@ -83,7 +83,7 @@ export async function sendHeartbeat(o) {
         const res = await fetch(endpoint(o.url, "heartbeat"), {
             method: "POST",
             headers: { authorization: `Bearer ${o.key}`, "content-type": "application/json" },
-            body: JSON.stringify({ environment: o.environment, release: o.release }),
+            body: JSON.stringify({ environment: o.environment, release: o.release, commit: o.commit }),
             signal: AbortSignal.timeout(10_000),
         });
         return res.ok;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbertha/sdk",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "Error reporting for bertha: browser, Node, edge and Next.js, with source maps by debug id.",
   "license": "MIT",
   "repository": {