-
Notifications
You must be signed in to change notification settings - Fork 5
feat: rename instrumentation to simulation #68
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.
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
feat: rename instrumentation to simulation #68
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR renames the "instrumentation" mode to "simulation" throughout the codebase while maintaining backward compatibility. The environment variable CODSPEED_RUNNER_MODE now accepts both "instrumentation" (deprecated) and "simulation" (preferred), with both values mapping to the same "simulation" mode internally.
Key Changes:
- Core mode handling updated to accept both "instrumentation" and "simulation" values for backward compatibility
- File renames:
instrumented.ts→simulation.tsin both vitest-plugin and tinybench-plugin packages - Class and function renames:
InstrumentedRunner→SimulationRunner,runInstrumentedBench→runSimulationBench, etc.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
packages/core/src/index.ts |
Updated type definition and logic to map both "instrumentation" and "simulation" to "simulation" mode |
packages/core/src/introspection.ts |
Updated mode check from "instrumented" to "simulation" |
packages/vitest-plugin/src/simulation.ts |
Renamed file and all internal functions/classes from "Instrumented" to "Simulation" |
packages/vitest-plugin/src/runner.ts |
Updated import to use SimulationRunner from simulation module |
packages/vitest-plugin/src/index.ts |
Updated mode check to compare against "simulation" instead of "instrumented" |
packages/vitest-plugin/src/__tests__/instrumented.test.ts |
Updated import to use SimulationRunner from simulation module |
packages/vitest-plugin/src/__tests__/index.test.ts |
Updated expected runner path to reference simulation.ts |
packages/vitest-plugin/rollup.config.ts |
Updated build configuration to output simulation.mjs instead of instrumented.mjs |
packages/tinybench-plugin/src/simulation.ts |
Renamed file and all internal functions/classes from "Instrumented" to "Simulation" |
packages/tinybench-plugin/src/index.ts |
Updated import and mode check to use "simulation" |
packages/tinybench-plugin/src/index.unit.test.ts |
Added tests for both "instrumentation" (backward compatibility) and "simulation" modes |
packages/tinybench-plugin/tests/__snapshots__/index.integ.test.ts.snap |
Updated snapshot to reflect "simulation mode" in console output |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
c8e08ba to
5ee0428
Compare
CodSpeed Performance ReportMerging #68 will degrade performances by 55.87%Comparing Summary
Benchmarks breakdown
Footnotes |
`instrumentation` is still accepted as an input, but it maps to simulation internally, as we plan to phase it out.
5ee0428 to
635c77c
Compare
instrumentationis still accepted as an input, but it maps to simulation internally, as we plan to phase it out.