Enable recommended rules for eslint-plugin-n (#5216)

Enables all recommended rules from the `eslint-plugin-n` ESLint plugin that can
reasonably be enabled without too much work. The following rules have been
disabled as they cause too many errors:

- `n/hashbang`
- `n/no-process-exit`
- `n/no-missing-require` (only disabled in benchmarks and tests)

All `eslint-plugin-n` rules are also disabled for `**/*.mjs` files as these for
some reason resulting in parsing errors.

Finally a select list of experimental Node.js APIs have been allowed in
`n/no-unsupported-features/node-builtins`, so that we can use them without
having to add ESLint comments all over the place:

- `Response`
- `async_hooks.createHook`
- `async_hooks.executionAsyncId`
- `async_hooks.executionAsyncResource`
- `fetch`
- `fs/promises.cp`

Author: watson

LICENSE-3rdparty.csv

@@ -68,6 +68,7 @@ dev,sinon,BSD-3-Clause,Copyright 2010-2017 Christian Johansen
 dev,sinon-chai,WTFPL and BSD-2-Clause,Copyright 2004 Sam Hocevar 2012–2017 Domenic Denicola
 dev,tap,ISC,Copyright 2011-2022 Isaac Z. Schlueter and Contributors
 dev,tiktoken,MIT,Copyright (c) 2022 OpenAI, Shantanu Jain
+dev,workerpool,Apache license 2.0,Copyright (C) 2014-2024 Jos de Jong wjosdejong@gmail.com
 dev,yaml,ISC,Copyright Eemeli Aro <eemeli@gmail.com>
 dev,yarn-deduplicate,Apache license 2.0,Copyright [yyyy] [name of copyright owner]
 file,aws-lambda-nodejs-runtime-interface-client,Apache 2.0,Copyright 2019 Amazon.com Inc. or its affiliates. All Rights Reserved.

esbuild.js

@@ -1,3 +1,5 @@
 'use strict'
 
+// TODO: It shouldn't be necessary to disable n/no-unpublished-require - Research
+// eslint-disable-next-line n/no-unpublished-require
 module.exports = require('./packages/datadog-esbuild/index.js')

eslint.config.mjs

@@ -286,6 +286,19 @@ export default [
       yoda: ['error', 'never']
     }
   },
+  {
+    ...eslintPluginN.configs['flat/recommended'],
+    ignores: [
+      'integration-tests/debugger/target-app/re-evaluation/index.js',
+      'integration-tests/debugger/target-app/re-evaluation/unique-filename.js',
+      'packages/dd-trace/test/appsec/next/app-dir/**/*.js',
+      'packages/dd-trace/test/appsec/next/pages-dir/**/*.js',
+      'packages/datadog-plugin-next/test/app/**/*.js',
+      'packages/datadog-plugin-next/test/**/pages/**/*.js',
+      'packages/datadog-plugin-next/test/middleware.js',
+      '**/*.mjs' // TODO: This shoudln't be required, research why it is
+    ]
+  },
   {
     name: 'dd-trace/defaults',
 
@@ -328,6 +341,18 @@ export default [
       }],
       'import/no-extraneous-dependencies': 'error',
       'n/no-restricted-require': ['error', ['diagnostics_channel']],
+      'n/hashbang': 'off', // TODO: Enable this rule once we have a plan to address it
+      'n/no-process-exit': 'off', // TODO: Enable this rule once we have a plan to address it
+      'n/no-unsupported-features/node-builtins': ['error', {
+        ignores: [
+          'Response',
+          'async_hooks.createHook',
+          'async_hooks.executionAsyncId',
+          'async_hooks.executionAsyncResource',
+          'fetch',
+          'fs/promises.cp'
+        ]
+      }],
       'no-console': 'error',
       'no-prototype-builtins': 'off', // Override (turned on by @eslint/js/recommended)
       'no-var': 'error',
@@ -421,6 +446,26 @@ export default [
     ...eslintPluginMocha.configs.flat.recommended,
     files: TEST_FILES
   },
+  {
+    name: 'dd-trace/benchmarks',
+    files: [
+      'benchmark/**/*'
+    ],
+    rules: {
+      'n/no-missing-require': 'off'
+    }
+  },
+  {
+    name: 'dd-trace/scripts',
+    files: [
+      'scripts/**/*'
+    ],
+    rules: {
+      'n/no-unsupported-features/node-builtins': ['error', {
+        allowExperimental: true
+      }]
+    }
+  },
   {
     name: 'dd-trace/tests/all',
     files: TEST_FILES,
@@ -447,6 +492,10 @@ export default [
       'mocha/no-skipped-tests': 'off',
       'mocha/no-top-level-hooks': 'off',
       'n/handle-callback-err': 'off',
+      'n/no-missing-require': 'off',
+      'n/no-unsupported-features/node-builtins': ['error', {
+        allowExperimental: true
+      }],
       'require-await': 'off'
     }
   },

index.js

@@ -1,3 +1,5 @@
 'use strict'
 
+// TODO: It shouldn't be necessary to disable n/no-unpublished-require - Research
+// eslint-disable-next-line n/no-unpublished-require
 module.exports = require('./packages/dd-trace')

init.js

@@ -2,6 +2,8 @@
 
 /* eslint-disable no-var */
 
+// TODO: It shouldn't be necessary to disable n/no-unpublished-require - Research
+// eslint-disable-next-line n/no-unpublished-require
 var guard = require('./packages/dd-trace/src/guardrails')
 
 module.exports = guard(function () {

initialize.mjs

@@ -10,6 +10,8 @@
   * hook will always be active for ESM support.
   */
 
+/* eslint n/no-unsupported-features/node-builtins: ['error', { ignores: ['module.register'] }] */
+
 import { isMainThread } from 'worker_threads'
 
 import * as Module from 'node:module'

integration-tests/appsec/esm-app/index.mjs

@@ -1,4 +1,5 @@
 'use strict'
+/* eslint n/no-unsupported-features/node-builtins: ['error', { ignores: ['module.register'] }] */
 
 import childProcess from 'node:child_process'
 import express from 'express'

integration-tests/ci-visibility/subproject/package.json

@@ -2,5 +2,8 @@
   "name": "subproject",
   "private": true,
   "version": "1.0.0",
-  "description": "app within repo"
+  "description": "app within repo",
+  "dependencies": {
+    "dd-trace": "file:../../.."
+  }
 }

integration-tests/ci-visibility/subproject/subproject-test.js

@@ -1,3 +1,5 @@
+// TODO: It shouldn't be necessary to disable n/no-extraneous-require - Research
+// eslint-disable-next-line n/no-extraneous-require
 const { expect } = require('chai')
 const dependency = require('./dependency')
 

integration-tests/esbuild/index.spec.js

@@ -7,6 +7,8 @@
 const chproc = require('child_process')
 const path = require('path')
 const fs = require('fs')
+// TODO: It shouldn't be necessary to disable n/no-extraneous-require - Research
+// eslint-disable-next-line n/no-extraneous-require
 const { assert } = require('chai')
 
 const TEST_DIR = path.join(__dirname, '.')