Migrate node CI to github actions to test on different node versions. (#820)

Author: silesky

.buildkite/pipeline.yml

@@ -72,46 +72,6 @@ steps:
           key: "v1.1-cache-dev-{{ checksum 'yarn.lock' }}"
           paths: ['.yarn/cache/']
 
-  - label: '[Node] Lint + Test'
-    key: analytics-node-test
-    agents:
-      queue: v1
-    commands:
-      - npm config set "//registry.npmjs.org/:_authToken" $${NPM_TOKEN}
-      - echo "--- Install dependencies"
-      - PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 HUSKY=0 yarn install --immutable
-      - echo "--- Build bundles"
-      - yarn run -T node+deps build
-      - echo "+++ Run tests"
-      - yarn run -T node lint
-      - yarn run -T node test
-    plugins:
-      - ssh://[email protected]/segmentio/cache-buildkite-plugin#v2.0.0:
-          key: "v1.1-cache-dev-{{ checksum 'yarn.lock' }}"
-          paths: ['.yarn/cache/']
-
-  - label: '[Node] Integration Tests :perfection:'
-    key: analytics-node-lint-test
-    agents:
-      queue: v1
-    commands:
-      - npm config set "//registry.npmjs.org/:_authToken" $${NPM_TOKEN}
-      - echo "--- Install dependencies"
-      - PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 HUSKY=0 yarn install --immutable
-      - echo "--- Build bundles"
-      - yarn turbo run --filter=node-integration-tests build
-      - echo "+++ Run tests"
-      - yarn turbo run --filter=node-integration-tests lint
-      - yarn turbo run --filter=node-integration-tests test
-    retry:
-      automatic:
-        - exit_status: '*'
-          limit: 2
-    plugins:
-      - ssh://[email protected]/segmentio/cache-buildkite-plugin#v2.0.0:
-          key: "v1.1-cache-dev-{{ checksum 'yarn.lock' }}"
-          paths: ['.yarn/cache/']
-
   - label: '[Core] Lint + Test'
     agents:
       queue: v1

.github/workflows/mardown-link-check.yml

@@ -1,6 +1,8 @@
 name: Markdown Links Check
 on:
-  push:
+  schedule:
+    # Runs once every 3 days
+    - cron: "0 0 */3 * *"
 jobs:
   check-links:
     name: Check Markdown Links

.github/workflows/node-ci.yml

@@ -0,0 +1,24 @@
+name: Node CI
+on:
+  push:
+env:
+  HUSKY: 0
+  PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+jobs:
+  test:
+    name: "Test (Node.js v${{ matrix.node-version }})"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ 14, 16, 18 ]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "yarn"
+      - run: yarn install --immutable
+      - run: yarn turbo run --filter='./packages/node*' lint
+      - run: yarn turbo run --filter='./packages/node*' test
+
+

package.json

@@ -53,7 +53,7 @@
     "jest": "^28.1.0",
     "lint-staged": "^13.0.0",
     "lodash": "^4.17.21",
-    "nock": "^13.2.9",
+    "nock": "^13.3.0",
     "node-gyp": "^9.0.0",
     "prettier": "^2.6.2",
     "ts-jest": "^28.0.4",

packages/browser-integration-tests/package.json

@@ -21,7 +21,6 @@
     "@playwright/test": "^1.28.1",
     "@segment/analytics-next": "workspace:^",
     "http-server": "14.1.1",
-    "nock": "^13.2.9",
     "tslib": "^2.4.1"
   }
 }

packages/node-integration-tests/package.json

@@ -19,8 +19,7 @@
     "@types/autocannon": "^7",
     "@types/node": "^16",
     "analytics-node": "^6.2.0",
-    "autocannon": "^7.10.0",
-    "nock": "^13.2.9"
+    "autocannon": "^7.10.0"
   },
   "packageManager": "[email protected]"
 }

packages/node-integration-tests/src/server/fetch-polyfill.ts

@@ -0,0 +1,10 @@
+import fetch from 'node-fetch'
+
+const majorVersion = parseInt(
+  process.version.replace('v', '').split('.')[0],
+  10
+)
+
+if (majorVersion >= 18) {
+  ;(globalThis as any).fetch = fetch // polyfill fetch so nock will work on node >= 18 -- see: https://github.com/nock/nock/issues/2336
+}

packages/node-integration-tests/src/server/server.ts

@@ -2,6 +2,7 @@ import express from 'express'
 import { Server } from 'http'
 import { nockRequests } from './nock'
 import { ServerReport } from './types'
+import './fetch-polyfill'
 
 // always run express in production mode just to be closer to our client's env -- logs less and consumes less memory.
 process.env.NODE_ENV = 'production'

packages/node/jest.config.js

@@ -1,3 +1,5 @@
 const { createJestTSConfig } = require('@internal/config')
 
-module.exports = createJestTSConfig()
+module.exports = createJestTSConfig({
+  setupFilesAfterEnv: ['./jest.setup.js'],
+})

packages/node/jest.setup.js

@@ -0,0 +1,4 @@
+const fetch = require('node-fetch')
+
+// eslint-disable-next-line no-undef
+globalThis.fetch = fetch // polyfill fetch so nock will work correctly on node 18 (https://github.com/nock/nock/issues/2336)