👷 remove glob dependency in favor of native glob from node:fs (#3950)

Author: thomas-lebeau

LICENSE-3rdparty.csv

@@ -40,7 +40,6 @@ dev,eslint-plugin-jasmine,MIT,Copyright (c) 2021 Tom Vincent
 dev,eslint-plugin-jsdoc,BSD-3-Clause,Copyright (c) 2018, Gajus Kuizinas (http://gajus.com/)
 dev,eslint-plugin-unicorn,MIT,Copyright (c) Sindre Sorhus <[email protected]> (https://sindresorhus.com)
 dev,express,MIT,Copyright 2009-2014 TJ Holowaychuk 2013-2014 Roman Shtylman 2014-2015 Douglas Christopher Wilson
-dev,glob,ISC,Copyright (c) 2009-2022 Isaac Z. Schlueter and Contributors
 dev,globals,MIT,Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com)
 dev,html-webpack-plugin,MIT,Copyright JS Foundation and other contributors
 dev,jasmine-core,MIT,Copyright 2008-2017 Pivotal Labs

eslint.config.mjs

@@ -360,6 +360,7 @@ export default tseslint.config(
     ignores: [SPEC_FILES],
     rules: {
       'local-rules/enforce-monitor-until-comment': 'error',
+      // @ts-expect-error - MONITOR_UNTIL_COMMENT_EXPIRED_LEVEL is either 'warn' or 'error'
       'local-rules/monitor-until-comment-expired': MONITOR_UNTIL_COMMENT_EXPIRED_LEVEL,
       'local-rules/disallow-side-effects': 'error',
       'local-rules/disallow-zone-js-patched-values': 'error',
@@ -429,6 +430,17 @@ export default tseslint.config(
     rules: {
       '@typescript-eslint/no-require-imports': 'off',
       'import/enforce-node-protocol-usage': ['error', 'always'],
+      'no-restricted-imports': [
+        'error',
+        {
+          paths: [
+            {
+              name: 'glob',
+              message: 'Use node:fs or node:fs/promises (fs.glob) instead.',
+            },
+          ],
+        },
+      ],
     },
   },
 

package.json

@@ -64,7 +64,6 @@
     "eslint-plugin-jsdoc": "61.1.5",
     "eslint-plugin-unicorn": "61.0.2",
     "express": "5.1.0",
-    "glob": "11.0.3",
     "globals": "16.4.0",
     "html-webpack-plugin": "5.6.4",
     "http-server": "14.1.1",

scripts/build/replace-build-env.ts

@@ -1,4 +1,5 @@
-import { globSync } from 'glob'
+import { globSync } from 'node:fs'
+import { resolve } from 'node:path'
 import { printLog, runMain } from '../lib/executionUtils.ts'
 import { modifyFile } from '../lib/filesUtils.ts'
 import { buildEnvKeys, getBuildEnvValue } from '../lib/buildEnv.ts'
@@ -12,8 +13,8 @@ import { buildEnvKeys, getBuildEnvValue } from '../lib/buildEnv.ts'
 runMain(async () => {
   const buildDirectory = process.argv[2]
 
-  for (const path of globSync('**/*.js', { cwd: buildDirectory, absolute: true })) {
-    if (await modifyFile(path, (content: string) => replaceBuildEnv(content))) {
+  for (const path of globSync('**/*.js', { cwd: buildDirectory })) {
+    if (await modifyFile(resolve(buildDirectory, path), (content: string) => replaceBuildEnv(content))) {
       printLog(`Replaced BuildEnv in ${path}`)
     }
   }

scripts/lib/computeBundleSize.ts

@@ -1,7 +1,6 @@
 import path from 'node:path'
 import fs from 'node:fs'
 import zlib from 'node:zlib'
-import { glob } from 'glob'
 
 const packages = ['rum', 'logs', 'flagging', 'rum-slim', 'worker'] as const
 
@@ -52,7 +51,7 @@ function getPackageSize(packageName: string): BundleSizes {
   const bundleSizes: BundleSizes = {}
   const packagePath = path.join(import.meta.dirname, `../../packages/${packageName}/bundle/`)
 
-  for (const file of glob.sync('**/*.js', { cwd: packagePath })) {
+  for (const file of fs.globSync('**/*.js', { cwd: packagePath })) {
     const name = getPackageName(file)
 
     if (!name) {

test/e2e/lib/helpers/validation.ts

@@ -1,15 +1,14 @@
 import fs from 'fs'
 import type { RumEvent } from '@datadog/browser-rum'
 import ajv from 'ajv'
-import { globSync } from 'glob'
 
 export function validateRumFormat(events: RumEvent[]) {
   const instance = new ajv({
     allErrors: true,
   })
-  const allJsonSchemas = globSync('./rum-events-format/schemas/**/*.json').map(
-    (path) => JSON.parse(fs.readFileSync(path, 'utf8')) as object
-  )
+  const allJsonSchemas = fs
+    .globSync('./rum-events-format/schemas/**/*.json')
+    .map((path) => JSON.parse(fs.readFileSync(path, 'utf8')) as object)
   instance.addSchema(allJsonSchemas)
 
   events.forEach((rumEvent) => {

yarn.lock

@@ -3895,7 +3895,6 @@ __metadata:
     eslint-plugin-jsdoc: "npm:61.1.5"
     eslint-plugin-unicorn: "npm:61.0.2"
     express: "npm:5.1.0"
-    glob: "npm:11.0.3"
     globals: "npm:16.4.0"
     html-webpack-plugin: "npm:5.6.4"
     http-server: "npm:14.1.1"
@@ -6950,22 +6949,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"glob@npm:11.0.3, glob@npm:^11.0.3":
-  version: 11.0.3
-  resolution: "glob@npm:11.0.3"
-  dependencies:
-    foreground-child: "npm:^3.3.1"
-    jackspeak: "npm:^4.1.1"
-    minimatch: "npm:^10.0.3"
-    minipass: "npm:^7.1.2"
-    package-json-from-dist: "npm:^1.0.0"
-    path-scurry: "npm:^2.0.0"
-  bin:
-    glob: dist/esm/bin.mjs
-  checksum: 10c0/7d24457549ec2903920dfa3d8e76850e7c02aa709122f0164b240c712f5455c0b457e6f2a1eee39344c6148e39895be8094ae8cfef7ccc3296ed30bce250c661
-  languageName: node
-  linkType: hard
-
 "glob@npm:^10.2.2":
   version: 10.4.5
   resolution: "glob@npm:10.4.5"
@@ -6982,6 +6965,22 @@ __metadata:
   languageName: node
   linkType: hard
 
+"glob@npm:^11.0.3":
+  version: 11.0.3
+  resolution: "glob@npm:11.0.3"
+  dependencies:
+    foreground-child: "npm:^3.3.1"
+    jackspeak: "npm:^4.1.1"
+    minimatch: "npm:^10.0.3"
+    minipass: "npm:^7.1.2"
+    package-json-from-dist: "npm:^1.0.0"
+    path-scurry: "npm:^2.0.0"
+  bin:
+    glob: dist/esm/bin.mjs
+  checksum: 10c0/7d24457549ec2903920dfa3d8e76850e7c02aa709122f0164b240c712f5455c0b457e6f2a1eee39344c6148e39895be8094ae8cfef7ccc3296ed30bce250c661
+  languageName: node
+  linkType: hard
+
 "glob@npm:^7.0.5, glob@npm:^7.1.3, glob@npm:^7.1.6, glob@npm:^7.1.7":
   version: 7.2.3
   resolution: "glob@npm:7.2.3"