Skip to content

Switch profiler-edit from minimist to commander #6065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mstange merged 1 commit into from
May 28, 2026
+82 −58
Merged

Switch profiler-edit from minimist to commander #6065

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@
"long": "^5.3.2",
"memoize-immutable": "^3.0.0",
"memoize-one": "^6.0.0",
"minimist": "^1.2.8",
"mixedtuplemap": "^1.0.0",
"namedtuplemap": "^1.0.0",
"photon-colors": "^3.3.2",
Expand Down Expand Up @@ -126,7 +125,6 @@
"@types/clamp": "^1.0.3",
"@types/common-tags": "^1.8.4",
"@types/jest": "^30.0.0",
"@types/minimist": "^1.2.5",
"@types/node": "^22.19.19",
"@types/query-string": "^6.3.0",
"@types/react": "^18.3.29",
Expand Down
134 changes: 80 additions & 54 deletions src/node-tools/profiler-edit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
import fs from 'fs';
import minimist from 'minimist';
import { Command, CommanderError, Option } from 'commander';

import { unserializeProfileOfArbitraryFormat } from 'firefox-profiler/profile-logic/process-profile';
import { computeCompactedProfile } from 'firefox-profiler/profile-logic/profile-compacting';
Expand Down Expand Up @@ -197,28 +197,73 @@ export async function run(options: CliOptions) {
console.log('Finished.');
}

function collectWasm(
value: string,
previous: WasmSymbolicationCliSpec[]
): WasmSymbolicationCliSpec[] {
// Accept "<url>=<path>" if the LHS looks like a URL, otherwise treat the
// whole string as a path and infer the URL from the profile. Split on
// the last `=` so URLs containing `=` (e.g. in query strings) survive
// intact; this assumes file paths don't contain `=`.
const eqIndex = value.lastIndexOf('=');
if (eqIndex !== -1 && /^[a-z]+:\/\//i.test(value.slice(0, eqIndex))) {
return [
...previous,
{
strippedWasmUrl: value.slice(0, eqIndex),
unstrippedWasmPath: value.slice(eqIndex + 1),
},
];
}
return [...previous, { unstrippedWasmPath: value }];
}

