|
| 1 | +# Reload Toast: Persist + Show What Changed |
| 2 | + |
| 3 | +**Branch:** `feat/reload-toast-persist` |
| 4 | +**Priority:** P0 |
| 5 | + |
| 6 | +--- |
| 7 | + |
| 8 | +## Problems |
| 9 | + |
| 10 | +1. Toast disappears before user can click |
| 11 | +2. Toast is vague - just says "Reload required" without specifics |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## Current Code |
| 16 | + |
| 17 | +**File:** `packages/app/src/app/app.tsx` L1799-1834 |
| 18 | + |
| 19 | +```tsx |
| 20 | +const [reloadToastDismissedAt, setReloadToastDismissedAt] = createSignal<number | null>(null); |
| 21 | + |
| 22 | +const reloadToastVisible = createMemo(() => { |
| 23 | + if (!reloadRequired()) return false; // <-- Hides when reload not required |
| 24 | + const lastTriggeredAt = reloadLastTriggeredAt(); |
| 25 | + const dismissedAt = reloadToastDismissedAt(); |
| 26 | + if (!lastTriggeredAt) return true; |
| 27 | + if (!dismissedAt) return true; |
| 28 | + return dismissedAt < lastTriggeredAt; |
| 29 | +}); |
| 30 | +``` |
| 31 | + |
| 32 | +### Code findings |
| 33 | +- Reload state + reasons live in `packages/app/src/app/system-state.ts:40-45` (`reloadRequired`, `reloadReasons`, `reloadLastTriggeredAt`) |
| 34 | +- `markReloadRequired(reason)` only stores the reason string: `packages/app/src/app/system-state.ts:135-139` |
| 35 | +- `ReloadReason` is a fixed union: `packages/app/src/app/types.ts:202` (`"plugins" | "skills" | "mcp" | "config"`) |
| 36 | +- Tauri watcher emits `openwork://reload-required` with `{ reason, path }`: `packages/desktop/src-tauri/src/workspace/watch.rs:99-124` |
| 37 | +- UI listener drops `path` and only maps `reason`: `packages/app/src/app/app.tsx:1870-1902` |
| 38 | +- Explicit triggers: |
| 39 | + - Skills/plugins: `packages/app/src/app/context/extensions.ts:526,549,588,669,750` |
| 40 | + - MCP: `packages/app/src/app/app.tsx:2557` |
| 41 | + - Config/model change: `packages/app/src/app/app.tsx:3020,3034` |
| 42 | + - Tool-driven file writes: `packages/app/src/app/context/session.ts:141-193` |
| 43 | + |
| 44 | +--- |
| 45 | + |
| 46 | +## Changes Required |
| 47 | + |
| 48 | +### 1. Investigate why toast disappears |
| 49 | + |
| 50 | +Add logging to track state changes: |
| 51 | +```tsx |
| 52 | +createEffect(() => { |
| 53 | + console.log('[ReloadToast] reloadRequired:', reloadRequired()); |
| 54 | + console.log('[ReloadToast] lastTriggeredAt:', reloadLastTriggeredAt()); |
| 55 | + console.log('[ReloadToast] dismissedAt:', reloadToastDismissedAt()); |
| 56 | +}); |
| 57 | +``` |
| 58 | + |
| 59 | +Possible causes: |
| 60 | +- `reloadRequired()` becomes false prematurely (auto-reload?) |
| 61 | +- Page navigation clears state |
| 62 | +- Effect at L1830-1834 clears state |
| 63 | + |
| 64 | +**Other auto-clear sites:** |
| 65 | +- `clearReloadRequired()` in `packages/app/src/app/system-state.ts:141-145` |
| 66 | +- Successful reload clears state in `packages/app/src/app/system-state.ts:281-282` |
| 67 | +- Workspace change clears reload state in `packages/app/src/app/app.tsx:1928-1933` |
| 68 | + |
| 69 | +### 2. Track what triggered the reload |
| 70 | + |
| 71 | +**Update `markReloadRequired` to accept details:** |
| 72 | + |
| 73 | +```tsx |
| 74 | +type ReloadTrigger = { |
| 75 | + type: "skill" | "plugin" | "config" | "mcp"; |
| 76 | + name?: string; |
| 77 | +}; |
| 78 | + |
| 79 | +const [reloadTrigger, setReloadTrigger] = createSignal<ReloadTrigger | null>(null); |
| 80 | + |
| 81 | +const markReloadRequired = (reason: ReloadReason, trigger?: ReloadTrigger) => { |
| 82 | + markReloadRequiredRaw(reason); |
| 83 | + if (trigger) { |
| 84 | + setReloadTrigger(trigger); |
| 85 | + } |
| 86 | +}; |
| 87 | +``` |
| 88 | + |
| 89 | +**Note:** There is already a `path` in the Tauri event payload (`workspace/watch.rs:119-121`). We can parse it to a name (skill/plugin) and pass it as `trigger.name`. |
| 90 | + |
| 91 | +### 3. Update toast to show specific change |
| 92 | + |
| 93 | +**File:** `packages/app/src/app/components/reload-workspace-toast.tsx` |
| 94 | + |
| 95 | +Add `trigger` prop: |
| 96 | +```tsx |
| 97 | +export type ReloadWorkspaceToastProps = { |
| 98 | + // ... existing props |
| 99 | + trigger?: { type: string; name?: string } | null; |
| 100 | +}; |
| 101 | +``` |
| 102 | + |
| 103 | +Update description display: |
| 104 | +```tsx |
| 105 | +const getDescription = () => { |
| 106 | + if (!props.trigger) return props.description; |
| 107 | + const { type, name } = props.trigger; |
| 108 | + switch (type) { |
| 109 | + case "skill": |
| 110 | + return `Skill '${name}' was added. Reload to use it.`; |
| 111 | + case "plugin": |
| 112 | + return `Plugin '${name}' was added. Reload to activate.`; |
| 113 | + case "mcp": |
| 114 | + return `MCP '${name}' was added. Reload to connect.`; |
| 115 | + default: |
| 116 | + return "Config changed. Reload to apply."; |
| 117 | + } |
| 118 | +}; |
| 119 | +``` |
| 120 | + |
| 121 | +### 4. Update callers to pass trigger info |
| 122 | + |
| 123 | +Find all places that call `markReloadRequired` and add trigger details: |
| 124 | +- When skill is created: `markReloadRequired("skills", { type: "skill", name: skillName })` |
| 125 | +- When plugin is added: `markReloadRequired("plugins", { type: "plugin", name: pluginName })` |
| 126 | +- When MCP is added: `markReloadRequired("mcp", { type: "mcp", name: mcpName })` |
| 127 | + |
| 128 | +**Concrete hook points:** |
| 129 | +- Skills: `packages/app/src/app/context/extensions.ts:588,669,750` |
| 130 | +- Plugins: `packages/app/src/app/context/extensions.ts:526,549` |
| 131 | +- MCP: `packages/app/src/app/app.tsx:2557` |
| 132 | +- Config/model changes: `packages/app/src/app/app.tsx:3020,3034` |
| 133 | +- File watcher: `packages/app/src/app/app.tsx:1870-1902` (parse `event.payload.path`) |
| 134 | + |
| 135 | +--- |
| 136 | + |
| 137 | +## Toast behavior rules |
| 138 | + |
| 139 | +Toast should ONLY hide when: |
| 140 | +1. User clicks "Dismiss" |
| 141 | +2. User clicks "Reload" AND reload completes successfully |
| 142 | + |
| 143 | +Toast should NOT auto-hide on: |
| 144 | +- Timeout |
| 145 | +- Navigation |
| 146 | +- Any automatic state change |
| 147 | + |
| 148 | +--- |
| 149 | + |
| 150 | +## Testing |
| 151 | + |
| 152 | +1. Create a skill → verify toast shows "Skill 'X' was added" |
| 153 | +2. Add a plugin → verify toast shows "Plugin 'X' was added" |
| 154 | +3. Change config → verify toast shows "Config changed" |
| 155 | +4. Wait 30 seconds → verify toast still visible |
| 156 | +5. Click Dismiss → verify toast hides |
| 157 | +6. Trigger again → verify toast reappears |
0 commit comments