feat!: add onPage callback with ScenarioContext#221
Merged
Conversation
Refactor readYamlAndInterpret to use an options object and add an onPage callback that receives ScenarioContext (scenarioName, workerIndex, iteration) after each browser.newPage(). This enables callers like Kyara to attach event listeners with scenario-aware labels for Prometheus metrics. BREAKING CHANGE: readYamlAndInterpret signature changed from (yaml, browsers?, logger?) to (yaml, options?). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ScenarioContexttype (scenarioName,workerIndex,iteration) andOnPageCallbacktype tosrc/core/model.tsonPageparameter toevalScenario()— called afterbrowser.newPage(), before action executionreadYamlAndInterpretfrom positional args(yaml, browsers?, logger?)to options object(yaml, { browsers?, logger?, onPage? })ScenarioContextandOnPageCallbackfrom package entry point2.0.0Motivation
Kyara (the load testing tool) needs to attach Puppeteer event listeners (request, response, error, console) on each page with scenario-aware labels for Prometheus metrics. Currently,
yaml-pptrmanages the page lifecycle internally with no hook point. This PR enables callers to receive eachPagewith full execution context before actions run.Test plan
onPagecalled with correct context (1 worker/1 iteration)onPagecalled N×M times for N workers × M iterationsonPageonPagepropagated throughreadYamlAndInterpret→evalScenarionpm test— 44/44 passingnpm run build— clean compilation🤖 Generated with Claude Code