export function makeOptionsFromArgv(processArgv: string[]): CliOptions {
const argv = minimist(processArgv.slice(2), {
alias: { i: 'input', o: 'output' },
});
const program = new Command();
program
.name('profiler-edit')
.description('Edit and transform Firefox performance profiles')
.exitOverride()
.option(
'-i, --input <fileOrUrl>',
'Input profile (file path or http(s) URL)'
)
.option('-o, --output <path>', 'Output path (.json or .json.gz)')
.option('--from-file <path>', 'Load input from a file')
.option('--from-url <url>', 'Load input from a URL')
.option('--from-hash <hash>', 'Load input from a profile hash')
.option(
'--symbolicate-with-server <url>',
'Symbolicate frames using this symbol server URL'
)
.addOption(
new Option(
'--symbolicate-wasm <spec>',
'Apply wasm symbol info, as <url>=<path> or just <path>'
)
.argParser(collectWasm)
.default([] as WasmSymbolicationCliSpec[])
);

const sources: ProfileSource[] = [];
program.parse(processArgv);
const opts = program.opts();

if (typeof argv.input === 'string' && argv.input !== '') {
if (/^https?:\/\//i.test(argv.input)) {
sources.push({ type: 'URL', url: argv.input });
const sources: ProfileSource[] = [];
if (typeof opts.input === 'string' && opts.input !== '') {
if (/^https?:\/\//i.test(opts.input)) {
sources.push({ type: 'URL', url: opts.input });
} else {
sources.push({ type: 'FILE', path: argv.input });
sources.push({ type: 'FILE', path: opts.input });
}
}
if (typeof argv['from-file'] === 'string' && argv['from-file'] !== '') {
sources.push({ type: 'FILE', path: argv['from-file'] });
if (typeof opts.fromFile === 'string' && opts.fromFile !== '') {
sources.push({ type: 'FILE', path: opts.fromFile });
}
if (typeof argv['from-url'] === 'string' && argv['from-url'] !== '') {
sources.push({ type: 'URL', url: argv['from-url'] });
if (typeof opts.fromUrl === 'string' && opts.fromUrl !== '') {
sources.push({ type: 'URL', url: opts.fromUrl });
}
if (typeof argv['from-hash'] === 'string' && argv['from-hash'] !== '') {
sources.push({ type: 'HASH', hash: argv['from-hash'] });
if (typeof opts.fromHash === 'string' && opts.fromHash !== '') {
sources.push({ type: 'HASH', hash: opts.fromHash });
}

if (sources.length === 0) {
Expand All @@ -232,55 +277,36 @@ export function makeOptionsFromArgv(processArgv: string[]): CliOptions {
);
}

if (!(typeof argv.output === 'string' && argv.output !== '')) {
if (!(typeof opts.output === 'string' && opts.output !== '')) {
throw new Error('An output path must be supplied with --output / -o');
}

const symbolicateWasm: WasmSymbolicationCliSpec[] = [];
const rawWasmArg = argv['symbolicate-wasm'];
let wasmArgs: unknown[];
if (rawWasmArg === undefined) {
wasmArgs = [];
} else if (Array.isArray(rawWasmArg)) {
wasmArgs = rawWasmArg;
} else {
wasmArgs = [rawWasmArg];
}
for (const arg of wasmArgs) {
if (typeof arg !== 'string' || arg === '') {
throw new Error('--symbolicate-wasm requires a value');
}
// Accept "<url>=<path>" if the LHS looks like a URL, otherwise treat the
// whole string as a path and infer the URL from the profile. Split on
// the last `=` so URLs containing `=` (e.g. in query strings) survive
// intact; this assumes file paths don't contain `=`.
const eqIndex = arg.lastIndexOf('=');
if (eqIndex !== -1 && /^[a-z]+:\/\//i.test(arg.slice(0, eqIndex))) {
symbolicateWasm.push({
strippedWasmUrl: arg.slice(0, eqIndex),
unstrippedWasmPath: arg.slice(eqIndex + 1),
});
} else {
symbolicateWasm.push({ unstrippedWasmPath: arg });
}
}

return {
input: sources[0],
output: argv.output,
output: opts.output,
symbolicateWithServer:
typeof argv['symbolicate-with-server'] === 'string' &&
argv['symbolicate-with-server'] !== ''
? argv['symbolicate-with-server']
typeof opts.symbolicateWithServer === 'string' &&
opts.symbolicateWithServer !== ''
? opts.symbolicateWithServer
: undefined,
symbolicateWasm,
symbolicateWasm: opts.symbolicateWasm,
};
}

if (require.main === module) {
const options = makeOptionsFromArgv(process.argv);
run(options).catch((err) => {
console.error(err);
try {
const options = makeOptionsFromArgv(process.argv);
run(options).catch((err) => {
console.error(err);
process.exit(1);
});
} catch (err) {
if (err instanceof CommanderError) {
// Commander already wrote its own output and chose the
// appropriate exit code.
process.exit(err.exitCode);
}
console.error(err instanceof Error ? err.message : String(err));
Copy link
Copy Markdown
Member

@canova canova May 28, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I think due to exitOverride() above, now the errors are being printed twice, one by commander and the second time here.

For example I tested this:

$ node node-tools-dist/profiler-edit.js --asdfsdf
error: unknown option '--asdfsdf'
error: unknown option '--asdfsdf'

Could we maybe add an early return like this?

  if (err instanceof CommanderError) {
      // Commander already wrote its own output and chose the
      // appropriate exit code.
      process.exit(err.exitCode);
    }

Copy link
Copy Markdown
Contributor Author

@mstange mstange May 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, good catch!

process.exit(1);
});
}
}
4 changes: 2 additions & 2 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2485,7 +2485,7 @@
dependencies:
"@types/unist" "*"

"@types/minimist@^1.2.0", "@types/minimist@^1.2.2", "@types/minimist@^1.2.5":
"@types/minimist@^1.2.0", "@types/minimist@^1.2.2":
version "1.2.5"
resolved "https://registry.yarnpkg.com/@types/minimist/-/minimist-1.2.5.tgz#ec10755e871497bcd83efe927e43ec46e8c0747e"
integrity sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==
Expand Down Expand Up @@ -8314,7 +8314,7 @@ minimist-options@4.1.0:
is-plain-obj "^1.1.0"
kind-of "^6.0.3"

minimist@^1.2.0, minimist@^1.2.6, minimist@^1.2.8:
minimist@^1.2.0, minimist@^1.2.6:
version "1.2.8"
resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c"
integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==
Expand Down
Loading