packages/utils/upgrade/src/modules/runner/json/transform.ts - develop - githubmirror/strapi

packages/utils/upgrade/src/modules/runner/json/transform.ts
98 строк3 KB
Jean-Sébastien Herbaux
[Upgrade Tool] Fix JSON Transform Loader (#20593)
21 июн 2024, 18:17
21 июн 2024, 18:17a9112aa
/* eslint-disable @typescript-eslint/no-var-requires */

import assert from 'node:assert';
import { isEqual } from 'lodash/fp';
import { register } from 'esbuild-register/dist/node';

import { createJSONTransformAPI, readJSON, saveJSON } from '../../json';

import type { Report } from '../../report';

import type { JSONRunnerConfiguration, JSONSourceFile, JSONTransformParams } from './types';

export const transformJSON = async (
  codemodPath: string,
  paths: string[],
  config: JSONRunnerConfiguration
): Promise<Report.Report> => {
  const { dry } = config;
  const startTime = process.hrtime();

  const report: Report.Report = {
    ok: 0,
    nochange: 0,
    skip: 0,
    error: 0,
    timeElapsed: '',
    stats: {},
  };

  /**
   * Why do we need to include node_modules (hookIgnoreNodeModules) and specify a matcher (hookMatcher) to esbuild?
   *
   * When using tools like npx or dlx, the execution context is different from when running the program in a local
   * project. npx and dlx run the commands in a temporary installation, which is isolated from local project files.
   *
   * When hookIgnoreNodeModules is not specified (or set to true), esbuild-register instructs
   * Pirates (https://github.com/danez/pirates) to not transpile any files that come from node_modules.
   *
   * Now, when using npx or dlx to run a script, its location can be seen as "external" because it's not part of
   * the temporary environment where npx or dlx execute. Therefore, it's considered to be part of node_modules.
   *
   * Due to this, if hookIgnoreNodeModules is set to true or left unspecified,
   * esbuild-register won't try to compile them upon require.
   *
   * hookMatcher is added to make sure we're not matching anything else than our codemod in external directories.
   */
  const esbuildOptions = {
    extensions: ['.js', '.mjs', '.ts'],
    hookIgnoreNodeModules: false,
    hookMatcher: isEqual(codemodPath),
  };
  const { unregister } = register(esbuildOptions);

  const module = require(codemodPath);

  unregister();

  const codemod = typeof module.default === 'function' ? module.default : module;

  assert(typeof codemod === 'function', `Codemod must be a function. Found ${typeof codemod}`);

  for (const path of paths) {
    try {
      const json = await readJSON(path);

      // Make sure the JSON value is a JSON object
      assert(typeof json === 'object' && !Array.isArray(json) && json !== null);

      // TODO: Optimize the API to limit parse/stringify operations
      const file: JSONSourceFile = { path, json };
      const params: JSONTransformParams = { cwd: config.cwd, json: createJSONTransformAPI };

      const out = await codemod(file, params);

      if (out === undefined) {
        report.error += 1;
      }
      // If the json object has modifications
      else if (!isEqual(json, out)) {
        if (!dry) {
          await saveJSON(path, out);
        }
        report.ok += 1;
      }
      // No changes
      else {
        report.nochange += 1;
      }
    } catch {
      report.error += 1;
    }
  }

  const endTime = process.hrtime(startTime);
  report.timeElapsed = (endTime[0] + endTime[1] / 1e9).toFixed(3);

  return report;
};