@takeshape/logger 7.134.4 → 10.49.13

package/build/types/types.d.ts

@@ -0,0 +1,305 @@
+import { type logLevels, type logProviders } from './constants.js';
+/**
+ * The duration, in fractional milliseconds, that it took to complete this event.
+ */
+export type TimeMs = number;
+/**
+ * The target host of the HTTP request. This may not be the same as the real hostname of the server.
+ */
+export type HttpHost = string;
+/**
+ * The HTTP method for the request.
+ */
+export type HttpMethod = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
+/**
+ * The path of the HTTP request.
+ */
+export type HttpPath = string;
+/**
+ * The IP address of the computer that issued the request.
+ */
+export type HttpRemoteAddr = string;
+/**
+ * An ID that uniquely identifies the request and can be used to trace requests.
+ */
+export type HttpRequestId = string;
+/**
+ * The body of the HTTP request / response.
+ */
+export type HttpBody = string;
+/**
+ * The value of the Content-Length header representing the size of the request in decimal number of octets.
+ */
+export type HttpContentLength = number;
+/**
+ * The direction of the HTTP request and response (incoming or outgoing).
+ */
+export type HttpDirection = 'incoming' | 'outgoing';
+/**
+ * An encoded JSON string representing *all* HTTP headers. This is used for request inspection without the overhead of creating and indexing fields for every header.
+ */
+export type HttpHeadersJson = string;
+/**
+ * An object representing *select* HTTP headers that need to be searched or graphed.
+ */
+export type HttpHeaders = Record<string, any>;
+/**
+ * The target port of the HTTP request. This may be different than the port the server is listening on.
+ */
+export type HttpPort = number;
+/**
+ * The query parameters present on the URL.
+ */
+export type HttpQueryString = string;
+/**
+ * The HTTP request scheme.
+ */
+export type HttpScheme = 'http' | 'https';
+/**
+ * A short label / name for the service you are sending the request to, ex: elasticsearch
+ */
+export type HttpServiceName = string;
+/**
+ * The status as defined by the HTTP status codes.
+ */
+export type HttpStatus = number;
+export type LogErrorBacktrace = {
+    /**
+     * Application name, if applicable. For example, erlang / elixir have multiple apps within the same umbrella project.
+     */
+    app_name?: string;
+    /**
+     * The line file path.
+     */
+    file: string;
+    /**
+     * The calling function name.
+     */
+    function: string;
+    /**
+     * The calling line number.
+     */
+    line: number;
+};
+export type LogError = {
+    /**
+     * An optional array of lines, representing the call stack, leading up to the error.
+     */
+    backtrace?: LogErrorBacktrace[];
+    /**
+     * Optional message describing the error.
+     */
+    message?: string;
+    /**
+     * A JSON encoded string representing additional metadata. This provides insight without the overhead of creating and indexing fields.
+     */
+    metadata_json?: string;
+    /**
+     * Required name of the error.
+     */
+    name: string;
+};
+export type LogContext = {
+    /**
+     * An open ended object where custom context is supplied.
+     */
+    custom?: Record<string, Record<string, any>>;
+    /**
+     * Context about the HTTP request currently being processed (if any)
+     */
+    http?: {
+        host?: HttpHost;
+        method: HttpMethod;
+        path?: HttpPath;
+        remote_addr?: HttpRemoteAddr;
+        request_id?: HttpRequestId;
+    };
+    /**
+     * Represents a task or job execution, typically for background tasks or jobs.
+     */
+    job?: {
+        /**
+         * The attempt number, if applicable.
+         */
+        attempt?: number;
+        /**
+         * A unique identifier for the job or task.
+         */
+        id?: string;
+        /**
+         * The name of the queue being processes, if applicable.
+         */
+        queue_name?: string;
+    };
+    /**
+     * Contextual information about the hosting platform (AWS, Google Cloud, Heroku, etc) the application is hosted.
+     */
+    platform?: {
+        [k: string]: any;
+        /**
+         * Contextual information about the service running on the Fargate
+         */
+        fargate?: {
+            [k: string]: any;
+            /**
+             * The unique identifier for the Docker container running inside the Fargate task.
+             */
+            container_name: string;
+            /**
+             * The collection of key value pairs found in the Kubernetes Pod metadata field Labels
+             */
+            labels?: Record<string, any>;
+            /**
+             * The Fargate service in which this task is running
+             */
+            service: string;
+            /**
+             * The task revision in which this container is running.
+             */
+            task_revision: string;
+            /**
+             * The task arn in which this container is running.
+             */
+            task_arn: string;
+        };
+        /**
+         * Contextual information about the Lambda fn
+         */
+        lambda?: {
+            [k: string]: any;
+            /**
+             * Function name for the Lambda fn.
+             */
+            function_name: string;
+        };
+    };
+    /**
+     * Contextual information on the current release
+     */
+    release?: {
+        /**
+         * The git commit sha for the deploy
+         */
+        commit_hash?: string;
+        /**
+         * When the release was created, ISO8601 date time.
+         */
+        created_at?: string;
+        /**
+         * Deploy version, can be an unique string. Ex: 1.1.2 or a43fdw
+         */
+        version?: string;
+    };
+    /**
+     * Represents a user in the platform being logged. The interpretation of "user" is left to the consumer.
+     */
+    user?: {
+        /**
+         * An email address for the user. This need not be unique to the user. Note that no validation is performed on this field.
+         */
+        email?: string;
+        /**
+         * A unique identifier for the user.
+         */
+        id?: string;
+        /**
+         * Additional custom metadata you'd like to add to the user.
+         */
+        meta?: Record<string, any>;
+        /**
+         * A display name for the user.
+         */
+        name?: string;
+        /**
+         * The type of user. Used in systems where there are multiple user types. This helps to denote users in the case of polymorphism.
+         */
+        type?: string;
+    };
+};
+export type LogEvent = {
+    /**
+     * An open ended object used for custom event data. Only a single root key is allowed, this represents the event type and avoids type collisions in the context of the entire schema.
+     */
+    custom?: Record<string, Record<string, any>>;
+    /**
+     * Represents an error or exception.
+     */
+    error?: LogError;
+    /**
+     * Represents a HTTP request, both incoming and outgoing. Note the direction field.
+     */
+    http_request?: {
+        body?: HttpBody;
+        content_length?: HttpContentLength;
+        direction?: HttpDirection;
+        headers?: HttpHeaders;
+        headers_json?: HttpHeadersJson;
+        host?: HttpHost;
+        method: HttpMethod;
+        path?: HttpPath;
+        port?: HttpPort;
+        query_string?: HttpQueryString;
+        request_id?: HttpRequestId;
+        scheme?: HttpScheme;
+        service_name?: HttpServiceName;
+    };
+    /**
+     * Represents a HTTP response event, both outgoing and incoming. Note the direction field.
+     */
+    http_response?: {
+        body?: HttpBody;
+        content_length?: HttpContentLength;
+        direction?: HttpDirection;
+        headers?: HttpHeaders;
+        headers_json?: HttpHeadersJson;
+        request_id?: HttpRequestId;
+        service_name?: HttpServiceName;
+        status: HttpStatus;
+        time_ms?: TimeMs;
+        /**
+         * The request being responded to. This couples the request data with the response event avoiding the need for joins or external data dependencies. In many cases the data must be coupled with this event because it is represented as a single event (nginx, apache web server, and other reverse proxy servers).
+         */
+        request?: {
+            [k: string]: any;
+            host?: HttpHost;
+            method?: HttpMethod;
+            path?: HttpPath;
+            scheme?: HttpScheme;
+        };
+    };
+};
+export type LogEntry = {
+    /**
+     * The IOS8601 formatted datetime when the log was generated.
+     */
+    timestamp?: string | undefined;
+    /**
+     * The raw log event message, formatting stripped.
+     */
+    message?: string | undefined;
+    /**
+     * Contextual metadata about the environment the event takes place in
+     */
+    context?: LogContext | undefined;
+    /**
+     * A controlled representation of the event this log line represents.
+     */
+    event?: LogEvent | undefined;
+};
+export type LogMetadata = {
+    error?: Error;
+} & Partial<LogEntry>;
+export type LogFn = typeof console.log;
+export type LoggerFn = (message: string | Error, metadata?: LogMetadata) => void;
+export type Logger = {
+    debug: LoggerFn;
+    info: LoggerFn;
+    warn: LoggerFn;
+    error: LoggerFn;
+    updateContext: (context: LogContext) => void;
+    updateEvent: (event: LogEvent) => void;
+    context: LogContext;
+    event: LogEvent;
+};
+export type LogLevel = (typeof logLevels)[number];
+export type LogProvider = (typeof logProviders)[number];

