feat!: Change to use @logdna/logger as the client

BREAKING CHANGE:

This changes the client to be the newer logdna node client.
Other changes were to add tests and map the log levels
between winston and logdna since they differ.  Also, the
`index_meta` property was changed to `indexMeta` as required
by the logdna logger client.

Semver: major
Ref: LOG-7378

.gitignore

@@ -1,3 +1,4 @@
-/node_modules/
-package-lock.json
-**/*.zip
+node_modules
+coverage
+.nyc_output
+.tap-output

.npmignore

@@ -0,0 +1,11 @@
+*.log
+npm-debug.log*
+coverage
+.nyc_output
+*.tgz
+.env
+*.swp
+*.vim
+.npm
+.tap-output
+Jenkinsfile

.npmrc

@@ -0,0 +1 @@
+package-lock=false

README.md

@@ -15,13 +15,14 @@
 
 ## Install
 
-```javascript
+```sh
 $ npm install --save logdna-winston
 ```
 
 ## API
 
-Please see the [logdna](https://github.com/logdna/nodejs/) npm module for the API.
+Please see [@logdna/logger](https://www.npmjs.com/package/@logdna/logger#createloggerkey-options) for
+instantiation options to passthrough to LogDNA's logger client.
 
 ## Winston Transport
 
@@ -39,8 +40,8 @@ const options = {
  app: appName,
  env: envName,
  level: level, // Default to debug, maximum level of log, doc: https://github.com/winstonjs/winston#logging-levels
- index_meta: true // Defaults to false, when true ensures meta object will be searchable
-};
+ indexMeta: true // Defaults to false, when true ensures meta object will be searchable
+}
 
 // Only add this line in order to track exceptions
 options.handleExceptions = true;
@@ -52,17 +53,25 @@ logger.add(new logdnaWinston(options));
 logger.log({
  level: 'info'
  , message: 'Log from LogDNA-winston'
- , index_meta: true // Ignore this if you would like to use default setting
- , data:'Some information' // Properties besides level, message and index_meta are considered as "meta"
+ , indexMeta: true // Optional. If not provided, it will use the default.
+ , data:'Some information' // Properties besides level, message and indexMeta are considered as "meta"
  , error: new Error("It's a trap.") // Transport will parse the error object under property 'error'
-});
+})
 
 // log without meta
 logger.info('Info: Log from LogDNA-winston');
+
+// A payload without 'message' will log the stringified object as the message
+logger.info({
+ key: 'value'
+, text: 'This is some text to get logged'
+, bool: true
+})
 ```
 
 ## License
 
-MIT © [LogDNA](https://logdna.com/)
+Copyright © [LogDNA](https://logdna.com), released under an MIT license.
+See the [LICENSE](./LICENSE) file and https://opensource.org/licenses/MIT
 
 *Happy Logging!*

index.js

@@ -2,45 +2,53 @@
 
 const pkg = require('./package.json')
 const Transport = require('winston-transport')
-const Logger = require('logdna').Logger
-
-const DEFAULT_LEVEL = 'debug'
-const DEFAULT_NAME = 'LogDNA'
-
+const {createLogger} = require('@logdna/logger')
+
+// Convert between Winston levels and @logdna/logger levels
+const levelTranslate = new Map([
+ ['error', 'error']
+, ['warn', 'warn']
+, ['info', 'info']
+, ['http', 'debug']
+, ['verbose', 'debug']
+, ['silly', 'trace']
+])
 /*
  * Support for Winston Transport
  */
 module.exports = class LogDNATransport extends Transport {
  constructor(options) {
  super(options)
- this.name = options.name || DEFAULT_NAME
- this.level = options.level || DEFAULT_LEVEL
- this.index_meta = options.index_meta || false
- this.logger = new Logger(options.key, {
+
+ // Create an instance of @logdna/logger
+ this.logger = createLogger(options.key, {
  ...options
  , UserAgent: `${pkg.name}/${pkg.version}`
  })
  }
 
  log(info, callback) {
- info = info || {}
-
  if (info.error instanceof Error) {
  info.error = info.error.stack || info.error.toString()
  }
 
  if (!info.message) {
- info.message = JSON.stringify(info, null, 2, function() { return undefined })
+ // Send the incoming object payload as the message
+ const level = levelTranslate.get(info.level)
+ this.logger.log(info, level)
+ callback(null, true)
+ return
  }
 
- const {level, message, index_meta, ...meta} = info
+ const {level, message, indexMeta, timestamp, ...meta} = info
  const opts = {
- level: level
- , index_meta: typeof info.index_meta === 'boolean' ? index_meta : this.index_meta
- , context: meta || {}
+ level
+ , indexMeta
+ , timestamp
+ , meta
  }
 
  this.logger.log(message, opts)
- if (callback) { callback(null, true) }
+ callback(null, true)
  }
 }

package.json

@@ -4,7 +4,9 @@
  "description": "LogDNA's Node.js logging module with support for Winston",
  "main": "index.js",
  "scripts": {
- "lint": "eslint ."
+ "lint": "eslint .",
+ "pretest": "npm run lint",
+ "test": "tap"
  },
  "repository": {
  "type": "git",
@@ -30,12 +32,15 @@
  },
  "homepage": "https://github.com/logdna/logdna-winston#readme",
  "dependencies": {
- "logdna": "^3.5.0"
+ "@logdna/logger": "^1.3.2",
+ "winston-transport": "^4.4.0"
  },
  "devDependencies": {
  "eslint": "^7.10.0",
  "eslint-config-logdna": "^2.0.0",
- "winston-transport": "^4.4.0"
+ "nock": "^13.0.4",
+ "tap": "^14.10.8",
+ "winston": "^3.3.3"
  },
  "eslintConfig": {
  "extends": [
@@ -49,5 +54,28 @@
  "parserOptions": {
  "ecmaVersion": 2019
  }
+ },
+ "tap": {
+ "100": true,
+ "esm": false,
+ "ts": false,
+ "jsx": false,
+ "check-coverage": true,
+ "coverage-report": [
+ "text",
+ "text-summary",
+ "json",
+ "html"
+ ],
+ "reporter": "tap",
+ "nyc-arg": [
+ "--exclude=test/",
+ "--exclude=tools",
+ "--all"
+ ],
+ "files": [
+ "test/**/*.js"
+ ],
+ "output-file": ".tap-output"
  }
 }