Increase performance and add production setting hideLogPositionForProduction

Author: terehov

.eslintrc.json

@@ -10,7 +10,7 @@
     "sourceType": "module"
   },
   "plugins": ["@typescript-eslint"],
-  "ignorePatterns": ["dist/*", "*/dist/*", "/examples/*", "tests/*", "*/tests/*", "build.js"],
+  "ignorePatterns": ["benchmarks/*", "dist/*", "*/dist/*", "/examples/*", "tests/*", "*/tests/*", "build.js"],
   "rules": {
     "linebreak-style": ["error", "unix"],
     "quotes": ["error", "double"],

.gitignore

@@ -83,3 +83,6 @@ bower_components
 # Vuepress
 .temp
 .cache
+
+# Ignore banchmarks for now
+/benchmarks/*

.npmignore

@@ -99,3 +99,6 @@ tsconfig*
 
 # Ignore docs
 /docs*
+
+# Ignore banchmarks for now
+/benchmarks/*

README.md

@@ -200,10 +200,16 @@ Every incoming log message runs through a number of steps before being displayed
 - **log message** Log message comes in through the `BaseLogger.log()` method
 - **mask** If masking is configured, log message gets recursively masked
 - **toLogObj** Log message gets transformed into a log object: A default typed log object can be passed to constructor as a second parameter and will be cloned and enriched with the incoming log parameters. Error properties will be handled accordingly. If there is only one log property, and it's an object, both objects (cloned default `logObj` as well as the log property object) will be merged. If there are more than one, they will be put into properties called "0", "1", ... and so on. Alternatively, log message properties can be put into a property with a name configured with the `argumentsArrayName` setting.
-- **addMetaToLogObj** Additional meta information, like the source code position of the log will be gathered and added to the `_meta` property or any other one configured with the setting `metaProperty`.
+- **addMetaToLogObj** Additional meta information, like date, runtime and source code position of the log will be gathered and added to the `_meta` property or any other one configured with the setting `metaProperty`.
 - **format** In case of "pretty" configuration, a log object will be formatted based on the templates configured in settings. Meta will be formatted by the method `_prettyFormatLogObjMeta` and the actual log payload will be formatted by `prettyFormatLogObj`. Both steps can be overwritten with the settings `formatMeta` and `formatLogObj`.
 - **transport** Last step is to "transport" a log message to every attached transport from the setting `attachedTransports`. Last step is the actual transport, either JSON (`transportJSON`), formatted (`transportFormatted`) or omitted, if its set to "hidden". Both default transports can also be overwritten by the corresponding setting.
 
+### ❗Performance
+
+By default, `tslog is optimized for the best developer experience and includes some default settings that may impact performance in production environments. `
+To ensure optimal performance in production, we recommend modifying these settings, such as `hideLogPositionForProduction`(s. below), as needed.  
+
+
 ### Default log level
 
 `tslog` comes with default log level `0: silly`, `1: trace`, `2: debug`, `3: info`, `4: warn`, `5: error`, `6: fatal`.
@@ -405,6 +411,13 @@ const logMsg = logger.silly("Test1", "Test2");
 
 ```
 
+
+#### hideLogPositionForProduction (default: `false`)
+
+By default, `tslog` gathers and includes the log code position in the meta information of a `logObj to improve the developer experience. `
+However, this can significantly impact performance and slow down execution times in production. 
+To improve performance, you can disable this functionality by setting the option `hideLogPositionForProduction` to `true`.
+
 #### Pretty templates and styles (color settings)
 Enables you to overwrite the looks of a formatted _"pretty"_ log message by providing a template string.
 Following settings are available for styling:
@@ -713,7 +726,7 @@ const logMsg = logger.info("Test");
 ### RequestID: Mark a request (e.g. HTTP) call with AsyncLocalStorage and `tslog`
 >**Node.js 13.10 introduced a new feature called <a href="https://nodejs.org/api/async_hooks.html#async_hooks_class_asynclocalstorage" target="_blank">AsyncLocalStorage.</a>**<br>
 
-**❗ Keep track of all subsequent calls and promises originated from a single request (e.g. HTTP).**
+** Keep track of all subsequent calls and promises originated from a single request (e.g. HTTP).**
 
 In a real world application a call to an API would lead to many logs produced across the entire application.
 When debugging it can be quite handy to be able to group all logs based on a unique identifier, e.g.  `requestId`.

examples/nodejs/index2.ts

@@ -55,3 +55,11 @@ firstSubLogger.silly("foo bar 1");
 
 const secondSubLogger = firstSubLogger.getSubLogger({ name: "SecondSubLogger" });
 secondSubLogger.silly("foo bar 2");
+
+////////////////////////////
+
+const performanceLogger = new Logger({
+  hideLogPositionForProduction: true,
+});
+
+performanceLogger.silly("log without code position information");

src/BaseLogger.ts

@@ -24,9 +24,10 @@ export class BaseLogger<LogObj> {
       parentNames: settings?.parentNames,
       minLevel: settings?.minLevel ?? 0,
       argumentsArrayName: settings?.argumentsArrayName,
+      hideLogPositionForProduction: settings?.hideLogPositionForProduction ?? false,
       prettyLogTemplate:
         settings?.prettyLogTemplate ??
-        "{{yyyy}}.{{mm}}.{{dd}} {{hh}}:{{MM}}:{{ss}}:{{ms}}\t{{logLevelName}}\t[{{filePathWithLine}}{{nameWithDelimiterPrefix}}]\t",
+        "{{yyyy}}.{{mm}}.{{dd}} {{hh}}:{{MM}}:{{ss}}:{{ms}}\t{{logLevelName}}\t{{filePathWithLine}}{{nameWithDelimiterPrefix}}\t",
       prettyErrorTemplate: settings?.prettyErrorTemplate ?? "\n{{errorName}} {{errorMessage}}\nerror stack:\n{{errorStack}}",
       prettyErrorStackTemplate: settings?.prettyErrorStackTemplate ?? "  • {{fileName}}\t{{method}}\n\t{{filePathWithLine}}",
       prettyErrorParentNamesSeparator: settings?.prettyErrorParentNamesSeparator ?? ":",
@@ -175,7 +176,7 @@ export class BaseLogger<LogObj> {
     };
 
     const subLogger: BaseLogger<LogObj> = new (this.constructor as new (
-      childSettings?: ISettingsParam<LogObj>,
+      subLoggerSettings?: ISettingsParam<LogObj>,
       logObj?: LogObj,
       stackDepthLevel?: number
     ) => this)(subLoggerSettings, logObj ?? this.logObj, this.stackDepthLevel);
@@ -238,7 +239,7 @@ export class BaseLogger<LogObj> {
       ? new Date(source.getTime())
       : source && typeof source === "object"
       ? Object.getOwnPropertyNames(source).reduce((o, prop) => {
-          Object.defineProperty(o, prop, Object.getOwnPropertyDescriptor(source, prop)!);
+          Object.defineProperty(o, prop, Object.getOwnPropertyDescriptor(source, prop) as PropertyDescriptor);
           // execute functions or clone
           o[prop] =
             typeof source[prop] === "function" ? source[prop]() : this._recursiveCloneAndExecuteFunctions((source as { [key: string]: unknown })[prop], seen);
@@ -276,7 +277,14 @@ export class BaseLogger<LogObj> {
   private _addMetaToLogObj(logObj: LogObj, logLevelId: number, logLevelName: string): LogObj & ILogObjMeta & ILogObj {
     return {
       ...logObj,
-      [this.settings.metaProperty]: getMeta(logLevelId, logLevelName, this.stackDepthLevel, this.settings.name, this.settings.parentNames),
+      [this.settings.metaProperty]: getMeta(
+        logLevelId,
+        logLevelName,
+        this.stackDepthLevel,
+        this.settings.hideLogPositionForProduction,
+        this.settings.name,
+        this.settings.parentNames
+      ),
     };
   }
 
@@ -316,9 +324,9 @@ export class BaseLogger<LogObj> {
     placeholderValues["rawIsoStr"] = dateInSettingsTimeZone?.toISOString();
     placeholderValues["dateIsoStr"] = dateInSettingsTimeZone?.toISOString().replace("T", " ").replace("Z", "");
     placeholderValues["logLevelName"] = logObjMeta?.logLevelName;
-    placeholderValues["fileNameWithLine"] = logObjMeta?.path?.fileNameWithLine;
-    placeholderValues["filePathWithLine"] = logObjMeta?.path?.filePathWithLine;
-    placeholderValues["fullFilePath"] = logObjMeta?.path?.fullFilePath;
+    placeholderValues["fileNameWithLine"] = logObjMeta?.path?.fileNameWithLine ?? "";
+    placeholderValues["filePathWithLine"] = logObjMeta?.path?.filePathWithLine ?? "";
+    placeholderValues["fullFilePath"] = logObjMeta?.path?.fullFilePath ?? "";
     // name
     let parentNamesString = this.settings.parentNames?.join(this.settings.prettyErrorParentNamesSeparator);
     parentNamesString = parentNamesString != null && logObjMeta?.name != null ? parentNamesString + this.settings.prettyErrorParentNamesSeparator : undefined;

src/interfaces.ts

@@ -14,6 +14,7 @@ export interface ISettingsParam<LogObj> {
   parentNames?: string[];
   minLevel?: number;
   argumentsArrayName?: string;
+  hideLogPositionForProduction?: boolean;
   prettyLogTemplate?: string;
   prettyErrorTemplate?: string;
   prettyErrorStackTemplate?: string;
@@ -69,6 +70,7 @@ export interface ISettings<LogObj> extends ISettingsParam<LogObj> {
   parentNames?: string[];
   minLevel: number;
   argumentsArrayName?: string;
+  hideLogPositionForProduction: boolean;
   prettyLogTemplate: string;
   prettyErrorTemplate: string;
   prettyErrorStackTemplate: string;

src/runtime/browser/index.ts

@@ -22,121 +22,71 @@ const meta: IMetaStatic = {
   browser: window?.["navigator"].userAgent,
 };
 
-export function getMeta(logLevelId: number, logLevelName: string, stackDepthLevel: number, name?: string): IMeta {
-  return {
-    ...meta,
+const pathRegex = /(?:(?:file|https?|global code|[^@]+)@)?(?:file:)?((?:\/[^:/]+){2,})(?::(\d+))?(?::(\d+))?/;
+
+export function getMeta(
+  logLevelId: number,
+  logLevelName: string,
+  stackDepthLevel: number,
+  hideLogPositionForPerformance: boolean,
+  name?: string,
+  parentNames?: string[]
+): IMeta {
+  // faster than spread operator
+  return Object.assign({}, meta, {
     name,
+    parentNames,
     date: new Date(),
     logLevelId,
     logLevelName,
-    path: getCallerStackFrame(stackDepthLevel),
-  };
+    path: !hideLogPositionForPerformance ? getCallerStackFrame(stackDepthLevel) : undefined,
+  }) as IMeta;
 }
 
-export function getCallerStackFrame(stackDepthLevel: number): IStackFrame {
-  try {
-    throw new Error("getStackTrace");
-  } catch (e: unknown) {
-    const href = window.location.origin;
-
-    const error = e as Error | undefined;
-    if (error?.stack) {
-      let fullFilePath: string | undefined = error?.stack
-        ?.split("\n")
-        ?.filter((line: string) => !line.includes("Error: "))
-        ?.[stackDepthLevel]?.replace(/^\s+at\s+/gm, "");
-      if (fullFilePath?.slice(-1) === ")") {
-        fullFilePath = fullFilePath?.match(/\(([^)]+)\)/)?.[1];
-      }
-
-      const pathArray = fullFilePath?.includes(":")
-        ? fullFilePath
-            ?.replace("global code@", "")
-            ?.replace("file://", "")
-            ?.replace(href, "")
-            ?.replace(/^\s+at\s+/gm, "")
-            ?.split(":")
-        : undefined;
-
-      // order plays a role, runs from the back: column, line, path
-      const fileColumn = pathArray?.pop();
-      const fileLine = pathArray?.pop();
-      const filePath = pathArray?.pop()?.split("?")?.[0];
-      const fileName = filePath?.split("/").pop();
-      const fileNameWithLine = `${fileName}:${fileLine}`;
-      const filePathWithLine = `${href}${filePath}:${fileLine}`;
-      const errorStackLine = fullFilePath?.split(" (");
-      return {
-        fullFilePath,
-        fileName,
-        fileNameWithLine,
-        fileColumn,
-        fileLine,
-        filePath,
-        filePathWithLine,
-        method: errorStackLine?.[0],
-      };
-    }
-
-    return {
-      fullFilePath: undefined,
-      fileName: undefined,
-      fileNameWithLine: undefined,
-      fileColumn: undefined,
-      fileLine: undefined,
-      filePath: undefined,
-      filePathWithLine: undefined,
-      method: undefined,
-    };
-  }
+export function getCallerStackFrame(stackDepthLevel: number, error: Error = Error()): IStackFrame {
+  return stackLineToStackFrame((error as Error | undefined)?.stack?.split("\n")?.filter((line: string) => !line.includes("Error: "))?.[stackDepthLevel]);
 }
 
 export function getErrorTrace(error: Error): IStackFrame[] {
-  const href = window.location.origin;
   return (error as Error)?.stack
     ?.split("\n")
     ?.filter((line: string) => !line.includes("Error: "))
     ?.reduce((result: IStackFrame[], line: string) => {
-      if (line?.slice(-1) === ")") {
-        line = line.match(/\(([^)]+)\)/)?.[1] ?? "";
-      }
-      line = line.replace(/^\s+at\s+/gm, "");
-      const errorStackLine = line.split(" (");
-      const fullFilePath = line?.slice(-1) === ")" ? line?.match(/\(([^)]+)\)/)?.[1] : line;
-      const pathArray = fullFilePath?.includes(":")
-        ? fullFilePath
-            ?.replace("global code@", "")
-            ?.replace("file://", "")
-            ?.replace(href, "")
-            ?.replace(/^\s+at\s+/gm, "")
-            ?.split(":")
-        : undefined;
-
-      // order plays a role, runs from the back: column, line, path
-      const fileColumn = pathArray?.pop();
-      const fileLine = pathArray?.pop();
-      const filePath = pathArray?.pop()?.split("?")[0];
-      const fileName = filePath?.split("/")?.pop()?.split("?")[0];
-      const fileNameWithLine = `${fileName}:${fileLine}`;
-      const filePathWithLine = `${href}${filePath}:${fileLine}`;
-
-      if (filePath != null && filePath.length > 0) {
-        result.push({
-          fullFilePath,
-          fileName,
-          fileNameWithLine,
-          fileColumn,
-          fileLine,
-          filePath,
-          filePathWithLine,
-          method: errorStackLine?.[1] != null ? errorStackLine?.[0] : undefined,
-        });
-      }
+      result.push(stackLineToStackFrame(line));
 
       return result;
     }, []) as IStackFrame[];
 }
 
+function stackLineToStackFrame(line?: string): IStackFrame {
+  const href = window.location.origin;
+  const pathResult: IStackFrame = {
+    fullFilePath: undefined,
+    fileName: undefined,
+    fileNameWithLine: undefined,
+    fileColumn: undefined,
+    fileLine: undefined,
+    filePath: undefined,
+    filePathWithLine: undefined,
+    method: undefined,
+  };
+  if (line != null) {
+    const match = line.match(pathRegex);
+    if (match) {
+      pathResult.filePath = match[1].replace(/\?.*$/, "");
+      pathResult.fullFilePath = `${href}${pathResult.filePath}`;
+      const pathParts = pathResult.filePath.split("/");
+      pathResult.fileName = pathParts[pathParts.length - 1];
+      pathResult.fileLine = match[2];
+      pathResult.fileColumn = match[3];
+      pathResult.filePathWithLine = `${pathResult.filePath}:${pathResult.fileLine}`;
+      pathResult.fileNameWithLine = `${pathResult.fileName}:${pathResult.fileLine}`;
+    }
+  }
+
+  return pathResult;
+}
+
 export function isError(e: Error | unknown): boolean {
   return e instanceof Error;
 }
@@ -174,6 +124,6 @@ export function transportJSON<LogObj>(json: LogObj & ILogObjMeta): void {
   console.log(jsonStringifyRecursive(json));
 }
 
-export function isBuffer(arg: unknown) {
-  return undefined;
+export function isBuffer(arg?: unknown) {
+  return arg ? undefined : undefined;
 }