[8.19] [ci] push script/eslint calls through run() to add timing data (#225306) (#226140)

# Backport

This will backport the following commits from `main` to `8.19`:
- [[ci] push script/eslint calls through run() to add timing data
(#225306)](#225306)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Alex
Szabo","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-07-02T10:24:57Z","message":"[ci]
push script/eslint calls through run() to add timing data
(#225306)\n\n## Summary\nThis PR adds a new script, `node scripts/node
scripts/eslint_all_files`\n- this would do the equivalent of `git
ls-files | grep -E\n'\\.(js|mjs|ts|tsx) BACKPORT--> | xargs -n 250 -P 8
node scripts/eslint\n--no-cache`, but wrapped in our dev-cli runner, so
the total run will be\nmeasured and reported.\n\nIt also adds the runner
wrapper around the previous eslint script -\nhowever, the calls from the
above script (eslint_all_files) would run\npreventing reporting so as
not to overload ci-stats.\n\n---------\n\nCo-authored-by: Copilot
<[email protected]>","sha":"2a97f913ba02c5a4c1086190b71b3d402a2cbf28","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Operations","release_note:skip","backport:all-open","v9.2.0"],"title":"[ci]
push script/eslint calls through run() to add timing
data","number":225306,"url":"https://github.com/elastic/kibana/pull/225306","mergeCommit":{"message":"[ci]
push script/eslint calls through run() to add timing data
(#225306)\n\n## Summary\nThis PR adds a new script, `node scripts/node
scripts/eslint_all_files`\n- this would do the equivalent of `git
ls-files | grep -E\n'\\.(js|mjs|ts|tsx) BACKPORT--> | xargs -n 250 -P 8
node scripts/eslint\n--no-cache`, but wrapped in our dev-cli runner, so
the total run will be\nmeasured and reported.\n\nIt also adds the runner
wrapper around the previous eslint script -\nhowever, the calls from the
above script (eslint_all_files) would run\npreventing reporting so as
not to overload ci-stats.\n\n---------\n\nCo-authored-by: Copilot
<[email protected]>","sha":"2a97f913ba02c5a4c1086190b71b3d402a2cbf28"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/225306","number":225306,"mergeCommit":{"message":"[ci]
push script/eslint calls through run() to add timing data
(#225306)\n\n## Summary\nThis PR adds a new script, `node scripts/node
scripts/eslint_all_files`\n- this would do the equivalent of `git
ls-files | grep -E\n'\\.(js|mjs|ts|tsx) BACKPORT--> | xargs -n 250 -P 8
node scripts/eslint\n--no-cache`, but wrapped in our dev-cli runner, so
the total run will be\nmeasured and reported.\n\nIt also adds the runner
wrapper around the previous eslint script -\nhowever, the calls from the
above script (eslint_all_files) would run\npreventing reporting so as
not to overload ci-stats.\n\n---------\n\nCo-authored-by: Copilot
<[email protected]>","sha":"2a97f913ba02c5a4c1086190b71b3d402a2cbf28"}}]}]
BACKPORT-->

Co-authored-by: Alex Szabo <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

.buildkite/scripts/steps/lint.sh

@@ -15,20 +15,17 @@ echo '--- Lint: eslint'
 # after possibly commiting fixed files to the repo
 set +e;
 if is_pr && ! is_auto_commit_disabled; then
-  git ls-files | grep -E '\.(js|mjs|ts|tsx)$' | xargs -n 250 -P 8 node scripts/eslint --no-cache --fix
+  desc="node scripts/eslint_all_files --no-cache --fix"
+  node scripts/eslint_all_files --no-cache --fix
 else
-  git ls-files | grep -E '\.(js|mjs|ts|tsx)$' | xargs -n 250 -P 8 node scripts/eslint --no-cache
+  desc="node scripts/eslint_all_files --no-cache"
+  node scripts/eslint_all_files --no-cache
 fi
 
 eslint_exit=$?
 # re-enable "Exit immediately" mode
 set -e;
 
-desc="node scripts/eslint --no-cache"
-if is_pr && ! is_auto_commit_disabled; then
-  desc="$desc --fix"
-fi
-
 check_for_changed_files "$desc" true
 
 if [[ "${eslint_exit}" != "0" ]]; then

scripts/eslint_all_files.js

@@ -0,0 +1,11 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+require('../src/setup_node_env');
+require('../src/dev/eslint/run_eslint_full');

src/dev/eslint/run_eslint_full.ts

@@ -0,0 +1,158 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { run } from '@kbn/dev-cli-runner';
+import { REPO_ROOT } from '@kbn/repo-info';
+import { ToolingLog } from '@kbn/tooling-log';
+import execa from 'execa';
+
+const batchSize = 250;
+const maxParallelism = 8;
+
+run(
+  async ({ log, flags }) => {
+    const bail = !!(flags.bail || false);
+
+    const { batches, files } = getLintableFileBatches();
+    log.info(`Found ${files.length} files in ${batches.length} batches to lint.`);
+
+    const eslintArgs =
+      // Unexpected will contain anything meant for ESLint directly, like `--fix`
+      flags.unexpected
+        // ESLint has no cache by default
+        .concat([flags.cache ? '--cache' : '--no-cache']);
+    log.info(
+      `Running ESLint with args: ${pretty({
+        args: eslintArgs,
+        batchSize,
+        maxParallelism,
+      })}`
+    );
+
+    const lintPromiseThunks = batches.map(
+      (batch, idx) => () =>
+        lintFileBatch({ batch, idx, eslintArgs, batchCount: batches.length, bail, log })
+    );
+    const results = await runBatchedPromises(lintPromiseThunks, maxParallelism);
+
+    const failedBatches = results.filter((result) => !result.success);
+    if (failedBatches.length > 0) {
+      log.error(`Linting errors found ❌`);
+      process.exit(1);
+    } else {
+      log.info('Linting successful ✅');
+    }
+  },
+  {
+    description: 'Run ESLint on all JavaScript/TypeScript files in the repository',
+    flags: {
+      boolean: ['bail', 'cache'],
+      default: {
+        bail: false,
+        cache: true, // Enable caching by default
+      },
+      allowUnexpected: true,
+      help: `
+        --bail            Stop on the first linting error
+        --no-cache        Disable ESLint caching
+      `,
+    },
+  }
+);
+
+function getLintableFileBatches() {
+  const files = execa
+    .sync('git', ['ls-files'], {
+      cwd: REPO_ROOT,
+      encoding: 'utf8',
+    })
+    .stdout.trim()
+    .split('\n')
+    .filter((file) => file.match(/\.(js|mjs|ts|tsx)$/));
+  const batches = [];
+  for (let i = 0; i < files.length; i += batchSize) {
+    batches.push(files.slice(i, i + batchSize));
+  }
+  return { batches, files };
+}
+
+async function lintFileBatch({
+  batch,
+  bail,
+  idx,
+  eslintArgs,
+  batchCount,
+  log,
+}: {
+  batch: string[];
+  bail: boolean;
+  idx: number;
+  eslintArgs: string[];
+  batchCount: number;
+  log: ToolingLog;
+}) {
+  log.info(`Running batch ${idx + 1}/${batchCount} with ${batch.length} files...`);
+
+  const timeBefore = Date.now();
+  const args = ['scripts/eslint'].concat(eslintArgs).concat(batch);
+  const { stdout, stderr, exitCode } = await execa('node', args, {
+    cwd: REPO_ROOT,
+    env: {
+      // Disable CI stats for individual runs, to avoid overloading ci-stats
+      CI_STATS_DISABLED: 'true',
+    },
+    reject: bail, // Don't throw on non-zero exit code
+  });
+
+  const time = Date.now() - timeBefore;
+  if (exitCode !== 0) {
+    const errorMessage = stderr?.toString() || stdout?.toString();
+    log.error(`Batch ${idx + 1}/${batchCount} failed (${time}ms) ❌: ${errorMessage}`);
+    return {
+      success: false,
+      idx,
+      time,
+      error: errorMessage,
+    };
+  } else {
+    log.info(`Batch ${idx + 1}/${batchCount} success (${time}ms) ✅: ${stdout.toString()}`);
+    return {
+      success: true,
+      idx,
+      time,
+    };
+  }
+}
+
+function runBatchedPromises<T>(
+  promiseCreators: Array<() => Promise<T>>,
+  maxParallel: number
+): Promise<T[]> {
+  const results: T[] = [];
+  let i = 0;
+
+  const next: () => Promise<any> = () => {
+    if (i >= promiseCreators.length) {
+      return Promise.resolve();
+    }
+
+    const promiseCreator = promiseCreators[i++];
+    return Promise.resolve(promiseCreator()).then((result) => {
+      results.push(result);
+      return next();
+    });
+  };
+
+  const tasks = Array.from({ length: maxParallel }, () => next());
+  return Promise.all(tasks).then(() => results);
+}
+
+function pretty(obj: any) {
+  return JSON.stringify(obj, null, 2);
+}

src/dev/run_eslint.js

@@ -7,39 +7,55 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import yargs from 'yargs';
+import { run } from '@kbn/dev-cli-runner';
 
 import { eslintBinPath } from './eslint';
 
-let quiet = true;
-if (process.argv.includes('--no-quiet')) {
-  quiet = false;
-} else {
-  process.argv.push('--quiet');
-}
-
-const options = yargs(process.argv).argv;
 process.env.KIBANA_RESOLVER_HARD_CACHE = 'true';
 
-if (!options._.length && !options.printConfig) {
-  process.argv.push('.');
-}
-
-if (!process.argv.includes('--no-cache')) {
-  process.argv.push('--cache');
-}
-
-if (!process.argv.includes('--ext')) {
-  process.argv.push('--ext', '.js,.mjs,.ts,.tsx');
-}
-
-// common-js is required so that logic before this executes before loading eslint
-require(eslintBinPath); // eslint-disable-line import/no-dynamic-require
-
-if (quiet) {
-  process.on('exit', (code) => {
-    if (!code) {
-      console.log('✅ no eslint errors found');
+if (process.argv.includes('--help') || process.argv.includes('-h')) {
+  console.log(
+    "This is a wrapper around ESLint's CLI that sets some defaults - see Eslint's help for flags:"
+  );
+  require(eslintBinPath); // eslint-disable-line import/no-dynamic-require
+} else {
+  run(
+    ({ flags }) => {
+      flags._ = flags._ || [];
+
+      // verbose is only a flag for our CLI runner, not for ESLint
+      if (process.argv.includes('--verbose')) {
+        process.argv.splice(process.argv.indexOf('--verbose'), 1);
+      } else {
+        process.argv.push('--quiet');
+      }
+
+      if (flags.cache) {
+        process.argv.push('--cache');
+      }
+
+      if (!flags._.ext) {
+        process.argv.push('--ext', '.js,.mjs,.ts,.tsx');
+      }
+
+      // common-js is required so that logic before this executes before loading eslint
+      // requiring the module is still going to pass along all flags
+      require(eslintBinPath); // eslint-disable-line import/no-dynamic-require
+
+      process.on('exit', (code) => {
+        if (!code) {
+          console.log('✅ no eslint errors found');
+        }
+      });
+    },
+    {
+      description: 'Run ESLint on all JavaScript/TypeScript files in the repository',
+      usage: 'node scripts/eslint.js [options] [<file>...]',
+      flags: {
+        allowUnexpected: true,
+        boolean: ['cache', 'fix', 'quiet'],
+        string: ['ext'],
+      },
     }
-  });
+  );
 }