1.0.23

.gitignore

@@ -1,6 +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,10 +1,10 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
   - security
@@ -20,49 +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
 
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
+testStable:
-  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:
   stage: test
   script:
     - npmci npm prepare
@@ -71,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
 
@@ -82,6 +75,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -90,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/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
+    - lossless
     - docker
     - priv
 
@@ -114,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:
@@ -135,13 +125,3 @@ pages:
     paths:
       - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

.snyk

@@ -0,0 +1,4 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.12.0
+ignore: {}
+patch: {}

.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

@@ -2,5 +2,16 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "mojoio",
+      "gitrepo": "logdna",
+      "shortDescription": "an unoffical package for the logdna api",
+      "npmPackagename": "@mojoio/logdna",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@mojoio/logdna",
-  "version": "1.0.6",
+  "version": "1.0.23",
   "private": false,
   "description": "an unoffical package for the logdna api",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
@@ -13,18 +13,31 @@
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.33",
-    "@pushrocks/qenv": "^2.0.2",
+    "@pushrocks/qenv": "^4.0.6",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.2.1",
-    "@types/node": "^10.11.7",
+    "@types/node": "^14.0.9",
-    "tslint": "^5.11.0",
+    "tslint": "^6.1.2",
-    "tslint-config-prettier": "^1.15.0"
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartlog-interfaces": "^1.0.15",
+    "@pushrocks/lik": "^4.0.13",
-    "@pushrocks/smartrequest": "^1.1.14",
+    "@pushrocks/smartlog-interfaces": "^2.0.9",
-    "@pushrocks/smartstring": "^3.0.4",
+    "@pushrocks/smartrequest": "^1.1.47",
-    "@pushrocks/taskbuffer": "^2.0.5"
+    "@pushrocks/smartstring": "^3.0.18",
-  }
+    "@pushrocks/taskbuffer": "^2.1.1"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

qenv.yml

@@ -1,2 +1,2 @@
-vars:
+required:
   - LOGDNA_APIKEY

readme.md

