Skip to content

Conversation

Jack251970
Copy link
Member

Resolve #3716.

When reading file stream, we need to wrap it with try-catch sentence.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a try-catch block when reading and deserializing the file stream to handle exceptions during file access.

  • Wraps file stream reading and deserialization with a try-catch to resolve issue #3716.
  • Removes the internal try-catch in DeserializeAsync to let the outer block handle exceptions.

Copy link

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors and Warnings Count
❌ forbidden-pattern 22
⚠️ non-alpha-in-dictionary 13

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Copy link

gitstream-cm bot commented Jun 17, 2025

🥷 Code experts: no user but you matched threshold 10

Jack251970 has most 👩‍💻 activity in the files.
Jack251970 has most 🧠 knowledge in the files.

See details

Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs

Activity based on git-commit:

Jack251970
JUN
MAY
APR 91 additions & 37 deletions
MAR
FEB 9 additions & 16 deletions
JAN

Knowledge based on git-blame:
Jack251970: 59%

To learn more about /:\ gitStream - Visit our Docs

Copy link

gitstream-cm bot commented Jun 17, 2025

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

Copy link
Contributor

coderabbitai bot commented Jun 17, 2025

📝 Walkthrough

Walkthrough

The change adds explicit exception handling to the TryLoadAsync method in BinaryStorage.cs, ensuring that file access and deserialization errors are caught and logged. If an exception occurs, the method returns the default data instead of propagating the error. No public API signatures were altered.

Changes

File(s) Change Summary
Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs Added try-catch to TryLoadAsync for file open/deserialization; moved error handling from DeserializeAsync to caller.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant BinaryStorage
    participant FileSystem
    participant Logger

    Caller->>BinaryStorage: TryLoadAsync(defaultData)
    BinaryStorage->>FileSystem: Open file stream
    alt File access succeeds
        BinaryStorage->>BinaryStorage: DeserializeAsync(stream)
        BinaryStorage->>Caller: Return deserialized data
    else Exception occurs
        BinaryStorage->>Logger: Log exception
        BinaryStorage->>Caller: Return defaultData
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Prevent unhandled UnauthorizedAccessException for cache file access (#3716)
Ensure exceptions during file open/deserialization are caught and logged (#3716)

Suggested labels

bug

Suggested reviewers

  • jjw24

Poem

A bug in the cache, a file locked tight,
Now handled with care, no more fright!
Exceptions are caught, the logs will show,
Default data returned, onward we go.
🐇✨
Flowing along, the launcher’s delight!

✨ 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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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

🧹 Nitpick comments (1)
Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs (1)

91-95: Minor async library nit – add ConfigureAwait(false)

DeserializeAsync is library/infra code and not UI-context bound; using ConfigureAwait(false) avoids incidental capturing of a synchronization context:

-var t = await MemoryPackSerializer.DeserializeAsync<T>(stream);
+var t = await MemoryPackSerializer.DeserializeAsync<T>(stream)
+                       .ConfigureAwait(false);

Small but standard for low-level libs.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3688837 and 7383beb.

📒 Files selected for processing (1)
  • Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: build
🔇 Additional comments (1)
Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs (1)

69-79: Here’s a quick inspection of the storage class to confirm its serialization and I/O patterns before updating the comment:

#!/bin/bash
set -eu
# Locate BinaryStorage.cs
FILE=$(fd BinaryStorage.cs | head -n1)
echo "File: $FILE"
echo "------ Head of file (first 50 lines) ------"
head -n 50 "$FILE"
echo
echo "------ Context around DeserializeAsync ------"
grep -n -C3 "DeserializeAsync" "$FILE"
echo
echo "------ Context around SaveAsync ------"
grep -n -C3 "SaveAsync" "$FILE"

@Jack251970 Jack251970 closed this Jun 17, 2025
auto-merge was automatically disabled June 17, 2025 15:12

Pull request was closed

@Jack251970 Jack251970 deleted the try_catch_when_loading branch June 17, 2025 15:12
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.

BUG: UnauthorizedAccessException for Cache Files

1 participant