Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stat File Error Overlay and Clear Errors on Connection Change #1997

Merged
merged 4 commits into from
Feb 20, 2025

Conversation

oneirocosm
Copy link
Member

This adds two small features:

  • if a backend file stat operation fails, an error overlay is shown on the frontend
  • for all frontend error overlays, if the connection changes, the error is cleared

Copy link
Contributor

coderabbitai bot commented Feb 19, 2025

Walkthrough

The changes modify the error handling in the statFile and fullFile functions within the PreviewModel class. Both functions have been updated to implement try-catch blocks, which capture exceptions during API calls to RpcApi.FileInfoCommand and RpcApi.FileReadCommand. When an error occurs, the errorMsgAtom state is updated with a "File Read Failed" message and the specifics of the error. Additionally, a new connection atom is introduced in the PreviewView component to track the connection status. An effect hook is added to reset the error message whenever the connection state changes, ensuring that previous error messages are cleared. These changes enhance error management in file operations and improve the user interface's response to connection status updates.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🔭 Outside diff range comments (1)
frontend/app/view/preview/preview.tsx (1)

414-435: ⚠️ Potential issue

Return null when file read fails.

The error handling is good, but the function should return null when an error occurs to prevent undefined behavior in the consuming code.

Apply this diff to fix the error case:

 const fullFileAtom = atom<Promise<FileData>>(async (get) => {
     const fileName = get(this.metaFilePath);
     const path = await this.formatRemoteUri(fileName, get);
     if (fileName == null) {
         return null;
     }
     let file: FileData;
     try {
         file = await RpcApi.FileReadCommand(TabRpcClient, {
             info: {
                 path,
             },
         });
+        return file;
     } catch (e) {
         const errorStatus: ErrorMsg = {
             status: "File Read Failed",
             text: `${e}`,
         };
         globalStore.set(this.errorMsgAtom, errorStatus);
+        return null;
     }
-    return file;
 });
🧹 Nitpick comments (1)
frontend/app/view/preview/preview.tsx (1)

1240-1240: Optimize UUID generation in render cycle.

Using crypto.randomUUID() directly in the render cycle can impact performance as it generates a new UUID on every render. Consider moving the UUID generation to the button definition or using a stable index.

Apply this diff to use the array index as a stable key:

-key={crypto.randomUUID()}
+key={`error-button-${index}`}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce9775c and f61b52f.

📒 Files selected for processing (1)
  • frontend/app/view/preview/preview.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Build for TestDriver.ai
  • GitHub Check: Analyze (go)
🔇 Additional comments (2)
frontend/app/view/preview/preview.tsx (2)

391-404: LGTM! Error handling is well implemented.

The try-catch block properly captures file stat operation errors and updates the error state with a clear message structure.


1074-1078: LGTM! Connection state management is well implemented.

The effect properly clears error messages when the connection changes, preventing stale error states from persisting.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
frontend/app/view/preview/preview.tsx (2)

385-405: Standardize error handling across RPC calls.

The error handling in statFile and fullFile functions is duplicated. Consider extracting the common error handling logic into a reusable function to improve maintainability and ensure consistent error reporting.

+const handleRpcError = (error: Error, errorMsgAtom: PrimitiveAtom<ErrorMsg>) => {
+  const errorStatus: ErrorMsg = {
+    status: "File Read Failed",
+    text: `${error}`,
+  };
+  globalStore.set(errorMsgAtom, errorStatus);
+};

 async statFile() {
   try {
     const statFile = await RpcApi.FileInfoCommand(TabRpcClient, {
       info: { path },
     });
     return statFile;
   } catch (e) {
-    const errorStatus: ErrorMsg = {
-      status: "File Read Failed",
-      text: `${e}`,
-    };
-    globalStore.set(this.errorMsgAtom, errorStatus);
+    handleRpcError(e, this.errorMsgAtom);
   }
 }

 async fullFile() {
   try {
     const file = await RpcApi.FileReadCommand(TabRpcClient, {
       info: { path },
     });
     return file;
   } catch (e) {
-    const errorStatus: ErrorMsg = {
-      status: "File Read Failed",
-      text: `${e}`,
-    };
-    globalStore.set(this.errorMsgAtom, errorStatus);
+    handleRpcError(e, this.errorMsgAtom);
   }
 }

Also applies to: 414-434


1073-1077: Use a more descriptive variable name for connection state.

The variable name connection could be more descriptive to indicate it represents the immediate connection state.

-const connection = useAtomValue(model.connectionImmediate);
+const currentConnectionState = useAtomValue(model.connectionImmediate);

 useEffect(() => {
   setErrorMsg(null);
-}, [connection]);
+}, [currentConnectionState]);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f61b52f and 3e33b0b.

📒 Files selected for processing (1)
  • frontend/app/view/preview/preview.tsx (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Build for TestDriver.ai
  • GitHub Check: Analyze (go)
🔇 Additional comments (1)
frontend/app/view/preview/preview.tsx (1)

1193-1263: Well-implemented error overlay component!

The ErrorOverlay component is well-structured with:

  • Proper error message display and styling
  • Good UX features (copy to clipboard, dismiss button)
  • Support for custom buttons and error levels
  • Performance optimization using memo

@oneirocosm oneirocosm merged commit 1f43020 into main Feb 20, 2025
6 of 7 checks passed
@oneirocosm oneirocosm deleted the sylvie/stat-file-error branch February 20, 2025 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant