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 cancel button of class performance config modal #5159

Closed
wants to merge 1 commit into from

Conversation

imanjra
Copy link
Contributor

@imanjra imanjra commented Nov 20, 2024

What changes are proposed in this pull request?

fix cancel button of class performance config modal

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

(Details)

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

    • Introduced enhanced dialog handling for class performance and confusion matrix configurations.
    • Updated dialog components for editing notes and configurations to improve user interaction.
  • Improvements

    • Refined state management for dialog components to ensure accurate configuration application.
    • Enhanced type safety with the addition of EvaluationProps for better clarity in component properties.

@imanjra imanjra requested a review from a team November 20, 2024 03:43
Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

Walkthrough

The pull request introduces modifications to the Evaluation component in Evaluation.tsx, focusing on dialog handling for class performance and confusion matrix configurations. Key updates include renaming functions for clarity, enhancing state management, and defining the EvaluationProps type for improved type safety. The changes ensure that dialog components interact correctly with the updated state variables, maintaining the component's functionality while refining user interactions and data handling.

Changes

File Change Summary
app/packages/core/src/plugins/SchemaIO/components/NativeModelEvaluationView/Evaluation.tsx - Updated dialog handling for class performance and confusion matrix configurations.
- Renamed closeConfusionMatrixConfigDialog to closeClassPerformanceConfigDialog.
- Enhanced state management and user interaction for dialog components.
- Defined EvaluationProps type for better type safety.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • Br2850

Poem

🐇 In the meadow where metrics play,
Dialogs dance in a bright new way.
With states aligned and props defined,
Performance blooms, and clarity's kind.
Hooray for changes, fresh and spry,
In the world of code, we happily hop high! 🌼


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

🧹 Outside diff range and nitpick comments (3)
app/packages/core/src/plugins/SchemaIO/components/NativeModelEvaluationView/Evaluation.tsx (3)

Line range hint 1353-1364: Improve type safety for component props

The EvaluationProps type definition could be enhanced for better type safety:

 type EvaluationProps = {
   name: string;
   id: string;
   navigateBack: () => void;
   loadEvaluation: (key?: string) => void;
   onChangeCompareKey: (compareKey: string) => void;
   compareKey?: string;
-  data: any;
+  data: {
+    evaluations?: Array<{ key: string }>;
+    permissions?: { can_edit_note?: boolean; can_edit_status?: boolean };
+    [key: `evaluation_${string}`]: unknown;
+  };
-  setStatusEvent: string;
-  setNoteEvent: string;
+  setStatusEvent: (params: { status: string }) => void;
+  setNoteEvent: (params: { note: string }) => void;
   statuses: Record<string, string>;
   notes: Record<string, string>;
   loadView: (type: string, params: any) => void;
 };

Line range hint 42-56: Consider consolidating dialog-related states

The state management for dialogs could be simplified by combining related states:

-  const [classPerformanceConfig, setClassPerformanceConfig] =
-    useState<PLOT_CONFIG_TYPE>({});
-  const [classPerformanceDialogConfig, setClassPerformanceDialogConfig] =
-    useState<PLOT_CONFIG_DIALOG_TYPE>(DEFAULT_BAR_CONFIG);
+  const [classPerformanceState, setClassPerformanceState] = useState({
+    config: {} as PLOT_CONFIG_TYPE,
+    dialogConfig: DEFAULT_BAR_CONFIG as PLOT_CONFIG_DIALOG_TYPE,
+    isOpen: false
+  });

This would reduce state updates and make the relationship between dialog state and configuration more explicit.


Line range hint 1166-1352: Consider extracting dialog components for better maintainability

The dialog components could be extracted into separate components to improve code organization and reusability:

+ const EditNoteDialog = ({ open, onClose, onSave, defaultValue }) => (
+   <Dialog open={open} fullWidth onClose={onClose}>
+     {/* ... existing dialog content ... */}
+   </Dialog>
+ );

+ const ClassPerformanceConfigDialog = ({ open, onClose, onSave, config }) => (
+   <Dialog open={open} fullWidth onClose={onClose}>
+     {/* ... existing dialog content ... */}
+   </Dialog>
+ );

  return (
    <Stack spacing={2} sx={{ p: 2 }}>
      {/* ... other content ... */}
-     <Dialog open={editNoteState.open} /* ... */}>
-       {/* ... dialog content ... */}
-     </Dialog>
+     <EditNoteDialog
+       open={editNoteState.open}
+       onClose={closeNoteDialog}
+       onSave={(note) => triggerEvent(setNoteEvent, { note })}
+       defaultValue={evaluationNotes}
+     />
      {/* ... similar for other dialogs ... */}
    </Stack>
  );

This would:

  1. Improve code readability
  2. Make the dialogs more reusable
  3. Reduce the complexity of the main component
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9967d21 and db59a37.

📒 Files selected for processing (1)
  • app/packages/core/src/plugins/SchemaIO/components/NativeModelEvaluationView/Evaluation.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/packages/core/src/plugins/SchemaIO/components/NativeModelEvaluationView/Evaluation.tsx (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 (1)
app/packages/core/src/plugins/SchemaIO/components/NativeModelEvaluationView/Evaluation.tsx (1)

1353-1353: LGTM: Dialog handlers are properly implemented

The cancel button for the class performance config modal is correctly wired to the close handler, addressing the PR's objective.

@imanjra
Copy link
Contributor Author

imanjra commented Nov 20, 2024

Closing in favour of #5166

@imanjra imanjra closed this Nov 20, 2024
@imanjra imanjra deleted the bugfix/class-perf-config-cancel branch November 20, 2024 18:32
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