docs(web): document per-action progress callbacks - #2890
Open
yaodong-shen wants to merge 1 commit into
Open
Conversation
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
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
aiActaction and capture a Playwright screenshot before execution continuesAiActProgressEventandisAiActProgressEvent()so consumers can narrow the generic progress stream withoutanyor unsafe casts@midscene/weband@midscene/web/playwrightCloses #2794.
Validation
pnpm exec nx test @midscene/core(123 files, 1350 passed, 8 skipped)pnpm --filter @midscene/core exec vitest --run tests/unit-test/agent-progress-bus.test.ts(8 passed)pnpm exec nx run-many --target=build --projects=@midscene/core,@midscene/webpnpm exec nx build doc(including search metadata checks)biome check . --diagnostic-level=info --no-errors-on-unmatched --fix(1386 files, clean)lint-stagedand commitlint hooksNotes
The progress listener is awaited by the existing progress bus. The documented callback therefore captures the page after
action_doneor at theaction_failedfailure site, before the next action begins oraiAct()rejects.