Observe perform candidates #426
Merged
+943
−139
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: 9776827 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
…M on a11y context
… observe_perform_candidates
…dates # Conflicts: # lib/StagehandPage.ts # lib/handlers/observeHandler.ts
… observe_perform_candidates
|
need to check if _waitForSettledDom is completely necessary in public performPlaywrightMethod |
|
just missing adding changeset |
kamath
reviewed
Jan 28, 2025
| await newOpenedTab.close(); | ||
| await stagehandPage.goto(newOpenedTab.url()); | ||
| await stagehandPage.waitForLoadState("domcontentloaded"); | ||
| // await stagehandPage._waitForSettledDom(domSettleTimeoutMs); |
There was a problem hiding this comment.
note: figure out how to get around this -- maybe we make waitForSettledDom a function that takes in a page?
| @@ -76,65 +78,22 @@ export class StagehandObserveHandler { | |||
| }, | |||
| }); | |||
|
|
|||
| let outputString: string; | |||
There was a problem hiding this comment.
checking my understanding: we're removing this because we're not cross-referencing DOM with a11y tree, and now we're basically just removing a11y tree if the user insists on only observing visible elements
kamath
approved these changes
Jan 29, 2025
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.
why
Observe got a major upgrade. Now it will return a suggested playwright method with any necessary arguments for the generated candidate elements. It also includes a significant speedup when using a11y tree processing for context.
what changed
The output of observe calls used to be in the format:
[ { description: 'A list element that...', selector: 'xpath=/html/body/div[1]/main/section/div[1]/section[2]/div[2]/ul' } ]Now, observe returns the following:
[ { description: 'The scrollable sidebar containing ...', method: 'scrollIntoViewIfNeeded', // or another playwright method such as click, type, etc... arguments: [], selector: 'xpath=/html/body/div[1]/main/section/div[1]/section[2]/div[2]/ul' } ]On top of that, the a11y tree context parsing / candidate generation got a major speedup by skipping processAllDom.
With a11y trees, the context might include elements present in the DOM but behind some effect in the UI. To give users control on whether to include these in the context or not, we provide the flag
onlyVisible. In essence, setting it to true will default to the previous observe method, and false (default) will use the new features described in this PR.Sample usage:
test plan