-
Notifications
You must be signed in to change notification settings - Fork 0
fix(studio): stop onboarding detect-site refetch loop on failed detection #36
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
Open
bnz183
wants to merge
1
commit into
feat/phase5-governance
Choose a base branch
from
fix/onboarding-detect-loop
base: feat/phase5-governance
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| import { expect, test } from "@playwright/test"; | ||
| import { enterDemoMode } from "./helpers.js"; | ||
|
|
||
| const DETECT_GLOB = "**/api/setup/detect"; | ||
|
|
||
| async function openWizardToDetectStep(page: import("@playwright/test").Page) { | ||
| await enterDemoMode(page); | ||
| await page | ||
| .getByRole("button", { name: /Run setup wizard|Review setup wizard/ }) | ||
| .click(); | ||
| await expect(page.getByRole("dialog")).toBeVisible(); | ||
| await expect( | ||
| page.getByRole("heading", { name: "Welcome", level: 1 }), | ||
| ).toBeVisible(); | ||
| await page.getByRole("button", { name: "Continue" }).click(); | ||
| await expect( | ||
| page.getByRole("heading", { name: "Your site", level: 1 }), | ||
| ).toBeVisible(); | ||
| } | ||
|
|
||
| test.describe("Onboarding detect-site failure handling", () => { | ||
| test("failed detection does not refetch in a loop", async ({ page }) => { | ||
| let hits = 0; | ||
| await page.route(DETECT_GLOB, async (route) => { | ||
| hits += 1; | ||
| await route.fulfill({ | ||
| status: 500, | ||
| contentType: "application/json", | ||
| body: "{}", | ||
| }); | ||
| }); | ||
|
|
||
| await openWizardToDetectStep(page); | ||
|
|
||
| // Sit on the detect-site step and measure the request rate. | ||
| const baseline = hits; | ||
| await page.waitForTimeout(3000); | ||
| const delta = hits - baseline; | ||
| expect( | ||
| delta, | ||
| `expected at most 1 detect request while idle on a failed scan, saw ${delta}`, | ||
| ).toBeLessThanOrEqual(1); | ||
|
|
||
| // The failure must surface as a real error state, and Continue must be blocked. | ||
| await expect(page.getByText("Could not scan your project")).toBeVisible(); | ||
| await expect(page.getByRole("button", { name: "Continue" })).toBeDisabled(); | ||
| }); | ||
|
|
||
| test("retry triggers exactly one refetch and recovers on success", async ({ | ||
| page, | ||
| }) => { | ||
| let hits = 0; | ||
| let mode: "fail" | "pass" = "fail"; | ||
| await page.route(DETECT_GLOB, async (route) => { | ||
| hits += 1; | ||
| if (mode === "fail") { | ||
| await route.fulfill({ | ||
| status: 500, | ||
| contentType: "application/json", | ||
| body: "{}", | ||
| }); | ||
| return; | ||
| } | ||
| await route.continue(); | ||
| }); | ||
|
|
||
| await openWizardToDetectStep(page); | ||
| await expect(page.getByText("Could not scan your project")).toBeVisible(); | ||
|
|
||
| // Next call should reach the real backend and succeed. | ||
| const before = hits; | ||
| mode = "pass"; | ||
| await page.getByRole("button", { name: "Try again" }).click(); | ||
|
|
||
| // Recovery: error clears and a real detection result renders. | ||
| await expect(page.getByText("Could not scan your project")).toBeHidden(); | ||
| const detected = page.getByText(/We found an? /); | ||
| const notDetected = page.getByText("We could not detect your site"); | ||
| await expect(detected.or(notDetected)).toBeVisible({ timeout: 15_000 }); | ||
|
|
||
| // Exactly one additional request was made by the retry. | ||
| expect(hits - before).toBe(1); | ||
| }); | ||
| }); |
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
Oops, something went wrong.
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.
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.
If the initial scan succeeds but the follow-up
fetchSetupDetection()inhandleApplySettingsreturnsnullafter saving settings,detectionErroris never set andresolvedAttemptstill matchesretryCount, so the wizard is in a loaded/null state. This disabled check treatsreport === nullas okay, leaving Continue enabled and allowing users to advance into blank confirmation steps with no active suggestion; please either preserve the previous report or treat this null refresh as an error/blocked state.Useful? React with 👍 / 👎.