🙌 OpenHands: AI-Driven Development
fix(onboarding): turn the setup guide off from its close button (OHE-3658) (#18703)
Hiep Le078050fcb7bf
diff --git a/__tests__/components/features/setup-guide/super-admin-setup-guide.test.tsx b/__tests__/components/features/setup-guide/super-admin-setup-guide.test.tsxindex d8d76bc9bf..50de068e12 100644--- a/__tests__/components/features/setup-guide/super-admin-setup-guide.test.tsx+++ b/__tests__/components/features/setup-guide/super-admin-setup-guide.test.tsx@@ -111,6 +111,22 @@ function serveSetupGuide({return requests;}+/** Serves the guide's dismissal and records each request body. */+function serveDismissal() {+ const dismissals: unknown[] = [];+ server.use(+ http.patch("*/api/admin/setup-state", async ({ request }) => {+ dismissals.push(await request.json());+ return HttpResponse.json({+ ...guideState(),+ guide_dismissed: true,+ guide_steps: null,+ });+ }),+ );+ return dismissals;+}+function activateBackend(backend: Backend) {setRegisteredBackends([backend]);setActiveSelection({ backendId: backend.id, orgId: GUIDE_ORG_ID });@@ -491,6 +507,46 @@ describe("SuperAdminSetupGuide", () => {).toBeInTheDocument();});+ it("turns the guide off when the admin confirms closing it", async () => {+ const user = userEvent.setup();+ activateBackend(cloudBackend);+ serveSetupGuide();+ const dismissals = serveDismissal();+ renderGuide();+ await screen.findByTestId("super-admin-setup-guide-panel");++ await user.click(+ screen.getByRole("button", { name: I18nKey.BUTTON$CLOSE }),+ );+ await user.click(screen.getByTestId("confirm-button"));++ await waitFor(() =>+ expect(+ screen.queryByTestId("super-admin-setup-guide"),+ ).not.toBeInTheDocument(),+ );+ expect(dismissals).toEqual([{ guide_dismissed: true }]);+ });++ it("keeps the guide on the pill when the admin cancels closing it", async () => {+ const user = userEvent.setup();+ activateBackend(cloudBackend);+ serveSetupGuide();+ const dismissals = serveDismissal();+ renderGuide();+ await screen.findByTestId("super-admin-setup-guide-panel");++ await user.click(+ screen.getByRole("button", { name: I18nKey.BUTTON$CLOSE }),+ );+ await user.click(screen.getByTestId("cancel-button"));++ expect(+ screen.getByTestId("super-admin-setup-guide-toggle"),+ ).toHaveAttribute("aria-expanded", "false");+ expect(dismissals).toEqual([]);+ });+it("does not ask for the setup state for a user who is not a Super Admin", async () => {activateBackend(cloudBackend);const requests = serveSetupGuide({ permissions: ["view_automations"] });diff --git a/src/api/cloud/setup-state-service.api.ts b/src/api/cloud/setup-state-service.api.tsindex 77af470691..bc6104cc4d 100644--- a/src/api/cloud/setup-state-service.api.ts+++ b/src/api/cloud/setup-state-service.api.ts@@ -25,3 +25,18 @@ export async function getCloudSetupState(guide_steps: state.guide_steps ?? null,};}++/**+ * Turn the setup guide off with `PATCH /api/admin/setup-state`. Super Admin+ * instance settings turn it back on.+ */+export async function dismissCloudSetupGuide(+ backend: Backend,+): Promise<CloudSetupState> {+ return callCloudProxy<CloudSetupState>({+ backend,+ method: "PATCH",+ path: "/api/admin/setup-state",+ body: { guide_dismissed: true },+ });+}diff --git a/src/components/features/setup-guide/super-admin-setup-guide.tsx b/src/components/features/setup-guide/super-admin-setup-guide.tsxindex 868bfa1ce4..0577d78439 100644--- a/src/components/features/setup-guide/super-admin-setup-guide.tsx+++ b/src/components/features/setup-guide/super-admin-setup-guide.tsx@@ -10,6 +10,7 @@ import {import { useTranslation } from "react-i18next";import { ArrowUpRight, Check, ClipboardList, X } from "lucide-react";import { getLockedCloudHost } from "#/api/agent-server-config";+import { ConfirmationModal } from "#/components/shared/modals/confirmation-modal";import { NavigationLink } from "#/components/shared/navigation-link";import { useNavigation } from "#/context/navigation-context";import { useActiveBackend } from "#/contexts/active-backend-context";@@ -88,8 +89,10 @@ export default function SuperAdminSetupGuide() {guideOrgId,visible,refetch,+ dismiss,} = useSuperAdminSetupGuide();const [open, setOpen] = useState(true);+ const [confirmDismiss, setConfirmDismiss] = useState(false);const tourActive = useSyncExternalStore(subscribeGuidedTourActive,isGuidedTourActive,@@ -308,7 +311,12 @@ export default function SuperAdminSetupGuide() {type="button"aria-label={t(I18nKey.BUTTON$CLOSE)}className={ICON_BUTTON_CLASS}- onClick={() => setOpen(false)}+ // Closing asks whether to turn the guide off for good;+ // cancelling leaves it closed to the pill.+ onClick={() => {+ setOpen(false);+ setConfirmDismiss(true);+ }}><X className="size-4" strokeWidth={2} aria-hidden /></button>@@ -420,6 +428,17 @@ export default function SuperAdminSetupGuide() {<ClipboardList className="size-4" strokeWidth={2} aria-hidden />{title}</button>++ {confirmDismiss ? (+ <ConfirmationModal+ text={t(I18nKey.ONBOARDING$SETUP_GUIDE_DISMISS_CONFIRM)}+ onConfirm={() => {+ setConfirmDismiss(false);+ dismiss();+ }}+ onCancel={() => setConfirmDismiss(false)}+ />+ ) : null}</div>);}diff --git a/src/components/features/setup-guide/use-super-admin-setup-guide.ts b/src/components/features/setup-guide/use-super-admin-setup-guide.tsindex fe1e09d38f..450a3b5b20 100644--- a/src/components/features/setup-guide/use-super-admin-setup-guide.ts+++ b/src/components/features/setup-guide/use-super-admin-setup-guide.ts@@ -1,6 +1,9 @@-import { useQuery } from "@tanstack/react-query";+import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";import { getCloudOrganizationMe } from "#/api/cloud/organization-service.api";-import { getCloudSetupState } from "#/api/cloud/setup-state-service.api";+import {+ dismissCloudSetupGuide,+ getCloudSetupState,+} from "#/api/cloud/setup-state-service.api";import type { CloudSetupGuideSteps } from "#/api/cloud/types";import { useActiveBackend } from "#/contexts/active-backend-context";import {@@ -46,8 +49,13 @@ export function getNextSetupStep(* an organization and is not dismissed. Local backends never see it.*/export function useSuperAdminSetupGuide() {+ const queryClient = useQueryClient();const { backend, orgId } = useActiveBackend();const isCloud = backend.kind === "cloud";+ const setupStateQueryKey = SUPER_ADMIN_SETUP_QUERY_KEYS.state(+ backend.id,+ backend.connectionRevision ?? 0,+ );// Same query as `useAutomationPermissions`, so no extra request is issued.// eslint-disable-next-line @tanstack/query/exhaustive-deps@@ -70,10 +78,7 @@ export function useSuperAdminSetupGuide() {// eslint-disable-next-line @tanstack/query/exhaustive-depsconst setupStateQuery = useQuery({- queryKey: SUPER_ADMIN_SETUP_QUERY_KEYS.state(- backend.id,- backend.connectionRevision ?? 0,- ),+ queryKey: setupStateQueryKey,queryFn: () => getCloudSetupState(backend),enabled: isCloud && isSuperAdmin,...CONFIG_CACHE_OPTIONS,@@ -81,6 +86,13 @@ export function useSuperAdminSetupGuide() {meta: { disableToast: true },});+ const dismissMutation = useMutation({+ mutationFn: () => dismissCloudSetupGuide(backend),+ onSuccess: (state) => {+ queryClient.setQueryData(setupStateQueryKey, state);+ },+ });+const setupState = isSuperAdmin ? setupStateQuery.data : undefined;const guideSteps = setupState?.guide_steps ?? null;const steps: SuperAdminSetupStepState[] = SUPER_ADMIN_SETUP_STEPS.map(@@ -103,5 +115,6 @@ export function useSuperAdminSetupGuide() {visible: active && nextStep !== null,isLoading: meQuery.isLoading || setupStateQuery.isLoading,refetch: setupStateQuery.refetch,+ dismiss: dismissMutation.mutate,};}diff --git a/src/i18n/translation.json b/src/i18n/translation.jsonindex 61ec038a64..9479913a13 100644--- a/src/i18n/translation.json+++ b/src/i18n/translation.json@@ -46079,6 +46079,24 @@"uk": "Почати","id": "Mulai"},+ "ONBOARDING$SETUP_GUIDE_DISMISS_CONFIRM": {+ "en": "Hide the Setup guide? You can turn it back on in Super Admin Instance Settings.",+ "ja": "セットアップガイドを非表示にしますか?Super Admin の Instance Settings で再びオンにできます。",+ "zh-CN": "要隐藏设置指南吗?你可以在 Super Admin 的 Instance Settings 中重新开启。",+ "zh-TW": "要隱藏設定指南嗎?你可以在 Super Admin 的 Instance Settings 中重新開啟。",+ "ko-KR": "설정 가이드를 숨길까요? Super Admin의 Instance Settings에서 다시 켤 수 있습니다.",+ "no": "Skjule oppsettsveiledningen? Du kan slå den på igjen under Instance Settings i Super Admin.",+ "ar": "هل تريد إخفاء دليل الإعداد؟ يمكنك إعادة تشغيله من Instance Settings في Super Admin.",+ "de": "Einrichtungsleitfaden ausblenden? Sie können ihn in Super Admin unter Instance Settings wieder einschalten.",+ "fr": "Masquer le guide de configuration ? Vous pouvez le réactiver dans Super Admin, sous Instance Settings.",+ "it": "Nascondere la guida alla configurazione? Puoi riattivarla in Super Admin, in Instance Settings.",+ "pt": "Ocultar o guia de configuração? Você pode ativá-lo novamente em Super Admin, em Instance Settings.",+ "es": "¿Ocultar la guía de configuración? Puedes volver a activarla en Super Admin, en Instance Settings.",+ "ca": "Vols amagar la guia de configuració? La pots tornar a activar a Super Admin, a Instance Settings.",+ "tr": "Kurulum rehberi gizlensin mi? Super Admin'deki Instance Settings bölümünden yeniden açabilirsiniz.",+ "uk": "Приховати посібник із налаштування? Його можна знову ввімкнути в Super Admin, у розділі Instance Settings.",+ "id": "Sembunyikan panduan penyiapan? Anda dapat mengaktifkannya kembali di Super Admin, pada Instance Settings."+ },"ONBOARDING$SETUP_GUIDE_TOUR_TEMPLATE_TITLE": {"en": "Choose a template","ja": "テンプレートを選択",