@edraj/sauron-browser 1.0.0 → 1.3.0

package/dist/index.cjs

@@ -8,7 +8,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 
 // src/utils.ts
 var SDK_NAME = "sauron.javascript";
-var SDK_VERSION = "1.0.0";
+var SDK_VERSION = "1.3.0";
 function getGlobal() {
   return globalThis;
 }
@@ -836,6 +836,30 @@ var Scope = class {
   }
 };
 
+// src/workflow.ts
+var WORKFLOW_NAME_MAX = 120;
+var WORKFLOW_REASON_MAX = 120;
+var current = null;
+function getWorkflow() {
+  return current;
+}
+function setWorkflowState(workflow) {
+  current = workflow;
+}
+function resetWorkflow() {
+  current = null;
+}
+function normalizeWorkflowName(name) {
+  if (typeof name !== "string") return null;
+  const trimmed = name.trim();
+  if (trimmed.length === 0 || trimmed.length > WORKFLOW_NAME_MAX) return null;
+  return trimmed;
+}
+function normalizeReason(reason) {
+  if (typeof reason !== "string" || reason.trim().length === 0) return "user";
+  return reason.trim().slice(0, WORKFLOW_REASON_MAX);
+}
+
 // src/api/product.ts
 function track(name, properties = {}, options = {}) {
   const client = getClient();
@@ -906,6 +930,86 @@ function trackTransaction(input) {
   const item = buildTransactionItem(input, client.getDistinctId(), getSessionId());
   client.captureItem(item);
 }
+var NOOP_LOGGER = makeLogger(false);
+function emitWorkflowClose(active, eventName, reason, logger) {
+  const properties = {
+    workflow_id: active.workflowId,
+    workflow_name: active.name,
+    duration_ms: Math.max(0, Date.now() - Date.parse(active.startedAt))
+  };
+  if (eventName === "$workflow_cancel") {
+    properties.reason = normalizeReason(reason);
+  }
+  try {
+    track(eventName, properties);
+  } catch (err) {
+    logger.warn(`${eventName}: failed to emit the lifecycle event`, err);
+  } finally {
+    resetWorkflow();
+  }
+}
+function startWorkflow(name, options) {
+  let logger = NOOP_LOGGER;
+  try {
+    const client = getClient();
+    if (!client || !client.isEnabled()) return { status: "disabled" };
+    logger = makeLogger(client.options.debug);
+    const normalized = normalizeWorkflowName(name);
+    if (!normalized) {
+      logger.warn("startWorkflow: invalid name", name);
+      return { status: "invalid_name" };
+    }
+    const active = getWorkflow();
+    if (active && !options?.force) {
+      logger.warn(
+        `startWorkflow("${normalized}"): "${active.name}" is already active; pass { force: true } to replace it`
+      );
+      return { status: "already_active" };
+    }
+    const workflow = {
+      workflowId: uuidv4(),
+      name: normalized,
+      startedAt: nowIso()
+    };
+    if (active) emitWorkflowClose(active, "$workflow_cancel", "superseded", logger);
+    setWorkflowState(workflow);
+    try {
+      track("$workflow_start", { workflow_id: workflow.workflowId, workflow_name: workflow.name });
+    } catch (err) {
+      logger.warn("startWorkflow: failed to emit $workflow_start", err);
+    }
+    return { status: "ok", workflowId: workflow.workflowId };
+  } catch (err) {
+    logger.warn("startWorkflow failed", err);
+    return { status: "disabled" };
+  }
+}
+function closeWorkflow(eventName, name, reason) {
+  let logger = NOOP_LOGGER;
+  try {
+    const client = getClient();
+    if (!client || !client.isEnabled()) return { status: "disabled" };
+    logger = makeLogger(client.options.debug);
+    const active = getWorkflow();
+    if (!active) return { status: "not_active" };
+    if (name !== void 0 && normalizeWorkflowName(name) !== active.name) {
+      logger.warn(`${eventName}: "${name}" does not match active workflow "${active.name}"`);
+      return { status: "name_mismatch" };
+    }
+    const workflowId = active.workflowId;
+    emitWorkflowClose(active, eventName, reason, logger);
+    return { status: "ok", workflowId };
+  } catch (err) {
+    logger.warn(`${eventName} failed`, err);
+    return { status: "disabled" };
+  }
+}
+function endWorkflow(name) {
+  return closeWorkflow("$workflow_end", name);
+}
+function cancelWorkflow(name, options) {
+  return closeWorkflow("$workflow_cancel", name, options?.reason);
+}
 
 // src/integrations/performance.ts
 var PERF_FETCH = "__sauron_perf_fetch__";
@@ -1358,6 +1462,9 @@ var Transport = class {
     __publicField(this, "pending", []);
     __publicField(this, "timer", null);
     __publicField(this, "onlineHandler", null);
+    /** Permanent auto-disable latch, flipped by this transport itself the moment
+     * it classifies a response as 401/403 — it is the source of truth for
+     * {@link isEnabled}, not merely a mirror of something the client decided. */
     __publicField(this, "disabled", false);
     this.dsn = config.dsn;
     this.makeEnvelope = config.makeEnvelope;
@@ -1405,6 +1512,10 @@ var Transport = class {
     this.pending = [];
     this.stop();
   }
+  /** Whether the transport still accepts items (false once auth-disabled by a 401/403). */
+  isEnabled() {
+    return !this.disabled;
+  }
   /** Queue an item for the next batch; flush eagerly once the batch is full. */
   send(item) {
     if (this.disabled) return;
@@ -1447,6 +1558,7 @@ var Transport = class {
         return;
       case "disable":
         this.logger.warn("server rejected credentials; disabling client");
+        this.disable();
         this.onDisable();
         return;
       case "split": {
@@ -1484,6 +1596,7 @@ var Transport = class {
         outcome = { action: "retry_backoff" };
       }
       if (outcome.action === "disable") {
+        this.disable();
         this.onDisable();
         this.offline.enqueue(json);
         return;
@@ -1649,8 +1762,19 @@ var SauronClient = class {
   getScope() {
     return this.scope;
   }
+  /**
+   * False once this client was explicitly disabled/closed, OR once the
+   * transport has auto-disabled itself on a 401/403 (revoked/invalid DSN
+   * key) — computed from the transport's own state on every call, not a
+   * separately mirrored flag, so a propagation regression there cannot leave
+   * this predicate stale. `this.transport` always exists once a client
+   * exists (it is constructed synchronously in the constructor); the
+   * "nothing installed yet" case is instead handled one layer up, by every
+   * module-level API (`startWorkflow`, `track`, ...) treating `getClient() ===
+   * null` as the no-op/disabled case before it ever reaches here.
+   */
   isEnabled() {
-    return this.enabled;
+    return this.enabled && this.transport.isEnabled();
   }
   /** The current distinct id: the user id when identified, else an anon id. */
   getDistinctId() {
@@ -1672,7 +1796,6 @@ var SauronClient = class {
       dsn: this.dsn.raw,
       sdk: { name: SDK_NAME, version: SDK_VERSION },
       sent_at: nowIso(),
-      environment: this.options.environment,
       release: this.options.release
     };
     const context = buildContext(this.options.release, this.scope.getUser());
@@ -1718,6 +1841,39 @@ var SauronClient = class {
       item.user = this.scope.getUser();
     }
   }
+  /**
+   * Stamp the active workflow (if any) onto a signal item.
+   *
+   * Done HERE — the single choke point every capture path funnels through —
+   * rather than at each item-construction site, so a capture path added later
+   * is stamped by construction instead of by remembering to. The keys are
+   * ASSIGNED ONLY when a workflow is active: an item with no workflow keeps
+   * them absent entirely (not present-as-`undefined`), which is what makes
+   * `JSON.stringify` omit them and keeps the no-workflow wire bytes identical
+   * to pre-1.3.0.
+   *
+   * Only error/event/transaction carry `workflow_id`/`workflow_name` columns
+   * server-side — identify and breadcrumb_batch items are deliberately left
+   * alone. An item that already carries an explicit `workflow_id` is left
+   * untouched, matching how `enrichErrorItem` defers to caller-set fields.
+   */
+  stampWorkflow(item) {
+    if (item.type !== "error" && item.type !== "event" && item.type !== "transaction") return;
+    const hasId = item.workflow_id !== void 0;
+    const hasName = item.workflow_name !== void 0;
+    if (hasId || hasName) {
+      if (hasId !== hasName) {
+        this.logger.warn(
+          "item sets only one of workflow_id/workflow_name; the server treats them as a pair and will drop this attribution. Set both, or neither."
+        );
+      }
+      return;
+    }
+    const workflow = getWorkflow();
+    if (!workflow) return;
+    item.workflow_id = workflow.workflowId;
+    item.workflow_name = workflow.name;
+  }
   /**
    * Run an item through sampling (errors only) and `beforeSend`, then hand it to
    * the transport. Returns silently when dropped.
@@ -1731,6 +1887,7 @@ var SauronClient = class {
       }
       this.enrichErrorItem(item, hint);
     }
+    this.stampWorkflow(item);
     let processed = item;
     if (this.options.beforeSend) {
       try {
@@ -1767,6 +1924,7 @@ var SauronClient = class {
     }
     onNavigation(null);
     resetScreen();
+    resetWorkflow();
     unpatchAll();
     setDsnHost(null);
     this.installed = false;
@@ -1789,7 +1947,6 @@ function resolveOptions(options) {
   const t = options.transport ?? {};
   return {
     dsn: options.dsn,
-    environment: options.environment ?? "production",
     release: options.release ?? null,
     sampleRate: clamp(options.sampleRate ?? 1, 0, 1),
     maxBreadcrumbs: options.maxBreadcrumbs ?? 50,
@@ -1874,6 +2031,18 @@ function setScreen2(name) {
 function getScreen2() {
   return getScreen();
 }
+function startWorkflow2(name, options) {
+  return startWorkflow(name, options);
+}
+function endWorkflow2(name) {
+  return endWorkflow(name);
+}
+function cancelWorkflow2(name, options) {
+  return cancelWorkflow(name, options);
+}
+function getWorkflow2() {
+  return getWorkflow();
+}
 function addBreadcrumb2(breadcrumb, hint) {
   addBreadcrumb(breadcrumb, hint);
 }
@@ -1915,6 +2084,10 @@ var Sauron = {
   setExtra,
   setScreen: setScreen2,
   getScreen: getScreen2,
+  startWorkflow: startWorkflow2,
+  endWorkflow: endWorkflow2,
+  cancelWorkflow: cancelWorkflow2,
+  getWorkflow: getWorkflow2,
   flush,
   close,
   getClient
@@ -1928,13 +2101,16 @@ exports.Sauron = Sauron;
 exports.SauronClient = SauronClient;
 exports.addBreadcrumb = addBreadcrumb2;
 exports.buildEnvelope = buildEnvelope;
+exports.cancelWorkflow = cancelWorkflow2;
 exports.captureException = captureException2;
 exports.captureMessage = captureMessage2;
 exports.close = close;
 exports.default = index_default;
+exports.endWorkflow = endWorkflow2;
 exports.flush = flush;
 exports.getClient = getClient;
 exports.getScreen = getScreen2;
+exports.getWorkflow = getWorkflow2;
 exports.identify = identify2;
 exports.init = init2;
 exports.isInAppFrame = isInAppFrame;
@@ -1947,6 +2123,7 @@ exports.setScreen = setScreen2;
 exports.setTag = setTag;
 exports.setTags = setTags;
 exports.setUser = setUser;
+exports.startWorkflow = startWorkflow2;
 exports.track = track2;
 exports.trackTransaction = trackTransaction2;
 //# sourceMappingURL=index.cjs.map