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

fix state scope missing in some panel hooks #4859

Merged
merged 1 commit into from
Sep 27, 2024

Conversation

imanjra
Copy link
Contributor

@imanjra imanjra commented Sep 27, 2024

What changes are proposed in this pull request?

Fixes state being lost due to missing scope in some spaces hook

How is this patch tested? If it is not, please explain why.

Using the Dashboard paenl

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • New Features

    • Improved state management for panels by dynamically determining the scope based on panel ID.
  • Bug Fixes

    • Enhanced type safety and clarity for panel ID to scope mapping.

@imanjra imanjra requested a review from ritch September 27, 2024 18:07
Copy link
Contributor

coderabbitai bot commented Sep 27, 2024

Walkthrough

The pull request modifies the panelStateSelector in the app/packages/spaces/src/state.ts file. It changes how the scope is determined when accessing the stateAtom, introducing a fallback mechanism that retrieves the scope from panelIdToScopeAtom if not provided. Additionally, the panelIdToScopeAtom is now explicitly typed, enhancing type safety. This adjustment alters the control flow for managing state across different panels.

Changes

File Path Change Summary
app/packages/spaces/src/state.ts - Updated panelIdToScopeAtom type to atom<PanelIdToScopeType>.
- Added type declaration for PanelIdToScopeType as an object mapping panelId strings to scope strings.

Possibly related PRs

Suggested reviewers

  • ritch

Poem

In the space where panels play,
A new scope finds its way.
With types so clear,
State flows without fear,
Hopping along, bright as day! 🐇✨


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 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.

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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 81037fa and d3960f8.

📒 Files selected for processing (1)
  • app/packages/spaces/src/state.ts (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/packages/spaces/src/state.ts (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

🔇 Additional comments (2)
app/packages/spaces/src/state.ts (2)

132-132: LGTM

The panelIdToScopeAtom is correctly declared with the appropriate type PanelIdToScopeType and a default empty object, enhancing type safety.


142-144: LGTM

The PanelIdToScopeType type is properly defined to map panelId strings to scope strings, improving clarity and maintainability.

Comment on lines +62 to +64
const fallbackScope = get(panelIdToScopeAtom)[panelId];
const computedScope = scope ?? fallbackScope;
const stateAtom = getStateAtom(local, computedScope);
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider refactoring duplicated logic in get and set functions

The logic for computing fallbackScope, computedScope, and stateAtom is repeated in both the get and set functions of panelStateSelector. Extracting this logic into a shared helper function would reduce code duplication and enhance maintainability.

Also applies to: 71-73

@brimoor brimoor merged commit 887654f into release/v1.0.0 Sep 27, 2024
11 checks passed
@brimoor brimoor deleted the bugfix/missing-panel-state-scope branch September 27, 2024 22:48
@coderabbitai coderabbitai bot mentioned this pull request Oct 10, 2024
7 tasks
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.

3 participants