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

externalize @fiftyone/plugins #4897

Merged
merged 1 commit into from
Oct 5, 2024

Conversation

sashankaryal
Copy link
Contributor

@sashankaryal sashankaryal commented Oct 4, 2024

This makes it so that fiftyone plugins can be referenced by JS panels.

Summary by CodeRabbit

  • New Features
    • Integrated the @fiftyone/plugins module into the global scope for enhanced accessibility across the application.
    • Added a new property __fop__ to the global Window interface for seamless usage of the fiftyone/plugins module.

Copy link
Contributor

coderabbitai bot commented Oct 4, 2024

Walkthrough

The changes introduce a new import for the @fiftyone/plugins module, assigning it to the alias fop. The global Window interface is modified to include a new property __fop__, which is typed as typeof fop. The code updates the window object to include this new property, enabling the integration of the fiftyone/plugins module throughout the application.

Changes

File Path Change Summary
app/packages/plugins/src/externalize.ts Added import for @fiftyone/plugins as fop; updated Window interface to include __fop__: typeof fop; assigned window.__fop__ to fop.

Possibly related PRs

  • overridable panel not found component #4522: The changes in this PR involve modifications to the plugin system in the FiftyOne application, which may relate to the integration of the @fiftyone/plugins module in the main PR.

🐰 In the code, a new friend appears,
Fop hops in, spreading cheer!
With __fop__ on the window wide,
Plugins now can take a ride!
Let’s celebrate this joyful change,
In our code, it’s not so strange! 🐇✨


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.

@sashankaryal sashankaryal changed the base branch from develop to release/v1.0.1 October 4, 2024 23:50
@sashankaryal sashankaryal requested a review from a team October 4, 2024 23:50
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 and nitpick comments (2)
app/packages/plugins/src/externalize.ts (2)

23-23: LGTM: Window interface updated for FiftyOne plugins

The global Window interface is correctly updated to include the __fop__ property for FiftyOne plugins. This change is consistent with how other FiftyOne modules are handled and supports the PR objective.

Consider documenting the reason for using double underscores in property names, as this convention typically indicates internal or private properties. While it's consistent with other properties in this file, it might be worth explaining this choice for future maintainers.


41-41: LGTM: Global assignment for FiftyOne plugins added

The assignment of the fop module to window.__fop__ is correctly implemented, making the FiftyOne plugins available globally. This change directly supports the PR objective and is consistent with how other modules are handled.

Consider grouping related assignments together for better code organization. For instance, you could move this line up to be adjacent to other FiftyOne module assignments (like __fos__, __foc__, etc.) rather than placing it between __mui__ and __styled__.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a2d26f0 and 2210188.

📒 Files selected for processing (1)
  • app/packages/plugins/src/externalize.ts (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/packages/plugins/src/externalize.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/plugins/src/externalize.ts (2)

6-6: LGTM: Import statement for FiftyOne plugins added

The import statement for @fiftyone/plugins is correctly added and follows the established naming convention used for other FiftyOne modules. This change aligns with the PR objective of enabling the referencing of FiftyOne plugins.


Line range hint 1-43: Summary: FiftyOne plugins successfully externalized

The changes in this file successfully implement the externalization of the FiftyOne plugins module. The implementation is consistent with the existing code patterns and directly supports the PR objective. The import, global interface modification, and window assignment are all correctly implemented.

Minor suggestions were made regarding code organization and documentation, but these are not critical issues. Overall, the changes look good and achieve the intended goal of enabling the referencing of FiftyOne plugins by JavaScript panels.

@sashankaryal sashankaryal merged commit 46c1929 into release/v1.0.1 Oct 5, 2024
11 checks passed
@sashankaryal sashankaryal deleted the fix/plugin-externalization branch October 5, 2024 00:31
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.

2 participants