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

upgraded testing-lib/user-event to 14.5.2 #2266

Conversation

Kanishk-tiwari-045
Copy link

@Kanishk-tiwari-045 Kanishk-tiwari-045 commented Sep 14, 2024

What kind of change does this PR introduce?

Dependency upgrade and refactoring

Issue Number:

Fixes #2072

Did you add tests for your changes?

No

Snapshots/Videos:

N/A

If relevant, did you update the documentation?

N/A

Summary

This PR addresses the dependency upgrade of @testing-library/user-event from 12.8.3 to 14.5.2.

Rationale: This upgrade was attempted by the automated dependabot job previously, but the PR tests failed.
This PR resolves multiple dependency issues, ensuring compatibility and preventing further build failures.
Additionally, it examines if this package is:

Unused or unnecessary (i.e., whether similar functionality can be provided by other existing packages or if it’s used in minor functionalities that the end user may not utilize).
After reviewing, it was determined that the package is necessary for certain testing functionalities.

Does this PR introduce a breaking change?

No

Other information

This PR resolves the dependency issue causing tests to fail in previous upgrade attempts.
Background failing PRs:

chore(deps): bump @testing-library/user-event from 12.8.3 to 14.5.2 #2065.

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • New Features

    • Updated the @testing-library/user-event package to enhance testing capabilities.
  • Bug Fixes

    • Improved clarity and accuracy of test assertions across multiple components by replacing toBeCalledWith with toHaveBeenCalledWith.
  • Chores

    • Minor updates to assertion methods in various test files to align with best practices in Jest testing.

Copy link

coderabbitai bot commented Sep 14, 2024

Walkthrough

This pull request updates the @testing-library/user-event package from version ^12.1.10 to ^14.5.2 in the package.json file. It also modifies test assertions across several test files, changing the assertion method from toBeCalledWith to toHaveBeenCalledWith for improved clarity and adherence to best practices in Jest testing. Additionally, one test file updates an error assertion from .toThrowError() to .toThrow().

Changes

File Change Summary
package.json Updated @testing-library/user-event version from ^12.1.10 to ^14.5.2.
src/components/AddOn/core/AddOnRegister/AddOnRegister.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/components/AgendaCategory/AgendaCategoryContainer.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/components/AgendaItems/AgendaItemsContainer.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/components/EventListCard/EventListCard.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategory.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/components/RecurrenceOptions/CustomRecurrence.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/components/RecurrenceOptions/RecurrenceOptions.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/components/TableLoader/TableLoader.test.tsx Changed error assertion from .toThrowError() to .toThrow().
src/components/UserPortal/PostCard/PostCard.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith and improved formatting.
src/components/UserPortal/Register/Register.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/components/UserPortal/StartPostModal/StartPostModal.test.tsx Changed assertions from toBeCalledWith to toHaveBeenCalledWith and not.toBeCalledWith to not.toHaveBeenCalledWith.
src/components/UsersTableItem/UserTableItem.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/screens/ManageTag/ManageTag.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/screens/OrganizationDashboard/OrganizationDashboard.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/screens/OrganizationEvents/OrganizationEvents.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/screens/OrganizationTags/OrganizationTags.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/screens/SubTags/SubTags.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.
src/screens/UserPortal/Events/Events.test.tsx Changed assertion from toBeCalledWith to toHaveBeenCalledWith.

Assessment against linked issues

