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

Fixed Bug #2455 #2991

Conversation

AryanSwaroop
Copy link

@AryanSwaroop AryanSwaroop commented Dec 28, 2024

What kind of change does this PR introduce?

Fixed User role not displaying bug in people section. This PR changes the interface that was causing mismatch.

Issue Number:

#2455

Did you add tests for your changes?

yes

Snapshots/Videos:

image

If relevant, did you update the documentation?

No , not relevant

Summary

The people section without any role looks empty and error full so this PR solves it , when users like me use this software.
#2455

Does this PR introduce a breaking change?

Np

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • New Features
    • Updated member role representation to use GraphQL typename instead of user-defined type.
  • Tests
    • Introduced new tests to ensure the structure of InterfaceMember is maintained.

Copy link
Contributor

coderabbitai bot commented Dec 28, 2024

Walkthrough

The pull request modifies the People component in the user portal by changing the InterfaceMember interface. The visibility of the interface is updated from private to public, and the userType property is replaced with __typename. This adjustment alters how member roles are represented in the PeopleCard component, now utilizing the GraphQL typename. The component's overall functionality, including pagination and filtering, remains unchanged.

Changes

File Change Summary
src/screens/UserPortal/People/People.tsx - Updated InterfaceMember interface: userType__typename
- Changed cardProps to use member.__typename for role assignment
src/screens/UserPortal/People/People.spec.tsx - Imported InterfaceMember type
- Added compareProperties function for property comparison
- Introduced tests for InterfaceMember properties

Possibly Related PRs

Suggested Reviewers

  • palisadoes
  • pranshugupta54

🐰 A Rabbit's Ode to Typename Change

From userType to typename we leap,
A GraphQL dance, a semantic sweep.
Interface shifts with gentle grace,
Roles now wear a new type's embrace.
Code evolves, yet purpose stays deep! 🔍


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

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

🧹 Nitpick comments (2)
src/screens/UserPortal/People/People.tsx (2)

31-31: Consider renaming or documenting __typename.

Currently, __typename might store a GraphQL type name rather than a human-readable role. If this property is genuinely intended for displaying the user’s role, you might rename it to something more explicit (e.g., roleType) or add a comment clarifying its usage. This will avoid confusion for future maintainers.


Line range hint 1-1: Adopt PascalCase for React components.

Your component is exported as a default function named people, but React convention suggests using PascalCase (e.g., People). Using a capital letter for the component name makes it more recognizable as a React component.

-export default function people(): JSX.Element {
+export default function People(): JSX.Element {
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c5a3000 and 29a422c.

📒 Files selected for processing (1)
  • src/screens/UserPortal/People/People.tsx (2 hunks)
🔇 Additional comments (1)
src/screens/UserPortal/People/People.tsx (1)

246-246: Confirm that __typename accurately reflects the user’s role.

Assigning member.__typename to the role field fixes the bug where the role was not displayed, but ensure you verify that __typename always corresponds to the user’s actual role. If the GraphQL field __typename is used for other logic or is more generic, consider adding a dedicated role field.

coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 28, 2024
Copy link

codecov bot commented Dec 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.09%. Comparing base (c5a3000) to head (6ce43fa).
Report is 32 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #2991       +/-   ##
=====================================================
+ Coverage             33.14%   89.09%   +55.95%     
=====================================================
  Files                   299      322       +23     
  Lines                  7429     8421      +992     
  Branches               1624     1839      +215     
=====================================================
+ Hits                   2462     7503     +5041     
+ Misses                 4762      676     -4086     
- Partials                205      242       +37     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Cioppolo14
Copy link
Contributor

@AryanSwaroop Please fix the first comment so that each issue listed automatically closes.

Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

Please add tests so that this doesn't happen again

@AryanSwaroop
Copy link
Author

sure ! on it

@AVtheking
Copy link
Contributor

Update your branch with latest upstream .
Add test so that it doesn't happens in future

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

🧹 Nitpick comments (1)
src/screens/UserPortal/People/People.spec.tsx (1)

171-177: Consider handling unexpected or null objects.
While compareProperties functions as intended, a null or unexpected object could throw a runtime error with Object.keys(). You could add a short-circuit condition to handle such cases gracefully.

 function compareProperties(
   expectedProps: string[],
   actualObject: object,
 ): boolean {
+  if (!actualObject || typeof actualObject !== 'object') {
+    return false;
+  }
   const actualProps = Object.keys(actualObject);
   return expectedProps.every((prop) => actualProps.includes(prop));
 }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 29a422c and 6ce43fa.

📒 Files selected for processing (2)
  • src/screens/UserPortal/People/People.spec.tsx (2 hunks)
  • src/screens/UserPortal/People/People.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/screens/UserPortal/People/People.tsx
🔇 Additional comments (2)
src/screens/UserPortal/People/People.spec.tsx (2)

14-14: Import usage looks good.
Bringing in InterfaceMember from ./People properly centralizes type definitions. Ensure that any further additions or refactorings in ./People continue to keep these types consistent.


179-224: Tests effectively validate interface properties.
These tests ensure the integrity of the InterfaceMember structure. However, consider adding a test that checks for empty arrays or partially filled objects to further improve coverage.

@palisadoes palisadoes merged commit 4713884 into PalisadoesFoundation:develop-postgres Dec 31, 2024
15 checks passed
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.

4 participants