Skip to content

Improve naming for benchmark suite options #49014

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

Closed
rubennorte wants to merge 1 commit into from
Closed

Improve naming for benchmark suite options #49014

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
47 changes: 32 additions & 15 deletions packages/react-native-fantom/src/Benchmark.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ import {
} from 'tinybench';

type SuiteOptions = $ReadOnly<{
...Pick<
BenchOptions,
'iterations' | 'time' | 'warmup' | 'warmupIterations' | 'warmupTime',
>,
minIterations?: number,
minDuration?: number,
warmup?: boolean,
minWarmupDuration?: number,
minWarmupIterations?: number,
disableOptimizedBuildCheck?: boolean,
}>;

Expand All @@ -35,7 +36,7 @@ interface SuiteAPI {

export function suite(
suiteName: string,
suiteOptions?: ?SuiteOptions,
suiteOptions?: SuiteOptions = {},
): SuiteAPI {
const tasks: Array<{
name: string,
Expand All @@ -57,7 +58,7 @@ export function suite(
// logic in the benchmark doesn't break.
const isTestOnly = isRunningFromCI && verifyFns.length === 0;

const overriddenOptions: BenchOptions = isTestOnly
const benchOptions: BenchOptions = isTestOnly
? {
warmupIterations: 1,
warmupTime: 0,
Expand All @@ -66,15 +67,31 @@ export function suite(
}
: {};

const {disableOptimizedBuildCheck, ...benchOptions} = suiteOptions ?? {};
benchOptions.name = suiteName;
benchOptions.throws = true;
benchOptions.now = () => NativeCPUTime.getCPUTimeNanos() / 1000000;

const bench = new Bench({
...benchOptions,
...overriddenOptions,
name: suiteName,
throws: true,
now: () => NativeCPUTime.getCPUTimeNanos() / 1000000,
});
if (suiteOptions.minIterations != null) {
benchOptions.iterations = suiteOptions.minIterations;
}

if (suiteOptions.minDuration != null) {
benchOptions.time = suiteOptions.minDuration;
}

if (suiteOptions.warmup != null) {
benchOptions.warmup = suiteOptions.warmup;
}

if (suiteOptions.minWarmupDuration != null) {
benchOptions.warmupTime = suiteOptions.minWarmupDuration;
}

if (suiteOptions.minWarmupIterations != null) {
benchOptions.warmupIterations = suiteOptions.minWarmupIterations;
}

const bench = new Bench(benchOptions);

for (const task of tasks) {
bench.add(task.name, task.fn, task.options);
Expand All @@ -96,7 +113,7 @@ export function suite(
);
}

if (__DEV__ && disableOptimizedBuildCheck !== true) {
if (__DEV__ && suiteOptions.disableOptimizedBuildCheck !== true) {
throw new Error('Benchmarks should not be run in development mode');
}
});
Expand Down