'Visit' Button Feature Added to Joined Organizations Filter #3232

gkbishnoi07 · 2025-01-10T00:44:26Z

What kind of change does this PR introduce?
Feature

Issue Number:
Fixes #3162

Did you add tests for your changes?
No

Snapshots/Videos:

issue.3162.mp4

Summary
This PR introduces a 'Visit' button in the Joined Organizations filter.

Enhances the user experience by providing direct navigation to organizations from the filter.
Solves the issue of limited navigation options in the Joined Organizations section.

Does this PR introduce a breaking change?
No

Other information

The feature was tested in multiple scenarios to ensure seamless functionality.

Have you read the contributing guide?
Yes

Summary by CodeRabbit

Tests
- Enhanced unit tests for the OrganizationCard component with comprehensive scenarios, including rendering variations and button visibility based on membership status.
- Improved test suite for OrganizationTags with better mock functions and more robust testing of user interactions.
New Features
- Added more detailed organization membership management functionality, including joining and withdrawing requests.
- Introduced isJoined property to track organization membership status.
- Added a new script for formatting files using Prettier.
Bug Fixes
- Improved error handling for organization membership interactions, providing better feedback to users.
Chores
- Updated the Organizations component name for consistency and improved clarity.
- Revised component documentation for better clarity on props.
- Streamlined rendering logic in the Organizations component for enhanced user experience.

…he Talawa User Portal

…he User Portal

coderabbitai · 2025-01-10T00:44:34Z

Walkthrough

This pull request introduces comprehensive changes to the OrganizationCard component and its associated test suite. The modifications enhance the component's functionality by adding new properties like description, admins, members, and address, and improving membership request handling. The test suite has been updated to provide more robust coverage, testing various scenarios such as rendering with different membership statuses and button interactions.

Changes

File	Change Summary
`src/components/OrganizationCard/OrganizationCard.spec.tsx`	Restructured unit tests with new imports, added comprehensive test cases for rendering and interaction scenarios, migrated from Jest to Vitest.
`src/components/OrganizationCard/OrganizationCard.tsx`	Updated props interface, added new imports, implemented membership request handling functions, enhanced rendering logic.
`src/screens/UserPortal/Organizations/Organizations.tsx`	Added `isJoined` property to organization objects to explicitly track membership status, renamed component for consistency.
`src/screens/OrganizationTags/OrganizationTags.spec.tsx`	Added mock functions for toast notifications, improved test structure and asynchronous handling, migrated from Jest to Vitest.
`package.json`	Added a new script for formatting files using Prettier.
`talawa-admin`	Introduced a new subproject commit.

Assessment against linked issues

