Open
Conversation
Co-authored-by: sawka <2722291+sawka@users.noreply.github.com>
Co-authored-by: sawka <2722291+sawka@users.noreply.github.com>
Co-authored-by: sawka <2722291+sawka@users.noreply.github.com>
Co-authored-by: sawka <2722291+sawka@users.noreply.github.com>
Contributor
WalkthroughThis pull request introduces a preview mode feature for the application. The changes add infrastructure to support a preview environment including a mock Electron API layer, preview-specific window type initialization gating, mock object handling in the WaveObj store, and refactored initialization flow using global state management. Additionally, the telemetry update function is propagated as a prop through the onboarding component, and supporting type definitions are extended to include an isPreview flag. The ESLint configuration is also updated to broaden unused variable ignore patterns. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes 🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
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. Comment |
Deploying waveterm with
|
| Latest commit: |
00a1d26
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e86a82dd.waveterm.pages.dev |
| Branch Preview URL: | https://sawka-preview-updates.waveterm.pages.dev |
Contributor
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (7 files)
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@frontend/preview/preview-electron-api.ts`:
- Around line 4-61: The previewElectronApi object is missing the required async
method setIsActive defined by the ElectronApi interface; add setIsActive: () =>
Promise<void> to previewElectronApi (e.g., implement a stub that returns
Promise.resolve() or an async no-op) so the object satisfies the type
contract—update the previewElectronApi declaration to include this method
alongside the other functions.
In `@frontend/preview/preview.tsx`:
- Line 138: Replace the unsafe cast "{} as FullConfigType" used in
globalStore.set(getAtoms().fullConfigAtom, {} as FullConfigType) with a
structurally complete default that matches FullConfigType (e.g., include default
presets array and default settings object or use an exported
DEFAULT_FULL_CONFIG). Update the initialization so fullConfig.presets and
fullConfig.settings are defined (either create and use a DEFAULT_FULL_CONFIG
constant or import an existing default) before calling globalStore.set to avoid
runtime property access errors.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: e8547e9e-3db6-401b-ac3e-86e84238962c
📒 Files selected for processing (9)
eslint.config.jsfrontend/app/onboarding/onboarding.tsxfrontend/app/store/client-model.tsfrontend/app/store/global-atoms.tsfrontend/app/store/wos.tsfrontend/preview/preview-electron-api.tsfrontend/preview/preview.tsxfrontend/preview/previews/onboarding.preview.tsxfrontend/types/custom.d.ts
Comment on lines
+4
to
+61
| const previewElectronApi: ElectronApi = { | ||
| getAuthKey: () => "", | ||
| getIsDev: () => false, | ||
| getCursorPoint: () => ({ x: 0, y: 0 } as Electron.Point), | ||
| getPlatform: () => "darwin", | ||
| getEnv: (_varName: string) => "", | ||
| getUserName: () => "", | ||
| getHostName: () => "", | ||
| getDataDir: () => "", | ||
| getConfigDir: () => "", | ||
| getHomeDir: () => "", | ||
| getWebviewPreload: () => "", | ||
| getAboutModalDetails: () => ({} as AboutModalDetails), | ||
| getZoomFactor: () => 1.0, | ||
| showWorkspaceAppMenu: (_workspaceId: string) => {}, | ||
| showBuilderAppMenu: (_builderId: string) => {}, | ||
| showContextMenu: (_workspaceId: string, _menu: ElectronContextMenuItem[]) => {}, | ||
| onContextMenuClick: (_callback: (id: string | null) => void) => {}, | ||
| onNavigate: (_callback: (url: string) => void) => {}, | ||
| onIframeNavigate: (_callback: (url: string) => void) => {}, | ||
| downloadFile: (_path: string) => {}, | ||
| openExternal: (_url: string) => {}, | ||
| onFullScreenChange: (_callback: (isFullScreen: boolean) => void) => {}, | ||
| onZoomFactorChange: (_callback: (zoomFactor: number) => void) => {}, | ||
| onUpdaterStatusChange: (_callback: (status: UpdaterStatus) => void) => {}, | ||
| getUpdaterStatus: () => "up-to-date", | ||
| getUpdaterChannel: () => "", | ||
| installAppUpdate: () => {}, | ||
| onMenuItemAbout: (_callback: () => void) => {}, | ||
| updateWindowControlsOverlay: (_rect: Dimensions) => {}, | ||
| onReinjectKey: (_callback: (waveEvent: WaveKeyboardEvent) => void) => {}, | ||
| setWebviewFocus: (_focusedId: number) => {}, | ||
| registerGlobalWebviewKeys: (_keys: string[]) => {}, | ||
| onControlShiftStateUpdate: (_callback: (state: boolean) => void) => {}, | ||
| createWorkspace: () => {}, | ||
| switchWorkspace: (_workspaceId: string) => {}, | ||
| deleteWorkspace: (_workspaceId: string) => {}, | ||
| setActiveTab: (_tabId: string) => {}, | ||
| createTab: () => {}, | ||
| closeTab: (_workspaceId: string, _tabId: string, _confirmClose: boolean) => Promise.resolve(false), | ||
| setWindowInitStatus: (_status: "ready" | "wave-ready") => {}, | ||
| onWaveInit: (_callback: (initOpts: WaveInitOpts) => void) => {}, | ||
| onBuilderInit: (_callback: (initOpts: BuilderInitOpts) => void) => {}, | ||
| sendLog: (_log: string) => {}, | ||
| onQuicklook: (_filePath: string) => {}, | ||
| openNativePath: (_filePath: string) => {}, | ||
| captureScreenshot: (_rect: Electron.Rectangle) => Promise.resolve(""), | ||
| setKeyboardChordMode: () => {}, | ||
| clearWebviewStorage: (_webContentsId: number) => Promise.resolve(), | ||
| setWaveAIOpen: (_isOpen: boolean) => {}, | ||
| closeBuilderWindow: () => {}, | ||
| incrementTermCommands: (_opts?: { isRemote?: boolean; isWsl?: boolean; isDurable?: boolean }) => {}, | ||
| nativePaste: () => {}, | ||
| openBuilder: (_appId?: string) => {}, | ||
| setBuilderWindowAppId: (_appId: string) => {}, | ||
| doRefresh: () => {}, | ||
| saveTextFile: (_fileName: string, _content: string) => Promise.resolve(false), | ||
| }; |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
python - <<'PY'
import re, pathlib
type_src = pathlib.Path("frontend/types/custom.d.ts").read_text()
mock_src = pathlib.Path("frontend/preview/preview-electron-api.ts").read_text()
type_block = re.search(r'type ElectronApi = \{(.*?)\n\s*\};', type_src, re.S)
mock_block = re.search(r'const previewElectronApi:\s*ElectronApi\s*=\s*\{(.*?)\n\};', mock_src, re.S)
if not type_block or not mock_block:
raise SystemExit("Could not locate ElectronApi type or previewElectronApi object.")
type_members = set(re.findall(r'^\s*([A-Za-z_]\w*)\s*[:(]', type_block.group(1), re.M))
mock_members = set(re.findall(r'^\s*([A-Za-z_]\w*)\s*:', mock_block.group(1), re.M))
print("Missing members in previewElectronApi:", sorted(type_members - mock_members))
print("Extra members in previewElectronApi:", sorted(mock_members - type_members))
PYRepository: wavetermdev/waveterm
Length of output: 158
🏁 Script executed:
cat frontend/types/custom.d.ts | grep -A 500 "type ElectronApi"Repository: wavetermdev/waveterm
Length of output: 14237
🏁 Script executed:
find . -path ".kilocode/skills/electron-api/SKILL.md" -o -path ".kilocode/skills/electron-api/*" | head -20Repository: wavetermdev/waveterm
Length of output: 46
Implement missing setIsActive method in previewElectronApi.
The object declared as type ElectronApi at line 4 is missing the setIsActive: () => Promise<void> method required by the type contract in frontend/types/custom.d.ts.
Fix
const previewElectronApi: ElectronApi = {
doRefresh: () => {},
saveTextFile: (_fileName: string, _content: string) => Promise.resolve(false),
+ setIsActive: () => Promise.resolve(),
};📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| const previewElectronApi: ElectronApi = { | |
| getAuthKey: () => "", | |
| getIsDev: () => false, | |
| getCursorPoint: () => ({ x: 0, y: 0 } as Electron.Point), | |
| getPlatform: () => "darwin", | |
| getEnv: (_varName: string) => "", | |
| getUserName: () => "", | |
| getHostName: () => "", | |
| getDataDir: () => "", | |
| getConfigDir: () => "", | |
| getHomeDir: () => "", | |
| getWebviewPreload: () => "", | |
| getAboutModalDetails: () => ({} as AboutModalDetails), | |
| getZoomFactor: () => 1.0, | |
| showWorkspaceAppMenu: (_workspaceId: string) => {}, | |
| showBuilderAppMenu: (_builderId: string) => {}, | |
| showContextMenu: (_workspaceId: string, _menu: ElectronContextMenuItem[]) => {}, | |
| onContextMenuClick: (_callback: (id: string | null) => void) => {}, | |
| onNavigate: (_callback: (url: string) => void) => {}, | |
| onIframeNavigate: (_callback: (url: string) => void) => {}, | |
| downloadFile: (_path: string) => {}, | |
| openExternal: (_url: string) => {}, | |
| onFullScreenChange: (_callback: (isFullScreen: boolean) => void) => {}, | |
| onZoomFactorChange: (_callback: (zoomFactor: number) => void) => {}, | |
| onUpdaterStatusChange: (_callback: (status: UpdaterStatus) => void) => {}, | |
| getUpdaterStatus: () => "up-to-date", | |
| getUpdaterChannel: () => "", | |
| installAppUpdate: () => {}, | |
| onMenuItemAbout: (_callback: () => void) => {}, | |
| updateWindowControlsOverlay: (_rect: Dimensions) => {}, | |
| onReinjectKey: (_callback: (waveEvent: WaveKeyboardEvent) => void) => {}, | |
| setWebviewFocus: (_focusedId: number) => {}, | |
| registerGlobalWebviewKeys: (_keys: string[]) => {}, | |
| onControlShiftStateUpdate: (_callback: (state: boolean) => void) => {}, | |
| createWorkspace: () => {}, | |
| switchWorkspace: (_workspaceId: string) => {}, | |
| deleteWorkspace: (_workspaceId: string) => {}, | |
| setActiveTab: (_tabId: string) => {}, | |
| createTab: () => {}, | |
| closeTab: (_workspaceId: string, _tabId: string, _confirmClose: boolean) => Promise.resolve(false), | |
| setWindowInitStatus: (_status: "ready" | "wave-ready") => {}, | |
| onWaveInit: (_callback: (initOpts: WaveInitOpts) => void) => {}, | |
| onBuilderInit: (_callback: (initOpts: BuilderInitOpts) => void) => {}, | |
| sendLog: (_log: string) => {}, | |
| onQuicklook: (_filePath: string) => {}, | |
| openNativePath: (_filePath: string) => {}, | |
| captureScreenshot: (_rect: Electron.Rectangle) => Promise.resolve(""), | |
| setKeyboardChordMode: () => {}, | |
| clearWebviewStorage: (_webContentsId: number) => Promise.resolve(), | |
| setWaveAIOpen: (_isOpen: boolean) => {}, | |
| closeBuilderWindow: () => {}, | |
| incrementTermCommands: (_opts?: { isRemote?: boolean; isWsl?: boolean; isDurable?: boolean }) => {}, | |
| nativePaste: () => {}, | |
| openBuilder: (_appId?: string) => {}, | |
| setBuilderWindowAppId: (_appId: string) => {}, | |
| doRefresh: () => {}, | |
| saveTextFile: (_fileName: string, _content: string) => Promise.resolve(false), | |
| }; | |
| const previewElectronApi: ElectronApi = { | |
| getAuthKey: () => "", | |
| getIsDev: () => false, | |
| getCursorPoint: () => ({ x: 0, y: 0 } as Electron.Point), | |
| getPlatform: () => "darwin", | |
| getEnv: (_varName: string) => "", | |
| getUserName: () => "", | |
| getHostName: () => "", | |
| getDataDir: () => "", | |
| getConfigDir: () => "", | |
| getHomeDir: () => "", | |
| getWebviewPreload: () => "", | |
| getAboutModalDetails: () => ({} as AboutModalDetails), | |
| getZoomFactor: () => 1.0, | |
| showWorkspaceAppMenu: (_workspaceId: string) => {}, | |
| showBuilderAppMenu: (_builderId: string) => {}, | |
| showContextMenu: (_workspaceId: string, _menu: ElectronContextMenuItem[]) => {}, | |
| onContextMenuClick: (_callback: (id: string | null) => void) => {}, | |
| onNavigate: (_callback: (url: string) => void) => {}, | |
| onIframeNavigate: (_callback: (url: string) => void) => {}, | |
| downloadFile: (_path: string) => {}, | |
| openExternal: (_url: string) => {}, | |
| onFullScreenChange: (_callback: (isFullScreen: boolean) => void) => {}, | |
| onZoomFactorChange: (_callback: (zoomFactor: number) => void) => {}, | |
| onUpdaterStatusChange: (_callback: (status: UpdaterStatus) => void) => {}, | |
| getUpdaterStatus: () => "up-to-date", | |
| getUpdaterChannel: () => "", | |
| installAppUpdate: () => {}, | |
| onMenuItemAbout: (_callback: () => void) => {}, | |
| updateWindowControlsOverlay: (_rect: Dimensions) => {}, | |
| onReinjectKey: (_callback: (waveEvent: WaveKeyboardEvent) => void) => {}, | |
| setWebviewFocus: (_focusedId: number) => {}, | |
| registerGlobalWebviewKeys: (_keys: string[]) => {}, | |
| onControlShiftStateUpdate: (_callback: (state: boolean) => void) => {}, | |
| createWorkspace: () => {}, | |
| switchWorkspace: (_workspaceId: string) => {}, | |
| deleteWorkspace: (_workspaceId: string) => {}, | |
| setActiveTab: (_tabId: string) => {}, | |
| createTab: () => {}, | |
| closeTab: (_workspaceId: string, _tabId: string, _confirmClose: boolean) => Promise.resolve(false), | |
| setWindowInitStatus: (_status: "ready" | "wave-ready") => {}, | |
| onWaveInit: (_callback: (initOpts: WaveInitOpts) => void) => {}, | |
| onBuilderInit: (_callback: (initOpts: BuilderInitOpts) => void) => {}, | |
| sendLog: (_log: string) => {}, | |
| onQuicklook: (_filePath: string) => {}, | |
| openNativePath: (_filePath: string) => {}, | |
| captureScreenshot: (_rect: Electron.Rectangle) => Promise.resolve(""), | |
| setKeyboardChordMode: () => {}, | |
| clearWebviewStorage: (_webContentsId: number) => Promise.resolve(), | |
| setWaveAIOpen: (_isOpen: boolean) => {}, | |
| closeBuilderWindow: () => {}, | |
| incrementTermCommands: (_opts?: { isRemote?: boolean; isWsl?: boolean; isDurable?: boolean }) => {}, | |
| nativePaste: () => {}, | |
| openBuilder: (_appId?: string) => {}, | |
| setBuilderWindowAppId: (_appId: string) => {}, | |
| doRefresh: () => {}, | |
| saveTextFile: (_fileName: string, _content: string) => Promise.resolve(false), | |
| setIsActive: () => Promise.resolve(), | |
| }; |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@frontend/preview/preview-electron-api.ts` around lines 4 - 61, The
previewElectronApi object is missing the required async method setIsActive
defined by the ElectronApi interface; add setIsActive: () => Promise<void> to
previewElectronApi (e.g., implement a stub that returns Promise.resolve() or an
async no-op) so the object satisfies the type contract—update the
previewElectronApi declaration to include this method alongside the other
functions.
| isPreview: true, | ||
| } as GlobalInitOptions; | ||
| initGlobalAtoms(initOpts); | ||
| globalStore.set(getAtoms().fullConfigAtom, {} as FullConfigType); |
Contributor
There was a problem hiding this comment.
Initialize fullConfigAtom with a structurally safe default, not {}.
Line 138 sets {} as FullConfigType; preview components that read fullConfig.presets/fullConfig.settings directly can throw at runtime.
🔧 Proposed fix
- globalStore.set(getAtoms().fullConfigAtom, {} as FullConfigType);
+ globalStore.set(
+ getAtoms().fullConfigAtom,
+ {
+ settings: {},
+ presets: {},
+ connections: {},
+ } as FullConfigType
+ );📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| globalStore.set(getAtoms().fullConfigAtom, {} as FullConfigType); | |
| globalStore.set( | |
| getAtoms().fullConfigAtom, | |
| { | |
| settings: {}, | |
| presets: {}, | |
| connections: {}, | |
| } as FullConfigType | |
| ); |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@frontend/preview/preview.tsx` at line 138, Replace the unsafe cast "{} as
FullConfigType" used in globalStore.set(getAtoms().fullConfigAtom, {} as
FullConfigType) with a structurally complete default that matches FullConfigType
(e.g., include default presets array and default settings object or use an
exported DEFAULT_FULL_CONFIG). Update the initialization so fullConfig.presets
and fullConfig.settings are defined (either create and use a DEFAULT_FULL_CONFIG
constant or import an existing default) before calling globalStore.set to avoid
runtime property access errors.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.