@hawk.so/nextjs 1.0.0 → 1.1.0

package/dist/react.js

@@ -0,0 +1,179 @@
+"use client";
+
+// src/react/index.tsx
+import { Component, useEffect } from "react";
+
+// src/common/carrier.ts
+var CARRIER_KEY = /* @__PURE__ */ Symbol.for("hawk.nextjs");
+function getCarrier() {
+  const store = globalThis;
+  store[CARRIER_KEY] ??= {};
+  return store[CARRIER_KEY];
+}
+
+// src/common/control-flow.ts
+var CONTROL_FLOW_DIGEST_PREFIXES = [
+  "NEXT_REDIRECT",
+  "NEXT_HTTP_ERROR_FALLBACK;",
+  "NEXT_NOT_FOUND",
+  "BAILOUT_TO_CLIENT_SIDE_RENDERING",
+  "DYNAMIC_SERVER_USAGE",
+  "NEXT_PRERENDER_INTERRUPTED",
+  "HANGING_PROMISE_REJECTION"
+];
+var STATIC_GEN_BAILOUT_CODE = "NEXT_STATIC_GEN_BAILOUT";
+var REACT_POSTPONE_TYPE = /* @__PURE__ */ Symbol.for("react.postpone");
+var MAX_CAUSE_DEPTH = 5;
+function isControlFlowDigest(value) {
+  return typeof value === "string" && CONTROL_FLOW_DIGEST_PREFIXES.some((prefix) => value.startsWith(prefix));
+}
+function isNextControlFlowError(error) {
+  let current = error;
+  for (let depth = 0; depth < MAX_CAUSE_DEPTH; depth++) {
+    if (typeof current !== "object" || current === null) {
+      return false;
+    }
+    const value = current;
+    if (isControlFlowDigest(value.digest) || isControlFlowDigest(value.message) || value.code === STATIC_GEN_BAILOUT_CODE || value.$$typeof === REACT_POSTPONE_TYPE) {
+      return true;
+    }
+    current = value.cause;
+  }
+  return false;
+}
+function getDigest(error) {
+  if (typeof error === "object" && error !== null) {
+    const { digest } = error;
+    if (typeof digest === "string" && digest !== "") {
+      return digest;
+    }
+  }
+  return void 0;
+}
+
+// src/react/index.tsx
+import { jsx, jsxs } from "react/jsx-runtime";
+function captureBoundaryError(error, boundary, componentStack) {
+  if (isNextControlFlowError(error) || getDigest(error) !== void 0) {
+    return;
+  }
+  getCarrier().capture?.(error, {
+    boundary,
+    ...typeof componentStack === "string" ? { componentStack } : {}
+  });
+}
+function useHawkError(error) {
+  useEffect(() => {
+    captureBoundaryError(error, "error");
+  }, [error]);
+}
+var globalErrorStyles = {
+  container: {
+    fontFamily: "system-ui, sans-serif",
+    minHeight: "100vh",
+    display: "flex",
+    flexDirection: "column",
+    alignItems: "center",
+    justifyContent: "center",
+    gap: 16,
+    textAlign: "center"
+  },
+  title: {
+    fontSize: 14,
+    fontWeight: 400,
+    margin: 0
+  },
+  digest: {
+    fontSize: 12,
+    opacity: 0.6,
+    margin: 0
+  },
+  button: {
+    fontSize: 14,
+    padding: "6px 14px",
+    cursor: "pointer"
+  }
+};
+function HawkGlobalError({ error, reset }) {
+  useEffect(() => {
+    captureBoundaryError(error, "global-error");
+  }, [error]);
+  const side = error.digest === void 0 ? "client" : "server";
+  return /* @__PURE__ */ jsx("html", { lang: "en", children: /* @__PURE__ */ jsx("body", { children: /* @__PURE__ */ jsxs("main", { style: globalErrorStyles.container, children: [
+    /* @__PURE__ */ jsxs("h2", { style: globalErrorStyles.title, children: [
+      "Application error: a ",
+      side,
+      "-side exception has occurred."
+    ] }),
+    error.digest !== void 0 && /* @__PURE__ */ jsxs("p", { style: globalErrorStyles.digest, children: [
+      "Digest: ",
+      error.digest
+    ] }),
+    reset !== void 0 && /* @__PURE__ */ jsx("button", { type: "button", style: globalErrorStyles.button, onClick: reset, children: "Try again" })
+  ] }) }) });
+}
+var HawkErrorBoundary = class extends Component {
+  /**
+   * Initial state
+   */
+  state = {
+    hasError: false,
+    error: null
+  };
+  /**
+   * Shows the fallback after an error
+   * @param error - caught error
+   */
+  static getDerivedStateFromError(error) {
+    return {
+      hasError: true,
+      error
+    };
+  }
+  /**
+   * Sends the caught error
+   * @param error - caught error
+   * @param info - component stack
+   */
+  componentDidCatch(error, info) {
+    if (isNextControlFlowError(error)) {
+      return;
+    }
+    captureBoundaryError(error, "boundary", info.componentStack);
+    this.props.onError?.(error, info);
+  }
+  /**
+   * Renders the children again
+   */
+  reset = () => {
+    this.setState({
+      hasError: false,
+      error: null
+    });
+  };
+  /**
+   * Renders the children or the fallback
+   */
+  render() {
+    const { hasError, error } = this.state;
+    if (!hasError) {
+      return this.props.children;
+    }
+    if (isNextControlFlowError(error)) {
+      throw error;
+    }
+    const { fallback } = this.props;
+    if (typeof fallback === "function") {
+      return fallback({
+        error,
+        reset: this.reset
+      });
+    }
+    return fallback ?? null;
+  }
+};
+export {
+  HawkErrorBoundary,
+  HawkGlobalError,
+  useHawkError
+};

