voxel51 / fiftyone

Refine high-quality datasets and visual AI models
https://fiftyone.ai
Apache License 2.0
8.72k stars 551 forks source link

Improve/fix modal navigation #4655

Closed benjaminpkane closed 1 month ago

benjaminpkane commented 1 month ago

What changes are proposed in this pull request?

Fixes modal navigation during prolonged use

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

Navigating all 200 quickstart samples from start to finish to start.

What areas of FiftyOne does this PR affect?

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!IMPORTANT]

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (2) * `docs/source/images/app/app-clip-views1.gif` is excluded by `!**/*.gif`, `!**/*.gif` * `docs/source/images/app/app-clip-views2.gif` is excluded by `!**/*.gif`, `!**/*.gif`

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates enhance user interaction and streamline code clarity across the application. New constants like SLOW_DOWN were introduced to manage excessive clicking behavior, while the control flow in various components was improved for better error handling. Additionally, iteration and state management structures were refined, resulting in a more robust and user-friendly experience.

Changes

Files Change Summary
.../spotlight/src/constants.ts Added constant SLOW_DOWN for managing excessive clicks and ZOOM_TIMEOUT for zoom functionality.
.../spotlight/src/createScrollReader.ts Simplified scrolling management; removed unnecessary state variables for improved efficiency.
.../spotlight/src/index.ts Adjusted logic in the Spotlight class for better control flow and readability; no functional changes.
.../spotlight/src/section.ts Enhanced error handling and navigation methods; integrated SLOW_DOWN for better control flow.
.../spotlight/src/iter.ts Introduced a new Iter class for iterating through data with enhanced rendering capabilities.
.../spotlight/src/row.ts Shifted from a function-based to an iteration-based approach in the Row class constructor.
.../state/src/hooks/useExpandSample.ts Refined cursor handling in next and previous functions for clearer state management.
.../core/src/components/Grid/recoil.ts Modified default value of gridZoomRange atom from [0, 10] to [-5, 10] for a broader zoom range.
.../core/src/components/Grid/useThreshold.ts Adjusted minimum threshold values to negative integers based on input width for improved calculations.
.../core/src/components/Grid/Grid.tsx Added cleanup logic to release resources associated with videos on component unmount.
.../core/src/components/Sidebar/Entries/PathValueEntry.tsx Added break statements to control flow in the format function to prevent fall-through behavior.
.../looker/src/elements/common/tags.ts Introduced TEMPORAL_DETECTION_RENDERER to enhance rendering of temporal detection labels.
.../utilities/src/index.ts Removed "TemporalDetection" from CLIPS_SAMPLE_FIELDS, focusing on pluralization for consistency.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Application
    participant Section

    User->>Application: Clicks rapidly
    Application->>Section: Check user interaction
    Section-->>Application: Respond with "slow down, you're clicking a lot"
    User->>Application: Corrects interaction
    Application->>Section: Processes valid request
    Section-->>Application: Returns results

πŸ‡ In a world of clicks so grand,
A gentle nudge, a guiding hand.
"Slow down," it softly cheers,
For joyful hops, not frantic fears.
With clearer paths, we leap and play,
In harmony, we'll find our way! 🌼


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
benjaminpkane commented 1 month ago

I like the addition of the Iter class, neat! It's a little hard to grok the relationship / ownership between different components - I guess an opportunity to improve spotlight's readme in the future.

Iter class worked out well, but is still a little disorganized. I can't be sure, but I believe this way Section instances will still be garbage collected because iteration is now scoped in a separate class. Would like to cleanup / move it out of Section and into Spotlight so only one instance is created per spotlight instance.