package/package.json

@@ -1,43 +1,51 @@
 {
   "name": "@takeshape/logger",
-  "version": "7.134.4",
+  "version": "10.49.13",
   "description": "Logging utility.",
   "homepage": "https://www.takeshape.io",
   "repository": {
     "type": "git",
     "url": "github.com:takeshape/takeshape.git"
   },
-  "author": "asprouse",
   "license": "UNLICENSED",
-  "engines": {
-    "node": ">=12"
+  "author": "asprouse",
+  "exports": {
+    "types": "./build/types/index.d.ts",
+    "require": "./build/cjs/index.js",
+    "import": "./build/esm/index.js",
+    "default": "./build/cjs/index.js"
   },
-  "main": "lib/index.js",
-  "module": "es/index.js",
-  "types": "lib/index.d.ts",
+  "main": "./build/cjs/index.js",
+  "module": "./build/esm/index.js",
+  "types": "./build/types/index.d.ts",
   "files": [
-    "lib",
-    "es"
+    "build"
   ],
   "scripts": {
-    "lint": "eslint . --ext .js,.ts",
-    "lint:code:ci": "eslint . --ext .js,.ts --format junit -o \"${HOME}/test-results/${npm_package_name#*\\/}/eslint-results.xml\"",
-    "test": "jest",
-    "test-changed": "pnpm run test -- --changedSince=master",
-    "test:ci": "JEST_JUNIT_OUTPUT_DIR=\"${HOME}/test-results/${npm_package_name#*\\/}\" JEST_JUNIT_OUTPUT_NAME=jest-results.xml jest --ci --reporters=default --reporters=jest-junit",
-    "typecheck": "tsc --noEmit",
-    "clean": "rimraf lib es build *.tsbuildinfo",
-    "prepublishOnly": "pnpm lint && pnpm test && pnpm clean && pnpm build",
-    "build": "pnpm clean && pnpm build:types && pnpm build:js && pnpm build:es && pnpm build:copy",
-    "build:types": "tsc --emitDeclarationOnly --project tsconfig.build.json",
-    "build:js": "cross-env BABEL_MODULES=commonjs babel src --out-dir lib --extensions \".js,.ts\" --ignore '**/__tests__'",
-    "build:es": "cross-env BABEL_MODULES=es babel src --out-dir es --extensions \".js,.ts\" --ignore '**/__tests__'",
-    "build:copy": "cp -rf build/src/* lib/",
-    "will-it-blend": "pnpm typecheck && pnpm lint -- --quiet && pnpm test -- --silent --coverage false"
+    "build": "pnpm build:cjs && pnpm build:esm && pnpm build:types",
+    "build:ci": "pnpm clean && pnpm build:cjs && pnpm build:esm && pnpm build:types",
+    "build:cjs": "tsc --project tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./build/cjs/package.json",
+    "build:esm": "tsc --project tsconfig.esm.json && echo '{\"type\": \"module\"}' > ./build/esm/package.json",
+    "build:types": "tsc --project tsconfig.types.json",
+    "clean": "del-cli build *.tsbuildinfo",
+    "lint": "eslint . --ext .js,.ts,.json",
+    "lint:ci": "pnpm lint --quiet --format json -o \"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}/eslint-results.json\"",
+    "test": "TZ=UTC vitest run --coverage.enabled --coverage.reporter text-summary",
+    "test:ci": "TZ=UTC vitest run --reporter=junit --outputFile=\"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}/vitest-results.xml\" --coverage.enabled --coverage.reportsDirectory=\"${GITHUB_WORKSPACE}/coverage/${npm_package_name#*\\/}\"",
+    "todo": "leasot 'src/**/*.{js,jsx,ts,tsx}'",
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@sentry/node": "^5.27.2",
-    "lodash": "^4.17.20",
-    "prettyjson": "^1.2.1"
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@sentry/types": "^8.30.0",
+    "@types/lodash": "^4.14.165"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }

package/es/index.js

@@ -1 +0,0 @@
-export { default, loggerWithContext, Logger, TimberMetadata } from './logger';

package/es/logger.js

@@ -1,97 +0,0 @@
-import merge from 'lodash/merge';
-import { captureException, setUser, setTag } from '@sentry/node';
-
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-const noop = () => {};
-
-export function getLogFn(level) {
-  if (process.env.NODE_ENV === 'test') {
-    return noop;
-  }
-
-  if (process.env.IS_OFFLINE) {
-    const prettyjson = require('prettyjson'); // eslint-disable-line @typescript-eslint/no-var-requires
-
-
-    return (message, metadata) => {
-      console[level](message);
-
-      if (metadata) {
-        console[level](prettyjson.render(metadata), '\n');
-      }
-    };
-  }
-
-  return (message, metadata) => {
-    const args = [message];
-
-    if (metadata) {
-      const {
-        error,
-        ...rest
-      } = metadata;
-
-      if (error) {
-        captureException(error);
-        args.push(error);
-      }
-
-      if (Object.keys(rest).length) {
-        args.push(JSON.stringify(rest, null, 2));
-      }
-    }
-
-    console[level].apply(null, args);
-  };
-}
-
-function createLogger() {
-  return {
-    info: getLogFn('info'),
-    warn: getLogFn('warn'),
-    error: getLogFn('error')
-  };
-}
-
-export default createLogger();
-
-function setSentryTags(context) {
-  var _context$custom, _context$custom$proje, _context$user;
-
-  if ((_context$custom = context.custom) !== null && _context$custom !== void 0 && (_context$custom$proje = _context$custom.project) !== null && _context$custom$proje !== void 0 && _context$custom$proje.id) {
-    var _context$custom2, _context$custom2$proj;
-
-    setTag('projectId', (_context$custom2 = context.custom) === null || _context$custom2 === void 0 ? void 0 : (_context$custom2$proj = _context$custom2.project) === null || _context$custom2$proj === void 0 ? void 0 : _context$custom2$proj.id);
-  }
-
-  if ((_context$user = context.user) !== null && _context$user !== void 0 && _context$user.id) {
-    setUser({
-      id: context.user.id
-    });
-  }
-}
-
-export function loggerWithContext(fnContext) {
-  let context = fnContext;
-  setSentryTags(context);
-
-  const decorate = logFn => (message, metadata) => {
-    logFn(message, {
-      context,
-      ...metadata
-    });
-  };
-
-  return {
-    info: decorate(getLogFn('info')),
-    warn: decorate(getLogFn('warn')),
-    error: decorate(getLogFn('error')),
-
-    updateContext(update) {
-      setSentryTags(update);
-      context = merge(context, update);
-    },
-
-    context
-  };
-}

package/lib/index.d.ts

@@ -1,2 +0,0 @@
-export { default, loggerWithContext, Logger, TimberMetadata } from './logger';
-//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,cAAc,EAAC,MAAM,UAAU,CAAC"}

package/lib/index.js

@@ -1,35 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "default", {
-  enumerable: true,
-  get: function () {
-    return _logger.default;
-  }
-});
-Object.defineProperty(exports, "loggerWithContext", {
-  enumerable: true,
-  get: function () {
-    return _logger.loggerWithContext;
-  }
-});
-Object.defineProperty(exports, "Logger", {
-  enumerable: true,
-  get: function () {
-    return _logger.Logger;
-  }
-});
-Object.defineProperty(exports, "TimberMetadata", {
-  enumerable: true,
-  get: function () {
-    return _logger.TimberMetadata;
-  }
-});
-
-var _logger = _interopRequireWildcard(require("./logger"));
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/lib/logger.d.ts

@@ -1,17 +0,0 @@
-import { TimberContext, TimberLogEntry } from './types';
-export interface TimberMetadata extends Partial<TimberLogEntry> {
-    error?: Error;
-}
-export declare type LogFn = (message: string, metadata?: TimberMetadata) => void;
-export interface Logger {
-    info: LogFn;
-    error: LogFn;
-    warn: LogFn;
-    updateContext: (context: TimberContext) => void;
-    context: TimberContext;
-}
-export declare function getLogFn(level: 'info' | 'warn' | 'error'): LogFn;
-declare const _default: Record<string, LogFn>;
-export default _default;
-export declare function loggerWithContext(fnContext: TimberContext): Logger;
-//# sourceMappingURL=logger.d.ts.map

package/lib/logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAE,cAAc,EAAC,MAAM,SAAS,CAAC;AAGtD,MAAM,WAAW,cAAe,SAAQ,OAAO,CAAC,cAAc,CAAC;IAC7D,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AACD,oBAAY,KAAK,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;AAEzE,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,KAAK,CAAC;IACZ,aAAa,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,CAAC;IAChD,OAAO,EAAE,aAAa,CAAC;CACxB;AAKD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CA+BhE;;AAUD,wBAA8B;AAW9B,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,aAAa,GAAG,MAAM,CAkBlE"}

package/lib/logger.js

@@ -1,111 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getLogFn = getLogFn;
-exports.loggerWithContext = loggerWithContext;
-exports.default = void 0;
-
-var _merge = _interopRequireDefault(require("lodash/merge"));
-
-var _node = require("@sentry/node");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-const noop = () => {};
-
-function getLogFn(level) {
-  if (process.env.NODE_ENV === 'test') {
-    return noop;
-  }
-
-  if (process.env.IS_OFFLINE) {
-    const prettyjson = require('prettyjson'); // eslint-disable-line @typescript-eslint/no-var-requires
-
-
-    return (message, metadata) => {
-      console[level](message);
-
-      if (metadata) {
-        console[level](prettyjson.render(metadata), '\n');
-      }
-    };
-  }
-
-  return (message, metadata) => {
-    const args = [message];
-
-    if (metadata) {
-      const {
-        error,
-        ...rest
-      } = metadata;
-
-      if (error) {
-        (0, _node.captureException)(error);
-        args.push(error);
-      }
-
-      if (Object.keys(rest).length) {
-        args.push(JSON.stringify(rest, null, 2));
-      }
-    }
-
-    console[level].apply(null, args);
-  };
-}
-
-function createLogger() {
-  return {
-    info: getLogFn('info'),
-    warn: getLogFn('warn'),
-    error: getLogFn('error')
-  };
-}
-
-var _default = createLogger();
-
-exports.default = _default;
-
-function setSentryTags(context) {
-  var _context$custom, _context$custom$proje, _context$user;
-
-  if ((_context$custom = context.custom) !== null && _context$custom !== void 0 && (_context$custom$proje = _context$custom.project) !== null && _context$custom$proje !== void 0 && _context$custom$proje.id) {
-    var _context$custom2, _context$custom2$proj;
-
-    (0, _node.setTag)('projectId', (_context$custom2 = context.custom) === null || _context$custom2 === void 0 ? void 0 : (_context$custom2$proj = _context$custom2.project) === null || _context$custom2$proj === void 0 ? void 0 : _context$custom2$proj.id);
-  }
-
-  if ((_context$user = context.user) !== null && _context$user !== void 0 && _context$user.id) {
-    (0, _node.setUser)({
-      id: context.user.id
-    });
-  }
-}
-
-function loggerWithContext(fnContext) {
-  let context = fnContext;
-  setSentryTags(context);
-
-  const decorate = logFn => (message, metadata) => {
-    logFn(message, {
-      context,
-      ...metadata
-    });
-  };
-
-  return {
-    info: decorate(getLogFn('info')),
-    warn: decorate(getLogFn('warn')),
-    error: decorate(getLogFn('error')),
-
-    updateContext(update) {
-      setSentryTags(update);
-      context = (0, _merge.default)(context, update);
-    },
-
-    context
-  };
-}