feat: PER-7348 add waitForReady() call before serialize()#1149
Draft
Shivanshu-07 wants to merge 1 commit intomasterfrom
Draft
feat: PER-7348 add waitForReady() call before serialize()#1149Shivanshu-07 wants to merge 1 commit intomasterfrom
Shivanshu-07 wants to merge 1 commit intomasterfrom
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
Adds Pattern C (in-browser) readiness gate ahead of
PercyDOM.serialize()per PER-7348.Pairs with: percy/cli#2184
Behavior
PercyDOM.waitForReady(readinessConfig)— async — and awaits the promise.typeof PercyDOM.waitForReady === 'function'guard preserves backward compatibility with older CLI builds that don't ship the readiness API.readiness.preset === 'disabled'short-circuits —waitForReadyis not called.waitForReadyrejects, the SDK logs at debug level and proceeds toserialize()so snapshot capture is never blocked.waitForReadyare attached todomSnapshot.readiness_diagnosticsso the CLI can log timing and pass/fail.options.readinessfirst, thenutils.percy.config.snapshot.readinessfrom.percy.yml.PercyDOM.serialize()itself is unchanged — still synchronous, called with the same options as today.SDK-visible contract
Test plan
QUnit acceptance tests added to
tests/acceptance/index-test.jsunder areadiness gate (PER-7348)module:waitForReadyis called beforeserializewhen CLI exposes itserializeruns whenwaitForReadyis absentreadiness.preset: disabledskipswaitForReadywaitForReadyrejects,serializestill runswaitForReadyare attached todomSnapshot.readiness_diagnosticsSmoke test against
example-percy-emberwas not run as part of this fan-out.🤖 Generated with Claude Code