@autter/runtime-cli 1.0.0 → 1.1.0

package/README.md

@@ -22,7 +22,7 @@ npm install -D @autter/runtime-cli
 ```
 
 Set `AUTTER_RUNTIME_KEY` to a **server** ingest key (`autter_rt_…`) where your
-build runs. Without it, debug ids are injected and nothing is uploaded.
+build runs. Without it, the plugins turn no source maps on and change nothing.
 
 ## Vite / Rollup
 
@@ -50,8 +50,10 @@ export default withAutterSourceMaps({ reactStrictMode: true });
 ```
 
 All three turn on hidden source maps when you haven't configured maps, inject
-debug ids after the build, upload when a key is present, and delete the maps
-they created once uploaded. Options (all optional): `release`, `urlPrefix`,
+debug ids after the build, upload when a key is present, and then delete the
+maps they created whether or not the upload succeeded (a rejected upload, an
+unreachable ingester, a dry run), printing one line that says why; without a
+key they turn none on. Maps you configured yourself are left alone. Options (all optional): `release`, `urlPrefix`,
 `endpoint`, `key`, `upload: false`, `deleteAfterUpload`, `dryRun`,
 `concurrency`, `failOnError` (default `false`: a failed upload is logged and
 never fails the build), `silent`.
@@ -74,10 +76,14 @@ autter-runtime sourcemaps upload <dir> [--release <r>] [--url-prefix <prefix>]
   `globalThis._autterDebugIds[new Error().stack] = "<id>"`, and `"debugId"` in
   the `.map`, for each `.js`/`.mjs`/`.cjs` with a map. The id is derived from
   sha256 of the bundle bytes; running it again changes nothing.
-- **upload** posts each map (without `sourcesContent`) to
-  `<endpoint>/v1/sourcemaps`, in parallel, skipping maps the ingester already
-  has. Release: `--release`, else `GITHUB_SHA`, `VERCEL_GIT_COMMIT_SHA`,
-  `CF_PAGES_COMMIT_SHA`, `GIT_SHA`, then `git rev-parse HEAD`.
+- **upload** posts each map (without `sourcesContent`, gzipped, up to 32 MB)
+  to `<endpoint>/v1/sourcemaps`, in parallel, skipping maps the ingester
+  already has. Each map carries the bundle's function scopes (`x_autter_scopes`),
+  parsed from the file as served, so frames are named after the function they
+  are in rather than their call site; a bundle that does not parse is uploaded
+  without them, with a warning. Release: `--release`, else `GITHUB_SHA`,
+  `VERCEL_GIT_COMMIT_SHA`, `CF_PAGES_COMMIT_SHA`, `GIT_SHA`, then
+  `git rev-parse HEAD`.
 
 Exit codes: `0` ok, `1` some maps failed, `2` no key / no release / key
 rejected, `64` usage error.

package/dist/{build-BXFh_jbP.d.cts → build-CPXR9Xd3.d.cts}

@@ -69,7 +69,11 @@ declare function injectBundle(bundle: BundleWithMap, options?: InjectOptions): P
 declare function injectDir(dir: string, options?: InjectOptions): Promise<InjectResult[]>;
 
 declare const DEFAULT_ENDPOINT = "https://otlp.autter.dev";
