2.0.24

.gitignore

@@ -1,5 +1,20 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -20,62 +20,28 @@ mirror:
   script:
     - npmci git mirror
   tags:
+    - lossless
     - docker
     - notpriv
 
-snyk:
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
+    - lossless
     - docker
     - notpriv
 
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
-  tags:
-  - docker
-  - priv
-
 # ====================
 # test stage
 # ====================
 
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
     - npmci npm prepare
@@ -84,6 +50,20 @@ testSTABLE:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
     - docker
     - notpriv
 
@@ -95,6 +75,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -103,20 +84,14 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
+    - lossless
     - docker
     - priv
 
@@ -127,18 +102,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -1,5 +1,6 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartlog",
-  "version": "2.0.19",
+  "version": "2.0.24",
   "private": false,
   "description": "minimalistic distributed and extensible logging tool",
   "keywords": [
@@ -11,25 +11,38 @@
     "elasticsearch",
     "logdna"
   ],
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.4",
-    "@gitzone/tsrun": "^1.1.17",
-    "@gitzone/tstest": "^1.0.18",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.18",
-    "tslint": "^5.12.1",
-    "tslint-config-prettier": "^1.17.0"
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.33",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^14.0.11",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartlog-interfaces": "^2.0.5"
-  }
+    "@pushrocks/isounique": "^1.0.4",
+    "@pushrocks/smartlog-interfaces": "^2.0.15"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -8,13 +8,20 @@ minimalistic distributed and extensible logging tool
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartlog/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartlog/badges/master/build.svg)](https://gitlab.com/pushrocks/smartlog/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartlog/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartlog/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartlog.svg)](https://www.npmjs.com/package/@pushrocks/smartlog)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartlog/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartlog)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartlog/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartlog/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartlog)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartlog)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartlog)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartlog)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartlog)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
@@ -69,9 +76,14 @@ The following destinations are available:
 // TBD
 ```
 
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -9,7 +9,12 @@ tap.test('should produce instance of Smartlog', async () => {
 });
 
 tap.test('should enable console logging', async () => {
-  defaultLogger.enableConsole();
+  defaultLogger.enableConsole({
+    captureAll: true
+  });
+  console.log('this is a normal log that should be captured');
+  console.log(new Error('hi there'));
+  defaultLogger.log('info', 'this should only be printed once');
 });
 
 tap.test('should be able to log things', async () => {

ts/smartlog.classes.smartlog.ts

@@ -1,32 +1,21 @@
 import * as plugins from './smartlog.plugins';
 
-// interfaces
-import {
-  TLogType,
-  TEnvironment,
-  ILogContext,
-  TLogLevel,
-  TRuntime,
-  ILogDestination,
-  ILogPackage
-} from '@pushrocks/smartlog-interfaces';
-
 import { LogRouter } from './smartlog.classes.logrouter';
 
 export interface ISmartlogContructorOptions {
-  logContext: ILogContext;
-  minimumLogLevel?: TLogLevel;
+  logContext: plugins.smartlogInterfaces.ILogContext;
+  minimumLogLevel?: plugins.smartlogInterfaces.TLogLevel;
 }
 
-export class Smartlog {
-  private logContext: ILogContext;
-  private minimumLogLevel: TLogLevel;
+export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
+  private logContext: plugins.smartlogInterfaces.ILogContext;
+  private minimumLogLevel: plugins.smartlogInterfaces.TLogLevel;
 
   private consoleEnabled: boolean;
 
   private logRouter = new LogRouter();
 
-  public addLogDestination(logDestinationArg: ILogDestination) {
+  public addLogDestination(logDestinationArg: plugins.smartlogInterfaces.ILogDestination) {
     this.logRouter.addLogDestination(logDestinationArg);
   }
 
@@ -42,7 +31,23 @@ export class Smartlog {
   /**
    * enables console logging
    */
-  enableConsole() {
+  public enableConsole(optionsArg?: { captureAll: boolean }) {
+    if (optionsArg && optionsArg.captureAll) {
+      const write = process.stdout.write;
+      /* import * as fs from 'fs';
+      const fileStream = fs.createWriteStream(plugins.path.join(paths.nogitDir, 'output.txt'), {
+        flags: 'a+'
+      }); */
+      process.stdout.write = (...args) => {
+        if (!args[0].startsWith('LOG')) {
+          this.log('info', args[0]);
+          return;
+        }
+        // fileStream.write(args[0]);
+        write.apply(process.stdout, args);
+        return true;
+      };
+    }
     this.consoleEnabled = true;
   }
 
@@ -54,18 +59,26 @@ export class Smartlog {
    * @param logLevelArg - the log level
    * @param logMessageArg - the log message
    * @param logDataArg - any additional log data
+   * @param correlationArg - info about corrleations
    */
-  public log(logLevelArg: TLogLevel, logMessageArg: string, logDataArg?: any) {
-    if (this.consoleEnabled) {
-      console.log(
-        `LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLevelArg}: ${logMessageArg}`
-      );
+  public log(
+    logLevelArg: plugins.smartlogInterfaces.TLogLevel,
+    logMessageArg: string,
+    logDataArg?: any,
+    correlationArg: plugins.smartlogInterfaces.ILogCorrelation = {
+      id: plugins.isounique.uni(),
+      type: 'none'
     }
-    const logPackage: ILogPackage = {
+  ) {
+    if (this.consoleEnabled) {
+      this.safeConsoleLog(`${logLevelArg}: ${logMessageArg}`);
+    }
+    const logPackage: plugins.smartlogInterfaces.ILogPackage = {
       timestamp: Date.now(),
       type: 'log',
       context: this.logContext,
       level: logLevelArg,
+      correlation: correlationArg,
       message: logMessageArg
     };
     if (logDataArg) {
@@ -74,20 +87,35 @@ export class Smartlog {
     this.logRouter.routeLog(logPackage);
   }
 
-  public increment(logLevelArg: TLogLevel, logMessageArg) {
+  public increment(
+    logLevelArg: plugins.smartlogInterfaces.TLogLevel,
+    logMessageArg: string,
+    logDataArg?: any,
+    correlationArg: plugins.smartlogInterfaces.ILogCorrelation = {
+      id: plugins.isounique.uni(),
+      type: 'none'
+    }
+  ) {
     if (this.consoleEnabled) {
-      console.log(`INCREMENT: ${logLevelArg}: ${logMessageArg}`);
+      this.safeConsoleLog(`INCREMENT: ${logLevelArg}: ${logMessageArg}`);
     }
     this.logRouter.routeLog({
       timestamp: Date.now(),
       type: 'increment',
       context: this.logContext,
       level: logLevelArg,
-      message: logMessageArg
+      message: logMessageArg,
+      correlation: correlationArg
     });
   }
 
-  public handleLogPackage(logPackageArg: ILogPackage) {
+  public handleLog(logPackageArg: plugins.smartlogInterfaces.ILogPackage) {
     this.logRouter.routeLog(logPackageArg);
   }
+
+  private safeConsoleLog(logLine: string) {
+    console.log(
+      `LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLine}`
+    );
+  }
 }

ts/smartlog.plugins.ts

@@ -1 +1,4 @@
-export {};
+import * as isounique from '@pushrocks/isounique';
+import * as smartlogInterfaces from '@pushrocks/smartlog-interfaces';
+
+export { isounique, smartlogInterfaces };