Fix: [utils-testing] Import Jest hooks from runner instead of globals

[theycallmeswift]

This PR changes where we import the Jest hooks from so the testing library can be used during Jest global setup and teardown.

Jest will currently raise an error if you attempt to use the library in the setup/teardown files due to how hooks are elevate to the global namespace. This change makes the library compatible with both Jest and non-Jest environments.

[coderabbitai]

Walkthrough

This update modifies the import statements for Jest testing hooks to replace @jest/globals with jest-circus. This change enhances the test execution framework by utilizing a specialized module designed for better control over asynchronous tests and custom environments. As a result, the overall testing efficiency and reliability may improve, aligning with modern JavaScript testing practices.

Changes

Files	Change Summary
.changeset/nine-suns-lick.md	Updated import from @jest/globals to jest-circus for Jest testing hooks across multiple files.
utils/testing/src/test.helpers.ts	Changed import from @jest/globals to jest-circus, indicating a shift in the test framework.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant TestHooks
    participant Tests

    TestRunner->>TestHooks: Load Hooks (beforeEach, afterEach)
    TestHooks->>Tests: Execute Tests
    Tests->>TestHooks: Report Results
    TestHooks->>TestRunner: Return Results

Loading

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bbe526e and 73e7d7b.

Files ignored due to path filters (2)

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

Files selected for processing (2)

• .changeset/nine-suns-lick.md (1 hunks)
• utils/testing/src/test.helpers.ts (1 hunks)

Additional comments not posted (2)

.changeset/nine-suns-lick.md (1)

1-5: Changeset looks good.

The changeset description is clear and concise, indicating a patch update for the @flatfile/utils-testing package and explaining the reason for importing Jest hooks from jest-circus instead of @jest/globals.

utils/testing/src/test.helpers.ts (1)

3-3: LGTM! But verify the usage of Jest hooks in the codebase.

The import statement for Jest hooks has been updated to use jest-circus. Ensure that all Jest hooks are correctly imported and used throughout the codebase.

Verification successful

---

Jest hooks are correctly imported and used throughout the codebase.

• The import statement for Jest hooks has been updated to use jest-circus, and no occurrences of Jest hooks being imported from other sources were found.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of Jest hooks in the codebase.

# Test: Search for the usage of Jest hooks. Expect: Only occurances of the new import source.
rg --type ts -A 5 $'from \'jest-circus\''

Length of output: 437

---

Script:

#!/bin/bash
# Description: Verify if there are any Jest hooks imported from sources other than 'jest-circus'.

# Test: Search for the usage of Jest hooks from sources other than 'jest-circus'. Expect: No occurrences.
rg --type ts -A 5 $'from \'jest\''

Length of output: 39

---

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>.
  • 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.