Package manager CI action

.github/workflows/package-manager-ci.yml

@@ -0,0 +1,92 @@
+name: package-manager-ci
+on:
+  push:
+    paths-ignore:
+        - 'docs/**'
+        - '*.md'
+  pull_request:
+    paths-ignore:
+        - 'docs/**'
+        - '*.md'
+jobs:
+  pnpm:
+    name: pnpm package manager on ${{ matrix.node-version }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macOS-latest, windows-latest]
+        node-version: [12, 14, 16]
+    steps:
+      - uses: actions/checkout@v2.3.4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2.4.0
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Use pnpm
+        uses: pnpm/action-setup@v2.0.1
+        with:
+          version: ^6.0.0
+      - name: Install dependancies
+        run: pnpm install
+      - name: Tests
+        run: pnpm run test-ci
+
+  yarn:
+    name: yarn package manager on ${{ matrix.node-version }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macOS-latest]
+        node-version: [12, 14, 16]
+    steps:
+      - uses: actions/checkout@v2.3.4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2.4.0
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Use yarn
+        run: |
+          npm install -g yarn
+          yarn set version berry && yarn set version 2.4.2
+          echo "nodeLinker: node-modules" >> .yarnrc.yml
+          # see https://github.com/yarnpkg/berry/issues/2935#issuecomment-911299992
+          yarn add --dev typescript@~4.3.2
+          yarn install
+        env:
+          # needed due the yarn.lock file in pino's .gitignore
+          YARN_ENABLE_IMMUTABLE_INSTALLS: false
+      - name: Tests
+        run: |
+          # yarn doesn't support ESM yet
+          mv ./test/esm/index.test.js ./test/esm/index.test.skip.js
+          yarn run test-ci
+
+  yarn-pnp:
+    name: yarn-pnp package manager on ${{ matrix.node-version }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macOS-latest]
+        node-version: [12, 14, 16]
+    steps:
+      - uses: actions/checkout@v2.3.4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2.4.0
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Use yarn
+        run: |
+          npm install -g yarn
+          yarn set version berry
+          echo "nodeLinker: pnp" >> .yarnrc.yml 
+          echo "pnpMode: loose" >> .yarnrc.yml 
+          yarn install
+          yarn add --dev transport@link:./test/fixtures/transport
+        env:
+          # needed due the yarn.lock file in pino's .gitignore
+          YARN_ENABLE_IMMUTABLE_INSTALLS: false
+      - name: Tests
+        run: yarn run test-ci

.gitignore

@@ -26,6 +26,12 @@ build/Release
 # Dependency directory
 node_modules
 
+# yarn cache
+.yarn
+.yarnrc.yml
+.pnp
+.pnp.*
+
 # Optional npm cache directory
 .npm
 

package.json

@@ -81,6 +81,7 @@
     "import-fresh": "^3.2.1",
     "log": "^6.0.0",
     "loglevel": "^1.6.7",
+    "pino-elasticsearch": "^6.1.0",
     "pino-pretty": "^5.1.0",
     "pre-commit": "^1.2.2",
     "proxyquire": "^2.1.3",
@@ -108,7 +109,7 @@
     "json-stringify-safe": "^5.0.1",
     "quick-format-unescaped": "^4.0.3",
     "sonic-boom": "^2.1.0",
-    "thread-stream": "^0.11.0"
+    "thread-stream": "^0.11.1"
   },
   "tsd": {
     "directory": "test/types"

test/helper.js

@@ -8,6 +8,7 @@ const pid = process.pid
 const hostname = os.hostname()
 
 const isWin = process.platform === 'win32'
+const isYarnPnp = process.versions.pnp !== undefined
 
 function getPathToNull () {
   return isWin ? '\\\\.\\NUL' : '/dev/null'
@@ -72,4 +73,4 @@ function watchFileCreated (filename) {
   })
 }
 
