@lidofinance/api-logger 0.0.2

package/README.md

@@ -0,0 +1,36 @@
+# @lidofinance/api-logger
+
+Logger, which hides secrets from logs.
+
+## Installation
+
+1. Authenticate to use GitHub registry as described in parent [README.md](../../../README.md).
+2. `yarn add @lidofinance/api-logger`.
+
+## Getting started
+
+You just need to initialize it with secrets you want to hide, usually it's all secrets from `serverRuntimeConfig` ,
+after that, you are free to use it as regular `console.log`.
+
+```ts
+import getConfig from 'next/config';
+import { serverLoggerFactory } from '@lidofinance/api-logger';
+
+const { serverRuntimeConfig } = getConfig();
+const {
+  infuraApiKey,
+  alchemyApiKey,
+  subgraphMainnet,
+  subgraphGoerli,
+} = serverRuntimeConfig;
+
+export const serverLogger = serverLoggerFactory([
+  infuraApiKey,
+  alchemyApiKey,
+  subgraphMainnet,
+  subgraphGoerli,
+]);
+
+serverLogger.log('Something common')
+serverLogger.error(new Error('Some error'))
+```

package/dist/index.cjs

@@ -0,0 +1,72 @@
+var $dDFU1$darkobitsmaskstring = require("@darkobits/mask-string");
+
+function $parcel$exportWildcard(dest, source) {
+  Object.keys(source).forEach(function(key) {
+    if (key === 'default' || key === '__esModule' || dest.hasOwnProperty(key)) {
+      return;
+    }
+
+    Object.defineProperty(dest, key, {
+      enumerable: true,
+      get: function get() {
+        return source[key];
+      }
+    });
+  });
+
+  return dest;
+}
+function $parcel$interopDefault(a) {
+  return a && a.__esModule ? a.default : a;
+}
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+var $2b0676a8d7ac44c3$exports = {};
+
+$parcel$export($2b0676a8d7ac44c3$exports, "serverLoggerFactory", () => $2b0676a8d7ac44c3$export$937ae38af6b48c0f);
+
+const $2b0676a8d7ac44c3$var$anyHex = new RegExp("0x[a-fA-F0-9]+", "ig");
+const $2b0676a8d7ac44c3$var$anyEnsAddress = new RegExp("[a-zA-Z.]+\\.eth", "ig");
+let $2b0676a8d7ac44c3$var$LEVEL;
+(function(LEVEL1) {
+    LEVEL1["error"] = "error";
+    LEVEL1["warn"] = "warn";
+    LEVEL1["info"] = "info";
+    LEVEL1["debug"] = "debug";
+    LEVEL1["log"] = "log";
+})($2b0676a8d7ac44c3$var$LEVEL || ($2b0676a8d7ac44c3$var$LEVEL = {}));
+const $2b0676a8d7ac44c3$var$stringify = (data)=>data instanceof Error ? JSON.stringify({
+        message: data.message,
+        stack: data.stack
+    }) : JSON.stringify(data);
+const $2b0676a8d7ac44c3$export$937ae38af6b48c0f = (secrets)=>{
+    const patterns = [
+        ...secrets,
+        $2b0676a8d7ac44c3$var$anyHex,
+        $2b0676a8d7ac44c3$var$anyEnsAddress
+    ].filter(Boolean);
+    // TODO: replace not with *** but with name of masked pattern e.g. https://example.com/{INFURA_KEY}
+    const mask = (message)=>(0, ($parcel$interopDefault($dDFU1$darkobitsmaskstring)))(patterns, message);
+    const log = (level)=>(...output)=>{
+            try {
+                console[level](...output.map($2b0676a8d7ac44c3$var$stringify).map(mask));
+            } catch (error) {
+                console.error(error);
+                console.warn("Failed to sanitize output");
+            }
+        };
+    return process.env.NODE_ENV === "production" ? {
+        error: log($2b0676a8d7ac44c3$var$LEVEL.error),
+        warn: log($2b0676a8d7ac44c3$var$LEVEL.warn),
+        info: log($2b0676a8d7ac44c3$var$LEVEL.info),
+        debug: log($2b0676a8d7ac44c3$var$LEVEL.debug),
+        log: log($2b0676a8d7ac44c3$var$LEVEL.log)
+    } : console;
+};
+
+
+$parcel$exportWildcard(module.exports, $2b0676a8d7ac44c3$exports);
+
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;ACAA;AAEA,MAAM,4BAAM,GAAG,IAAI,MAAM,CAAC,gBAAgB,EAAE,IAAI,CAAC;AACjD,MAAM,mCAAa,GAAG,IAAI,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC;IAE1D,2BAMC;UANI,MAAK;IAAL,MAAK,CACR,OAAK,IAAL,OAAK;IADF,MAAK,CAER,MAAI,IAAJ,MAAI;IAFD,MAAK,CAGR,MAAI,IAAJ,MAAI;IAHD,MAAK,CAIR,OAAK,IAAL,OAAK;IAJF,MAAK,CAKR,KAAG,IAAH,KAAG;GALA,2BAAK,KAAL,2BAAK;AAQV,MAAM,+BAAS,GAAG,CAAC,IAAa,GAC9B,IAAI,YAAY,KAAK,GAEjB,IAAI,CAAC,SAAS,CAAC;QACb,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,KAAK,EAAE,IAAI,CAAC,KAAK;KAClB,CAAC,GACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;AAWnB,MAAM,yCAAmB,GAAG,CAAC,OAA+B,GAAmB;IACpF,MAAM,QAAQ,GAAG;WAAI,OAAO;QAAE,4BAAM;QAAE,mCAAa;KAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IACpE,mGAAmG;IACnG,MAAM,IAAI,GAAG,CAAC,OAAe,GAAa,CAAA,GAAA,oDAAU,CAAA,CAAC,QAAQ,EAAE,OAAO,CAAC;IAEvE,MAAM,GAAG,GACP,CAAC,KAAY,GACb,CAAC,GAAG,MAAM,AAAW,GAAW;YAC9B,IAAI;gBACF,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,+BAAS,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;aACnD,CAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;gBACpB,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC;aAC1C;SACF;IACH,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,GACxC;QACE,KAAK,EAAE,GAAG,CAAC,2BAAK,CAAC,KAAK,CAAC;QACvB,IAAI,EAAE,GAAG,CAAC,2BAAK,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,GAAG,CAAC,2BAAK,CAAC,IAAI,CAAC;QACrB,KAAK,EAAE,GAAG,CAAC,2BAAK,CAAC,KAAK,CAAC;QACvB,GAAG,EAAE,GAAG,CAAC,2BAAK,CAAC,GAAG,CAAC;KACpB,GACD,OAAO,CAAA;CACZ;;ADvDD","sources":["packages/api/logger/src/index.ts","packages/api/logger/src/serverLoggerFactory.ts"],"sourcesContent":["export * from './serverLoggerFactory'\n","import maskString from '@darkobits/mask-string'\n\nconst anyHex = new RegExp('0x[a-fA-F0-9]+', 'ig')\nconst anyEnsAddress = new RegExp('[a-zA-Z.]+\\\\.eth', 'ig')\n\nenum LEVEL {\n  error = 'error',\n  warn = 'warn',\n  info = 'info',\n  debug = 'debug',\n  log = 'log',\n}\n\nconst stringify = (data: unknown) =>\n  data instanceof Error\n    ? // extract Error's non-enumerable props before stringifying\n      JSON.stringify({\n        message: data.message,\n        stack: data.stack,\n      })\n    : JSON.stringify(data)\n\nexport type Logger = (...messages: unknown[]) => void\nexport type ServerLogger = {\n  error: Logger\n  warn: Logger\n  info: Logger\n  debug: Logger\n  log: Logger\n}\n\nexport const serverLoggerFactory = (secrets: Array<RegExp | string>): ServerLogger => {\n  const patterns = [...secrets, anyHex, anyEnsAddress].filter(Boolean)\n  // TODO: replace not with *** but with name of masked pattern e.g. https://example.com/{INFURA_KEY}\n  const mask = (message: string): string => maskString(patterns, message)\n\n  const log =\n    (level: LEVEL) =>\n    (...output: unknown[]): void => {\n      try {\n        console[level](...output.map(stringify).map(mask))\n      } catch (error) {\n        console.error(error)\n        console.warn('Failed to sanitize output')\n      }\n    }\n  return process.env.NODE_ENV === 'production'\n    ? {\n        error: log(LEVEL.error),\n        warn: log(LEVEL.warn),\n        info: log(LEVEL.info),\n        debug: log(LEVEL.debug),\n        log: log(LEVEL.log),\n      }\n    : console\n}\n"],"names":[],"version":3,"file":"index.cjs.map","sourceRoot":"../../../../"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export type Logger = (...messages: unknown[]) => void;
+export type ServerLogger = {
+    error: Logger;
+    warn: Logger;
+    info: Logger;
+    debug: Logger;
+    log: Logger;
+};
+export const serverLoggerFactory: (secrets: Array<RegExp | string>) => ServerLogger;
+
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAqBA,qBAAqB,CAAC,GAAG,QAAQ,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;AACrD,2BAA2B;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,OAAO,MAAM,+BAAgC,MAAM,MAAM,GAAG,MAAM,CAAC,KAAG,YAwBrE,CAAA","sources":["packages/api/logger/src/src/serverLoggerFactory.ts","packages/api/logger/src/src/index.ts","packages/api/logger/src/index.ts"],"sourcesContent":[null,null,"export * from './serverLoggerFactory'\n"],"names":[],"version":3,"file":"index.d.ts.map","sourceRoot":"../../../../"}