-/** The ingester's `/v1/sourcemaps` body limit. */
+/** Largest map the ingester stores: characters of JSON without
+ * `sourcesContent` (otlp-ingester's SOURCE_MAP_MAX_CHARS). */
+declare const MAX_MAP_CHARS: number;
+/** The ingester's `/v1/sourcemaps` body limit, counted after the gzip body
+ * is inflated: the map plus room for the rest of the request. */
 declare const MAX_UPLOAD_BYTES: number;
 interface UploadOptions {
     /** Only these bundles (absolute, or relative to the directory). */
@@ -145,13 +149,17 @@ interface AutterSourceMapsOptions {
     /** Ingester base URL. Default: $AUTTER_ENDPOINT, $AUTTER_RUNTIME_ENDPOINT,
      * $OTEL_EXPORTER_OTLP_ENDPOINT, else https://otlp.autter.dev. */
     endpoint?: string;
-    /** Server ingest key. Default: $AUTTER_RUNTIME_KEY. Without one, debug ids
-     * are still injected but nothing is uploaded. */
+    /** Server ingest key. Default: $AUTTER_RUNTIME_KEY. Without one (and
+     * without `upload: false` or `dryRun`), the plugin generates no source
+     * maps it would have to delete again: the build is left as it was. */
     key?: string;
-    /** Set false to inject debug ids only (upload later with the CLI). */
+    /** Set false to inject debug ids only (upload later with the CLI). Maps
+     * the plugin generated are then kept for that upload: don't deploy them. */
     upload?: boolean;
-    /** Delete `.map` files once uploaded so they are never deployed. Default:
-     * true when the plugin turned source maps on itself, false when you had. */
+    /** Maps the plugin generated itself are always deleted after the upload
+     * step, uploaded or not, so they are never deployed; set false to keep
+     * them (you must then keep them out of the deploy). Maps you configured
+     * yourself are deleted only when this is true, and only once uploaded. */
     deleteAfterUpload?: boolean;
     /** Log what would be uploaded without sending anything. */
     dryRun?: boolean;
@@ -166,13 +174,19 @@ interface AutterSourceMapsOptions {
 interface BuildOutputResult {
     injected: InjectResult[];
     upload: UploadSummary | null;
+    /** Maps the plugin generated and deleted (paths relative to the directory). */
+    removedMaps: string[];
 }
 /** Human-readable lines for an upload summary (CLI and plugins). */
 declare function formatUploadSummary(summary: UploadSummary): string[];
 /**
  * What every bundler integration does after a build: inject debug ids into
  * the emitted bundles, then upload their maps when a key is present.
- * Failures are logged, and thrown only with `failOnError`.
+ * Failures are logged, and thrown only with `failOnError`. When the
+ * integration turned source maps on itself (`ownMaps`), every map it made
+ * is deleted afterwards whatever happened to the upload (no key, a failed
+ * or partial upload, an unreachable ingester, a dry run), with the
+ * sourceMappingURL comments that name them, so none is deployed.
  */
 declare function processBuildOutput(input: {
     dir: string;
@@ -182,6 +196,11 @@ declare function processBuildOutput(input: {
     /** Default for `deleteAfterUpload` (true when the plugin enabled maps). */
     deleteAfterUpload: boolean;
     stripSourceMappingUrl?: boolean;
+    /** The integration turned source maps on itself: none may be deployed. */
+    ownMaps?: boolean;
+    /** Map files the build emitted (absolute), when the bundler lists them;
+     * the maps of `files` (or of every bundle under `dir`) are added. */
+    maps?: string[];
 }): Promise<BuildOutputResult>;
 
-export { type AutterSourceMapsOptions as A, BUNDLE_RE as B, DEFAULT_ENDPOINT as D, FatalUploadError as F, type InjectOptions as I, MAX_UPLOAD_BYTES as M, SNIPPET_LINE_KEY as S, type UploadItem as U, type BuildOutputResult as a, type BundleWithMap as b, type InjectResult as c, type UploadOptions as d, type UploadSummary as e, findBundles as f, formatUploadSummary as g, injectDir as h, injectBundle as i, resolveEndpoint as j, shiftMappings as k, snippetLine as l, mapPathFor as m, storedMapJson as n, stripSourceMappingUrl as o, processBuildOutput as p, readSourceMappingUrl as r, servedFilename as s, uploadDir as u };
+export { type AutterSourceMapsOptions as A, BUNDLE_RE as B, DEFAULT_ENDPOINT as D, FatalUploadError as F, type InjectOptions as I, MAX_MAP_CHARS as M, SNIPPET_LINE_KEY as S, type UploadItem as U, type BuildOutputResult as a, type BundleWithMap as b, type InjectResult as c, MAX_UPLOAD_BYTES as d, type UploadOptions as e, type UploadSummary as f, findBundles as g, formatUploadSummary as h, injectBundle as i, injectDir as j, resolveEndpoint as k, shiftMappings as l, mapPathFor as m, snippetLine as n, storedMapJson as o, processBuildOutput as p, stripSourceMappingUrl as q, readSourceMappingUrl as r, servedFilename as s, uploadDir as u };

package/dist/{build-BXFh_jbP.d.ts → build-CPXR9Xd3.d.ts}

@@ -69,7 +69,11 @@ declare function injectBundle(bundle: BundleWithMap, options?: InjectOptions): P
 declare function injectDir(dir: string, options?: InjectOptions): Promise<InjectResult[]>;
 
 declare const DEFAULT_ENDPOINT = "https://otlp.autter.dev";
-/** The ingester's `/v1/sourcemaps` body limit. */
+/** Largest map the ingester stores: characters of JSON without
+ * `sourcesContent` (otlp-ingester's SOURCE_MAP_MAX_CHARS). */
+declare const MAX_MAP_CHARS: number;
+/** The ingester's `/v1/sourcemaps` body limit, counted after the gzip body
+ * is inflated: the map plus room for the rest of the request. */
 declare const MAX_UPLOAD_BYTES: number;
 interface UploadOptions {
     /** Only these bundles (absolute, or relative to the directory). */
@@ -145,13 +149,17 @@ interface AutterSourceMapsOptions {
     /** Ingester base URL. Default: $AUTTER_ENDPOINT, $AUTTER_RUNTIME_ENDPOINT,
      * $OTEL_EXPORTER_OTLP_ENDPOINT, else https://otlp.autter.dev. */
     endpoint?: string;
-    /** Server ingest key. Default: $AUTTER_RUNTIME_KEY. Without one, debug ids
-     * are still injected but nothing is uploaded. */
+    /** Server ingest key. Default: $AUTTER_RUNTIME_KEY. Without one (and
+     * without `upload: false` or `dryRun`), the plugin generates no source
+     * maps it would have to delete again: the build is left as it was. */
     key?: string;
-    /** Set false to inject debug ids only (upload later with the CLI). */
+    /** Set false to inject debug ids only (upload later with the CLI). Maps
+     * the plugin generated are then kept for that upload: don't deploy them. */
     upload?: boolean;
-    /** Delete `.map` files once uploaded so they are never deployed. Default:
-     * true when the plugin turned source maps on itself, false when you had. */
+    /** Maps the plugin generated itself are always deleted after the upload
+     * step, uploaded or not, so they are never deployed; set false to keep
+     * them (you must then keep them out of the deploy). Maps you configured
+     * yourself are deleted only when this is true, and only once uploaded. */
     deleteAfterUpload?: boolean;
     /** Log what would be uploaded without sending anything. */
     dryRun?: boolean;
@@ -166,13 +174,19 @@ interface AutterSourceMapsOptions {
 interface BuildOutputResult {
     injected: InjectResult[];
     upload: UploadSummary | null;
+    /** Maps the plugin generated and deleted (paths relative to the directory). */
+    removedMaps: string[];
 }
 /** Human-readable lines for an upload summary (CLI and plugins). */
 declare function formatUploadSummary(summary: UploadSummary): string[];
 /**
  * What every bundler integration does after a build: inject debug ids into
  * the emitted bundles, then upload their maps when a key is present.
- * Failures are logged, and thrown only with `failOnError`.
+ * Failures are logged, and thrown only with `failOnError`. When the
+ * integration turned source maps on itself (`ownMaps`), every map it made
+ * is deleted afterwards whatever happened to the upload (no key, a failed
+ * or partial upload, an unreachable ingester, a dry run), with the
+ * sourceMappingURL comments that name them, so none is deployed.
  */
 declare function processBuildOutput(input: {
     dir: string;
@@ -182,6 +196,11 @@ declare function processBuildOutput(input: {
     /** Default for `deleteAfterUpload` (true when the plugin enabled maps). */
     deleteAfterUpload: boolean;
     stripSourceMappingUrl?: boolean;
+    /** The integration turned source maps on itself: none may be deployed. */
+    ownMaps?: boolean;
+    /** Map files the build emitted (absolute), when the bundler lists them;
+     * the maps of `files` (or of every bundle under `dir`) are added. */
+    maps?: string[];
 }): Promise<BuildOutputResult>;
 
-export { type AutterSourceMapsOptions as A, BUNDLE_RE as B, DEFAULT_ENDPOINT as D, FatalUploadError as F, type InjectOptions as I, MAX_UPLOAD_BYTES as M, SNIPPET_LINE_KEY as S, type UploadItem as U, type BuildOutputResult as a, type BundleWithMap as b, type InjectResult as c, type UploadOptions as d, type UploadSummary as e, findBundles as f, formatUploadSummary as g, injectDir as h, injectBundle as i, resolveEndpoint as j, shiftMappings as k, snippetLine as l, mapPathFor as m, storedMapJson as n, stripSourceMappingUrl as o, processBuildOutput as p, readSourceMappingUrl as r, servedFilename as s, uploadDir as u };
+export { type AutterSourceMapsOptions as A, BUNDLE_RE as B, DEFAULT_ENDPOINT as D, FatalUploadError as F, type InjectOptions as I, MAX_MAP_CHARS as M, SNIPPET_LINE_KEY as S, type UploadItem as U, type BuildOutputResult as a, type BundleWithMap as b, type InjectResult as c, MAX_UPLOAD_BYTES as d, type UploadOptions as e, type UploadSummary as f, findBundles as g, formatUploadSummary as h, injectBundle as i, injectDir as j, resolveEndpoint as k, shiftMappings as l, mapPathFor as m, snippetLine as n, storedMapJson as o, processBuildOutput as p, stripSourceMappingUrl as q, readSourceMappingUrl as r, servedFilename as s, uploadDir as u };