@wdio/logger 7.0.0-beta.1 → 7.0.0

package/build/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * environment check to allow to use this package in a web context
+ */
 declare let mode: any;
 export default mode;
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,QAAA,IAAI,IAAI,KAA2B,CAAA;AAcnC,eAAe,IAAI,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;GAEG;AAGH,QAAA,IAAI,IAAI,KAA2B,CAAA;AAcnC,eAAe,IAAI,CAAA"}

package/build/index.js

@@ -1,8 +1,21 @@
 "use strict";
+/* istanbul ignore file */
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * environment check to allow to use this package in a web context
+ */
+// By default, import the web code using a literal require, so that in webpack
+// contexts, it will always be bundled
 let mode = require('./web').default;
+// Then, if we're in a Node.js context, require the node version of this module
+// using a variable, so that it will _not_ be included in a bundle, either
+// during compilation or execution
 if (typeof process !== 'undefined' && typeof process.release !== 'undefined' && process.release.name === 'node') {
     const nodeMode = './node';
     mode = require(nodeMode).default;
 }
+// The net result will be that in a Node context, we'll have required both
+// files but will use the correct one, and in the web context, we'll have only
+// required the web file, thus ensuring that the Node file and related
+// dependencies will not be bundled inadvertently.
 exports.default = mode;

package/build/node.js

@@ -26,15 +26,27 @@ const matches = {
     RESULT: 'RESULT'
 };
 const SERIALIZERS = [{
+        /**
+         * display error stack
+         */
         matches: (err) => err instanceof Error,
         serialize: (err) => err.stack
     }, {
+        /**
+         * color commands blue
+         */
         matches: (log) => log === matches.COMMAND,
         serialize: (log) => chalk_1.default.magenta(log)
     }, {
+        /**
+         * color data yellow
+         */
         matches: (log) => log === matches.DATA,
         serialize: (log) => chalk_1.default.yellow(log)
     }, {
+        /**
+         * color result cyan
+         */
         matches: (log) => log === matches.RESULT,
         serialize: (log) => chalk_1.default.cyan(log)
     }];
@@ -46,9 +58,16 @@ const originalFactory = loglevel_1.default.methodFactory;
 const wdioLoggerMethodFactory = function (methodName, logLevel, loggerName) {
     const rawMethod = originalFactory(methodName, logLevel, loggerName);
     return (...args) => {
+        /**
+         * create logFile lazily
+         */
         if (!logFile && process.env.WDIO_LOG_PATH) {
             logFile = fs_1.default.createWriteStream(process.env.WDIO_LOG_PATH);
         }
+        /**
+         * split `prefixer: value` sting to `prefixer: ` and `value`
+         * so that SERIALIZERS can match certain string
+         */
         const match = Object.values(matches).filter(x => args[0].endsWith(`: ${x}`))[0];
         if (match) {
             const prefixStr = args.shift().slice(0, -match.length - 1);
@@ -64,6 +83,9 @@ const wdioLoggerMethodFactory = function (methodName, logLevel, loggerName) {
         });
         const logText = strip_ansi_1.default(`${util_1.default.format.apply(this, args)}\n`);
         if (logFile && logFile.writable) {
+            /**
+             * empty logging cache if stuff got logged before
+             */
             if (logCache.size) {
                 logCache.forEach((log) => {
                     if (logFile) {
@@ -79,6 +101,9 @@ const wdioLoggerMethodFactory = function (methodName, logLevel, loggerName) {
     };
 };
 function getLogger(name) {
+    /**
+     * check if logger was already initiated
+     */
     if (loggers[name]) {
         return loggers[name];
     }
@@ -99,7 +124,12 @@ function getLogger(name) {
     return loggers[name];
 }
 exports.default = getLogger;
+/**
+ * Wait for writable stream to be flushed.
+ * Calling this prevents part of the logs in the very env to be lost.
+ */
 getLogger.waitForBuffer = async () => new Promise(resolve => {
+    // @ts-ignore
     if (logFile && Array.isArray(logFile.writableBuffer) && logFile.writableBuffer.length !== 0) {
         return setTimeout(async () => {
             await getLogger.waitForBuffer();
@@ -116,16 +146,28 @@ getLogger.clearLogger = () => {
     logFile = null;
 };
 getLogger.setLogLevelsConfig = (logLevels = {}, wdioLogLevel = DEFAULT_LEVEL) => {
+    /**
+     * set log level
+     */
     if (process.env.WDIO_LOG_LEVEL === undefined) {
         process.env.WDIO_LOG_LEVEL = wdioLogLevel;
     }
     logLevelsConfig = {};
+    /**
+     * build logLevelsConfig object
+     */
     Object.entries(logLevels).forEach(([logName, logLevel]) => {
         const logLevelName = getLogLevelName(logName);
         logLevelsConfig[logLevelName] = logLevel;
     });
+    /**
+     * set log level for each logger
+     */
     Object.keys(loggers).forEach(logName => {
         const logLevelName = getLogLevelName(logName);
+        /**
+         * either apply log level from logLevels object or use global logLevel
+         */
         const logLevel = typeof logLevelsConfig[logLevelName] !== 'undefined' ? logLevelsConfig[logLevelName] : process.env.WDIO_LOG_LEVEL;
         loggers[logName].setLevel(logLevel);
     });

package/build/web.js

@@ -1,16 +1,22 @@
 "use strict";
+/* istanbul ignore file */
 Object.defineProperty(exports, "__esModule", { value: true });
 const LOG_METHODS = ['error', 'warn', 'info', 'debug', 'trace', 'silent'];
 function getLogger(component) {
     return LOG_METHODS.reduce((acc, cur) => {
         const prop = cur;
+        // check if the method is available on console (web doesn't have
+        // 'silent', for example) before adding to acc
+        // eslint-disable-next-line no-console
         if (console[prop]) {
+            // eslint-disable-next-line no-console
             acc[prop] = console[prop].bind(console, `${component}:`);
         }
         return acc;
     }, {});
 }
 exports.default = getLogger;
+// logging interface expects a 'setLevel' method
 getLogger.setLevel = () => { };
 getLogger.setLogLevelsConfig = () => { };
 getLogger.waitForBuffer = () => { };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/logger",
-  "version": "7.0.0-beta.1",
+  "version": "7.0.0",
   "description": "A helper utility for logging of WebdriverIO packages",
   "author": "Christian Bromann <christian@saucelabs.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-logger",
@@ -32,5 +32,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8d9ac36cadb5ccba689ce76173ef0545ee72df86"
+  "gitHead": "b03188f55479f936d9ca899967883d929cde191c"
 }