test: add TAV tests for pino and winston supported versions

We support pino@6, pino@7, pino@8, and winston@3.

Refs: #131
Refs: #115

Author: trentm

.github/workflows/tav.yml

@@ -0,0 +1,31 @@
+## TAV (test-all-versions) tests to test with multiple versions of deps.
+name: tav
+
+on:
+  workflow_dispatch: ~
+  schedule:
+    # Weekly on Monday, 16:00 UTC, so hopefully near my PST morning.
+    - cron: '0 16 * * 1'
+
+permissions:
+  contents: read
+
+jobs:
+  tav:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [10, 12, 14, 16, 18, 20]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Update npm to at least v7 for workspaces support
+        if: ${{ matrix.node-version < 16 }} # node@16 comes with npm@8, node@14 with npm@6
+        run: npm install -g npm@7 # npm@7 supports node >=10
+      - name: Install dependencies
+        run: utils/run-install.sh
+      - name: TAV Node.js v${{ matrix.node-version }}
+        run: npm --workspaces run --if-present tav

.github/workflows/test.yml

@@ -5,7 +5,6 @@ on:
   push:
     branches:
       - main
-    tags:
   pull_request:
     branches:
       - main

Makefile

@@ -16,6 +16,10 @@ all:
 test:
 	./utils/run-test.sh
 
+.PHONY: tav
+tav:
+	npm --workspaces run --if-present tav # requires npm>=7 (aka node>=16)
+
 .PHONY: lint
 lint: check-license-headers
 	./utils/run-lint.sh

packages/ecs-pino-format/.tav.yml

@@ -0,0 +1,15 @@
+# Ideally we'd test all pino releases, but that is too many to justify the
+# compute time -- so we test a subset.
+pino:
+  - versions: '6.0.0 || ^6.14.0'
+    # versions: '^6.0.0'
+    node: '>=10 <17'
+    commands: 'npm test'
+  - versions: '7.0.0 || ^7.11.0'
+    # versions: '^7.0.0'
+    node: '>=12 <18'
+    commands: 'npm test'
+  - versions: '8.0.0 || >=8.16.1'
+    # versions: '>=8.0.0'
+    node: '>=14'
+    commands: 'npm test'

packages/ecs-pino-format/package.json

@@ -32,7 +32,8 @@
   "scripts": {
     "lint": "standard",
     "lint:fix": "standard --fix",
-    "test": "tap --timeout ${TAP_TIMEOUT:-10} test/*.test.js"
+    "test": "tap --timeout ${TAP_TIMEOUT:-10} test/*.test.js",
+    "tav": "tav --quiet"
   },
   "engines": {
     "node": ">=10"
@@ -48,8 +49,10 @@
     "express": "^4.17.1",
     "pino": "^6.0.0",
     "pino-http": "^5.3.0",
+    "semver": "^7.5.4",
     "split2": "^3.1.1",
     "standard": "16.x",
-    "tap": "^15.0.10"
+    "tap": "^15.0.10",
+    "test-all-versions": "^5.0.1"
   }
 }

packages/ecs-pino-format/test/basic.test.js

@@ -25,6 +25,7 @@ const os = require('os')
 const addFormats = require('ajv-formats').default
 const Ajv = require('ajv').default
 const pino = require('pino')
+const semver = require('semver')
 const split = require('split2')
 const test = require('tap').test
 const ecsVersion = require('@elastic/ecs-helpers').version
@@ -319,6 +320,12 @@ test('can handle circular refs', t => {
 
   const rec = JSON.parse(lines[0])
   t.ok(validate(rec))
-  t.strictSame(rec.obj, { foo: 'bar', self: '[Circular]' })
+  if (semver.satisfies(pino.version, '>=7.0.0 <7.1.0')) {
+    // For some versions pino used json-stringify-safe with a slightly different
+    // serialization for circular refs.
+    t.strictSame(rec.obj, { foo: 'bar', self: '[Circular ~]' })
+  } else {
+    t.strictSame(rec.obj, { foo: 'bar', self: '[Circular]' })
+  }
   t.end()
 })

packages/ecs-winston-format/.tav.yml

@@ -0,0 +1,7 @@
+winston:
+  - versions: '>=3.0.0 <3.6.0'
+    node: '>=6.4.0'
+    commands: 'npm test'
+  - versions: '>=3.6.0'
+    node: '>=12'
+    commands: 'npm test'

packages/ecs-winston-format/package.json

@@ -33,7 +33,8 @@
     "bench": "./benchmarks/bench",
     "lint": "standard",
     "lint:fix": "standard --fix",
-    "test": "tap --timeout ${TAP_TIMEOUT:-10} test/*.test.js"
+    "test": "tap --timeout ${TAP_TIMEOUT:-10} test/*.test.js",
+    "tav": "tav --quiet"
   },
   "engines": {
     "node": ">=10"