fix (desktop): flash render of setup script not setup by AviPeltz · Pull Request #719 · superset-sh/superset

AviPeltz · 2026-01-12T22:00:53Z

Description

Related Issues

Type of Change

Testing

Screenshots (if applicable)

Additional Notes

Summary by CodeRabbit

New Features
- Workspace creation now shows immediate progress with a "Preparing..." status so setup feedback appears right away.
Bug Fixes
- Improved interrupted-setup behavior: the interrupted message is now delayed to avoid flicker, with updated wording and a muted icon; actions now read "retry" or "remove" for clarity.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-12T22:01:05Z

📝 Walkthrough

Walkthrough

Adds optimistic initialization progress updates to workspace creation and delays/updates the interrupted-state UI for workspace initialization. The hook now sets a "Preparing..." optimistic progress entry when a created workspace is initializing. The initializing view defers showing the interrupted UI for 500ms and updates copy and icon styling.

Changes

Cohort / File(s)	Summary
Workspace creation hook `apps/desktop/src/renderer/react-query/workspaces/useCreateWorkspace.ts`	Adds import/use of `updateProgress` and `WorkspaceInitProgress`; on success, if `data.isInitializing` is true, writes an optimistic progress entry (workspaceId, projectId, step: "pending", message: "Preparing...") before invalidating workspace queries.
Initializing UI behavior `apps/desktop/src/renderer/screens/main/components/WorkspaceView/WorkspaceInitializingView/WorkspaceInitializingView.tsx`	Adds `useEffect` to delay showing interrupted UI by 500ms (`showInterruptedUI`), changes interrupted-state icon to a muted branch icon, updates copy from "Setup was interrupted" → "Setup incomplete" and associated description/action labels, and conditions rendering on `showInterruptedUI`.

Sequence Diagram

sequenceDiagram
    participant User
    participant Hook as useCreateWorkspace
    participant API as CreateWorkspace API
    participant ProgressStore as Progress Store
    participant QueryCache as Query Cache
    participant UI as WorkspaceInitializingView

    User->>Hook: Request create workspace
    Hook->>API: POST create workspace
    API-->>Hook: Respond with workspace data (isInitializing: true)
    alt isInitializing == true
        Hook->>ProgressStore: updateProgress({workspaceId, projectId, step: "pending", message: "Preparing..."})
        ProgressStore-->>UI: Emits optimistic progress
    end
    Hook->>QueryCache: Invalidate workspace queries
    QueryCache-->>UI: Refreshed workspace list
    UI->>User: Shows initializing state (delays interrupted UI by 500ms)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

feat(desktop): streaming workspace creation UX #580 — Related to workspace initialization flow and progress updates; touches overlapping init/progress logic.
Add config.json onboarding flow for workspace setup scripts #224 — Related changes to the workspace creation onSuccess flow and UX for creation (toasts/config handling), modifying same hook area.

Poem

🐰
A tiny hop, a task begun,
"Preparing..." hums before the sun.
I plant a progress, soft and quick,
Delay the frown, make setup slick.
✨🥕

🚥 Pre-merge checks | ❌ 3

❌ Failed checks (2 warnings, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is incomplete; it contains only the template structure with most sections left blank, including Description, Related Issues, Testing, and Additional Notes.	Fill in the Description section explaining the optimistic progress handling and interrupted state display logic, add Related Issues links, and provide testing steps to verify the fix works correctly.
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	The title is unclear and contains a grammatical error; 'flash render of setup script not setup' is vague and difficult to understand without additional context.	Clarify the title to better describe the actual change, such as 'fix (desktop): add delayed display for interrupted workspace setup state' to accurately reflect the modifications.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

apps/desktop/src/renderer/screens/main/components/WorkspaceView/WorkspaceInitializingView/WorkspaceInitializingView.tsx (1)
47-56: Extract magic number to a named constant.

The 500ms delay value should be extracted to a named constant at the module level for clarity and maintainability. As per coding guidelines, magic numbers should be named constants.
Suggested fix

Add constant at module top (after imports):
/** Delay before showing interrupted UI to avoid flash during normal creation */
const INTERRUPTED_UI_DELAY_MS = 500;
Then update the effect:
 	useEffect(() => {
 		if (isInterrupted && !progress) {
-			const timer = setTimeout(() => setShowInterruptedUI(true), 500);
+			const timer = setTimeout(() => setShowInterruptedUI(true), INTERRUPTED_UI_DELAY_MS);
 			return () => clearTimeout(timer);
 		}
 		setShowInterruptedUI(false);
 	}, [isInterrupted, progress]);

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 425cae4 and 6bda2c8.

📒 Files selected for processing (2)

apps/desktop/src/renderer/react-query/workspaces/useCreateWorkspace.ts
apps/desktop/src/renderer/screens/main/components/WorkspaceView/WorkspaceInitializingView/WorkspaceInitializingView.tsx

🚧 Files skipped from review as they are similar to previous changes (1)

apps/desktop/src/renderer/react-query/workspaces/useCreateWorkspace.ts

🧰 Additional context used

📓 Path-based instructions (6)

apps/desktop/**/*.{ts,tsx}

📄 CodeRabbit inference engine (apps/desktop/AGENTS.md)

apps/desktop/**/*.{ts,tsx}: For Electron interprocess communication, ALWAYS use tRPC as defined in src/lib/trpc
Use alias as defined in tsconfig.json when possible
Prefer zustand for state management if it makes sense. Do not use effect unless absolutely necessary.
For tRPC subscriptions with trpc-electron, ALWAYS use the observable pattern from @trpc/server/observable instead of async generators, as the library explicitly checks isObservable(result) and throws an error otherwise

Files:

apps/desktop/src/renderer/screens/main/components/WorkspaceView/WorkspaceInitializingView/WorkspaceInitializingView.tsx

**/*.{ts,tsx}