@apify/log - npm Package Compare versions

Comparing version 1.2.5 to 2.0.0

index.js

 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
+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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+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(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  LEVELS: () => LEVELS,
+  LEVEL_TO_STRING: () => LEVEL_TO_STRING,
+  Log: () => Log,
+  LogLevel: () => LogLevel,
+  Logger: () => Logger,
+  LoggerJson: () => LoggerJson,
+  LoggerText: () => LoggerText,
+  PREFIX_DELIMITER: () => PREFIX_DELIMITER,
+  default: () => src_default,
+  getLevelFromEnv: () => getLevelFromEnv,
+  limitDepth: () => limitDepth,
+  truncate: () => truncate
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/logger_text.ts
+var import_ansi_colors = __toESM(require("ansi-colors"));
+
+// src/logger.ts
+var import_events = __toESM(require("events"));
+
+// src/log_consts.ts
+var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
+  LogLevel2[LogLevel2["OFF"] = 0] = "OFF";
+  LogLevel2[LogLevel2["ERROR"] = 1] = "ERROR";
+  LogLevel2[LogLevel2["SOFT_FAIL"] = 2] = "SOFT_FAIL";
+  LogLevel2[LogLevel2["WARNING"] = 3] = "WARNING";
+  LogLevel2[LogLevel2["INFO"] = 4] = "INFO";
+  LogLevel2[LogLevel2["DEBUG"] = 5] = "DEBUG";
+  LogLevel2[LogLevel2["PERF"] = 6] = "PERF";
+  return LogLevel2;
+})(LogLevel || {});
+var PREFIX_DELIMITER = ":";
+var LEVELS = LogLevel;
+var LEVEL_TO_STRING = Object.keys(LogLevel).filter((x) => Number.isNaN(+x));
+
+// src/logger.ts
+var Logger = class extends import_events.default {
+  constructor(options) {
+    super();
+    this.options = options;
+  }
+  setOptions(options) {
+    this.options = { ...this.options, ...options };
+  }
+  getOptions() {
+    return this.options;
+  }
+  _outputWithConsole(level, line) {
+    switch (level) {
+      case 1 /* ERROR */:
+        console.error(line);
+        break;
+      case 3 /* WARNING */:
+        console.warn(line);
+        break;
+      case 5 /* DEBUG */:
+        console.debug(line);
+        break;
+      default:
+        console.log(line);
     }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+  }
+  _log(level, message, data, exception, opts = {}) {
+    throw new Error("log() method must be implemented!");
+  }
+  log(level, message, ...args) {
+    const line = this._log(level, message, ...args);
+    this.emit("line", line);
+  }
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-const log_1 = require("./log");
-__exportStar(require("./log"), exports);
-__exportStar(require("./log_consts"), exports);
-__exportStar(require("./log_helpers"), exports);
-__exportStar(require("./logger"), exports);
-__exportStar(require("./logger_json"), exports);
-__exportStar(require("./logger_text"), exports);
-// Default export is an initialized instance of logger.
-const log = new log_1.Log();
-exports.default = log;
+__name(Logger, "Logger");
+
+// src/logger_text.ts
+var SHORTEN_LEVELS = {
+  SOFT_FAIL: "SFAIL",
+  WARNING: "WARN"
+};
+var LEVEL_TO_COLOR = {
+  [1 /* ERROR */]: "red",
+  [2 /* SOFT_FAIL */]: "red",
+  [3 /* WARNING */]: "yellow",
+  [4 /* INFO */]: "green",
+  [5 /* DEBUG */]: "blue",
+  [6 /* PERF */]: "magenta"
+};
+var SHORTENED_LOG_LEVELS = LEVEL_TO_STRING.map((level) => SHORTEN_LEVELS[level] || level);
+var MAX_LEVEL_LENGTH_SPACES = Math.max(...SHORTENED_LOG_LEVELS.map((l) => l.length));
+var getLevelIndent = /* @__PURE__ */ __name((level) => {
+  let spaces = "";
+  for (let i = 0; i < MAX_LEVEL_LENGTH_SPACES - level.length; i++)
+    spaces += " ";
+  return spaces;
+}, "getLevelIndent");
+var DEFAULT_OPTIONS = {
+  skipTime: true
+};
+var LoggerText = class extends Logger {
+  constructor(options = {}) {
+    super({ ...DEFAULT_OPTIONS, ...options });
+  }
+  _log(level, message, data, exception, opts = {}) {
+    let { prefix, suffix } = opts;
+    let maybeDate = "";
+    if (!this.options.skipTime) {
+      maybeDate = `${new Date().toISOString().replace("Z", "").replace("T", " ")} `;
+    }
+    const errStack = exception ? this._parseException(exception) : "";
+    const color = LEVEL_TO_COLOR[level];
+    const levelStr = SHORTENED_LOG_LEVELS[level];
+    const levelIndent = getLevelIndent(levelStr);
+    const dataStr = !data ? "" : ` ${JSON.stringify(data)}`;
+    prefix = prefix ? ` ${prefix}${PREFIX_DELIMITER}` : "";
+    suffix = suffix ? ` ${suffix}` : "";
+    const line = `${import_ansi_colors.default.gray(maybeDate)}${import_ansi_colors.default[color](levelStr)}${levelIndent}${import_ansi_colors.default.yellow(prefix)} ${message || ""}${import_ansi_colors.default.gray(dataStr)}${import_ansi_colors.default.yellow(suffix)}${errStack}`;
+    this._outputWithConsole(level, line);
+    return line;
+  }
+  _parseException(exception) {
+    let errStack = "";
+    const errDetails = [];
+    if (exception.type)
+      errDetails.push(`type=${exception.type}`);
+    if (exception.details) {
+      Object.entries(exception.details).map(([key, val]) => errDetails.push(`${key}=${val}`));
+    }
+    const errorString = exception.stack || exception.reason || exception.toString();
+    const errorLines = errorString.split("\n");
+    if (errDetails.length)
+      errorLines[0] += import_ansi_colors.default.gray(`(details: ${errDetails.join(", ")})`);
+    errStack = errorLines.map((line) => `  ${line}`).join("\n");
+    errStack = `
+${errStack}`;
+    return errStack;
+  }
+};
+__name(LoggerText, "LoggerText");
+
+// src/log_helpers.ts
+var import_consts = require("@apify/consts");
+function truncate(str, maxLength, suffix = "...[truncated]") {
+  maxLength = Math.floor(maxLength);
+  if (suffix.length > maxLength) {
+    throw new Error("suffix string cannot be longer than maxLength");
+  }
+  if (typeof str === "string" && str.length > maxLength) {
+    str = str.substr(0, maxLength - suffix.length) + suffix;
+  }
+  return str;
+}
+__name(truncate, "truncate");
+function getLevelFromEnv() {
+  const envVar = process.env[import_consts.ENV_VARS.LOG_LEVEL];
+  if (!envVar)
+    return 4 /* INFO */;
+  if (Number.isFinite(+envVar))
+    return +envVar;
+  if (LogLevel[envVar])
+    return LogLevel[envVar];
+  return +envVar;
+}
+__name(getLevelFromEnv, "getLevelFromEnv");
+function limitDepth(record, depth, maxStringLength) {
+  if (typeof record === "string") {
+    return maxStringLength && record.length > maxStringLength ? truncate(record, maxStringLength) : record;
+  }
+  if (["number", "boolean"].includes(typeof record) || record == null || record instanceof Date) {
+    return record;
+  }
+  if (record instanceof Error) {
+    const { name, message, stack, ...rest } = record;
+    record = { name, message, stack, ...rest };
+  }
+  const nextCall = /* @__PURE__ */ __name((rec) => limitDepth(rec, depth - 1, maxStringLength), "nextCall");
+  if (Array.isArray(record)) {
+    return depth ? record.map(nextCall) : "[array]";
+  }
+  if (typeof record === "object" && record !== null) {
+    const mapObject = /* @__PURE__ */ __name((obj) => {
+      const res = {};
+      Object.keys(obj).forEach((key) => {
+        res[key] = nextCall(obj[key]);
+      });
+      return res;
+    }, "mapObject");
+    return depth ? mapObject(record) : "[object]";
+  }
+  if (typeof record === "function") {
+    return "[function]";
+  }
+  console.log(`WARNING: Object cannot be logged: ${record}`);
+  return void 0;
+}
+__name(limitDepth, "limitDepth");
+
+// src/log.ts
+var getDefaultOptions = /* @__PURE__ */ __name(() => ({
+  level: getLevelFromEnv(),
+  maxDepth: 4,
+  maxStringLength: 2e3,
+  prefix: null,
+  suffix: null,
+  logger: new LoggerText(),
+  data: {}
+}), "getDefaultOptions");
+var Log = class {
+  constructor(options = {}) {
+    this.LEVELS = LogLevel;
+    this.deprecationsReported = {};
+    this.options = { ...getDefaultOptions(), ...options };
+    if (!LogLevel[this.options.level])
+      throw new Error('Options "level" must be one of log.LEVELS enum!');
+    if (typeof this.options.maxDepth !== "number")
+      throw new Error('Options "maxDepth" must be a number!');
+    if (typeof this.options.maxStringLength !== "number")
+      throw new Error('Options "maxStringLength" must be a number!');
+    if (this.options.prefix && typeof this.options.prefix !== "string")
+      throw new Error('Options "prefix" must be a string!');
+    if (this.options.suffix && typeof this.options.suffix !== "string")
+      throw new Error('Options "suffix" must be a string!');
+    if (typeof this.options.logger !== "object")
+      throw new Error('Options "logger" must be an object!');
+    if (typeof this.options.data !== "object")
+      throw new Error('Options "data" must be an object!');
+  }
+  _limitDepth(obj) {
+    return limitDepth(obj, this.options.maxDepth);
+  }
+  getLevel() {
+    return this.options.level;
+  }
+  setLevel(level) {
+    if (!LogLevel[level])
+      throw new Error('Options "level" must be one of log.LEVELS enum!');
+    this.options.level = level;
+  }
+  internal(level, message, data, exception) {
+    if (level > this.options.level)
+      return;
+    data = { ...this.options.data, ...data };
+    data = Object.keys(data).length > 0 ? this._limitDepth(data) : void 0;
+    exception = this._limitDepth(exception);
+    this.options.logger.log(level, message, data, exception, {
+      prefix: this.options.prefix,
+      suffix: this.options.suffix
+    });
+  }
+  setOptions(options) {
+    this.options = { ...this.options, ...options };
+  }
+  getOptions() {
+    return { ...this.options };
+  }
+  child(options) {
+    let { prefix } = this.options;
+    if (options.prefix) {
+      prefix = prefix ? `${prefix}${PREFIX_DELIMITER}${options.prefix}` : options.prefix;
+    }
+    const data = options.data ? { ...this.options.data, ...options.data } : this.options.data;
+    const newOptions = {
+      ...this.options,
+      ...options,
+      prefix,
+      data
+    };
+    return new Log(newOptions);
+  }
+  error(message, data) {
+    this.internal(1 /* ERROR */, message, data);
+  }
+  exception(exception, message, data) {
+    this.internal(1 /* ERROR */, message, data, exception);
+  }
+  softFail(message, data) {
+    this.internal(2 /* SOFT_FAIL */, message, data);
+  }
+  warning(message, data) {
+    this.internal(3 /* WARNING */, message, data);
+  }
+  info(message, data) {
+    this.internal(4 /* INFO */, message, data);
+  }
+  debug(message, data) {
+    this.internal(5 /* DEBUG */, message, data);
+  }
+  perf(message, data) {
+    this.internal(6 /* PERF */, message, data);
+  }
+  deprecated(message) {
+    if (this.deprecationsReported[message])
+      return;
+    this.deprecationsReported[message] = true;
+    this.warning(message);
+  }
+};
+__name(Log, "Log");
+
+// src/logger_json.ts
+var DEFAULT_OPTIONS2 = {
+  skipLevelInfo: false,
+  skipTime: false
+};
+var LoggerJson = class extends Logger {
+  constructor(options = {}) {
+    super({ ...DEFAULT_OPTIONS2, ...options });
+  }
+  _log(level, message, data, exception, opts = {}) {
+    const { prefix, suffix } = opts;
+    if (exception)
+      data = { ...data, exception };
+    if (prefix)
+      message = `${prefix}${PREFIX_DELIMITER} ${message}`;
+    if (suffix)
+      message = `${message} ${suffix}`;
+    const rec = {
+      time: !this.options.skipTime ? new Date() : void 0,
+      level: this.options.skipLevelInfo && level === 4 /* INFO */ ? void 0 : LogLevel[level],
+      msg: message,
+      ...data
+    };
+    const line = JSON.stringify(rec);
+    this._outputWithConsole(level, line);
+    return line;
+  }
+};
+__name(LoggerJson, "LoggerJson");
+
+// src/index.ts
+var log = new Log();
+var src_default = log;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  LEVELS,
+  LEVEL_TO_STRING,
+  Log,
+  LogLevel,
+  Logger,
+  LoggerJson,
+  LoggerText,
+  PREFIX_DELIMITER,
+  getLevelFromEnv,
+  limitDepth,
+  truncate
+});
+//# sourceMappingURL=index.js.map

