style: move to Biome for linting (#3648)

Author: hassy

.eslintignore

@@ -47,6 +47,7 @@ jobs:
       - id: generate-matrix
         run: |
           RESULT=$(node .github/workflows/scripts/get-tests-in-package-location.js)
+          echo $RESULT
           echo "matrix=$RESULT" >> $GITHUB_OUTPUT
 
   run-tests:
@@ -99,7 +100,7 @@ jobs:
           echo "ECR_IMAGE_VERSION=${{ inputs.COMMIT_SHA }}" >> $GITHUB_ENV
           echo "LAMBDA_IMAGE_VERSION=${{ inputs.COMMIT_SHA }}" >> $GITHUB_ENV
       # runs the single test file from `package` workspace in the `file`, as defined in the matrix output
-      - run: npm run test:aws:ci --workspace ${{fromJson(needs.generate-test-matrix.outputs.matrix).namesToFiles[matrix.testName].package }} -- --files ${{ fromJson(needs.generate-test-matrix.outputs.matrix).namesToFiles[matrix.testName].file }}
+      - run: npm run test:aws:ci --workspace ${{fromJson(needs.generate-test-matrix.outputs.matrix).namesToFiles[matrix.testName].packageName }} -- --files ${{ fromJson(needs.generate-test-matrix.outputs.matrix).namesToFiles[matrix.testName].file }}
         env:
           FORCE_COLOR: 1
 

.eslintrc

@@ -1,4 +1,4 @@
-const fs = require('fs');
+const fs = require('node:fs');
 
 const packageNames = [];
 fs.readdirSync('packages').forEach((pkg) => {

.github/workflows/run-distributed-tests.yml

@@ -1,5 +1,5 @@
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 /**
  * This script is used to discover all the tests in different test directories that match a specific suffix
@@ -9,17 +9,17 @@ const path = require('path');
 const testLocations = [
   {
     location: 'test/cloud-e2e/fargate',
-    package: 'artillery',
+    packageName: 'artillery',
     suffix: '.test.js'
   },
   {
     location: 'test/cloud-e2e/lambda',
-    package: 'artillery',
+    packageName: 'artillery',
     suffix: '.test.js'
   },
   {
     location: 'test',
-    package: 'artillery-engine-playwright',
+    packageName: 'artillery-engine-playwright',
     suffix: '.aws.js'
   }
 ];
@@ -38,7 +38,7 @@ const addTest = (fileName, baseLocation, packageName, suffix) => {
   tests.names.push(jobName);
   tests.namesToFiles[jobName] = {
     file: `${baseLocation}/${fileName}`,
-    package: packageName
+    packageName: packageName
   };
 };
 
@@ -55,9 +55,9 @@ function scanDirectory(location, baseLocation, packageName, suffix) {
 }
 
 // Scan all the test locations
-for (const { package, location, suffix } of testLocations) {
-  const fullLocation = `packages/${package}/${location}`;
-  scanDirectory(fullLocation, location, package, suffix);
+for (const { packageName, location, suffix } of testLocations) {
+  const fullLocation = `packages/${packageName}/${location}`;
+  scanDirectory(fullLocation, location, packageName, suffix);
 }
 
 // Output the tests object as a JSON string to be used by Github Actions

.github/workflows/scripts/get-all-packages-by-name.js

@@ -1,19 +1,19 @@
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 const packagesDir = '../../../packages';
 const commitSha = process.env.COMMIT_SHA;
 
 const getNewVersion = (version) => {
-  if (!commitSha || commitSha == 'null') {
+  if (!commitSha || commitSha === 'null') {
     return version;
   }
 
   const shortSha = commitSha.slice(0, 7);
   return `${version}-${shortSha}`;
 };
 
-let versionMapping = {};
+const versionMapping = {};
 
 /**
  * This script iterates through every folder in ./packages and replaces their package.version with VERSION-COMMIT_SHA.
@@ -61,7 +61,7 @@ const updateDependencies = (pkg) => {
   } = pkg;
 
   for (const packageNameToReplace of Object.keys(versionMapping)) {
-    if (dependencies && dependencies[packageNameToReplace]) {
+    if (dependencies?.[packageNameToReplace]) {
       //replace the dependency we care about in this package with its corrected canary version
       dependencies[packageNameToReplace] =
         versionMapping[packageNameToReplace].content.version;

.github/workflows/scripts/get-tests-in-package-location.js

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.3.3/schema.json",
+  "formatter": {
+    "enabled": false
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "suspicious": {
+        "noThenProperty": "off",
+        "noExplicitAny": "off"
+      }
+    }
+  },
+  "files": {
+    "includes": [
+      "**",
+      "!**/packages/types",
+      "!**/packages/artillery-engine-playwright/test/**/*.ts",
+      "!**/examples/browser-playwright-reuse-typescript/**/*.ts",
+      "!**/node_modules",
+      "!**/dist",
+      "!**/build"
+    ]
+  }
+}