package/dist/index.mjs

@@ -0,0 +1,53 @@
+import $2Az7d$darkobitsmaskstring from "@darkobits/mask-string";
+
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+var $3e685537995feb8a$exports = {};
+
+$parcel$export($3e685537995feb8a$exports, "serverLoggerFactory", () => $3e685537995feb8a$export$937ae38af6b48c0f);
+
+const $3e685537995feb8a$var$anyHex = new RegExp("0x[a-fA-F0-9]+", "ig");
+const $3e685537995feb8a$var$anyEnsAddress = new RegExp("[a-zA-Z.]+\\.eth", "ig");
+let $3e685537995feb8a$var$LEVEL;
+(function(LEVEL1) {
+    LEVEL1["error"] = "error";
+    LEVEL1["warn"] = "warn";
+    LEVEL1["info"] = "info";
+    LEVEL1["debug"] = "debug";
+    LEVEL1["log"] = "log";
+})($3e685537995feb8a$var$LEVEL || ($3e685537995feb8a$var$LEVEL = {}));
+const $3e685537995feb8a$var$stringify = (data)=>data instanceof Error ? JSON.stringify({
+        message: data.message,
+        stack: data.stack
+    }) : JSON.stringify(data);
+const $3e685537995feb8a$export$937ae38af6b48c0f = (secrets)=>{
+    const patterns = [
+        ...secrets,
+        $3e685537995feb8a$var$anyHex,
+        $3e685537995feb8a$var$anyEnsAddress
+    ].filter(Boolean);
+    // TODO: replace not with *** but with name of masked pattern e.g. https://example.com/{INFURA_KEY}
+    const mask = (message)=>(0, $2Az7d$darkobitsmaskstring)(patterns, message);
+    const log = (level)=>(...output)=>{
+            try {
+                console[level](...output.map($3e685537995feb8a$var$stringify).map(mask));
+            } catch (error) {
+                console.error(error);
+                console.warn("Failed to sanitize output");
+            }
+        };
+    return process.env.NODE_ENV === "production" ? {
+        error: log($3e685537995feb8a$var$LEVEL.error),
+        warn: log($3e685537995feb8a$var$LEVEL.warn),
+        info: log($3e685537995feb8a$var$LEVEL.info),
+        debug: log($3e685537995feb8a$var$LEVEL.debug),
+        log: log($3e685537995feb8a$var$LEVEL.log)
+    } : console;
+};
+
+
+
+
+export {$3e685537995feb8a$export$937ae38af6b48c0f as serverLoggerFactory};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;ACAA;AAEA,MAAM,4BAAM,GAAG,IAAI,MAAM,CAAC,gBAAgB,EAAE,IAAI,CAAC;AACjD,MAAM,mCAAa,GAAG,IAAI,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC;IAE1D,2BAMC;UANI,MAAK;IAAL,MAAK,CACR,OAAK,IAAL,OAAK;IADF,MAAK,CAER,MAAI,IAAJ,MAAI;IAFD,MAAK,CAGR,MAAI,IAAJ,MAAI;IAHD,MAAK,CAIR,OAAK,IAAL,OAAK;IAJF,MAAK,CAKR,KAAG,IAAH,KAAG;GALA,2BAAK,KAAL,2BAAK;AAQV,MAAM,+BAAS,GAAG,CAAC,IAAa,GAC9B,IAAI,YAAY,KAAK,GAEjB,IAAI,CAAC,SAAS,CAAC;QACb,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,KAAK,EAAE,IAAI,CAAC,KAAK;KAClB,CAAC,GACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;AAWnB,MAAM,yCAAmB,GAAG,CAAC,OAA+B,GAAmB;IACpF,MAAM,QAAQ,GAAG;WAAI,OAAO;QAAE,4BAAM;QAAE,mCAAa;KAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IACpE,mGAAmG;IACnG,MAAM,IAAI,GAAG,CAAC,OAAe,GAAa,CAAA,GAAA,0BAAU,CAAA,CAAC,QAAQ,EAAE,OAAO,CAAC;IAEvE,MAAM,GAAG,GACP,CAAC,KAAY,GACb,CAAC,GAAG,MAAM,AAAW,GAAW;YAC9B,IAAI;gBACF,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,+BAAS,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;aACnD,CAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;gBACpB,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC;aAC1C;SACF;IACH,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,GACxC;QACE,KAAK,EAAE,GAAG,CAAC,2BAAK,CAAC,KAAK,CAAC;QACvB,IAAI,EAAE,GAAG,CAAC,2BAAK,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,GAAG,CAAC,2BAAK,CAAC,IAAI,CAAC;QACrB,KAAK,EAAE,GAAG,CAAC,2BAAK,CAAC,KAAK,CAAC;QACvB,GAAG,EAAE,GAAG,CAAC,2BAAK,CAAC,GAAG,CAAC;KACpB,GACD,OAAO,CAAA;CACZ;;ADvDD","sources":["packages/api/logger/src/index.ts","packages/api/logger/src/serverLoggerFactory.ts"],"sourcesContent":["export * from './serverLoggerFactory'\n","import maskString from '@darkobits/mask-string'\n\nconst anyHex = new RegExp('0x[a-fA-F0-9]+', 'ig')\nconst anyEnsAddress = new RegExp('[a-zA-Z.]+\\\\.eth', 'ig')\n\nenum LEVEL {\n  error = 'error',\n  warn = 'warn',\n  info = 'info',\n  debug = 'debug',\n  log = 'log',\n}\n\nconst stringify = (data: unknown) =>\n  data instanceof Error\n    ? // extract Error's non-enumerable props before stringifying\n      JSON.stringify({\n        message: data.message,\n        stack: data.stack,\n      })\n    : JSON.stringify(data)\n\nexport type Logger = (...messages: unknown[]) => void\nexport type ServerLogger = {\n  error: Logger\n  warn: Logger\n  info: Logger\n  debug: Logger\n  log: Logger\n}\n\nexport const serverLoggerFactory = (secrets: Array<RegExp | string>): ServerLogger => {\n  const patterns = [...secrets, anyHex, anyEnsAddress].filter(Boolean)\n  // TODO: replace not with *** but with name of masked pattern e.g. https://example.com/{INFURA_KEY}\n  const mask = (message: string): string => maskString(patterns, message)\n\n  const log =\n    (level: LEVEL) =>\n    (...output: unknown[]): void => {\n      try {\n        console[level](...output.map(stringify).map(mask))\n      } catch (error) {\n        console.error(error)\n        console.warn('Failed to sanitize output')\n      }\n    }\n  return process.env.NODE_ENV === 'production'\n    ? {\n        error: log(LEVEL.error),\n        warn: log(LEVEL.warn),\n        info: log(LEVEL.info),\n        debug: log(LEVEL.debug),\n        log: log(LEVEL.log),\n      }\n    : console\n}\n"],"names":[],"version":3,"file":"index.mjs.map","sourceRoot":"../../../../"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@lidofinance/api-logger",
+  "description": "API logger, which hides secrets",
+  "repository": "git@github.com:lidofinance/lido-ui-blocks.git",
+  "license": "MIT",
+  "version": "0.0.2",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">= 16"
+  },
+  "source": "./src/index.ts",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "parcel build",
+    "format": "prettier --check src",
+    "format:fix": "yarn format --write",
+    "types": "tsc --noEmit",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@darkobits/mask-string": "^2.0.1"
+  },
+  "devDependencies": {
+    "@lidofinance/config-prettier": "0.0.1",
+    "@types/jest": "^28.1.6",
+    "@types/node": "^18.0.6",
+    "jest": "^28.1.3",
+    "ts-jest": "^28.0.7"
+  }
+}