package.json

 {
     "name": "@apify/log",
-    "version": "1.2.5",
+    "version": "2.0.0",
     "description": "Tools and constants shared across Apify projects.",
-    "main": "index.js",
-    "typings": "index.d.ts",
+    "main": "./index.js",
+    "module": "./index.mjs",
+    "typings": "./index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./index.mjs",
+            "require": "./index.js",
+            "types": "./index.d.ts"
+        }
+    },
     "keywords": [
@@ -31,3 +39,3 @@ "apify"
         "clean": "rimraf ./dist",
-        "compile": "tsc -p tsconfig.build.json",
+        "compile": "tsup && tsc -p tsconfig.build.json",
         "copy": "ts-node -T ../../scripts/copy.ts"
@@ -39,6 +47,6 @@ },
     "dependencies": {
-        "@apify/consts": "^1.11.0",
+        "@apify/consts": "^2.0.0",
         "ansi-colors": "^4.1.1"
     },
-    "gitHead": "e12348baa263a86c0de15cc3faab521b59ca0284"
+    "gitHead": "9e31c174fe30c8c5b517b0d26874d123e233d807"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

102040

increased by121.86%

Lines of code

921

increased by22.64%

Worsened metrics

Number of package files

14

decreased by-17.65%

Number of low supply chain risk alerts

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@apify/consts@2.31.0(transitive)

• - Removed@apify/consts@1.11.0(transitive)

• Updated@apify/consts@^2.0.0