-module.exports = { getPathToNull, sink, check, once, sleep, watchFileCreated, isWin }
+module.exports = { getPathToNull, sink, check, once, sleep, watchFileCreated, isWin, isYarnPnp }

test/transport.test.js

@@ -5,7 +5,7 @@ const { join } = require('path')
 const { once } = require('events')
 const { readFile, symlink, unlink } = require('fs').promises
 const { test } = require('tap')
-const { isWin, watchFileCreated } = require('./helper')
+const { isWin, isYarnPnp, watchFileCreated } = require('./helper')
 const pino = require('../')
 const url = require('url')
 const strip = require('strip-ansi')
@@ -15,6 +15,32 @@ const writer = require('flush-write-stream')
 const { pid } = process
 const hostname = os.hostname()
 
+async function installTransportModule () {
+  try {
+    await uninstallTransportModule()
+  } catch {}
+  try {
+    await symlink(
+      join(__dirname, 'fixtures', 'transport'),
+      join(__dirname, '..', 'node_modules', 'transport')
+    )
+  } catch (err) {
+    if (!isYarnPnp) {
+      throw err
+    }
+  }
+}
+
+async function uninstallTransportModule () {
+  try {
+    await unlink(join(__dirname, '..', 'node_modules', 'transport'))
+  } catch (err) {
+    if (!isYarnPnp) {
+      throw err
+    }
+  }
+}
+
 test('pino.transport with file', async ({ same, teardown }) => {
   const destination = join(
     os.tmpdir(),
@@ -53,21 +79,14 @@ test('pino.transport with package', { skip: isWin }, async ({ same, teardown })
     '_' + Math.random().toString(36).substr(2, 9)
   )
 
-  try {
-    await unlink(join(__dirname, '..', 'node_modules', 'transport'))
-  } catch {}
-
-  await symlink(
-    join(__dirname, 'fixtures', 'transport'),
-    join(__dirname, '..', 'node_modules', 'transport')
-  )
+  await installTransportModule()
 
   const transport = pino.transport({
     target: 'transport',
     options: { destination }
   })
   teardown(async () => {
-    await unlink(join(__dirname, '..', 'node_modules', 'transport'))
+    await uninstallTransportModule()
     transport.end()
   })
   const instance = pino(transport)
@@ -83,6 +102,29 @@ test('pino.transport with package', { skip: isWin }, async ({ same, teardown })
   })
 })
 
+test('pino.transport loads the pino-elasticsearch package', ({ plan, ok, fail, equal, pass }) => {
+  plan(3)
+  const transport = pino.transport({
+    target: 'pino-elasticsearch',
+    options: {
+      node: null // triggers the error if the module is loaded correctly
+    }
+  })
+
+  const instance = pino(transport)
+  instance.info('hello')
+
+  transport.on('ready', function () {
+    fail('ready event should not be emitted')
+  })
+  transport.on('error', function (err) {
+    ok(err)
+    equal(err.message, 'Missing node(s) option', 'pino-elastisearch trigger a valid error')
+  })
+
+  pass('pino instance created')
+})
+
 test('pino.transport with file URL', async ({ same, teardown }) => {
   const destination = join(
     os.tmpdir(),
@@ -297,14 +339,7 @@ test('pino.transport with package as a target', { skip: isWin }, async ({ same,
     '_' + Math.random().toString(36).substr(2, 9)
   )
 
-  try {
-    await unlink(join(__dirname, '..', 'node_modules', 'transport'))
-  } catch {}
-
-  await symlink(
-    join(__dirname, 'fixtures', 'transport'),
-    join(__dirname, '..', 'node_modules', 'transport')
-  )
+  await installTransportModule()
 
   const transport = pino.transport({
     targets: [{
@@ -313,7 +348,7 @@ test('pino.transport with package as a target', { skip: isWin }, async ({ same,
     }]
   })
   teardown(async () => {
-    await unlink(join(__dirname, '..', 'node_modules', 'transport'))
+    await uninstallTransportModule()
     transport.end()
   })
   const instance = pino(transport)