Upgrade dependencies and migrate CJS to ESM

Author: binarymist

.eslintrc.js renamed to .eslintrc.cjs

@@ -24,23 +24,17 @@ module.exports = {
     // enforce consistent line breaks inside function parentheses
     // https://eslint.org/docs/rules/function-paren-newline
     'function-paren-newline': ['error', 'multiline'],
-    'import/no-unresolved': ['error', { commonjs: true }],
+    // Eslint can't deal with ESM modules currently.
+    'import/no-unresolved': ['error', { ignore: ['ava', 'purpleteam-logger'] }],
+    // Used in order to supress the errors in the use of appending file extensions to the import statement for local modules
+    // Which is required in order to upgrade from CJS to ESM. At time of upgrade file extensions have to be provided in import statements.
+    'import/extensions': ['error', { 'js': 'ignorePackages' }],
     'no-unused-expressions': ['error', { allowShortCircuit: true, allowTernary: true }],
     'object-curly-newline': ['error', { multiline: true }],
     'no-multiple-empty-lines': ['error', { max: 2, maxBOF: 0, maxEOF: 1 }],
     'newline-per-chained-call': 'off',
     'lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: true }]
   },
-  env: { node: true },
-  parserOptions: { ecmaVersion: 2021 },
-  parser: 'babel-eslint', // required for private class members as eslint only supports ECMA Stage 4, will be able to remove in the future
-  settings: {
-    'import/resolver': {
-      node: {
-        paths: [
-          `${process.cwd()}`
-        ]
-      }
-    }
-  }
+  env: { node: true, 'es2021': true },
+  parserOptions: { sourceType: 'module', ecmaVersion: 'latest' }
 };

.github/workflows/node.js.yml

@@ -25,7 +25,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x, 16.x]
+        node-version: [17.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

Dockerfile

@@ -7,7 +7,7 @@
 # the Business Source License, use of this software will be governed
 # by the Apache License, Version 2.0
 
-FROM node:16-alpine
+FROM node:17-alpine
 
 ARG LOCAL_USER_ID
 ARG LOCAL_GROUP_ID

bin/purpleteamCucumber renamed to bin/purpleteamCucumber.js

@@ -3,5 +3,6 @@
 // Following code taken from https://github.com/cucumber/cucumber-js/blob/cfc9b4a1db5b97d95350ce41144ae69084096adc/bin/cucumber-js
 //   then modified
 
-require('app-module-path/cwd');
-require('../src/scripts/runCuc').default();
+import runCuc from '../src/scripts/runCuc.js';
+
+runCuc();

config/config.js

@@ -7,9 +7,10 @@
 // the Business Source License, use of this software will be governed
 // by the Apache License, Version 2.0
 
-const convict = require('convict');
-const { duration } = require('convict-format-with-moment');
-const path = require('path');
+import convict from 'convict';
+import { duration } from 'convict-format-with-moment';
+import { fileURLToPath } from 'url';
+import path, { dirname } from 'path';
 
 convict.addFormat(duration);
 
@@ -69,8 +70,7 @@ const schema = {
       doc: 'The options used for creating the redis client.',
       format: (val) => typeof val === 'object',
       default: {
-        port: 6379,
-        host: 'redis'
+        socket: { host: 'redis', port: 6379 }
         // "host": "172.17.0.2" // host networking or not running in container
       }
     }
@@ -121,7 +121,7 @@ const schema = {
       doc: 'The location of the Cucumber binary.',
       format: String,
       // default: `${process.cwd()}/node_modules/.bin/cucumber-js`
-      default: `${process.cwd()}/bin/purpleteamCucumber`
+      default: path.join(process.cwd(), '/bin/purpleteamCucumber.js')
     },
     timeout: {
       doc: 'The value used to set the timeout (https://github.com/cucumber/cucumber-js/blob/master/docs/support_files/timeouts.md)',
@@ -139,7 +139,9 @@ const schema = {
 };
 
 const config = convict(schema);
-config.loadFile(path.join(__dirname, `config.${process.env.NODE_ENV}.json`));
+const filename = fileURLToPath(import.meta.url);
+const currentDirName = dirname(filename);
+config.loadFile(path.join(currentDirName, `config.${process.env.NODE_ENV}.json`));
 config.validate();
 
-module.exports = config;
+export default config;

healthcheck.js

@@ -7,9 +7,9 @@
 // the Business Source License, use of this software will be governed
 // by the Apache License, Version 2.0
 
-const http = require('http');
-require('convict');
-const config = require('./config/config');
+import http from 'http';
+import 'convict';
+import config from './config/config.js';
 
 const options = {
   host: config.get('host.host'),

index.js

@@ -7,8 +7,7 @@
 // the Business Source License, use of this software will be governed
 // by the Apache License, Version 2.0
 
-require('app-module-path/register');
-const server = require('src/server');
+import server from './src/server.js';
 
 const init = async () => {
   await server.registerPlugins();