package/dist/server.cjs

@@ -0,0 +1,500 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/server/index.ts
+var server_exports = {};
+__export(server_exports, {
+  HawkErrorBoundary: () => import_react.HawkErrorBoundary,
+  HawkGlobalError: () => import_react.HawkGlobalError,
+  breadcrumbs: () => breadcrumbs,
+  clearUser: () => clearUser,
+  flush: () => flush,
+  init: () => init,
+  onRequestError: () => onRequestError,
+  onRouterTransitionStart: () => onRouterTransitionStart,
+  send: () => send,
+  setContext: () => setContext,
+  setUser: () => setUser,
+  useHawkError: () => import_react.useHawkError
+});
+module.exports = __toCommonJS(server_exports);
+
+// src/server/sdk.ts
+var import_core3 = require("@hawk.so/core");
+
+// src/common/carrier.ts
+var CARRIER_KEY = /* @__PURE__ */ Symbol.for("hawk.nextjs");
+function getCarrier() {
+  const store = globalThis;
+  store[CARRIER_KEY] ??= {};
+  return store[CARRIER_KEY];
+}
+
+// src/common/control-flow.ts
+var CONTROL_FLOW_DIGEST_PREFIXES = [
+  "NEXT_REDIRECT",
+  "NEXT_HTTP_ERROR_FALLBACK;",
+  "NEXT_NOT_FOUND",
+  "BAILOUT_TO_CLIENT_SIDE_RENDERING",
+  "DYNAMIC_SERVER_USAGE",
+  "NEXT_PRERENDER_INTERRUPTED",
+  "HANGING_PROMISE_REJECTION"
+];
+var STATIC_GEN_BAILOUT_CODE = "NEXT_STATIC_GEN_BAILOUT";
+var REACT_POSTPONE_TYPE = /* @__PURE__ */ Symbol.for("react.postpone");
+var MAX_CAUSE_DEPTH = 5;
+function isControlFlowDigest(value) {
+  return typeof value === "string" && CONTROL_FLOW_DIGEST_PREFIXES.some((prefix) => value.startsWith(prefix));
+}
+function isNextControlFlowError(error) {
+  let current = error;
+  for (let depth = 0; depth < MAX_CAUSE_DEPTH; depth++) {
+    if (typeof current !== "object" || current === null) {
+      return false;
+    }
+    const value = current;
+    if (isControlFlowDigest(value.digest) || isControlFlowDigest(value.message) || value.code === STATIC_GEN_BAILOUT_CODE || value.$$typeof === REACT_POSTPONE_TYPE) {
+      return true;
+    }
+    current = value.cause;
+  }
+  return false;
+}
+function getDigest(error) {
+  if (typeof error === "object" && error !== null) {
+    const { digest } = error;
+    if (typeof digest === "string" && digest !== "") {
+      return digest;
+    }
+  }
+  return void 0;
+}
+
+// src/common/error.ts
+function isErrorLike(value) {
+  return typeof value === "object" && value !== null && typeof value.message === "string" && typeof value.stack === "string";
+}
+function normalizeError(value) {
+  if (value instanceof Error || typeof value === "string") {
+    return value;
+  }
+  if (isErrorLike(value)) {
+    const error = new Error(value.message);
+    error.name = typeof value.name === "string" ? value.name : error.name;
+    error.stack = value.stack;
+    return error;
+  }
+  try {
+    return JSON.stringify(value) ?? String(value);
+  } catch (_error) {
+    return String(value);
+  }
+}
+
+// src/common/options.ts
+var DEFAULT_FLUSH_TIMEOUT = 2e3;
+
+// src/common/request.ts
+var SAFE_HEADERS = ["host", "referer", "user-agent"];
+function pickSafeHeaders(headers) {
+  const result = {};
+  for (const name of SAFE_HEADERS) {
+    const value = headers[name];
+    if (value !== void 0) {
+      result[name] = Array.isArray(value) ? value.join(", ") : value;
+    }
+  }
+  return result;
+}
+function getRequestAddons(error, request, context) {
+  const addons = {
+    digest: getDigest(error),
+    routerKind: context.routerKind,
+    routePath: context.routePath,
+    routeType: context.routeType,
+    renderSource: context.renderSource,
+    revalidateReason: context.revalidateReason,
+    renderType: context.renderType,
+    method: request.method,
+    path: request.path,
+    headers: pickSafeHeaders(request.headers)
+  };
+  return Object.fromEntries(Object.entries(addons).filter(([, value]) => value !== void 0));
+}
+
+// src/server/catcher.ts
+var import_core2 = require("@hawk.so/core");
+
+// src/common/timeout.ts
+async function settleWithTimeout(promises, timeout) {
+  const list = [...promises];
+  if (list.length === 0) {
+    return true;
+  }
+  let timer;
+  const timeoutReached = new Promise((resolve) => {
+    timer = setTimeout(() => resolve(false), timeout);
+  });
+  const allSettled = Promise.allSettled(list).then(() => true);
+  try {
+    return await Promise.race([allSettled, timeoutReached]);
+  } finally {
+    clearTimeout(timer);
+  }
+}
+
+// src/common/version.ts
+var VERSION = true ? "1.1.0" : "dev";
+
+// src/server/stack-parser.ts
+var import_core = require("@hawk.so/core");
+var import_error_stack_parser = __toESM(require("error-stack-parser"), 1);
+var ServerStackParser = class extends import_core.StackParser {
+  /**
+   * Returns frames of the stack trace
+   * @param error - error with the stack trace
+   */
+  parse(error) {
+    const frames = import_error_stack_parser.default.parse(error).map((frame) => ({
+      file: frame.fileName ?? "",
+      line: frame.lineNumber ?? 0,
+      column: frame.columnNumber,
+      function: frame.functionName,
+      arguments: frame.args
+    }));
+    return Promise.resolve(frames);
+  }
+};
+
+// src/server/transport.ts
+var REQUEST_TIMEOUT = 1e4;
+var FetchTransport = class {
+  /**
+   * Collector endpoint
+   */
+  endpoint;
+  /**
+   * Requests in progress
+   */
+  pending = /* @__PURE__ */ new Set();
+  /**
+   * @param endpoint - collector endpoint, e.g. `https://<integration id>.k1.hawk.so/`
+   */
+  constructor(endpoint) {
+    this.endpoint = endpoint;
+  }
+  /**
+   * Sends the event
+   * @param message - event with the token and the catcher type
+   */
+  send(message) {
+    const request = this.post(message).finally(() => {
+      this.pending.delete(request);
+    });
+    this.pending.add(request);
+    return request;
+  }
+  /**
+   * Waits for the requests in progress
+   * @param timeout - max time to wait, in milliseconds
+   * @returns false when the timeout is reached
+   */
+  flush(timeout) {
+    return settleWithTimeout(this.pending, timeout);
+  }
+  /**
+   * Posts the event to the collector
+   * @param message - event with the token and the catcher type
+   */
+  async post(message) {
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(), REQUEST_TIMEOUT);
+    try {
+      const response = await fetch(this.endpoint, {
+        method: "POST",
+        headers: [["Content-Type", "application/json"]],
+        body: JSON.stringify(message),
+        signal: controller.signal
+      });
+      if (!response.ok) {
+        throw new Error(`Collector responded with ${response.status} ${response.statusText}`);
+      }
+    } finally {
+      clearTimeout(timer);
+    }
+  }
+};
+
+// src/server/catcher.ts
+var usersByError = /* @__PURE__ */ new WeakMap();
+var noopStorage = {
+  getItem: () => null,
+  setItem: () => void 0,
+  removeItem: () => void 0
+};
+var zeroRandomGenerator = {
+  getRandomNumbers: (length) => new Uint8Array(length)
+};
+var ServerUserManager = class extends import_core2.HawkUserManager {
+  /**
+   * Creates a manager that never stores the user
+   */
+  constructor() {
+    super(noopStorage, zeroRandomGenerator);
+  }
+};
+var ServerUserProcessor = class {
+  /**
+   * @param payload - event being built
+   * @param error - sent error
+   */
+  apply(payload, error) {
+    const user = typeof error === "object" ? usersByError.get(error) : void 0;
+    if (user !== void 0) {
+      payload.user = user;
+    } else {
+      delete payload.user;
+    }
+    return payload;
+  }
+};
+function getDefaultEndpoint(token) {
+  return `https://${(0, import_core2.decodeIntegrationId)(token)}.k1.hawk.so/`;
+}
+var ServerCatcher = class extends import_core2.BaseCatcher {
+  /**
+   * Transport kept to wait for the events in progress
+   */
+  fetchTransport;
+  /**
+   * Current runtime: `nodejs` or `edge`
+   */
+  runtime;
+  /**
+   * Events being built: the stack trace is parsed asynchronously before the event gets to the transport
+   */
+  pending = /* @__PURE__ */ new Set();
+  /**
+   * @param settings - token, release and other settings
+   * @throws when the token is invalid and the collector endpoint is not set
+   */
+  constructor(settings) {
+    const transport = new FetchTransport(settings.collectorEndpoint ?? getDefaultEndpoint(settings.token));
+    super(settings.token, transport, new ServerUserManager(), settings.release, settings.context, settings.beforeSend);
+    this.fetchTransport = transport;
+    this.runtime = settings.runtime;
+    this.addMessageProcessor(new ServerUserProcessor());
+    this.stackParser = new ServerStackParser();
+  }
+  /**
+   * Sends the error and resolves when it is passed to the transport
+   * @param error - error or message
+   * @param options - context, user and Next.js data of the event
+   */
+  capture(error, options = {}) {
+    if (options.user !== void 0 && typeof error === "object") {
+      usersByError.set(error, options.user);
+    }
+    const addons = {
+      runtime: this.runtime,
+      ...options.addons
+    };
+    const building = this.formatAndSend(error, { nextjs: addons }, options.context).finally(() => {
+      this.pending.delete(building);
+    });
+    this.pending.add(building);
+    return building;
+  }
+  /**
+   * Waits for the events being built and sent
+   * @param timeout - max time to wait, in milliseconds
+   * @returns false when the timeout is reached
+   */
+  async flush(timeout) {
+    const deadline = Date.now() + timeout;
+    if (!await settleWithTimeout(this.pending, timeout)) {
+      return false;
+    }
+    return this.fetchTransport.flush(Math.max(deadline - Date.now(), 0));
+  }
+  /**
+   * Returns the catcher type
+   */
+  getCatcherType() {
+    return "errors/nodejs";
+  }
+  /**
+   * Returns the catcher version
+   */
+  getCatcherVersion() {
+    return VERSION;
+  }
+};
+
+// src/server/sdk.ts
+var REQUEST_CONTEXT_KEY = /* @__PURE__ */ Symbol.for("@next/request-context");
+var noopBreadcrumbs = {
+  add: () => void 0,
+  get: () => [],
+  clear: () => void 0
+};
+var isSetUserWarningShown = false;
+function getCatcher() {
+  return getCarrier().catcher;
+}
+function setConsoleLogger() {
+  if ((0, import_core3.isLoggerSet)()) {
+    return;
+  }
+  (0, import_core3.setLogger)((message, type = "log", args) => {
+    const method = type === "warn" || type === "error" || type === "info" ? type : "log";
+    const text = `\u{1F985} Hawk | ${message}`;
+    if (args === void 0) {
+      console[method](text);
+    } else {
+      console[method](text, args);
+    }
+  });
+}
+function getEnvToken() {
+  return [process.env.HAWK_TOKEN, process.env.NEXT_PUBLIC_HAWK_TOKEN].find((value) => value !== void 0 && value !== "");
+}
+function waitUntil(promise) {
+  globalThis[REQUEST_CONTEXT_KEY]?.get?.()?.waitUntil?.(promise);
+}
+function initServerCatcher(options, runtime) {
+  const carrier = getCarrier();
+  if (carrier.catcher !== void 0) {
+    return void 0;
+  }
+  setConsoleLogger();
+  const token = options.token ?? getEnvToken();
+  if (token === void 0 || token === "") {
+    (0, import_core3.log)("Integration Token is not provided, errors will not be sent. Set NEXT_PUBLIC_HAWK_TOKEN or pass `token` to init()", "warn");
+    return void 0;
+  }
+  try {
+    carrier.catcher = new ServerCatcher({
+      token,
+      release: options.release ?? process.env.HAWK_RELEASE,
+      context: options.context,
+      beforeSend: options.beforeSend,
+      collectorEndpoint: options.collectorEndpoint,
+      runtime
+    });
+  } catch (_error) {
+    (0, import_core3.log)("Invalid Integration Token, errors will not be sent", "error");
+    return void 0;
+  }
+  const { catcher } = carrier;
+  carrier.capture = (error, addons) => {
+    void catcher.capture(normalizeError(error), { addons });
+  };
+  return catcher;
+}
+async function captureServerError(error, options = {}) {
+  const catcher = getCatcher();
+  if (catcher === void 0 || isNextControlFlowError(error)) {
+    return;
+  }
+  await catcher.capture(normalizeError(error), options);
+}
+function send(error, context, user) {
+  void captureServerError(error, {
+    context,
+    user
+  });
+}
+function setUser(_user) {
+  if (!isSetUserWarningShown) {
+    isSetUserWarningShown = true;
+    (0, import_core3.log)("setUser() is ignored on the server, pass the user to send() instead", "warn");
+  }
+}
+function clearUser() {
+}
+function setContext(context) {
+  getCatcher()?.setContext(context);
+}
+var breadcrumbs = noopBreadcrumbs;
+async function flush(timeout = DEFAULT_FLUSH_TIMEOUT) {
+  const catcher = getCatcher();
+  return catcher === void 0 ? false : catcher.flush(timeout);
+}
+async function onRequestError(error, request, context) {
+  const catcher = getCatcher();
+  if (catcher === void 0 || isNextControlFlowError(error)) {
+    return;
+  }
+  const sending = captureServerError(error, {
+    addons: getRequestAddons(error, request, context)
+  }).then(() => catcher.flush(DEFAULT_FLUSH_TIMEOUT));
+  waitUntil(sending);
+  await sending;
+}
+function onRouterTransitionStart(_url, _navigationType) {
+}
+
+// src/server/index.ts
+var import_react = require("./react.cjs");
+async function handleProcessError(event, error) {
+  await captureServerError(error);
+  await flush();
+  if (process.listenerCount(event) === 1) {
+    console.error(error);
+    process.exit(1);
+  }
+}
+function init(options = {}) {
+  const catcher = initServerCatcher(options, "nodejs");
+  if (catcher === void 0 || options.disableGlobalErrorsHandling === true) {
+    return;
+  }
+  process.on("uncaughtException", (error) => {
+    void handleProcessError("uncaughtException", error);
+  });
+  process.on("unhandledRejection", (reason) => {
+    void handleProcessError("unhandledRejection", reason);
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  HawkErrorBoundary,
+  HawkGlobalError,
+  breadcrumbs,
+  clearUser,
+  flush,
+  init,
+  onRequestError,
+  onRouterTransitionStart,
+  send,
+  setContext,
+  setUser,
+  useHawkError
+});