appsmithorg / appsmith

Platform to build admin panels, internal tools, and dashboards. Integrates with 25+ databases and any API.
https://www.appsmith.com
Apache License 2.0
34.69k stars 3.75k forks source link

chore: update jest version to 29 #37587

Closed ayushpahwa closed 4 days ago

ayushpahwa commented 5 days ago

Description

Update version of the jest package to leverage new node features. Changes needed to make the new version compatible

  1. ts-jest had to be moved from globals to the transform block since it is a transformer and with new version, it is deprecated to keep them in globals.
  2. For snapshot tests, the keyword Array before tests is no longer needed, it is implicit.
  3. With new jest version, features of node js v20 can be utilised. One of these is crypto.subtle.digest. Our usage of the peculiar/webcrypto lib has this but was not being utilised since global.crypto is immutable and hence needs to be deleted before the new lib can be properly used. Reference

Fixes #37586

Automation

/test sanity

:mag: Cypress test results

[!TIP] 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11946938998 Commit: 99c7f2bf02a2fda5fe570774a2c7a993c38dea9b Cypress dashboard. Tags: @tag.Sanity Spec:


Thu, 21 Nov 2024 08:25:00 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

Summary by CodeRabbit

coderabbitai[bot] commented 5 days ago

Walkthrough

The changes in this pull request primarily involve updates to the Jest configuration, dependency versions in package.json, and modifications to the test setup in setup.ts. The Jest configuration now includes enhanced options for TypeScript handling, while the package.json reflects upgrades to several dependencies, particularly related to Jest. The test setup file has been adjusted to improve the mocking of global objects and APIs, ensuring a more robust testing environment.

Changes

File Path Change Summary
app/client/jest.config.js Updated transform property for ts-jest with new options; modified moduleNameMapper; removed ts-jest from globals.
app/client/package.json Updated dependency versions for @types/jest, jest, jest-environment-jsdom, and ts-jest.
app/client/test/setup.ts Replaced global crypto with @peculiar/webcrypto; updated API mocking; mocked IntersectionObserver and ResizeObserver; defined WorkerStub.

Assessment against linked issues

Objective Addressed Explanation
Upgrade version of jest from 27 to 29

Possibly related PRs

Suggested labels

Enhancement, Test, JS Objects, Javascript Product

Suggested reviewers

🎉 In the land of code where Jest does play,
Dependencies danced and upgraded today.
With mocks and stubs, the tests now shine,
A seamless config, oh how divine!
TypeScript's embrace, a joyful embrace,
In the realm of testing, we've found our place! 🌟


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.