Refactor: Move check_require_cache code to helpers folder (#5416)

The root of the `datadog-instrumentations` package is reserved for
module instrumentation code. The `check_require_cache.js` file is a
helper file and should be in a sub-directory.

This commit also consolidates the `helpers` and `utils` folders as they
served the same purpose.

Author: watson

.github/workflows/instrumentations.yml

@@ -45,14 +45,6 @@ jobs:
   # instrumentations directory, so they need to be run somewhere. This seems to
   # be a reasonable place to run them for now.
 
-  check_require_cache:
-    runs-on: ubuntu-latest
-    env:
-      PLUGINS: check_require_cache
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - uses: ./.github/actions/plugins/test
-
   express-session:
     runs-on: ubuntu-latest
     env:

packages/datadog-esbuild/index.js

@@ -4,7 +4,9 @@
 
 const instrumentations = require('../datadog-instrumentations/src/helpers/instrumentations.js')
 const hooks = require('../datadog-instrumentations/src/helpers/hooks.js')
-const extractPackageAndModulePath = require('../datadog-instrumentations/src/utils/src/extract-package-and-module-path')
+const extractPackageAndModulePath = require(
+  '../datadog-instrumentations/src/helpers/extract-package-and-module-path.js'
+)
 
 for (const hook of Object.values(hooks)) {
   if (typeof hook === 'object') {

…trumentations/src/check_require_cache.js …tions/src/helpers/check-require-cache.jspackages/datadog-instrumentations/src/check_require_cache.js renamed to packages/datadog-instrumentations/src/helpers/check-require-cache.js packages/datadog-instrumentations/src/check_require_cache.js renamed to packages/datadog-instrumentations/src/helpers/check-require-cache.js

@@ -26,7 +26,7 @@ const potentialConflicts = new Set([
   'sqreen'
 ])
 
-const extractPackageAndModulePath = require('./utils/src/extract-package-and-module-path')
+const extractPackageAndModulePath = require('./extract-package-and-module-path')
 
 /**
  * The lowest hanging fruit to debug an app that isn't tracing
@@ -45,7 +45,7 @@ const extractPackageAndModulePath = require('./utils/src/extract-package-and-mod
  * This is OK as the tracer should be loaded earlier anyway.
  */
 module.exports.checkForRequiredModules = function () {
-  const packages = require('../../datadog-instrumentations/src/helpers/hooks')
+  const packages = require('./hooks')
   const naughties = new Set()
   let didWarn = false
 

…s/src/extract-package-and-module-path.js …lpers/extract-package-and-module-path.jspackages/datadog-instrumentations/src/utils/src/extract-package-and-module-path.js renamed to packages/datadog-instrumentations/src/helpers/extract-package-and-module-path.js packages/datadog-instrumentations/src/utils/src/extract-package-and-module-path.js renamed to packages/datadog-instrumentations/src/helpers/extract-package-and-module-path.js

@@ -6,7 +6,7 @@ const satisfies = require('semifies')
 const Hook = require('./hook')
 const requirePackageJson = require('../../../dd-trace/src/require-package-json')
 const log = require('../../../dd-trace/src/log')
-const checkRequireCache = require('../check_require_cache')
+const checkRequireCache = require('./check-require-cache')
 const telemetry = require('../../../dd-trace/src/guardrails/telemetry')
 const { isInServerlessEnvironment } = require('../../../dd-trace/src/serverless')
 

packages/datadog-instrumentations/src/helpers/register.js

@@ -2,7 +2,7 @@
 
 const { exec } = require('node:child_process')
 
-describe('check_require_cache', () => {
+describe('check-require-cache', () => {
   const opts = {
     cwd: __dirname,
     env: {
@@ -11,7 +11,7 @@ describe('check_require_cache', () => {
   }
 
   it('should be no warnings when tracer is loaded first', (done) => {
-    exec(`${process.execPath} ./check_require_cache/good-order.js`, opts, (error, stdout, stderr) => {
+    exec(`${process.execPath} ./check-require-cache/good-order.js`, opts, (error, stdout, stderr) => {
       expect(error).to.be.null
       expect(stderr).to.not.include("Package 'express' was loaded")
       done()
@@ -21,7 +21,7 @@ describe('check_require_cache', () => {
   // stderr is empty on Windows
   if (process.platform !== 'windows') {
     it('should find warnings when tracer loaded late', (done) => {
-      exec(`${process.execPath} ./check_require_cache/bad-order.js`, opts, (error, stdout, stderr) => {
+      exec(`${process.execPath} ./check-require-cache/bad-order.js`, opts, (error, stdout, stderr) => {
         expect(error).to.be.null
         expect(stderr).to.include("Package 'express' was loaded")
         done()

…tations/test/check_require_cache.spec.js …test/helpers/check-require-cache.spec.jspackages/datadog-instrumentations/test/check_require_cache.spec.js renamed to packages/datadog-instrumentations/test/helpers/check-require-cache.spec.js packages/datadog-instrumentations/test/check_require_cache.spec.js renamed to packages/datadog-instrumentations/test/helpers/check-require-cache.spec.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 require('express') // package required before tracer
-const tracer = require('../../../../')
+const tracer = require('../../../../../')
 tracer.init()
 
 process.exit()

…ns/test/check_require_cache/bad-order.js …helpers/check-require-cache/bad-order.jspackages/datadog-instrumentations/test/check_require_cache/bad-order.js renamed to packages/datadog-instrumentations/test/helpers/check-require-cache/bad-order.js packages/datadog-instrumentations/test/check_require_cache/bad-order.js renamed to packages/datadog-instrumentations/test/helpers/check-require-cache/bad-order.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-const tracer = require('../../../../')
+const tracer = require('../../../../../')
 require('express') // package required after tracer
 tracer.init()
 

…s/test/check_require_cache/good-order.js …elpers/check-require-cache/good-order.jspackages/datadog-instrumentations/test/check_require_cache/good-order.js renamed to packages/datadog-instrumentations/test/helpers/check-require-cache/good-order.js packages/datadog-instrumentations/test/check_require_cache/good-order.js renamed to packages/datadog-instrumentations/test/helpers/check-require-cache/good-order.js

@@ -7,7 +7,7 @@ const { isError } = require('./util')
 const { setStartupLogConfig } = require('./startup-log')
 const { ERROR_MESSAGE, ERROR_TYPE, ERROR_STACK } = require('../../dd-trace/src/constants')
 const { DataStreamsCheckpointer, DataStreamsManager, DataStreamsProcessor } = require('./datastreams')
-const { flushStartupLogs } = require('../../datadog-instrumentations/src/check_require_cache')
+const { flushStartupLogs } = require('../../datadog-instrumentations/src/helpers/check-require-cache')
 const log = require('./log/writer')
 
 const SPAN_TYPE = tags.SPAN_TYPE