Added vitest to the avatar component

[NishantSinghhhhh]

hat kind of change does this PR introduce?
Feature/Refactoring Avatar component

Issue Number : #2492

Did you add tests for your changes?
Yes

Snapshots/Videos:

[
Screencast from 2024-12-04 23-13-59.webm
](url)

Summary

Does this PR introduce a breaking change?
NO

Migrated the testing framework to Vitest.
Updated all test files and configurations to be compatible with Vitest's syntax and features.
Have you read the contributing guide?
Yes

Summary by CodeRabbit

• New Features

  • Enhanced Avatar component with support for a custom avatar URL.
  • New testing scripts added for improved testing capabilities.

• Bug Fixes

  • Improved error handling for undefined names in the Avatar component.

• Documentation

  • Updated configuration files for TypeScript and Vitest to improve project structure and testing environment.

• Tests

  • Comprehensive test suite added for the Avatar component to ensure reliability and functionality.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request includes updates to the package.json, tsconfig.json, and several component files within the talawa-admin project. Key changes involve updating various dependencies and adding new testing scripts to enhance testing capabilities. A new configuration file for Vitest is introduced, and the Avatar component is modified to allow for an optional custom URL for avatars. Additionally, a new test suite for the Avatar component is created, ensuring comprehensive testing of its functionalities.

Changes

File	Change Summary
package.json	Updated dependencies: @mui/x-charts, @mui/x-date-pickers, @vitejs/plugin-react, etc. Added new packages: @pdfme/generator, @vitest/coverage-istanbul, vitest. New test scripts added: test:vitest, test:vitest:watch, test:vitest:coverage.
src/components/Avatar/Avatar.spec.tsx	Introduced a test suite for the Avatar component using Vitest, covering rendering, functionality, and error handling.
src/components/Avatar/Avatar.tsx	Modified name property to optional in InterfaceAvatarProps, added customUrl property, and updated avatar generation logic to handle custom URLs.
tsconfig.json	Added exclude property to specify directories and files to be excluded from TypeScript compilation.
vitest.config.js	Introduced configuration for Vitest, including plugins, test file inclusion, and coverage reporting.

Possibly related issues

• Refactor : src/components/Avatar/Avatar.test.tsx from Jest to Vitest #2492: This issue relates to refactoring tests from Jest to Vitest, which aligns with the new testing capabilities introduced in this PR.
• Refactor: src/screens/CommunityProfile from Jest to Vitest #2545: Refactoring tests in src/screens/CommunityProfile to Vitest is relevant as this PR enhances the testing framework.
• Refactor: src/screens/UserPortal/UserScreen from Jest to Vitest #2580: Similar to the above, this issue involves refactoring tests in src/screens/UserPortal/UserScreen to Vitest, connecting to the broader migration efforts.
• Refactor: src/screens/UserPortal/Pledges from Jest to Vitest #2577: Refactoring tests in src/screens/UserPortal/Pledges to Vitest is related to the changes in testing introduced in this PR.

Possibly related PRs

• Upgrade @pdfme/generator to 5.0.0 #2413: Upgrades the @pdfme/generator package, which is directly related to this PR's addition of the same package.
• update the @mui/x-date-pickers #2439: Downgrades the @mui/x-date-pickers package, relevant as this PR also updates this dependency.
• feat!: Migrate Testing Framework from Jest to Vitest #2457: Introduces new test scripts and updates dependencies related to testing, aligning with the new test scripts added in this PR.
• Refactored src/components/AddOn/support/components/Action/Action.test.tsx from Jest to Vitest #2482: Refactors tests from Jest to Vitest, relevant to the testing enhancements in this PR.
• Refactored src/components/AddOn/core/AddOnEntry/AddOnEntry.test.tsx from Jest to Vitest #2501: Similar to Refactored src/components/AddOn/support/components/Action/Action.test.tsx from Jest to Vitest #2482, this PR also focuses on refactoring tests from Jest to Vitest, indicating a broader testing improvement effort.

Suggested labels

test, refactor

Suggested reviewers

• pranshugupta54
• varshith257
• AVtheking

🐰 In the code, I hop and play,
With tests and scripts, I pave the way.
Dependencies updated, all in line,
A custom avatar? Oh, how divine!
From Jest to Vitest, we take the leap,
In our project garden, new features we reap! 🌼

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3d1f1f0 and a5eaf8d.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (5)

• package.json (5 hunks)
• src/components/Avatar/Avatar.spec.tsx (1 hunks)
• src/components/Avatar/Avatar.tsx (3 hunks)
• tsconfig.json (1 hunks)
• vitest.config.js (1 hunks)

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[github-actions]

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

[palisadoes]

We have to close this again. You need to merge into the develop-postgres branch

[NishantSinghhhhh]

@palisadoes okay , i will do it and raise 1 more PR