Skip to content

Comments

Handle shareWithMe failures non-fatally in useWorkspaceData#157

Open
mcollard0 wants to merge 2 commits intoAppFlowy-IO:mainfrom
mcollard0:rcf-nonfatal-sharewithme
Open

Handle shareWithMe failures non-fatally in useWorkspaceData#157
mcollard0 wants to merge 2 commits intoAppFlowy-IO:mainfrom
mcollard0:rcf-nonfatal-sharewithme

Conversation

@mcollard0
Copy link

@mcollard0 mcollard0 commented Nov 17, 2025

In self-hosted AppFlowy deployments the share-with-me API ( /api/sharing/workspace/:id/folder ) may be disabled or unconfigured, which currently results in noisy errors when loading the workspace outline. This change updates useWorkspaceData to catch failures from service.getShareWithMe, surface the error on window.RCF_LAST_SHARE_WITH_ME_ERROR for debugging, and continue using the normal workspace outline when share-with-me fails.

Summary by Sourcery

Handle failures from the share-with-me service non-fatally in useWorkspaceData by catching errors, exposing the last error on window.RCF_LAST_SHARE_WITH_ME_ERROR for debugging, and falling back to the standard workspace outline.

Enhancements:

  • Treat share-with-me API errors as non-fatal to avoid noisy failures in self-hosted deployments
  • Store the last share-with-me error on window.RCF_LAST_SHARE_WITH_ME_ERROR for debugging purposes

@sourcery-ai
Copy link

sourcery-ai bot commented Nov 17, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Modify useWorkspaceData hook to gracefully handle share-with-me API failures by capturing the error to a global variable and proceeding with the standard workspace outline.

Sequence diagram for non-fatal shareWithMe API failure handling in useWorkspaceData

sequenceDiagram
    participant useWorkspaceData
    participant service
    participant window
    useWorkspaceData->>service: getShareWithMe()
    alt shareWithMe succeeds
        service-->>useWorkspaceData: shareWithMe data
        useWorkspaceData->>useWorkspaceData: Merge shareWithMe data into outline
    else shareWithMe fails
        service-->>useWorkspaceData: error
        useWorkspaceData->>window: Set __RCF_LAST_SHARE_WITH_ME_ERROR__
        useWorkspaceData->>useWorkspaceData: Continue with main workspace outline
    end
Loading

File-Level Changes

Change Details Files
Non-fatal shareWithMe error handling
  • Catch exceptions from service.getShareWithMe and log using console.error
  • Assign the caught error to window.RCF_LAST_SHARE_WITH_ME_ERROR for debugging
  • Enhance comments to explain self-hosted fallback and continue with the main outline
src/components/app/hooks/useWorkspaceData.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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