@cedarjs/cli-helpers 8.0.0-canary.3599 → 8.0.0-canary.3601

package/dist/telemetry/index.d.ts

@@ -1,24 +1,3 @@
-import type { AttributeValue, Span } from '@opentelemetry/api';
-export { redactError, redactErrorMessage } from './redact.js';
-type TelemetryAttributes = {
-    [key: string]: AttributeValue | undefined;
-};
-/**
- * Safely records attributes to the opentelemetry span
- *
- * @param attributes An object of key-value pairs to be individually recorded as attributes
- * @param span An optional span to record the attributes to. If not provided, the current active span will be used
- */
-export declare function recordTelemetryAttributes(attributes: TelemetryAttributes, span?: Span): void;
-/**
- * Safely records an error to the opentelemetry span
- *
- * Only a redacted version of the error is recorded: the first line of the
- * message, with URLs and file paths replaced by placeholders, and no stack
- * trace. See `redactErrorMessage`.
- *
- * @param error An error to record to the span
- * @param span An optional span to record the error to. If not provided, the current active span will be used
- */
-export declare function recordTelemetryError(error: unknown, span?: Span): void;
+export { recordTelemetryAttributes, recordTelemetryError, } from '@cedarjs/telemetry/record';
+export type { TelemetryAttributes, TelemetryAttributeValue, } from '@cedarjs/telemetry/record';
 //# sourceMappingURL=index.d.ts.map

package/dist/telemetry/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/telemetry/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAA;AAK9D,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAE7D,KAAK,mBAAmB,GAAG;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAAA;CAC1C,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,mBAAmB,EAC/B,IAAI,CAAC,EAAE,IAAI,QAaZ;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,QAa/D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/telemetry/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,2BAA2B,CAAA;AAClC,YAAY,EACV,mBAAmB,EACnB,uBAAuB,GACxB,MAAM,2BAA2B,CAAA"}

package/dist/telemetry/index.js

