3.0.1

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -19,23 +22,36 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+  allow_failure: true
+
+auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +66,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +77,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,11 +97,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -109,11 +122,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "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"
+      "type": "node-terminal"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -5,7 +5,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartlog",
-      "shortDescription": "minimalistic distributed and extensible logging tool",
+      "description": "minimalistic distributed and extensible logging tool",
       "npmPackagename": "@pushrocks/smartlog",
       "license": "MIT",
       "projectDomain": "push.rocks"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartlog",
-  "version": "2.0.24",
+  "version": "3.0.1",
   "private": false,
   "description": "minimalistic distributed and extensible logging tool",
   "keywords": [
@@ -17,21 +17,23 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild --web)",
-    "format": "(gitzone format)"
+    "build": "(tsbuild --web && tsbundle npm)",
+    "format": "(gitzone format)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@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",
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsbundle": "^2.0.6",
+    "@gitzone/tsrun": "^1.2.17",
+    "@gitzone/tstest": "^1.0.72",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.6.1",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
     "@pushrocks/isounique": "^1.0.4",
-    "@pushrocks/smartlog-interfaces": "^2.0.15"
+    "@pushrocks/smartlog-interfaces": "^2.0.22"
   },
   "files": [
     "ts/**/*",
@@ -44,5 +46,9 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
-  ]
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "type": "module"
 }

readme.md

@@ -76,7 +76,6 @@ 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). :)

test/test.browser.ts

@@ -0,0 +1,48 @@
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as smartlog from '../ts/index.js';
+
+let testConsoleLog: smartlog.ConsoleLog;
+let testSmartLog: smartlog.Smartlog;
+
+tap.test('should produce a valid ConsoleLog instance', async () => {
+  testConsoleLog = new smartlog.ConsoleLog();
+  testConsoleLog.log('ok', 'this is ok');
+});
+
+tap.test('should produce instance of Smartlog', async () => {
+  testSmartLog = new smartlog.Smartlog({
+    logContext: {
+      environment: 'test',
+      runtime: 'node',
+      zone: 'gitzone',
+      company: 'Lossless GmbH',
+      companyunit: 'Lossless Cloud',
+      containerName: 'testing',
+    },
+  });
+});
+
+tap.test('should enable console logging', async () => {
+  testSmartLog.enableConsole({
+    captureAll: true,
+  });
+  console.log('this is a normal log that should be captured');
+  console.log(new Error('hi there'));
+  testSmartLog.log('info', 'this should only be printed once');
+});
+
+tap.test('should be able to log things', async () => {
+  testSmartLog.log('silly', 'hi');
+});
+
+tap.test('should create a log group', async () => {
+  const logGroup = testSmartLog.createLogGroup('some cool transaction');
+  logGroup.log('info', 'this is logged from a log group');
+});
+
+tap.test('should catch error', async () => {
+  console.error(new Error('hey'));
+  // throw new Error('hey');
+});
+
+tap.start();

test/test.ts

@@ -1,24 +1,48 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartlog from '../ts/index';
+import * as smartlog from '../ts/index.js';
 
