New: adds paramsLevel prop. closes #125

Author: pustovitDmytro

.eslintrc

@@ -4,5 +4,8 @@
     ],
     "globals": {
         "performance": true
+    },
+    "rules": {
+        "unicorn/expiring-todo-comments": 0
     }
 }

README.md

@@ -95,31 +95,33 @@ class Rectangle {
 
 ### Configuration
 
-Config must be a JavaScript ```Object``` with  the following attributes:
-  * **logger** - logger, which build decorator will use, *[console](https://nodejs.org/api/console.html)* by default, see [logger](#logger) for more details 
-  * **name** - the app name, to include in all logs, could be omitted.
-  
-Next values could also be passed to constructor config, but are customizable from ```decorator(customConfig)``` invokation:
-  * **timestamp** - if set to *true* timestamps will be added to all logs.
-  * **level** - default log-level, pay attention that logger must support it as ```logger.level(smth)```, *'info'* by default. Also *function* could be passed. The function will receive logged data and should return log-level as *string*.
-  *  **errorLevel** - level, used for errors. *'error'* by default. Also *function* could be passed. The function will receive logged data and should return log-level as *string*.
-  * **errorsOnly** - if set to *true* logger will catch only errors.
+Config must be a JavaScript `Object` with the following attributes:
+  * **logger** - the logger that the build decorator will use. *[console](https://nodejs.org/api/console.html)* by default; see [logger](#logger) for more details.
+  * **name** - the app name to include in all logs; it could be omitted.
+
+Next values could also be passed to the constructor config, but are customizable from the `decorator(customConfig)` invocation:
+  * **timestamp** - if set to *true*, timestamps will be added to all logs.
+  * **level** - the default log-level; pay attention that the logger must support it as `logger.level(smth)`, *'info'* by default. Also, a *function* could be passed. The function will receive logged data and should return the log-level as a *string*.
+  * **errorLevel** - the level used for errors; *'error'* by default. Also, a *function* could be passed. The function will receive logged data and should return the log-level as a *string*.
+  * **paramsLevel** - the level used for logging params. Logger will print input params before the function starts executing. Also, a *function* could be passed. The function will receive logged data and should return the log-level as a *string*. If omitted, nothing will be logged before execution.
+  * **errorsOnly** - if set to *true*, the logger will catch only errors.
   * **logErrors**: next options available:
-    -   `deepest`: log only the deepest occurrence of the error. This option prevents 'error spam'
-  * **paramsSanitizer** - function to sanitize input parametrs from sensitive or redundant data, see [sanitizers](#sanitizers) for more details, by default [dataSanitizer](#sanitizers).
-  * **resultSanitizer** - output data sanitizer, by default [dataSanitizer](#sanitizers)
-  * **errorSanitizer** - error sanitizer, by default [simpleSanitizer](#sanitizers)
-  * **contextSanitizer** - function context sanitizer, if ommited, no context will be logged.
-  * **dublicates** - if set to *true*, it is possible to use multiple decorators at once (see [example](#duplicates)). **Note:** `duplicates` key also works, `dublicates` will be completle renamed to `duplicates` in version 2.0.
-  * **keepReflectMetadata** - if `logger-decorator` is used with other decorators, they can set own [reflect metadata](https://blog.bitsrc.io/typescripts-reflect-metadata-what-it-is-and-how-to-use-it-fb7b19cfc7e2). by passing `keepReflectMetadata` array, you can prevent metadata from reset. For example for nestJS its good idea to use `{ keepReflectMetadata: ['method', 'path'] }`.
-  
-Next parametrs could help in class method filtering:
-  *  **getters** - if set to *true*, [getters](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get) will also be logged (applied to class and class-method decorators)
-  *  **setters** - if set to *true*, [setters](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/set) will also be logged (applied to class and class-method decorators)
-  *  **classProperties** - if set to *true*, [class-properties](https://babeljs.io/docs/en/babel-plugin-proposal-class-properties) will also be logged (applied to class decorators only)
-  *  **include** - array with method names, for which logs will be added.
-  *  **exclude** - array with method names, for which logs won't be added.
-  *  **methodNameFilter** - function, to filter method names
+    -   `deepest`: log only the deepest occurrence of the error. This option prevents 'error spam.'
+  * **paramsSanitizer** - function to sanitize input parameters from sensitive or redundant data; see [sanitizers](#sanitizers) for more details, by default [dataSanitizer](#sanitizers).
+  * **resultSanitizer** - output data sanitizer, by default [dataSanitizer](#sanitizers).
+  * **errorSanitizer** - error sanitizer, by default [simpleSanitizer](#sanitizers).
+  * **contextSanitizer** - function context sanitizer; if omitted, no context will be logged.
+  * **duplicates** - if set to *true*, it is possible to use multiple decorators at once (see [example](#duplicates)).
+  * **keepReflectMetadata** - if `logger-decorator` is used with other decorators, they can set own [reflect metadata](https://blog.bitsrc.io/typescripts-reflect-metadata-what-it-is-and-how-to-use-it-fb7b19cfc7e2). By passing `keepReflectMetadata` array, you can prevent metadata from resetting. For example, for NestJS, it's a good idea to use `{ keepReflectMetadata: ['method', 'path'] }`.
+
+Next parameters could help in class method filtering:
+  *  **getters** - if set to *true*, [getters](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get) will also be logged (applied to class and class-method decorators).
+  *  **setters** - if set to *true*, [setters](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/set) will also be logged (applied to class and class-method decorators).
+  *  **classProperties** - if set to *true*, [class-properties](https://babeljs.io/docs/en/babel-plugin-proposal-class-properties) will also be logged (applied to class decorators only).
+  *  **include** - array with method names for which logs will be added.
+  *  **exclude** - array with method names for which logs won't be added.
+  *  **methodNameFilter** - function to filter method names.
+
 
 
 ### Functions

package-lock.json

@@ -78,7 +78,7 @@
     "eslint-plugin-scanjs-rules": "^0.2.1",
     "eslint-plugin-security": "^1.4.0",
     "eslint-plugin-sonarjs": "^0.11.0",
-    "eslint-plugin-unicorn": "^40.1.0",
+    "eslint-plugin-unicorn": "42.0.0",
     "fs-extra": "^10.0.0",
     "husky": "^7.0.4",
     "jscpd": "^3.4.5",

package.json

@@ -54,7 +54,7 @@ export default class FunctionDecorator extends BaseFunctionDecorator {
                 result    : result && resultSanitizer(result),
                 error     : error && errorSanitizer(error),
                 context   : (contextSanitizer && context) ? contextSanitizer(context) : undefined,
-                benchmark : getBenchmark(time),
+                benchmark : time ? getBenchmark(time) : undefined,
                 timestamp : timestamp ? (new Date()).toISOString() : undefined
             });
         };
@@ -79,6 +79,19 @@ export default class FunctionDecorator extends BaseFunctionDecorator {
         };
     }
 
+    onParams({ params, config, log, context }) {
+        const { paramsLevel } = config;
+
+        if (paramsLevel) {
+            log(paramsLevel, {
+                args : params,
+                context
+            });
+        }
+
+        return params;
+    }
+
     onSuccess({ result, log, config, time, context, params }) {
         if (config.level && !config.errorsOnly) {
             log(config.level, {

src/decorators/function.js

@@ -0,0 +1,40 @@
+import { assert } from 'chai';
+import { Decorator } from '../entry';
+import Logger from '../Logger';
+import { verifyStdout } from '../utils';
+
+suite('Params');
+
+test('Positive: function paramsLevel', function () {
+    const logger = new Logger();
+    const decorator = new Decorator({ logger, paramsLevel: 'verbose' });
+
+    const decorated = decorator()(function x(n) {
+        if (n > 0) return n * 2;
+
+        return n;
+    });
+
+    assert.equal(decorated(4), 8);
+    assert.isNotEmpty(logger.stack.verbose);
+    verifyStdout(logger, { params: '[ 4 ]', result: '8' }, { level: 'info' });
+    verifyStdout(logger, { method: 'x', params: '[ 4 ]' }, { level: 'verbose' });
+});
+
+
+test('Negative: function paramsLevel', function () {
+    const logger = new Logger();
+    const decorator = new Decorator({ logger });
+
+    const decorated = decorator()(function (n) {
+        if (n > 0) return n * 2;
+
+        return n;
+    });
+
+    assert.equal(decorated(4), 8);
+
+    verifyStdout(logger, { params: '[ 4 ]', result: '8' }, { level: 'info' });
+
+    assert.isEmpty(logger.stack.verbose);
+});