Skip to content

Automate browser based workflows with AI

fix(SKY-11430): guard ab_variant against missing onboarding_state (#6803)

Aaron Perez7bafb06ed0f4
diff --git a/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.test.tsx b/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.test.tsx
index fb1dc4844..0f289fdd4 100644
--- a/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.test.tsx
+++ b/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.test.tsx
@@ -22,7 +22,6 @@ const tagKeys: Array<TagKey> = [
];
function renderControl(props: {
- exactValuesOnly?: boolean;
value?: Array<TagFilterTerm>;
onChange?: (terms: Array<TagFilterTerm>) => void;
}) {
@@ -33,7 +32,6 @@ function renderControl(props: {
value={props.value ?? []}
onChange={props.onChange ?? (() => {})}
labelSuggestions={["adhoc"]}
- exactValuesOnly={props.exactValuesOnly}
/>
</MemoryRouter>,
);
@@ -45,32 +43,37 @@ function openAndType(query: string) {
fireEvent.change(input, { target: { value: query } });
}
-describe("TagFilterControl exactValuesOnly", () => {
- it("does not offer a bare label as an addable filter", () => {
- renderControl({ exactValuesOnly: true });
+// All surfaces (workflows list + analytics dashboard) accept the same three
+// term shapes: bare label, group:* (group-any), and exact group:value.
+describe("TagFilterControl", () => {
+ it("offers a bare label as an addable filter", () => {
+ renderControl({});
openAndType("prod");
- expect(screen.queryByText(/^Filter by/)).toBeNull();
+ expect(screen.getByText(/Filter by label/)).toBeTruthy();
});
- it("offers an exact group:value as an addable filter", () => {
- renderControl({ exactValuesOnly: true });
- openAndType("env:prod");
- expect(screen.getByText(/env: prod/)).toBeTruthy();
+ it("adds a bare label on selection", () => {
+ const onChange = vi.fn();
+ renderControl({ onChange });
+ openAndType("prod");
+ fireEvent.click(screen.getByText(/Filter by/));
+ expect(onChange).toHaveBeenCalledWith([{ key: null, value: "prod" }]);
});
- it("adds an exact term on selection", () => {
+ it("offers and adds an exact group:value", () => {
const onChange = vi.fn();
- renderControl({ exactValuesOnly: true, onChange });
+ renderControl({ onChange });
openAndType("env:prod");
+ expect(screen.getByText(/env: prod/)).toBeTruthy();
fireEvent.click(screen.getByText(/Filter by/));
expect(onChange).toHaveBeenCalledWith([{ key: "env", value: "prod" }]);
});
-});
-describe("TagFilterControl default mode", () => {
- it("still offers a bare label as an addable filter (workflows list parity)", () => {
- renderControl({ exactValuesOnly: false });
- openAndType("prod");
- expect(screen.getByText(/Filter by label/)).toBeTruthy();
+ it("adds a group-any term from a group suggestion", () => {
+ const onChange = vi.fn();
+ renderControl({ onChange });
+ openAndType("env");
+ fireEvent.click(screen.getByText(/: any/));
+ expect(onChange).toHaveBeenCalledWith([{ key: "env", value: null }]);
});
});
diff --git a/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.tsx b/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.tsx
index 74ffc7dc8..968bc67d1 100644
--- a/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.tsx
+++ b/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.tsx
@@ -51,11 +51,6 @@ type Props = {
// to this callback. Omit it for read-only surfaces (e.g. the analytics
// dashboard filter) that must not expose destructive tag-key management.
onDeleteKey?: (tagKey: TagKey) => void;
- // Restrict filtering to exact `group:value` terms only — no bare labels and
- // no group-any (`key:*`). Use on surfaces whose backend matches values
- // literally (the analytics summary endpoint), where those broader forms
- // would silently return unfiltered/empty data.
- exactValuesOnly?: boolean;
// (key, value) -> palette color; only exact group:value chips are colored.
// Omit on surfaces that don't load colors (chips stay neutral).
colors?: TagColorMap;
@@ -88,7 +83,6 @@ function TagFilterControl({
valueSuggestionsByKey,
triggerLabel = "Tags",
onDeleteKey,
- exactValuesOnly = false,
colors,
}: Props) {
const [open, setOpen] = React.useState(false);
@@ -143,12 +137,7 @@ function TagFilterControl({
const trimmedQuery = query.trim();
const normalizedQuery = trimmedQuery.toLowerCase();
const candidate = parseTagFilterTerm(query);
- // In exact mode only fully-specified group:value terms are addable; bare
- // labels and group-any (key:null) are rejected because the backend can't
- // honor them.
- const candidateAddable =
- candidate !== null &&
- (!exactValuesOnly || (candidate.key !== null && candidate.value !== null));
+ const candidateAddable = candidate !== null;
const candidateExists =
candidate !== null && value.some((term) => sameTerm(term, candidate));
const showAdd = candidateAddable && !candidateExists;
@@ -166,7 +155,7 @@ function TagFilterControl({
.slice(0, MAX_AUTOCOMPLETE_SUGGESTIONS)
: [];
const labelMatches =
- typedKey === null && !exactValuesOnly
+ typedKey === null
? labelSuggestions
.filter((label) => label.toLowerCase().includes(normalizedQuery))
.filter(
@@ -307,11 +296,7 @@ function TagFilterControl({
) : null}
<Command shouldFilter={false}>
<CommandInput
- placeholder={
- exactValuesOnly
- ? "Filter by group:value…"
- : "Filter by label or group:label…"
- }
+ placeholder="Filter by label, group:*, or group:label…"
value={query}
onValueChange={setQuery}
onKeyDown={(event) => {
@@ -322,11 +307,7 @@ function TagFilterControl({
}}
/>
<CommandList>
- <CommandEmpty>
- {exactValuesOnly
- ? "Type group:value to filter."
- : "Type a label, group:*, or group:label."}
- </CommandEmpty>
+ <CommandEmpty>Type a label, group:*, or group:label.</CommandEmpty>
{showAdd && candidate ? (
<CommandGroup>
<CommandItem
@@ -345,21 +326,13 @@ function TagFilterControl({
key={tagKey.key}
value={`__group__,${tagKey.key}`}
className="justify-between gap-2"
- // Default: filter by group (any value in it). In exact mode
- // group-any isn't supported, so prefill `key:` and make the
- // user pick a concrete value instead.
- onSelect={() =>
- exactValuesOnly
- ? setQuery(`${tagKey.key}:`)
- : addTerm({ key: tagKey.key, value: null })
- }
+ // Filter by group (any value in it).
+ onSelect={() => addTerm({ key: tagKey.key, value: null })}
>
<div className="flex min-w-0 flex-col">
<span className="truncate">
<span className="font-medium">{tagKey.key}</span>
- <span className="text-muted-foreground">
- {exactValuesOnly ? ": …" : ": any"}
- </span>
+ <span className="text-muted-foreground">: any</span>
</span>
{tagKey.description ? (
<span className="truncate text-xs text-muted-foreground">
diff --git a/skyvern-frontend/src/store/onboarding/OnboardingProvider.test.tsx b/skyvern-frontend/src/store/onboarding/OnboardingProvider.test.tsx
index cfb6fcfea..79acb664a 100644
--- a/skyvern-frontend/src/store/onboarding/OnboardingProvider.test.tsx
+++ b/skyvern-frontend/src/store/onboarding/OnboardingProvider.test.tsx
@@ -36,25 +36,30 @@ vi.mock("@/util/onboarding/OnboardingTelemetry", () => ({
}));
import { OnboardingProvider } from "./OnboardingProvider";
-import type { OnboardingStateResponse } from "./types";
+import type { OnboardingState, OnboardingStateResponse } from "./types";
import { useOnboardingState } from "./useOnboardingState";
+import { OnboardingTelemetry } from "@/util/onboarding/OnboardingTelemetry";
const DISMISSED_AT = "2026-01-01T00:00:00.000Z";
+function freshOnboardingState(): OnboardingState {
+ return {
+ tour_completed_at: null,
+ modal_dismissed_at: null,
+ first_save_at: null,
+ first_run_at: null,
+ ab_variant: null,
+ user_intent: null,
+ seen_canvas: null,
+ seen_node_adder: null,
+ seen_sidebar: null,
+ seen_save_run: null,
+ };
+}
+
function freshResponse(): OnboardingStateResponse {
return {
- onboarding_state: {
- tour_completed_at: null,
- modal_dismissed_at: null,
- first_save_at: null,
- first_run_at: null,
- ab_variant: null,
- user_intent: null,
- seen_canvas: null,
- seen_node_adder: null,
- seen_sidebar: null,
- seen_save_run: null,
- },
+ onboarding_state: freshOnboardingState(),
launch_date_at_signup: "2025-01-01T00:00:00Z",
};
}
@@ -120,7 +125,7 @@ describe("OnboardingProvider write resilience", () => {
const dismissedResponse: OnboardingStateResponse = {
...freshResponse(),
onboarding_state: {
- ...freshResponse().onboarding_state,
+ ...freshOnboardingState(),
modal_dismissed_at: DISMISSED_AT,
},
};
@@ -142,3 +147,25 @@ describe("OnboardingProvider write resilience", () => {
expect(screen.getByTestId("dismissed").textContent).toBe(DISMISSED_AT);
});
});
+
+describe("OnboardingProvider missing onboarding_state", () => {
+ it("renders without throwing when the response omits onboarding_state", async () => {
+ // A signed-out / transitional /users/me/onboarding body can lack
+ // onboarding_state; the provider must not dereference it (SKY-11430).
+ // The key is absent (not explicitly undefined) to mirror the real JSON.
+ const responseWithoutState: OnboardingStateResponse = {
+ launch_date_at_signup: null,
+ };
+ mockGet.mockResolvedValue({ data: responseWithoutState });
+
+ renderProvider();
+
+ await waitFor(() => expect(mockGet).toHaveBeenCalledTimes(1));
+ // state resolves to null, so the consumer reads an undefined field rather
+ // than crashing on a missing onboarding_state.
+ await waitFor(() =>
+ expect(screen.getByTestId("dismissed").textContent).toBe("undefined"),
+ );
+ expect(OnboardingTelemetry.registerVariant).not.toHaveBeenCalled();
+ });
+});
diff --git a/skyvern-frontend/src/store/onboarding/OnboardingProvider.tsx b/skyvern-frontend/src/store/onboarding/OnboardingProvider.tsx
index 69fb16cd6..395cb5e51 100644
--- a/skyvern-frontend/src/store/onboarding/OnboardingProvider.tsx
+++ b/skyvern-frontend/src/store/onboarding/OnboardingProvider.tsx
@@ -49,7 +49,7 @@ function OnboardingProvider({ children }: Readonly<Props>) {
await queryClient.cancelQueries({ queryKey: QUERY_KEY });
const previous =
queryClient.getQueryData<OnboardingStateResponse>(QUERY_KEY);
- if (previous) {
+ if (previous?.onboarding_state) {
queryClient.setQueryData<OnboardingStateResponse>(QUERY_KEY, {
...previous,
onboarding_state: { ...previous.onboarding_state, ...patch },
@@ -70,7 +70,7 @@ function OnboardingProvider({ children }: Readonly<Props>) {
data?.launch_date_at_signup != null &&
new Date(data.launch_date_at_signup) >= new Date(PRODUCT_LAUNCH_DATE);
- const abVariant = data?.onboarding_state.ab_variant ?? null;
+ const abVariant = data?.onboarding_state?.ab_variant ?? null;
useEffect(() => {
if (abVariant) {
diff --git a/skyvern-frontend/src/store/onboarding/types.ts b/skyvern-frontend/src/store/onboarding/types.ts
index 11912d185..67798c1f9 100644
--- a/skyvern-frontend/src/store/onboarding/types.ts
+++ b/skyvern-frontend/src/store/onboarding/types.ts
@@ -15,7 +15,7 @@ export type OnboardingState = {
};
export type OnboardingStateResponse = {
- onboarding_state: OnboardingState;
+ onboarding_state?: OnboardingState;
launch_date_at_signup: string | null;
};