Objective	Addressed	Explanation
Visit Button for Joined Organizations [#3162]	❌	The changes do not directly address the visibility of the "Visit" button for joined organizations in the filter.

Possibly related issues

Refactor: src/screens/OrganizationTags/OrganizationTags.test.tsx from Jest to Vitest #3071: Refactoring tests for the OrganizationTags component to Vitest aligns with the current PR's migration efforts.
Refactor: src/screens/UserPortal/Organizations from Jest to Vitest #2575: Refactoring tests for the UserPortal/Organizations to Vitest directly relates to the changes in the Organizations.tsx file.
Refactor: src/screens/OrganizationEvents.tsx from Jest to Vitest #2559: Refactoring tests for OrganizationEvents.tsx to Vitest is part of the broader migration effort.
Refactor: src/screens/OrganizationPeople from Jest to Vitest #2562: Refactoring tests for OrganizationPeople to Vitest connects to the overall testing strategy.
Refactor: src/screens/OrganizationActionItems from Jest to Vitest #2557: Refactoring tests for OrganizationActionItems to Vitest is relevant to the migration context.

Possibly related PRs

Feat : Write Unittests for src/components/UserPortal/OrganizationCard/OrganizationCard.tsx #2393: Introduces unit tests for the OrganizationCard component.
Refactored src/components/AddOn/core/AddOnEntry/AddOnEntry.test.tsx from Jest to Vitest #2501: Refactors the test file for the AddOnEntry component from Jest to Vitest.
Migrated src/screens/CommunityProfile/* from Jest to Vitest #3115: Migrates tests from Jest to Vitest for the CommunityProfile component.

Suggested labels

test, ignore-sensitive-files-pr, refactor

Suggested reviewers

palisadoes
disha1202
noman2002

Poem

🐰 A Rabbit's Ode to Organization Cards 🏢
Buttons dance, memberships flow,
Tests leap high, code starts to glow,
Cards now smart, with details bright,
Joining orgs becomes a delight!
Hop, hop, hooray for clean design! 🎉

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.

github-actions · 2025-01-10T00:45:00Z

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

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

We don't merge PRs with poor code quality.
1. Follow coding best practices such that CodeRabbit.ai approves your PR.
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.
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:

comments in this PR or
our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

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

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

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

Other

🎯 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.
Read the CONTRIBUTING.md file make

coderabbitai

Actionable comments posted: 4

🧹 Nitpick comments (12)

src/components/OrganizationCard/OrganizationCard.tsx (6)
184-186: Safely render props.description to prevent potential errors

If props.description is undefined or null, rendering it directly could cause unintended output or errors. Consider conditionally rendering the description only if it exists.

Modify the code to:
{props.description && (
  <h6 className={`${styles.orgdesc} fw-semibold`}>
    <span>{props.description}</span>
  </h6>
)}
🧰 Tools

🪛 Biome (1.9.4)

[error] 186-186: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

72-73: Ensure userId is not null before using it in queries

Since userId can be null, using it directly in GraphQL queries may result in errors or unintended behavior. Consider adding a null check before using it in useQuery or provide a default value.

Example:
const userId = getItem('userId');

if (userId) {
  const { refetch } = useQuery(USER_JOINED_ORGANIZATIONS, {
    variables: { id: userId },
  });
  // Rest of your code that depends on userId
}
Alternatively, you can handle the null case gracefully within the component or redirect the user to log in if userId is not available.

107-136: Handle potential errors more comprehensively in joinOrganization

The error handling in joinOrganization assumes that the error is an ApolloError with graphQLErrors. However, there's a possibility of other errors occurring. Consider adding a general error message or logging for unexpected error types.

Modify the catch block to handle unexpected errors:
} catch (error: unknown) {
  if (error instanceof ApolloError) {
    const errorCode = error.graphQLErrors[0]?.extensions?.code;

    if (errorCode === 'ALREADY_MEMBER') {
      toast.error(t('AlreadyJoined') as string);
    } else {
      toast.error(t('errorOccured') as string);
    }
  } else {
    // Handle non-ApolloError types
    toast.error(t('unexpectedError') as string);
    console.error('An unexpected error occurred:', error);
  }
}
143-145: Improve type safety when finding membershipRequest

When finding the membershipRequest, ensure that userId is not null to avoid potential errors.

Add a null check for userId:
if (!userId) {
  toast.error(t('UserNotLoggedIn') as string);
  return;
}

const membershipRequest = props.membershipRequests.find(
  (request) => request.user._id === userId,
);
198-200: Handle undefined props.admins and props.members safely

In cases where props.admins or props.members might be undefined, using .length may cause errors. Consider providing default values to ensure safe access.

Modify the code to provide default empty arrays:
{tCommon('admins')}: <span>{props.admins?.length ?? 0}</span> &nbsp;
&nbsp; &nbsp; {tCommon('members')}: <span>{props.members?.length ?? 0}</span>
170-177: Simplify image rendering logic

You can simplify the conditional rendering of the organization image by leveraging short-circuit evaluation.

Simplify the code as follows:
<div className={styles.orgImgContainer}>
  {props.image ? (
    <img src={props.image} alt={`${props.name} image`} />
  ) : (
    <Avatar
      name={props.name}
      alt={`${props.name} image`}
      dataTestId="emptyContainerForImage"
    />
  )}
</div>
This maintains readability and reduces unnecessary complexity.
src/components/OrganizationCard/OrganizationCard.spec.tsx (2)
168-209: Separate tests for each membership status to improve clarity

Currently, the test displays correct button based on membership status uses rerender to test different statuses within a single test case. Separating these into individual test cases enhances readability and maintainability.

Refactor the tests as follows:
test('renders "Join Now" button when membershipRequestStatus is empty', () => {
  render(
    // ...
    <OrganizationCard {...defaultProps} membershipRequestStatus="" />
    // ...
  );
  expect(screen.getByTestId('joinBtn')).toBeInTheDocument();
});

test('renders "Visit" button when membershipRequestStatus is accepted', () => {
  render(
    // ...
    <OrganizationCard {...defaultProps} membershipRequestStatus="accepted" />
    // ...
  );
  const visitButton = screen.getByTestId('manageBtn');
  expect(visitButton).toBeInTheDocument();
  fireEvent.click(visitButton);
  expect(mockNavigate).toHaveBeenCalledWith('/user/organization/123');
});

test('renders "Withdraw" button when membershipRequestStatus is pending', () => {
  render(
    // ...
    <OrganizationCard {...defaultProps} membershipRequestStatus="pending" />
    // ...
  );
  expect(screen.getByTestId('withdrawBtn')).toBeInTheDocument();
});
19-23: Avoid side effects in mocks by using jest.fn() within the mock scope

To ensure that mocks do not leak between tests, consider defining mockNavigate within the mock scope rather than at the module level.

Modify the mock setup:
jest.mock('react-router-dom', () => {
  const originalModule = jest.requireActual('react-router-dom');
  return {
    ...originalModule,
    useNavigate: jest.fn(),
  };
});
Then, within your tests, you can access useNavigate:
import { useNavigate } from 'react-router-dom';

// Inside your test
const mockNavigate = useNavigate() as jest.Mock;
// Now you can assert on `mockNavigate`
src/screens/UserPortal/Organizations/Organizations.tsx (4)
254-258: Ensure membershipRequestStatus is accurately determined

In the mapping function, consider handling cases where membershipRequestStatus might not be 'accepted' or may be undefined. This ensures that isJoined reflects the actual membership status.

Add a default case for membershipRequestStatus:
return {
  ...organization,
  membershipRequestStatus,
  isJoined: membershipRequestStatus === 'accepted',
};
Ensure that membershipRequestStatus is set correctly and consider handling other statuses like 'pending' if applicable.

Line range hint 98-100: Check for null userId before using it in queries

Since userId can be null, using it directly in useQuery may cause issues. Add a null check or default handling to prevent potential errors.

Example:
const userId: string | null = getItem('userId');

if (userId) {
  const { data: joinedOrganizationsData } = useQuery(USER_JOINED_ORGANIZATIONS, {
    variables: { id: userId },
  });

  const { data: createdOrganizationsData } = useQuery(
    USER_CREATED_ORGANIZATIONS,
    {
      variables: { id: userId },
    },
  );
} else {
  // Handle the case when userId is null, e.g., redirect to login
}
This ensures that queries relying on userId do not execute with invalid parameters.

266-272: Handle undefined data when mapping joinedOrganizations

When mapping over joinedOrganizations, ensure that the nested properties are not undefined to prevent runtime errors.

Modify the code:
const organizations =
  joinedOrganizationsData.users[0]?.user?.joinedOrganizations?.map(
    (org: InterfaceOrganization) => ({
      ...org,
      membershipRequestStatus: 'accepted',
      isJoined: true,
    }),
  ) || [];
Adding ? before .map ensures that the code does not attempt to map over undefined.

281-287: Handle undefined data when mapping createdOrganizations

Similar to the previous comment, ensure that createdOrganizations is defined before mapping.

Modify the code:
const organizations =
  createdOrganizationsData.users[0]?.appUserProfile?.createdOrganizations?.map(
    (org: InterfaceOrganization) => ({
      ...org,
      membershipRequestStatus: 'accepted',
      isJoined: true,
    }),
  ) || [];
This prevents runtime errors if createdOrganizations is undefined.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e9aec17 and 34335ce.

📒 Files selected for processing (5)

eslint.config.cjs (1 hunks)
eslint.config.js (1 hunks)
src/components/OrganizationCard/OrganizationCard.spec.tsx (2 hunks)
src/components/OrganizationCard/OrganizationCard.tsx (1 hunks)
src/screens/UserPortal/Organizations/Organizations.tsx (2 hunks)

🧰 Additional context used

🪛 GitHub Actions: PR Workflow

eslint.config.cjs

[error] SyntaxError: Unexpected identifier 'eslint' - Possible configuration file syntax error

🪛 Biome (1.9.4)

eslint.config.js

[error] 17-17: Expected a semicolon or an implicit semicolon after a statement, but found none

An explicit or implicit semicolon is expected here...

...Which is required to end this statement

(parse)

[error] 17-17: Expected a semicolon or an implicit semicolon after a statement, but found none

An explicit or implicit semicolon is expected here...

...Which is required to end this statement

(parse)

src/components/OrganizationCard/OrganizationCard.tsx

[error] 186-186: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: Analyse Code With CodeQL (javascript)

eslint.config.cjs

eslint.config.js

Cioppolo14 · 2025-01-10T00:54:25Z

@gkbishnoi07 Please fix the failed tests and make sure coderabbit approves of the PR.

gkbishnoi07 · 2025-01-10T00:56:43Z

@Cioppolo14 working on failed test cases

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (2)

src/components/OrganizationCard/OrganizationCard.tsx (2)
74-101: Destructure props for better code readability

Multiple static analysis tools suggest destructuring props. This would improve code readability and follow React best practices.
-function OrganizationCard(props: InterfaceOrganizationCardProps): JSX.Element {
+function OrganizationCard({
+  id,
+  name,
+  image,
+  description,
+  admins,
+  members,
+  address,
+  membershipRequestStatus,
+  userRegistrationRequired,
+  membershipRequests
+}: InterfaceOrganizationCardProps): JSX.Element {
🧰 Tools

🪛 GitHub Check: Performs linting, formatting, type-checking, checking for different source and target branch

[failure] 85-85:
Must use destructuring props assignment

[failure] 90-90:
Must use destructuring props assignment

[failure] 95-95:
Must use destructuring props assignment

🪛 eslint

[error] 85-85: Must use destructuring props assignment

(react/destructuring-assignment)

[error] 90-90: Must use destructuring props assignment

(react/destructuring-assignment)

[error] 95-95: Must use destructuring props assignment

(react/destructuring-assignment)

186-196: Use optional chaining for address checks

Simplify the address check using optional chaining for better readability.
-            {props.address && props.address.city && (
+            {props.address?.city && (
🧰 Tools

🪛 Biome (1.9.4)

[error] 186-186: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🪛 eslint

[error] 186-186: Must use destructuring props assignment

(react/destructuring-assignment)

[error] 186-186: Must use destructuring props assignment

(react/destructuring-assignment)

[error] 189-189: Must use destructuring props assignment

(react/destructuring-assignment)

[error] 190-190: Must use destructuring props assignment

(react/destructuring-assignment)

[error] 192-192: Must use destructuring props assignment

(react/destructuring-assignment)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 34335ce and 60df684.

📒 Files selected for processing (1)

src/components/OrganizationCard/OrganizationCard.tsx (1 hunks)

🧰 Additional context used

🪛 GitHub Check: Performs linting, formatting, type-checking, checking for different source and target branch

src/components/OrganizationCard/OrganizationCard.tsx

[failure] 12-12:
'/home/runner/work/talawa-admin/talawa-admin/node_modules/@apollo/client/index.js' imported multiple times

[failure] 20-20:
All imports in the declaration are only used as types. Use import type

[failure] 20-20:
'/home/runner/work/talawa-admin/talawa-admin/node_modules/@apollo/client/index.js' imported multiple times

[failure] 85-85:
Must use destructuring props assignment

[failure] 90-90:
Must use destructuring props assignment

[failure] 95-95:
Must use destructuring props assignment

[failure] 108-108:
Must use destructuring props assignment

[failure] 111-111:
Must use destructuring props assignment

[failure] 118-118:
Must use destructuring props assignment

[failure] 143-143:
Must use destructuring props assignment

🪛 Biome (1.9.4)

src/components/OrganizationCard/OrganizationCard.tsx

[error] 186-186: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🪛 eslint

src/components/OrganizationCard/OrganizationCard.tsx

[error] 12-12: '@apollo/client' imported multiple times.

(import/no-duplicates)

[error] 20-20: All imports in the declaration are only used as types. Use import type.

(@typescript-eslint/consistent-type-imports)

[error] 20-20: '@apollo/client' imported multiple times.

(import/no-duplicates)

[error] 85-85: Must use destructuring props assignment