.github/workflows/scripts/replace-package-versions.js

@@ -29,8 +29,6 @@ class ExampleEngine {
     if (!opts.mandatoryString) {
       throw new Error('mandatoryString setting must be set');
     }
-
-    return this;
   }
 
   // For each scenario in the script using this engine, Artillery calls this function
@@ -71,7 +69,7 @@ class ExampleEngine {
 
     if (rs.log) {
       return function log(context, callback) {
-        return process.nextTick(function () {
+        return process.nextTick(() => {
           callback(null, context);
         });
       };
@@ -82,17 +80,15 @@ class ExampleEngine {
     }
 
     if (rs.function) {
-      return function (context, callback) {
-        let func = self.script.config.processor[rs.function];
+      return (context, callback) => {
+        const func = self.script.config.processor[rs.function];
         if (!func) {
-          return process.nextTick(function () {
+          return process.nextTick(() => {
             callback(null, context);
           });
         }
 
-        return func(context, ee, function () {
-          return callback(null, context);
-        });
+        return func(context, ee, () => callback(null, context));
       };
     }
 

biome.json

@@ -2,10 +2,8 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-'use strict';
-
 const { test } = require('tap');
-const EventEmitter = require('events');
+const EventEmitter = require('node:events');
 
 const ExampleEngine = require('..');
 
@@ -31,7 +29,7 @@ const script = {
   ]
 };
 
-test('Engine interface', async function (t) {
+test('Engine interface', async (t) => {
   const events = new EventEmitter();
   const engine = new ExampleEngine(script, events, {});
   const scenario = engine.createScenario(script.scenarios[0], events);

examples/artillery-engine-example/index.js

@@ -22,8 +22,6 @@ function ArtilleryHelloWorldPlugin(script, events) {
   const pluginConfig = script.config.plugins['hello-world'];
   this.greeting = pluginConfig.greeting || 'hello, world';
 
-  const self = this;
-
   // But we could also read anything else defined in the test
   // script, e.g.:
   debug('target is:', script.config.target);
@@ -35,16 +33,16 @@ function ArtilleryHelloWorldPlugin(script, events) {
   // Create processor object if needed to hold our custom function:
   script.config.processor = script.config.processor || {};
   // Add our custom function:
-  script.config.processor['pluginHelloWorldBeforeRequestHook'] = function (
-    req,
-    vuContext,
+  script.config.processor.pluginHelloWorldBeforeRequestHook = (
+    _req,
+    _vuContext,
     events,
     next
-  ) {
+  ) => {
     // This a beforeRequest handler function:
     // https://artillery.io/docs/guides/guides/http-reference.html#beforeRequest
 
-    console.log(self.greeting); // print greeting
+    console.log(this.greeting); // print greeting
     events.emit('counter', 'greeting_count', 1); // increase custom counter
     return next(); // the hook is done, go on to the next one (or let Artillery make the request)
   };
@@ -60,7 +58,7 @@ function ArtilleryHelloWorldPlugin(script, events) {
 // Artillery will call this before it exits to give plugins
 // a chance to clean up, e.g. by flushing any in-flight data,
 // writing something to disk etc.
-ArtilleryHelloWorldPlugin.prototype.cleanup = function (done) {
+ArtilleryHelloWorldPlugin.prototype.cleanup = (done) => {
   debug('cleaning up');
   done(null);
 };