Objective Addressed Explanation
Upgrade @testing-library/user-event from 12.8.3 to 14.5.2 (#2072)
Ensure all tests are valid and pass (#2072)
Update multiple dependency requirements that need updating (#2072)

Possibly related issues

  • None.

Possibly related PRs

Poem

🐰 In fields of code, I hop and play,
With tests that shine, come what may.
User events now dance with glee,
As Jest's best practices set us free.
A toast to changes, bright and new,
In every test, our dreams come true! 🌼

Tip

OpenAI O1 model for chat
  • We have deployed OpenAI's latest O1 model for chat.
  • OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
  • Please share any feedback with us in the discussions post.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 315641f and 17d1be7.

Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
Files selected for processing (20)
  • package.json (1 hunks)
  • src/components/AddOn/core/AddOnRegister/AddOnRegister.test.tsx (1 hunks)
  • src/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister.test.tsx (4 hunks)
  • src/components/AgendaCategory/AgendaCategoryContainer.test.tsx (2 hunks)
  • src/components/AgendaItems/AgendaItemsContainer.test.tsx (1 hunks)
  • src/components/EventListCard/EventListCard.test.tsx (8 hunks)
  • src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategory.test.tsx (1 hunks)
  • src/components/RecurrenceOptions/CustomRecurrence.test.tsx (2 hunks)
  • src/components/RecurrenceOptions/RecurrenceOptions.test.tsx (2 hunks)
  • src/components/TableLoader/TableLoader.test.tsx (1 hunks)
  • src/components/UserPortal/PostCard/PostCard.test.tsx (2 hunks)
  • src/components/UserPortal/Register/Register.test.tsx (7 hunks)
  • src/components/UserPortal/StartPostModal/StartPostModal.test.tsx (2 hunks)
  • src/components/UsersTableItem/UserTableItem.test.tsx (3 hunks)
  • src/screens/ManageTag/ManageTag.test.tsx (1 hunks)
  • src/screens/OrganizationDashboard/OrganizationDashboard.test.tsx (1 hunks)
  • src/screens/OrganizationEvents/OrganizationEvents.test.tsx (3 hunks)
  • src/screens/OrganizationTags/OrganizationTags.test.tsx (2 hunks)
  • src/screens/SubTags/SubTags.test.tsx (2 hunks)
  • src/screens/UserPortal/Events/Events.test.tsx (2 hunks)
Files skipped from review due to trivial changes (18)
  • src/components/AddOn/core/AddOnRegister/AddOnRegister.test.tsx
  • src/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister.test.tsx
  • src/components/AgendaCategory/AgendaCategoryContainer.test.tsx
  • src/components/AgendaItems/AgendaItemsContainer.test.tsx
  • src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategory.test.tsx
  • src/components/RecurrenceOptions/CustomRecurrence.test.tsx
  • src/components/RecurrenceOptions/RecurrenceOptions.test.tsx
  • src/components/TableLoader/TableLoader.test.tsx
  • src/components/UserPortal/PostCard/PostCard.test.tsx
  • src/components/UserPortal/Register/Register.test.tsx
  • src/components/UserPortal/StartPostModal/StartPostModal.test.tsx
  • src/components/UsersTableItem/UserTableItem.test.tsx
  • src/screens/ManageTag/ManageTag.test.tsx
  • src/screens/OrganizationDashboard/OrganizationDashboard.test.tsx
  • src/screens/OrganizationEvents/OrganizationEvents.test.tsx
  • src/screens/OrganizationTags/OrganizationTags.test.tsx
  • src/screens/SubTags/SubTags.test.tsx
  • src/screens/UserPortal/Events/Events.test.tsx
Additional comments not posted (10)
package.json (2)

101-101: Approve the version upgrade.

The version change from ^12.1.10 to ^14.5.2 aligns with the stated PR objectives to resolve the failed tests and dependency issues from the previous upgrade attempt. This is a necessary change.


101-101: Verify the test coverage.

Since this is a major version upgrade, it's important to ensure that the existing tests have been updated to accommodate any breaking changes introduced by the new version. Please verify that the test coverage is adequate and all tests are passing.

Do you need any assistance with updating the tests or improving the test coverage? I'd be happy to help!

src/components/EventListCard/EventListCard.test.tsx (8)

365-365: LGTM!

The change from toBeCalledWith to toHaveBeenCalledWith improves the clarity and correctness of the assertion, aligning it with the Jest best practices.


418-418: LGTM!

The change from toBeCalledWith to toHaveBeenCalledWith improves the clarity and correctness of the assertion, aligning it with the Jest best practices.


462-462: LGTM!

The change from toBeCalledWith to toHaveBeenCalledWith improves the clarity and correctness of the assertion, aligning it with the Jest best practices.


699-699: LGTM!

The change from toBeCalledWith to toHaveBeenCalledWith improves the clarity and correctness of the assertion, aligning it with the Jest best practices.


765-765: LGTM!

The change from toBeCalledWith to toHaveBeenCalledWith improves the clarity and correctness of the assertion, aligning it with the Jest best practices.


826-826: LGTM!

The change from toBeCalledWith to toHaveBeenCalledWith improves the clarity and correctness of the assertion, aligning it with the Jest best practices.


866-866: LGTM!

The change from toBeCalledWith to toHaveBeenCalledWith improves the clarity and correctness of the assertion, aligning it with the Jest best practices.


924-924: LGTM!

The change from toBeCalledWith to toHaveBeenCalledWith improves the clarity and correctness of the assertion, aligning it with the Jest best practices.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

  1. The overall code coverage drops below the target threshold of the repository
  2. Any file in the pull request has code coverage levels below the repository threshold
  3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

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
Copy link
Contributor

Please fix the failing test

@Kanishk-tiwari-045
Copy link
Author

@palisadoes I am on it, but can you please assign this issue to me, as I requested earlier in issue #2072

@pranshugupta54
Copy link
Member

Assigned it. Make sure to first get assigned and then only raise PRs from next time.

@Kanishk-tiwari-045
Copy link
Author

@pranshugupta54 Thank you.
Will keep it in mind from now on.

@Kanishk-tiwari-045
Copy link
Author

Kanishk-tiwari-045 commented Sep 24, 2024

@palisadoes Please do not close this PR, as I've resolved most of the testcases since. Now I 'm only left with 6.
Will push the work soon.

Copy link

github-actions bot commented Oct 5, 2024

This pull request did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please verify it has no conflicts with the develop branch and rebase if needed. Mention it now if you need help or give permission to other people to finish your work.

@github-actions github-actions bot added the no-pr-activity No pull request activity label Oct 5, 2024
@palisadoes
Copy link
Contributor

Closing. Inactivity

@palisadoes palisadoes closed this Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-pr-activity No pull request activity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants