refactor: add previewContextProviderProps to renderWithHooks function for testing

[standeren]

Description

Add previewContextProviderProps to renderWithHooks function for testing. This is done so we can use the renderWithProviders function when testing components that are dependent on access to the functions inside the previewContextProvider.

Adding skip-manual-testing since our automatic tests should be sufficient testing.

Related Issue(s)

• #{issue number}

Verification

• Your code builds clean without any errors or warnings
• Manual testing done (required)

Summary by CodeRabbit

• Improvements
  • Enhanced rendering utilities with more flexible preview context configuration
  • Added default preview context properties for testing components
  • Improved type safety for component rendering and rerendering

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request modifies the renderWithProviders function in the frontend testing utilities. A new optional parameter previewContextProps is introduced, allowing more flexible configuration of the preview context during component rendering. A new defaultPreviewContextProps constant is added to provide default values for preview context properties. The changes enhance the rendering function's type safety and configurability, particularly for testing components that require preview context.

Changes

File	Change Summary
frontend/app-development/test/mocks.tsx	- Updated renderWithProviders method signature to include optional previewContextProps - Added defaultPreviewContextProps constant with default preview context values - Modified PreviewConnectionContextProvider to spread default and custom preview context props

Possibly related PRs

• refactor: Make useBpmnEditor return callback ref #14423: Modifications to useBpmnEditor hook that might interact with rendering utilities in testing scenarios

Suggested labels

area/process, quality/code

Suggested reviewers

• github-actions
• ErlingHauan

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db69ab4 and bba67da.

📒 Files selected for processing (1)

• frontend/app-development/test/mocks.tsx (3 hunks)

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

• GitHub Check: Build environment and run e2e test
• GitHub Check: Testing

🔇 Additional comments (6)

frontend/app-development/test/mocks.tsx (6)

12-12: New import for PreviewContextProps looks good.
No issues here. The addition aligns with the changes below.

---

15-19: Useful addition of previewContextProps.
The new optional parameter helps customize the preview context for component testing, which improves flexibility.

---

28-28: Combining default and user-defined props is correct.
Spreading defaultPreviewContextProps first and then previewContextProps ensures that user-provided values override the defaults. Nicely done.

---

66-66: No concerns regarding the new line.

---

67-71: Default preview context props look appropriate for test usage.
Mock functions here are fine for testing.

---

33-33: 🛠️ Refactor suggestion

Ensure consistent usage of previewContextProps on rerender.
Currently, the rerender function omits both defaultPreviewContextProps and previewContextProps, preventing consistent testing of preview context overrides.

Consider the following diff to mirror the initial behavior:

-<PreviewConnectionContextProvider>
+<PreviewConnectionContextProvider {...defaultPreviewContextProps} {...previewContextProps}>

Likely invalid or redundant comment.

---

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

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.

[wrt95]

🥳

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.69%. Comparing base (fd014a5) to head (bba67da).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #14500   +/-   ##
=======================================
  Coverage   95.69%   95.69%           
=======================================
  Files        1893     1893           
  Lines       24634    24637    +3     
  Branches     2823     2825    +2     
=======================================
+ Hits        23573    23576    +3     
  Misses        800      800           
  Partials      261      261           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.