-let defaultLogger: smartlog.Smartlog;
+let testConsoleLog: smartlog.ConsoleLog;
+let testSmartLog: smartlog.Smartlog;
+
+tap.test('should produce a valid ConsoleLog instance', async () => {
+  testConsoleLog = new smartlog.ConsoleLog();
+  testConsoleLog.log('ok', 'this is ok');
+});
 
 tap.test('should produce instance of Smartlog', async () => {
-  defaultLogger = smartlog.defaultLogger;
-  expect(defaultLogger).to.be.instanceOf(smartlog.Smartlog);
+  testSmartLog = new smartlog.Smartlog({
+    logContext: {
+      environment: 'test',
+      runtime: 'node',
+      zone: 'gitzone',
+      company: 'Lossless GmbH',
+      companyunit: 'Lossless Cloud',
+      containerName: 'testing',
+    },
+  });
 });
 
 tap.test('should enable console logging', async () => {
-  defaultLogger.enableConsole({
-    captureAll: true
+  testSmartLog.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');
+  testSmartLog.log('info', 'this should only be printed once');
 });
 
 tap.test('should be able to log things', async () => {
-  defaultLogger.log('silly', 'hi');
+  testSmartLog.log('silly', 'hi');
+});
+
+tap.test('should create a log group', async () => {
+  const logGroup = testSmartLog.createLogGroup('some cool transaction');
+  logGroup.log('info', 'this is logged from a log group');
+});
+
+tap.test('should catch error', async () => {
+  console.error(new Error('hey'));
+  // throw new Error('hey');
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartlog',
+  version: '3.0.1',
+  description: 'minimalistic distributed and extensible logging tool'
+}

ts/index.ts

@@ -1,16 +1,6 @@
-import * as plugins from './smartlog.plugins';
-import { Smartlog } from './smartlog.classes.smartlog';
-const defaultLogger: Smartlog = new Smartlog({
-  logContext: {
-    company: 'undefined',
-    companyunit: 'undefefined',
-    containerName: 'undefined',
-    environment: 'local',
-    runtime: 'node',
-    zone: 'undefined'
-  }
-});
+import * as plugins from './smartlog.plugins.js';
+import { ConsoleLog } from './smartlog.classes.consolelog.js';
+import { LogGroup } from './smartlog.classes.loggroup.js';
+import { Smartlog } from './smartlog.classes.smartlog.js';
 
-defaultLogger.enableConsole();
-
-export { Smartlog, defaultLogger };
+export { ConsoleLog, LogGroup, Smartlog };

ts/smartlog.classes.consolelog.ts

@@ -0,0 +1,15 @@
+import * as plugins from './smartlog.plugins.js';
+
+/**
+ * a console log optimized for smartlog
+ */
+export class ConsoleLog {
+  public log(
+    logLevelArg: plugins.smartlogInterfaces.TLogLevel,
+    logMessageArg: string,
+    dataArg?: any,
+    correlationArg?: plugins.smartlogInterfaces.ILogCorrelation
+  ) {
+    console.log(`__# ${logLevelArg}: ${logMessageArg}`);
+  }
+}

ts/smartlog.classes.loggroup.ts

@@ -0,0 +1,27 @@
+import * as plugins from './smartlog.plugins.js';
+import { Smartlog } from './smartlog.classes.smartlog.js';
+
+export class LogGroup {
+  public smartlogRef: Smartlog;
+  public transactionId: string;
+  public groupId = plugins.isounique.uni();
+
+  constructor(smartlogInstance: Smartlog, transactionIdArg: string) {
+    this.smartlogRef = smartlogInstance;
+    this.transactionId = transactionIdArg;
+  }
+
+  public log(
+    logLevelArg: plugins.smartlogInterfaces.TLogLevel,
+    logMessageArg: string,
+    logDataArg?: any
+  ) {
+    this.smartlogRef.log(logLevelArg, logMessageArg, logDataArg, {
+      id: plugins.isounique.uni(),
+      type: 'none',
+      group: this.groupId,
+      instance: this.smartlogRef.uniInstanceId,
+      transaction: this.transactionId,
+    });
+  }
+}

ts/smartlog.classes.logrouter.ts

@@ -1,4 +1,4 @@
-import * as plugins from './smartlog.plugins';
+import * as plugins from './smartlog.plugins.js';
 
 import { ILogDestination, ILogPackage } from '@pushrocks/smartlog-interfaces';
 
@@ -15,9 +15,9 @@ export class LogRouter {
   }
 
   // routes the log according to added logDestinations
-  routeLog(logPackageArg: ILogPackage) {
+  public async routeLog(logPackageArg: ILogPackage) {
     for (const logDestination of this.logDestinations) {
-      logDestination.handleLog(logPackageArg);
+      await logDestination.handleLog(logPackageArg);
     }
   }
 }

ts/smartlog.classes.smartlog.ts

@@ -1,6 +1,7 @@
-import * as plugins from './smartlog.plugins';
+import * as plugins from './smartlog.plugins.js';
 
-import { LogRouter } from './smartlog.classes.logrouter';
+import { LogRouter } from './smartlog.classes.logrouter.js';
+import { LogGroup } from './smartlog.classes.loggroup.js';
 
 export interface ISmartlogContructorOptions {
   logContext: plugins.smartlogInterfaces.ILogContext;
@@ -8,8 +9,10 @@ export interface ISmartlogContructorOptions {
 }
 
 export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
-  private logContext: plugins.smartlogInterfaces.ILogContext;
-  private minimumLogLevel: plugins.smartlogInterfaces.TLogLevel;
+  public logContext: plugins.smartlogInterfaces.ILogContext;
+  public minimumLogLevel: plugins.smartlogInterfaces.TLogLevel;
+
+  public uniInstanceId: string = plugins.isounique.uni();
 
   private consoleEnabled: boolean;
 
@@ -21,7 +24,7 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
 
   constructor(optionsArg: ISmartlogContructorOptions) {
     this.logContext = optionsArg.logContext;
-    this.minimumLogLevel = optionsArg.minimumLogLevel;
+    this.minimumLogLevel = optionsArg.minimumLogLevel || 'silly';
   }
 
   // ============
@@ -32,21 +35,37 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
    * enables console logging
    */
   public enableConsole(optionsArg?: { captureAll: boolean }) {
-    if (optionsArg && optionsArg.captureAll) {
+    if (globalThis.process && optionsArg && optionsArg.captureAll) {
+      const process = globalThis.process;
       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;
+      process.stdout.write = (...args: any) => {
+        const logString: string = args[0];
+        if (!logString || typeof logString.startsWith !== 'function') {
+          // lets continue as planned
+        } else if (!logString.startsWith('LOG') && typeof logString === 'string') {
+          switch (true) {
+            case logString.substr(0, 20).includes('Error:'):
+              this.log('error', logString);
+              break;
+            default:
+              this.log('info', logString);
+          }
+          return true;
         }
         // fileStream.write(args[0]);
         write.apply(process.stdout, args);
         return true;
       };
+
+      process.stderr.write = (...args: any) => {
+        if (!args[0].startsWith('LOG')) {
+          this.log('error', args[0]);
+          return true;
+        }
+        // fileStream.write(args[0]);
+        write.apply(process.stderr, args);
+        return true;
+      };
     }
     this.consoleEnabled = true;
   }
@@ -61,30 +80,37 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
    * @param logDataArg - any additional log data
    * @param correlationArg - info about corrleations
    */
-  public log(
+  public async log(
     logLevelArg: plugins.smartlogInterfaces.TLogLevel,
     logMessageArg: string,
     logDataArg?: any,
-    correlationArg: plugins.smartlogInterfaces.ILogCorrelation = {
-      id: plugins.isounique.uni(),
-      type: 'none'
-    }
+    correlationArg?: plugins.smartlogInterfaces.ILogCorrelation
   ) {
+    correlationArg = {
+      ...{
+        id: plugins.isounique.uni(),
+        type: 'none',
+        instance: this.uniInstanceId,
+      },
+      ...correlationArg,
+    };
+
     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
+      message: logMessageArg,
     };
     if (logDataArg) {
       logPackage.data = logDataArg;
     }
-    this.logRouter.routeLog(logPackage);
+    await this.logRouter.routeLog(logPackage);
   }
 
   public increment(
@@ -93,7 +119,7 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
     logDataArg?: any,
     correlationArg: plugins.smartlogInterfaces.ILogCorrelation = {
       id: plugins.isounique.uni(),
-      type: 'none'
+      type: 'none',
     }
   ) {
     if (this.consoleEnabled) {
@@ -105,12 +131,12 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
       context: this.logContext,
       level: logLevelArg,
       message: logMessageArg,
-      correlation: correlationArg
+      correlation: correlationArg,
     });
   }
 
-  public handleLog(logPackageArg: plugins.smartlogInterfaces.ILogPackage) {
-    this.logRouter.routeLog(logPackageArg);
+  public async handleLog(logPackageArg: plugins.smartlogInterfaces.ILogPackage) {
+    await this.logRouter.routeLog(logPackageArg);
   }
 
   private safeConsoleLog(logLine: string) {
@@ -118,4 +144,8 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
       `LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLine}`
     );
   }
+
+  public createLogGroup(transactionId: string = 'none') {
+    return new LogGroup(this, transactionId);
+  }
 }

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}