@@ -0,0 +1,88 @@
+# @mojoio/logdna
+an unoffical package for the logdna api
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/logdna)
+* [gitlab.com (source)](https://gitlab.com/mojoio/logdna)
+* [github.com (source mirror)](https://github.com/mojoio/logdna)
+* [docs (typedoc)](https://mojoio.gitlab.io/logdna/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/mojoio/logdna/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/mojoio/logdna/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@mojoio/logdna)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/mojoio/logdna)](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/@mojoio/logdna)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@mojoio/logdna)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@mojoio/logdna)](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
+
+Use TypeScript for best in class instellisense.
+
+This package is an unofficial package for the logdna. It comes with the following festures:
+
+- aggregates logs that require the same uri query parameters and sends them as bundle. This ensures the correct order of logs
+- resends logs that failed to send.
+- supports smartlog messages and the smartlog ecosystem
+
+```typescript
+import { ILogPackage } from '@pushrocks/smartlog-interfaces';
+
+import { LogdnaAccount, LogdnaMessage } from '@mojoio/logdna';
+
+// lets create a logDnaAccount
+const logDnaAccount = new LogdnaAccount(process.env.LOGDNA_APIKEY);
+
+// lets create a smartlog message (smartlog normally takes care of creating those objects)
+const smartlogPackage: ILogPackage = {
+  timestamp: Date.now(),
+  type: 'log',
+  level: 'info',
+  context: {
+    company: 'Lossless GmbH',
+    companyunit: 'lossless.cloud',
+    containerName: 'ci-mojoio-logdna',
+    environment: 'test',
+    runtime: 'node',
+    zone: 'shipzone'
+  },
+  message: 'this is an awesome log message sent by the tapbundle test'
+};
+
+const logdnaMessage = LogdnaMessage.fromSmartLogPackage(smartlogPackage);
+
+logDnaAccount.sendLogdnaMessage(logdnaMessage);
+
+// alternatively simply send the smartlogPackage
+// creation of the LogdnaMessage is done for you
+logDnaAccount.sendSmartlogPackage(smartlogPackage);
+
+// most of the above funtions return promises should you want to wait for a log to be fully sent
+```
+
+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)
+
+[![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://mojo.io)
+
+
+## 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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -2,6 +2,7 @@ import { expect, tap } from '@pushrocks/tapbundle';
 import * as logdna from '../ts/index';
 
 import { Qenv } from '@pushrocks/qenv';
+import { ILogPackage } from '@pushrocks/smartlog-interfaces';
 
 const testQenv = new Qenv('./', './.nogit');
 
@@ -9,26 +10,50 @@ let testLogDnaAccount: logdna.LogdnaAccount;
 let testLogMessage: logdna.LogdnaMessage;
 
 tap.test('should create a valid logDna account', async () => {
-  testLogDnaAccount = new logdna.LogdnaAccount(process.env.LOGDNA_APIKEY);
+  testLogDnaAccount = new logdna.LogdnaAccount(testQenv.getEnvVarOnDemand('LOGDNA_APIKEY'));
 });
 
 tap.test('should create a standard log message', async () => {
   testLogMessage = logdna.LogdnaMessage.fromSmartLogPackage({
-    logContext: {
+    timestamp: Date.now(),
+    type: 'log',
+    level: 'info',
+    context: {
       company: 'Lossless GmbH',
       companyunit: 'lossless.cloud',
       containerName: 'ci-mojoio-logdna',
       environment: 'test',
       runtime: 'node',
-      zone: 'ship.zone'
+      zone: 'shipzone'
     },
-    logLevel: 'info',
+    message: 'this is an awesome log message sent by the tapbundle test'
-    message: 'this is a awesome log message :)'
   });
 });
 
 tap.test('should send the message', async () => {
-  await testLogDnaAccount.sendLogDnaMessage(testLogMessage);
+  await testLogDnaAccount.sendLogdnaMessage(testLogMessage);
+});
+
+tap.test('should send in order', async () => {
+  let i = 1;
+  while (i < 21) {
+    const testSmartlogMessage: ILogPackage = {
+      timestamp: Date.now(),
+      type: 'log',
+      level: 'info',
+      context: {
+        company: 'Lossless GmbH',
+        companyunit: 'lossless.cloud',
+        containerName: 'ci-mojoio-logdna',
+        environment: 'test',
+        runtime: 'node',
+        zone: 'shipzone'
+      },
+      message: `this is an awesome log message sent by the tapbundle test #${i}`
+    };
+    testLogDnaAccount.sendSmartlogPackage(testSmartlogMessage);
+    i++;
+  }
 });
 
 tap.start();

ts/logdna.aggregator.ts

@@ -0,0 +1,60 @@
+import * as plugins from './logdna.plugins';
+import { LogdnaAccount } from './logdna.logdnaaccount';
+
+export interface ILogCandidate {
+  urlIdentifier: string;
+  logLines: any[];
+}
+
+export class LogAggregator {
+  private apiKey: string;
+  private baseUrl = 'https://logs.logdna.com/logs/ingest';
+
+  private logObjectMap = new plugins.lik.ObjectMap<ILogCandidate>();
+
+  constructor(apiKeyArg: string) {
+    this.apiKey = apiKeyArg;
+  }
+
+  /**
+   * Create basic authentication
+   */
+  private createBasicAuth() {
+    const userNamePasswordString = `${this.apiKey}:`;
+    return `Basic ${plugins.smartstring.base64.encode(userNamePasswordString)}`;
+  }
+
+  public addLog(urlIdentifierArg: string, logLineArg: any) {
+    let existinglogCandidate = this.logObjectMap.find(logCandidate => {
+      return logCandidate.urlIdentifier === urlIdentifierArg;
+    });
+    if (!existinglogCandidate) {
+      existinglogCandidate = { urlIdentifier: urlIdentifierArg, logLines: [] };
+      this.logObjectMap.add(existinglogCandidate);
+      setTimeout(() => {
+        this.sendAggregatedLogs(existinglogCandidate);
+      }, 500);
+    }
+    existinglogCandidate.logLines.push(logLineArg);
+  }
+
+  private async sendAggregatedLogs(logCandidate: ILogCandidate) {
+    this.logObjectMap.remove(logCandidate);
+    // lets post the message to logdna
+    const response = await plugins.smartrequest.postJson(
+      `${this.baseUrl}${logCandidate.urlIdentifier}&now=${Date.now()}`,
+      {
+        headers: {
+          Authorization: this.createBasicAuth(),
+          charset: 'UTF-8'
+        },
+        requestBody: {
+          lines: logCandidate.logLines
+        }
+      }
+    );
+    if (response.statusCode !== 200) {
+      console.log(response.body);
+    }
+  }
+}

ts/logdna.classes.logmessage.ts

@@ -6,6 +6,11 @@ import { TLogLevel, TEnvironment, ILogPackage } from '@pushrocks/smartlog-interf
  * the constructor options for LogdnaMessage
  */
 export interface ILogdnaMessageContructorOptions {
+  /**
+   * a timestamp for then the log message was created
+   */
+  timestamp: number;
+
   /**
    * the hostname where the log message was created
    */
@@ -60,18 +65,22 @@ export class LogdnaMessage {
    * create lgdna messages from smartlog package
    * @param smartlogPackageArg
    */
-  static fromSmartLogPackage(smartlogPackageArg: ILogPackage): LogdnaMessage {
+  public static fromSmartLogPackage(smartlogPackageArg: ILogPackage): LogdnaMessage {
     return new LogdnaMessage({
+      timestamp: smartlogPackageArg.timestamp,
       line: smartlogPackageArg.message,
-      meta: smartlogPackageArg.logContext,
+      meta: {
-      env: smartlogPackageArg.logContext.environment,
+        ...smartlogPackageArg.context,
-      hostname: smartlogPackageArg.logContext.zone,
+        logType: smartlogPackageArg.type
-      level: smartlogPackageArg.logLevel,
+      },
-      app: smartlogPackageArg.logContext.zone,
+      env: smartlogPackageArg.context.environment,
+      hostname: smartlogPackageArg.context.zone,
+      level: smartlogPackageArg.level,
+      app: smartlogPackageArg.context.containerName,
       tags: (() => {
         const tagArray: string[] = [];
-        tagArray.push(smartlogPackageArg.logContext.company);
+        tagArray.push(smartlogPackageArg.context.company);
-        tagArray.push(smartlogPackageArg.logContext.companyunit);
+        tagArray.push(smartlogPackageArg.context.companyunit);
         return tagArray;
       })(),
       ip: '0.0.0.0',

ts/logdna.logdnaaccount.ts

@@ -1,69 +1,72 @@
 import * as plugins from './logdna.plugins';
 
 import { LogdnaMessage } from './logdna.classes.logmessage';
+import { LogAggregator } from './logdna.aggregator';
+import { ILogPackage, ILogDestination } from '@pushrocks/smartlog-interfaces';
 
 /**
  * the main logdna account
  */
 export class LogdnaAccount {
-  apiKey: string;
+  private logAggregator: LogAggregator;
-  baseUrl = 'https://logs.logdna.com/logs/ingest';
-
-  /**
-   * Create basic authentication
-   */
-  createBasicAuth() {
-    const userNamePasswordString = `${this.apiKey}:`;
-    return `Basic ${plugins.smartstring.base64.encode(userNamePasswordString)}`;
-  }
 
   /**
    *
    * @param apiKeyArg
    */
   constructor(apiKeyArg: string) {
-    this.apiKey = apiKeyArg;
+    this.logAggregator = new LogAggregator(apiKeyArg);
   }
 
   /**
    * sends a logmessage
    * async, so it returns a Promise. In most cases it does not make sense to wait for it though.
    */
-  public async sendLogDnaMessage(logdnaMessageArg: LogdnaMessage) {
+  public async sendLogdnaMessage(logdnaMessageArg: LogdnaMessage) {
     const lm = logdnaMessageArg;
     const euc = encodeURIComponent;
 
-    // let construct the request uri
+    const uriHostname = euc(lm.options.hostname);
-    const requestUrlWithParams = `${this.baseUrl}?hostname=${euc(lm.options.hostname)}&mac=${euc(
+    const uriMac = euc(lm.options.mac);
-      lm.options.mac
+    const uriIp = euc(lm.options.ip);
-    )}&ip=1${euc(lm.options.ip)}&now=${Date.now()}`;
+    const uriTags = euc(
-
+      (() => {
-    const requestBodyObject = {
-      lines: [
-        {
-          line: lm.options.line,
-          app: lm.options.app,
-          level: lm.options.level,
-          env: lm.options.env,
-          meta: lm.options.meta,
-          tags: (() => {
         return lm.options.tags.reduce((reduced, newItem) => {
           return `${reduced},${newItem}`;
         });
       })()
-        }
+    );
-      ]
+
+    // let construct the request uri
+    const requestUrlWithParams = `?hostname=${uriHostname}&mac=${uriMac}&ip=1${uriIp}&tags=${uriTags}`;
+
+    const logLine = {
+      timestamp: lm.options.timestamp,
+      line: lm.options.line,
+      app: lm.options.app,
+      level: lm.options.level,
+      env: lm.options.env,
+      meta: lm.options.meta
     };
 
-    // console.log(requestBodyObject);
+    this.logAggregator.addLog(requestUrlWithParams, logLine);
+  }
 
-    // lets post the message to logdna
+  /**
-    await plugins.smartrequest.postJson(requestUrlWithParams, {
+   * convenience function for smartlog
-      headers: {
+   */
-        Authorization: this.createBasicAuth(),
+  public async sendSmartlogPackage(smartlogPackageArg: ILogPackage) {
-        charset: 'UTF-8'
+    this.sendLogdnaMessage(LogdnaMessage.fromSmartLogPackage(smartlogPackageArg));
-      },
+  }
-      requestBody: requestBodyObject
+
-    });
+  /**
+   * returns a smartlog compatible log destination
+   */
+  public get smartlogDestination(): ILogDestination {
+    return {
+      handleLog: logPackageArg => {
+        this.sendSmartlogPackage(logPackageArg);
+      }
+    };
   }
 }

ts/logdna.plugins.ts

@@ -1,5 +1,6 @@
+import * as lik from '@pushrocks/lik';
 import * as smartrequest from '@pushrocks/smartrequest';
 import * as smartstring from '@pushrocks/smartstring';
 import * as smartlogInterfaces from '@pushrocks/smartlog-interfaces';
 
-export { smartrequest, smartstring, smartlogInterfaces };
+export { lik, smartrequest, smartstring, smartlogInterfaces };