Repository navigation
fix(dashboard): keep feature-preview switches on the gateway - #22830
mbriones98 wants to merge 2 commits into
Conversation
The Feature previews switches lived only in browser localStorage, so a new origin, the desktop app beside a browser tab, or cleared site data turned them back off. Each switch is now stored in the gateway config under dashboard.feature_previews.<name>, written through the existing owner-only config PATCH, with localStorage kept as a cache. A switch set only in this browser is carried up once with if_unset; a refused toggle names the switch that went back and says why. A carry-up refused as owner-only says the switch stays on in this browser only, with no reload step. Each browser records which switches it has seen the gateway hold, so a switch removed there reads as off even when another switch's carry-up failed. An accepted save is written into the cached config with the shared setConfigPathValue helper. The Preview-gated surfaces paragraph in the dashboard module spec now says the switch is kept under dashboard.feature_previews.<name>, that localStorage is a cache, that writes go through the owner-only config PATCH, and names usePreviewFlagServerSync. Fixes #21396
UX Review (Opus 5.5) — 🔴 BLOCKUX-level review of UX-Verdict: BLOCK The new intro copy says previews are "saved for everyone using this Kiro Crew", and that makes the blind reader afraid to turn on the PR's own example preview, Crewmates. BlockersThe intro copy scares users away from the switches this PR is meant to make reliable Notes
[UX-REVIEWED] 2a7b76c Description read[DESCRIPTION-READ] d9721c63e5ebfd30355b8ff689c45cdd8ba969eacf7454a2a8ee3e5582b66df1 That sha256 names everything this verdict read: the PR description, plus the 8 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with |
Design Review (Opus 5.5) — ✅ PASSDesign-level review of Design-Verdict: PASS Nothing blocks. Keeping the switches in gateway config fixes the root cause (localStorage was the only copy), and it uses the existing owner-only PATCH and refresh-frame paths. Notes
[DESIGN-REVIEWED] 2a7b76c Description read[DESCRIPTION-READ] ad8737b44250d631e12e0b98ef132ef0a690f7007ed7c45b081b69d5821392e3 That sha256 names everything this verdict read: the PR description, plus the 1 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with |
First Principles Review (Opus 5.5) — ✅ PASSPremise-level review of First-Principles-Verdict: PASS Nothing blocks. The sync hook keeps two localStorage records that both answer "did the gateway drop this switch?", and the description says other dashboards get the refresh frame "already", yet this diff is what adds it. Notes
What this change shipsInventory (9 items) — 7 justifiedIntent: a feature-preview switch stays on across every browser and the desktop app on one gateway. FIX.
[FIRST-PRINCIPLES-REVIEWED] 2a7b76c Description read[DESCRIPTION-READ] 817a1e56a4e2ab5fdbbbf861c1e2ddf7d3f8ea660bcb9f745c1b2a8d7bf5c828 That sha256 names the PR description this verdict read. Recompute it with |
Opus 5.5 Review — ✅ no blocking findingsReviewed Verdict parsed from the review's SHA-scoped output markers for commit False positive or not applicable? A repository writer can comment: |
GPT 6.1 Review — 🔴 changes requested (blocking)GPT 6.1 found at least one blocking issue that must be resolved before merging This comment is updated in place on each push. BLOCKING -- website/src/hooks/usePreviewFlagServerSync.ts:273 -- Clear stale carry-up notices when the server supplies a saved value
[BLOCK-MERGE] 2a7b76c Adjudication (Opus 5.5) — is blocking on each finding proportionate?F1: LOW harm. A notice is shown that is wrong, but it can be dismissed and the switch itself shows the correct OFF state. I confirmed the conditions in the code. The carry is refused and the error is set at False positive or not applicable? A repository writer can comment: |
A Feature previews switch saved from one dashboard did not reach the other open ones until they reloaded or reconnected: they read the switches from a config query that never goes stale on its own, and a config write to dashboard.feature_previews sent no refresh frame. The gateway's config watcher now pushes a config refresh when that section changes, so every open dashboard re-reads it.
|
Re the GPT 6.1 Review blocking finding: fixed in 2a7b76c. The gateway's config watcher now subscribes to |
bolichen97
left a comment
There was a problem hiding this comment.
Needs changes: two AI review lanes still block this head, and both findings hold when I read the code.
Head reviewed: 2a7b76c. Bots read: Design PASS, First Principles PASS, UX BLOCK, Opus no findings, GPT BLOCK (upheld by adjudication). Readiness: checking, with 6 checks still pending.
The backend half is sound. The PATCH allowlist accepts only the six known names as bool, the loader drops unknown names and non-bool values, and the new config watcher push is covered by a test.
Two items remain before this can merge:
- The GPT finding is not fixed yet. The reply on this PR says it was fixed in this commit, but that change adds the config refresh push. The finding is about a different thing: reconcile never clears a refused carry notice when the server later supplies a value for that switch. See the inline comment on
usePreviewFlagServerSync.ts. - The UX lane blocks on the new section intro. "Saved for everyone using this" reads as if the switch changes things for other people. See the inline comment on
en.manual.json.
Minor, not blocking: the hook docstring and the PR description both say the config refresh frame "already" reaches other dashboards. This PR is what adds that push in config_watch.py. Please say so in both places.
🔴 0 must-fix, 🟡 2 should-fix. Not repeated: the two localStorage records and the carry-up retirement noted by Design and First Principles.
| } | ||
| const server = fp[previewFlagName(flag)] | ||
| if (typeof server === 'boolean') { | ||
| if (readPreviewFlag(flag) !== server) cachePreviewFlag(flag, server) |
There was a problem hiding this comment.
🟡 A refused carry notice stays up after the server supplies a value for the same switch
A non-owner browser has a legacy ON, and its one-time carry is refused (line 210 sets a carry error). Later the owner saves that switch as OFF on another surface. The refresh runs reconcile, and this line moves the cache to OFF. Nothing clears the carry error, so the section keeps saying the switch "is on in this browser only" while the switch shows OFF.
if (readPreviewFlag(flag) !== server) cachePreviewFlag(flag, server)Why it matters: the notice states the opposite of what the switch shows. The only way out is the manual dismiss.
Suggestion: in this branch, clear the error only when it is a carry error for this same flag, for example if (writeError?.carry && writeError.flag === flag) setWriteError(null). Add a test: refused carry, then a config body with false for that flag, then expect no notice. This is the GPT lane finding on this head; the refresh push added in this commit does not change it.
| "developerPanel": { | ||
| "feature_previews": "Feature Previews", | ||
| "feature_previews_desc": "Unreleased features and pages. The pages stay hidden from the sidebar and from Search Everywhere until you turn them on here; the switches themselves do show up in Settings search. Unpolished on purpose, and per-device unless a card says otherwise." | ||
| "feature_previews_desc": "Unreleased features and pages. These switches are saved for everyone using this {{productName}}, so they stay set in every browser and in the desktop app. The pages stay hidden from the sidebar and from Search Everywhere until you turn them on here; the switches themselves do show up in Settings search. Unpolished on purpose.", |
There was a problem hiding this comment.
🟡 "Saved for everyone" reads as if the switch affects other people
The UX lane blocks on this line. In a tool that one person mostly uses, "saved for everyone using this" suggests that turning on Crewmates changes things for other users. The PR goal is that the switch stays on, and this copy can stop people from turning it on at all.
"feature_previews_desc": "Unreleased features and pages. These switches are saved for everyone using this {{productName}}, so they stay set in every browser and in the desktop app. ..."Why it matters: every visitor to the section reads this intro, before any switch.
Suggestion: lead with what the user gets and drop "everyone", for example: "Unreleased features and pages. A switch you turn on stays on in every browser and in the desktop app connected to this {{productName}}." The owner-only rule is already in the refused-toggle notices. Update the 12 catalogs and regenerate en-XA. The same word appears in feature_previews_carry_failed and feature_previews_carry_denied; consider the same change there.
|
Superseded by #22913, the same change rebuilt as one commit off current main with both review fixes. |
Pull request was closed
Problem / Motivation
Goal: A Feature previews switch (such as Crewmates) stays on once you turn it on, in every browser and in the desktop app that use the same Kiro Crew.
The switches under Settings > Developer > Feature previews were kept only in browser localStorage (
mc-preview-*). A new origin or port, the desktop app next to a browser tab, or cleared site data each read the switch as off, so Crewmates and the other previews kept turning themselves off.Why it matters
Anyone trying a preview has to turn it on again on every surface and after every storage reset. A preview that seems to switch itself off reads as broken.
Not a goal
DURABLE_PREF_KEYS//api/ui-prefsbackup, so there is one source of truth.configKey/ settings-registry entries for the new paths (<SettingRef>deep links). That is a separate navigation feature.What changed (motivation → approach → change)
Symptom: a switch turned on in one surface is off in another. Root cause: localStorage was the only copy.
#21396 was filed by its owner asking for the switches to sync across surfaces, so moving them from per-device to gateway-wide is the requested behaviour, not a side effect.
Approach: the gateway config keeps each switch, and localStorage stays as a fast cache. Config rather than adding the keys to
DURABLE_PREF_KEYS: the uiPrefs backup restores only on a cold profile, so a warm desktop app and a warm browser tab would never pick up each other's change. The config route reaches every open dashboard through the configrefreshframe it already receives.sections_dashboard.py,loader_builders.py,loader.py,sections.py,handlers/core_config_schema.py,handlers/core.py,change_card_catalog.py):dashboard.feature_previews.<name>, for the 6 live flags:webhooks,artifact_deploy,crew,remote_crew_chat,layout_harness,folder_conductor.configuration.mdandconfig-baseline.jsonare updated.mc-preview-instance-sessionskey is not kept on the gateway. Its ON is carried up asremote_crew_chat.usePreviewFlagServerSync.ts, mounted inshell/appShell.tsxbeside the shell's existing reader of the same config query, so boot order is unchanged):setConfigPathValuehelper.if_unset, so it never replaces a stored value.kc-feature-previews-syncedmarker makes a cache-only ON read as off, so a key the operator removed stays off. The marker is not set while a toggle is in flight, or after a refused toggle or a refused carry, so a browser-only value is never wiped.kc-feature-previews-server-backed, with an in-memory copy for when storage is full). A recorded switch that the gateway no longer holds reads as off even before the browser is marked synced, so another switch's failed carry-up cannot send a removed switch back up.{{productName}}), without the word "gateway".en-XAis regenerated.Why this does not use
useOptimisticConfigPaths: that hook gives one settings component an in-flight display value per config path and lets saves run side by side. The switches here are shared by every surface outside any one component, so the sync keeps its own small queue. It sends one switch's writes in click order, so the gateway keeps the last click, and when a write is refused it puts the switch back to the last value the gateway accepted, in the cache and in localStorage. The hook does neither of those, so only its path-write helper is reused.Docs: the Preview-gated surfaces paragraph in
docs/system-specs/modules/learn-cron-dashboard.mdnow says each switch is kept on the gateway underdashboard.feature_previews.<name>, that localStorage is a cache, that writes go through the owner-only config PATCH, and thatusePreviewFlagServerSynckeeps the two in step.Overlap: open PR #20420 also edits
DURABLE_PREF_KEYS. This PR does not touch that list, so the two do not conflict.Backwards compatibility
Compatible: the new config fields are optional and default to off, the PATCH allowlist only gains names, and an existing browser-only ON is carried up once instead of being dropped.
The diff takes one thing away: localStorage is no longer the source of truth for a switch. Once synced, a cache-only ON that the gateway does not hold reads as off, and a non-owner's toggle no longer overrides the gateway's stored value.
Reader: website/src/utils/previewFlags.ts:readPreviewFlag -- chat|crew page -- still reads the cache, which reconcile keeps equal to the gateway copy | previewFlagServerSync.test.tsx "lets the server copy win over a stale browser copy"
Reader: website/src/hooks/usePreviewFlag.ts:usePreviewFlag / useRemoteCrewChat -- chat|crew page -- re-renders on the same cache write event | previewFlagServerSync.test.tsx "turns Crewmates on from the server when this browser has no copy"
Reader: website/src/surfaces/registry.ts:surfacePreviewEnabled (nav rail, pagesProvider, appNavHidden, CommandBarOverlay) -- chat|crew page -- reads the cache via readPreviewFlag | previewSurfaces.test.tsx
Reader: website/src/pages/settings/FeaturePreviewsSection.tsx -- crew page -- toggles still write the cache first, then the gateway | previewSurfaces.test.tsx "says why a switch went back when the gateway refuses the write"
Reader: non-owner dashboard session (e.g. a QR session) -- chat|crew page -- intended: config saves are owner-only, so it sees every switch the owner set (the config GET is not owner-gated), its own toggle is refused and switched back with the owner-only notice, and a switch it had already turned on in that browser stays on there | featurePreviewsSectionNotice.test.tsx "names the %s switch when the owner-only write is refused", "names the owner, not a reload, when a one-time carry is refused as owner-only"
Reader: retired mc-preview-instance-sessions -- chat -- carried up as remote_crew_chat, then cleared | previewFlagServerSync.test.tsx "carries the retired Remote crew sessions switch up as Chat on a crew", "never lets the retired key turn Chat on a crew back on after it was turned off"
Tests
website/src/test/previewFlagServerSync.test.tsx(33 tests). The repro: Crewmates turns on from the server when localStorage is empty, and it fails with the sync disabled. The other tests cover:if_unsetcarry-up, not replacing a stored value, a 409 counted as synced, and a refused carry reported and kept on;PREVIEW_FLAGSand every declared flag constant.I removed each of these lines on a scratch copy, and each removal makes a test fail:
pending.sizeguard;website/src/test/previewSurfaces.test.tsx: the section shows the owner-only notice naming the switch when the PATCH returns 403.website/src/test/featurePreviewsSectionNotice.test.tsx(11 tests), with the sync mounted as the shell mounts it:It lifts
FeaturePreviewsSection.tsxabove the 80% per-file coverage floor (93.9% of lines locally, across the tests that render it).test/test_feature_previews_config.py(25 tests):if_unsetwrites an absent switch and never replaces a stored one;Local runs on this commit:
src/i18nfolder including thestyle/French U+202F and Korean checks.FeaturePreviewsSection.tsxis at 93.9% of lines andusePreviewFlagServerSync.tsat 100% in that run.tsc(app),eslint src/ --max-warnings 0,check-i18n-strings.mjs,check-i18n-keys.mjs,check-dnt-catalogs.mjsandi18n-check.mjsare clean withI18N_BASE_REFset to the base commit, and the regenerateden-XAhas no diff.test_feature_previews_config.pytests pass (2,952), with the slowest tree scan well under the 120 s limit. Onetest_config_loader_default_agent.pytest reported a pytest unraisable-hookRecursionErroronce under the parallel run and passes on its own (3 of 3).Local AI review: GPT (
gpt-6.1-sol) and Opus read-only reviews ran over several rounds. Each quoted the commit SHA it read, and I checked those against the worktree. Every Critical/High/Medium finding is fixed in this commit, and the final round on the last code change found none open. On this rebuild, a GPT (gpt-6.1-sol) and an Opus review of the new commit each quoted its SHA, confirmed the diff matches fix(dashboard): keep feature-preview switches on the gateway #22544 apart from keeping both sides next to the default sidebar folder setting, and found nothing Critical or High.Manual verification
I took screenshots against the built SPA, with
/api/config/kirocrewreturningcrew: true:Screenshots / video
Synced from the gateway (Crewmates on, empty browser storage):
A toggle refused with 403, naming the switch:
A toggle refused with 500 (the same notice shows for an expired session's 403), naming the switch:
A browser-only switch whose carry-up failed:
A browser-only switch whose carry-up was refused as owner-only (403): the switch stays on, the notice names the owner and has no reload step:
Related Issues
Fixes #21396
Related: #16237, #17424, #14232, #9876
Replaces #22544, which conflicted with main after #21999 added the default sidebar folder setting next to this one in
loader.pyandloader_builders.py, and already had the two commits PR Hygiene allows. This is #22544's two commits as one commit off current main, keeping both settings side by side. Earlier versions: #22298, #22000, #21722, #21624, #21602 and #21569.Pattern harvest
Rule candidate: review-prompt
Pattern: a user-visible setting persisted only in browser localStorage, when it is meant to hold across surfaces of the same gateway; check whether it should live in gateway config with localStorage as a cache.
Checklist
feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert: ...)Contribution License Agreement
Contributions are accepted under the project's Apache-2.0 license; see the Licensing section of CONTRIBUTING.md.