@@ -1,32 +1,8 @@
-import opentelemetry, { SpanStatusCode } from "@opentelemetry/api";
-import { redactError } from "./redact.js";
-import { redactError as redactError2, redactErrorMessage } from "./redact.js";
-function recordTelemetryAttributes(attributes, span) {
-  const spanToRecord = span ?? opentelemetry.trace.getActiveSpan();
-  if (spanToRecord === void 0) {
-    return;
-  }
-  for (const [key, value] of Object.entries(attributes)) {
-    if (value !== void 0) {
-      spanToRecord.setAttribute(key, value);
-    }
-  }
-}
-function recordTelemetryError(error, span) {
-  const spanToRecord = span ?? opentelemetry.trace.getActiveSpan();
-  if (spanToRecord === void 0) {
-    return;
-  }
-  const redacted = redactError(error ?? "Unknown error");
-  spanToRecord.setStatus({
-    code: SpanStatusCode.ERROR,
-    message: redacted.message
-  });
-  spanToRecord.recordException(redacted);
-}
+import {
+  recordTelemetryAttributes,
+  recordTelemetryError
+} from "@cedarjs/telemetry/record";
 export {
   recordTelemetryAttributes,
-  recordTelemetryError,
-  redactError2 as redactError,
-  redactErrorMessage
+  recordTelemetryError
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cedarjs/cli-helpers",
-  "version": "8.0.0-canary.3599",
+  "version": "8.0.0-canary.3601",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cedarjs/cedar.git",
@@ -125,10 +125,9 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@cedarjs/project-config": "8.0.0-canary.3599",
-    "@cedarjs/telemetry": "8.0.0-canary.3599",
+    "@cedarjs/project-config": "8.0.0-canary.3601",
+    "@cedarjs/telemetry": "8.0.0-canary.3601",
     "@listr2/prompt-adapter-enquirer": "4.4.3",
-    "@opentelemetry/api": "1.9.1",
     "ansis": "4.4.0",
     "dotenv": "16.6.1",
     "dotenv-defaults": "5.0.2",
@@ -146,7 +145,7 @@
     "yargs-parser": "21.1.1"
   },
   "devDependencies": {
-    "@cedarjs/framework-tools": "8.0.0-canary.3599",
+    "@cedarjs/framework-tools": "8.0.0-canary.3601",
     "@types/dotenv-defaults": "^5.0.0",
     "@types/lodash": "4.17.27",
     "@types/pascalcase": "1.0.3",

package/dist/telemetry/redact.d.ts

@@ -1,27 +0,0 @@
-/**
- * Turns an error (or any thrown value) into a message that is safe to send
- * with telemetry.
- *
- * Only the first line is kept, because some errors include the full stack
- * trace in the message. Then every word that could identify a user, their
- * project or their infrastructure is replaced: anything containing `/`, `\`,
- * `@` or `:`, and IPv4 addresses. Replacements are labelled `[url]`, `[host]`,
- * `[path]` or `[redacted]`. Quoted paths are replaced as a whole, since they
- * can contain spaces, and so are hostnames in DNS errors.
- *
- * Words that describe the failure without identifying anyone are kept:
- * scoped package names (`@cedarjs/vite`), known specifiers (`node:fs`),
- * version numbers, clock times and words that only end in a colon (`Error:`).
- * What is left is the shape of the error, e.g.
- * `ENOENT: no such file or directory, open '[path]'`.
- *
- * This module has no imports so it can be bundled into create-cedar-app
- * without pulling in anything else.
- */
-export declare function redactErrorMessage(error: unknown): string;
-/**
- * Returns a new Error that only carries the redacted message of `error`.
- * The original stack trace is left out, since it contains file paths.
- */
-export declare function redactError(error: unknown): Error;
-//# sourceMappingURL=redact.d.ts.map

package/dist/telemetry/redact.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"redact.d.ts","sourceRoot":"","sources":["../../src/telemetry/redact.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAwBzD;AA2FD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAYjD"}

package/dist/telemetry/redact.js

@@ -1,78 +0,0 @@
-function redactErrorMessage(error) {
-  const message = error instanceof Error ? error.message : typeof error === "string" ? error : String(error);
-  return (message.split("\n")[0] || "Unknown error").replace(
-    /(['"`])([^'"`\\/\n]*[\\/][^'"`\n]*)\1/g,
-    (_match, quote, inner) => `${quote}${isSafeWord(inner) ? inner : placeholderFor(inner)}${quote}`
-  ).replace(/\b(ENOTFOUND|EAI_AGAIN)\s+[^\s'"`]+/g, "$1 [host]").replace(/\S+/g, redactWord);
-}
-const SCOPED_PACKAGE = /^@[a-z0-9~-][\w.~-]*\/[a-z0-9~-][\w.~-]*(?:\/[\w.-]+)*(?:@[\w.^~*<>=-]+)?$/i;
-const KNOWN_SPECIFIER = /^(?:node|npm|workspace|catalog):[\w.^~*<>=-]*$/;
-const CLOCK_TIME = /^\d{1,2}:\d{2}(?::\d{2})?$/;
-const IPV4 = /(?:^|[^\d.])\d{1,3}(?:\.\d{1,3}){3}(?![.\d])/;
-const IPV6 = /^\[?[\da-f]*:[\da-f]*:[\da-f:]*\]?(?::\d+)?$/i;
-const HOST_AND_PORT = /^[\w.-]+:\d+$/;
-const LEADING_PUNCTUATION = /* @__PURE__ */ new Set(["(", "'", '"', "`", "<", "[", "{"]);
-const TRAILING_PUNCTUATION = /* @__PURE__ */ new Set([
-  ")",
-  "'",
-  '"',
-  "`",
-  ">",
-  "]",
-  "}",
-  ",",
-  ";",
-  ".",
-  "!",
-  "?"
-]);
-function isSafeWord(word) {
-  if (!/[/\\@:]/.test(word) && !IPV4.test(word)) {
-    return true;
-  }
-  return SCOPED_PACKAGE.test(word) || KNOWN_SPECIFIER.test(word) || word.startsWith("npm:") && SCOPED_PACKAGE.test(word.slice(4)) || CLOCK_TIME.test(word);
-}
-function placeholderFor(word) {
-  if (word.includes("://")) {
-    return "[url]";
-  }
-  if (IPV4.test(word) || IPV6.test(word) || HOST_AND_PORT.test(word)) {
-    return "[host]";
-  }
-  if (/[/\\]/.test(word)) {
-    return "[path]";
-  }
-  return "[redacted]";
-}
-function redactWord(word) {
-  let start = 0;
-  let end = word.length;
-  while (end > start && TRAILING_PUNCTUATION.has(word[end - 1])) {
-    end--;
-  }
-  const withoutTrailing = word.slice(0, end);
-  if (!CLOCK_TIME.test(withoutTrailing) && IPV6.test(withoutTrailing)) {
-    return "[host]" + word.slice(end);
-  }
-  while (start < end && LEADING_PUNCTUATION.has(word[start])) {
-    start++;
-  }
-  const core = word.slice(start, end);
-  const checked = core.endsWith(":") ? core.slice(0, -1) : core;
-  if (checked === "" || isSafeWord(checked)) {
-    return word;
-  }
-  return word.slice(0, start) + placeholderFor(core) + word.slice(end);
-}
-function redactError(error) {
-  const redacted = new Error(redactErrorMessage(error));
-  if (error instanceof Error) {
-    redacted.name = error.name;
-  }
-  redacted.stack = `${redacted.name}: ${redacted.message}`;
-  return redacted;
-}
-export {
-  redactError,
-  redactErrorMessage
-};