Skip to content

Commit

Permalink
Improve helper-fixtures (#15890)
Browse files Browse the repository at this point in the history 
* remove unused traceur checks

* ignore test suites for different major versions

* reduce test loading IO

* reduce readFile IO

* reduce source map loading IO

* improve

* fix tests

* add check

---------

Co-authored-by: liuxingbaoyu <30521560+liuxingbaoyu@users.noreply.github.com>
  • Loading branch information
@JLHwung @liuxingbaoyu
JLHwung and liuxingbaoyu committed Aug 28, 2023
1 parent 85ae11e commit 9de5c44
Show file tree
Hide file tree
Showing 7 changed files with 129 additions and 101 deletions.
1 change: 1 addition & 0 deletions packages/babel-helper-fixtures/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"semver": "condition:BABEL_8_BREAKING ? ^7.3.4 : ^6.3.1"
},
"devDependencies": {
"@jridgewell/gen-mapping": "^0.3.3",
"@types/semver": "^7.3.4"
},
"engines": {
Expand Down
220 changes: 123 additions & 97 deletions packages/babel-helper-fixtures/src/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,21 +96,22 @@ function shouldIgnore(name: string, ignore?: Array<string>) {
const EXTENSIONS = [".js", ".mjs", ".ts", ".tsx", ".cts", ".mts", ".vue"];
const JSON_AND_EXTENSIONS = [".json", ...EXTENSIONS];

function findFile(filepath: string, allowJSON?: boolean) {
const matches = [];
function checkFile(
loc: string,
allowJSON: boolean,
matchedLoc: string | undefined,
) {
const ext = path.extname(loc);
const extensions = allowJSON ? JSON_AND_EXTENSIONS : EXTENSIONS;

for (const ext of extensions) {
const name = filepath + ext;

if (fs.existsSync(name)) matches.push(name);
if (!extensions.includes(ext)) {
throw new Error(`Unsupported input extension: ${loc}`);
}

if (matches.length > 1) {
throw new Error(`Found conflicting file matches: ${matches.join(", ")}`);
if (!matchedLoc) {
return loc;
} else {
throw new Error(`Found conflicting file matches: ${matchedLoc},${loc}`);
}

return matches[0];
}

function pushTask(
Expand All @@ -120,86 +121,128 @@ function pushTask(
suiteName: string,
) {
const taskDirStats = fs.statSync(taskDir);
let actualLoc = findFile(taskDir + "/input");
let execLoc = findFile(taskDir + "/exec");
let actualLoc,
expectLoc,
execLoc,
execLocAlias,
taskOptsLoc,
stdoutLoc,
stderrLoc,
sourceMapLoc,
inputSourceMap;

// If neither input nor exec is present it is not a real testcase
if (taskDirStats.isDirectory() && !actualLoc && !execLoc) {
if (fs.readdirSync(taskDir).length > 0) {
const taskOpts: TaskOptions = JSON.parse(JSON.stringify(suite.options));
if (taskDirStats.isDirectory()) {
const files = fs.readdirSync(taskDir);
for (const file of files) {
const loc = path.join(taskDir, file);
const name = path.basename(file, path.extname(file));

switch (name) {
case "input":
actualLoc = checkFile(loc, false, actualLoc);
break;
case "exec":
execLoc = checkFile(loc, false, execLoc);
break;
case "output":
expectLoc = checkFile(loc, true, expectLoc);
break;
case "output.extended":
expectLoc = checkFile(loc, true, expectLoc);
break;
case "options":
taskOptsLoc = loc;
Object.assign(taskOpts, require(taskOptsLoc));
break;
case "source-map": {
sourceMapLoc = loc;
break;
}
case "input-source-map":
inputSourceMap = JSON.parse(readFile(loc));
break;
}
}
// If neither input nor exec is present it is not a real testcase
if (files.length > 0 && !actualLoc && !execLoc) {
console.warn(`Skipped test folder with invalid layout: ${taskDir}`);
return;
}
return;
} else if (!actualLoc) {
actualLoc = taskDir + "/input.js";
} else if (!execLoc) {
execLoc = taskDir + "/exec.js";
}
actualLoc ??= taskDir + "/input.js";
execLoc ??= taskDir + "/exec.js";
expectLoc ??= taskDir + "/output.js";

const expectLoc =
findFile(taskDir + "/output", true /* allowJSON */) ||
findFile(`${taskDir}/output.extended`, true) ||
taskDir + "/output.js";
const stdoutLoc = taskDir + "/stdout.txt";
const stderrLoc = taskDir + "/stderr.txt";

const actualLocAlias =
suiteName + "/" + taskName + "/" + path.basename(actualLoc);
const expectLocAlias =
suiteName + "/" + taskName + "/" + path.basename(actualLoc);
let execLocAlias =
suiteName + "/" + taskName + "/" + path.basename(actualLoc);

if (taskDirStats.isFile()) {
stdoutLoc = taskDir + "/stdout.txt";
stderrLoc = taskDir + "/stderr.txt";
} else if (taskDirStats.isFile()) {
const ext = path.extname(taskDir);
if (EXTENSIONS.indexOf(ext) === -1) return;

execLoc = taskDir;
execLocAlias = suiteName + "/" + taskName;
} else {
console.warn(`Skipped test folder with invalid layout: ${taskDir}`);
return;
}

const taskOpts: TaskOptions = JSON.parse(JSON.stringify(suite.options));
const shouldIgnore = process.env.BABEL_8_BREAKING
? taskOpts.BABEL_8_BREAKING === false
: taskOpts.BABEL_8_BREAKING === true;

if (shouldIgnore) return;

function buildTestFile(
loc: string | undefined,
fileName?: true | string,
): TestFile {
return {
loc,
code: readFile(loc),
filename: !loc
? undefined
: fileName === true
? suiteName + "/" + taskName + "/" + path.basename(loc)
: fileName || undefined,
};
}

const taskOptsLoc = tryResolve(taskDir + "/options");
if (taskOptsLoc) Object.assign(taskOpts, require(taskOptsLoc));
const sourceMapFile = buildTestFile(sourceMapLoc, true);
// TODO: code should not be a object
sourceMapFile.code &&= JSON.parse(sourceMapFile.code);

const test: Test = {
taskDir,
optionsDir: taskOptsLoc ? path.dirname(taskOptsLoc) : null,
title: humanize(taskName, true),
disabled:
taskName[0] === "." ||
(process.env.BABEL_8_BREAKING
? taskOpts.BABEL_8_BREAKING === false
: taskOpts.BABEL_8_BREAKING === true),
disabled: taskName[0] === ".",
options: taskOpts,
doNotSetSourceType: taskOpts.DO_NOT_SET_SOURCE_TYPE,
externalHelpers:
taskOpts.externalHelpers ??
!!tryResolve("@babel/plugin-external-helpers"),
validateLogs: taskOpts.validateLogs,
ignoreOutput: taskOpts.ignoreOutput,
stdout: { loc: stdoutLoc, code: readFile(stdoutLoc) },
stderr: { loc: stderrLoc, code: readFile(stderrLoc) },
exec: {
loc: execLoc,
code: readFile(execLoc),
filename: execLocAlias,
},
actual: {
loc: actualLoc,
code: readFile(actualLoc),
filename: actualLocAlias,
},
expect: {
loc: expectLoc,
code: readFile(expectLoc),
filename: expectLocAlias,
},
sourceMap: undefined,
sourceMapFile: undefined,
inputSourceMap: undefined,
stdout: buildTestFile(stdoutLoc),
stderr: buildTestFile(stderrLoc),
exec: buildTestFile(execLoc, execLocAlias),
actual: buildTestFile(actualLoc, true),
expect: buildTestFile(expectLoc, true),
sourceMap: sourceMapFile.code,
sourceMapFile,
inputSourceMap,
};

if (
test.exec.code &&
test.actual.code &&
path.extname(execLoc) !== path.extname(actualLoc)
) {
throw new Error(
`Input file extension should match exec file extension: ${execLoc}, ${actualLoc}`,
);
}

delete taskOpts.BABEL_8_BREAKING;
delete taskOpts.DO_NOT_SET_SOURCE_TYPE;

Expand Down Expand Up @@ -241,29 +284,8 @@ function pushTask(
delete taskOpts.os;
}

// traceur checks

if (test.exec.code.indexOf("// Async.") >= 0) {
return;
}

suite.tests.push(test);

const sourceMapLoc = taskDir + "/source-map.json";
if (fs.existsSync(sourceMapLoc)) {
test.sourceMap = JSON.parse(readFile(sourceMapLoc));
}
test.sourceMapFile = {
loc: sourceMapLoc,
code: test.sourceMap,
filename: "",
};

const inputMapLoc = taskDir + "/input-source-map.json";
if (fs.existsSync(inputMapLoc)) {
test.inputSourceMap = JSON.parse(readFile(inputMapLoc));
}

if (taskOpts.throws) {
if (test.expect.code) {
throw new Error(
Expand Down Expand Up @@ -396,8 +418,8 @@ export function resolveOptionPluginOrPreset(
return options;
}

export default function get(entryLoc: string): Array<Suite> {
const suites = [];
export default function get(entryLoc: string) {
const suites: Suite[] = [];

let rootOpts: TaskOptions = {};
const rootOptsLoc = tryResolve(entryLoc + "/options");
Expand All @@ -406,9 +428,9 @@ export default function get(entryLoc: string): Array<Suite> {
for (const suiteName of fs.readdirSync(entryLoc)) {
if (shouldIgnore(suiteName)) continue;

const suite = {
const suite: Suite = {
options: { ...rootOpts },
tests: [] as Test[],
tests: [],
title: humanize(suiteName),
filename: entryLoc + "/" + suiteName,
};
Expand Down Expand Up @@ -447,12 +469,16 @@ export function multiple(entryLoc: string, ignore?: Array<string>) {
return categories;
}

export function readFile(filename: string) {
if (fs.existsSync(filename)) {
let file = fs.readFileSync(filename, "utf8").trimRight();
file = file.replace(/\r\n/g, "\n");
return file;
} else {
return "";
export function readFile(filename: string | undefined) {
try {
if (filename === undefined) {
return "";
}
return fs.readFileSync(filename, "utf8").trimRight();
} catch (e) {
if (e.code === "ENOENT") {
return "";
}
throw e;
}
}
0 ...xtures/function-bind/complex-call/exec.js → ...tures/function-bind/complex-call/exec.mjs
View file
File renamed without changes.
0 ...es/misc/copy-getters-setters-star/exec.js → ...s/misc/copy-getters-setters-star/exec.mjs
View file
File renamed without changes.
0 ...ixtures/misc/copy-getters-setters/exec.js → ...xtures/misc/copy-getters-setters/exec.mjs
View file
File renamed without changes.
0 ...es/plugins-integration/issue-7527/exec.js → ...s/plugins-integration/issue-7527/exec.mjs
View file
File renamed without changes.
9 changes: 5 additions & 4 deletions yarn.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -769,6 +769,7 @@ __metadata:
version: 0.0.0-use.local
resolution: "@babel/helper-fixtures@workspace:packages/babel-helper-fixtures"
dependencies:
"@jridgewell/gen-mapping": ^0.3.3
"@types/semver": ^7.3.4
semver: "condition:BABEL_8_BREAKING ? ^7.3.4 : ^6.3.1"
languageName: unknown
Expand Down Expand Up @@ -4694,14 +4695,14 @@ __metadata:
languageName: node
linkType: hard

"@jridgewell/gen-mapping@npm:^0.3.0, @jridgewell/gen-mapping@npm:^0.3.2":
version: 0.3.2
resolution: "@jridgewell/gen-mapping@npm:0.3.2"
"@jridgewell/gen-mapping@npm:^0.3.0, @jridgewell/gen-mapping@npm:^0.3.2, @jridgewell/gen-mapping@npm:^0.3.3":
version: 0.3.3
resolution: "@jridgewell/gen-mapping@npm:0.3.3"
dependencies:
"@jridgewell/set-array": ^1.0.1
"@jridgewell/sourcemap-codec": ^1.4.10
"@jridgewell/trace-mapping": ^0.3.9
checksum: 1832707a1c476afebe4d0fbbd4b9434fdb51a4c3e009ab1e9938648e21b7a97049fa6009393bdf05cab7504108413441df26d8a3c12193996e65493a4efb6882
checksum: 4a74944bd31f22354fc01c3da32e83c19e519e3bbadafa114f6da4522ea77dd0c2842607e923a591d60a76699d819a2fbb6f3552e277efdb9b58b081390b60ab
languageName: node
linkType: hard

Expand Down

0 comments on commit 9de5c44

Please sign in to comment.