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

fix: use built in provider declaration for previewContext in render function for mocks #14525

Merged

Conversation

standeren
Copy link
Contributor

@standeren standeren commented Jan 28, 2025

Description

Use built in provider declaration for previewContext in render function for mocks, instead of the custom prover component. The custom provider component does not allow setting the context-value from outside.

Related Issue(s)

  • #{issue number}

Verification

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

Summary by CodeRabbit

  • Refactor
    • Updated context provider implementation in test mocking utility
    • Modified how preview context is passed during component rendering

@standeren standeren added quality/testing Tests that are missing, needs to be created or could be improved. skip-releasenotes Issues that do not make sense to list in our release notes skip-manual-testing PRs that do not need to be tested manually skip-documentation Issues where updating documentation is not relevant labels Jan 28, 2025
Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the renderWithProviders function in the frontend/app-development/test/mocks.tsx file, specifically changing how the PreviewContext is implemented. The change involves replacing the PreviewContextProvider with PreviewContext.Provider and directly passing context values using the value prop. The import statement for PreviewContext has been updated to include both the context and its type.

Changes

File Change Summary
frontend/app-development/test/mocks.tsx - Updated import to include PreviewContext
- Replaced PreviewContextProvider with PreviewContext.Provider
- Modified context value passing mechanism

Possibly related PRs

Suggested labels

solution/studio/designer, frontend

Suggested reviewers

  • github-actions
  • wrt95

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

@github-actions github-actions bot added solution/studio/designer Issues related to the Altinn Studio Designer solution. frontend labels Jan 28, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
frontend/app-development/test/mocks.tsx (1)

46-50: Consider reducing code duplication.

The context value computation is identical in both the initial render and rerender. Consider extracting the provider wrapper into a separate component to maintain DRY principles.

+ const PreviewContextWrapper = ({ children, previewContextProps }) => (
+   <PreviewContext.Provider
+     value={{ ...defaultPreviewContextProps, ...previewContextProps }}
+   >
+     <BrowserRouter>{children}</BrowserRouter>
+   </PreviewContext.Provider>
+ );

  export const renderWithProviders = (
    queries: Partial<ServicesContextProps> = {},
    queryClient?: QueryClient,
    previewContextProps: Partial<PreviewContextProps> = {},
  ) =>
  (component: ReactNode) => {
    const renderResult = render(
      <ServicesContextProvider
        {...queriesMock}
        {...queries}
        client={queryClient}
        clientConfig={queryClientConfigMock}
      >
        <PreviewConnectionContextProvider>
-         <PreviewContext.Provider
-           value={{ ...defaultPreviewContextProps, ...previewContextProps }}
-         >
-           <BrowserRouter>{component}</BrowserRouter>
-         </PreviewContext.Provider>
+         <PreviewContextWrapper previewContextProps={previewContextProps}>
+           {component}
+         </PreviewContextWrapper>
        </PreviewConnectionContextProvider>
      </ServicesContextProvider>,
    );
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3958771 and f1aac09.

📒 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 (2)
frontend/app-development/test/mocks.tsx (2)

12-12: LGTM! Import statement updated correctly.

The import now includes both the PreviewContext and its type, which is necessary for using the built-in context provider.


29-33: Great improvement using the built-in context provider!

The implementation is now more flexible as it:

  1. Uses React's built-in context provider mechanism
  2. Correctly merges default and custom props
  3. Allows external control of context values

Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.70%. Comparing base (789cfb3) to head (f1aac09).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14525   +/-   ##
=======================================
  Coverage   95.70%   95.70%           
=======================================
  Files        1901     1901           
  Lines       24739    24739           
  Branches     2833     2833           
=======================================
  Hits        23676    23676           
  Misses        802      802           
  Partials      261      261           

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

@standeren standeren merged commit 1571041 into main Jan 28, 2025
16 checks passed
@standeren standeren deleted the fix-preview-context-provider-impl-in-render-function-mock branch January 28, 2025 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
frontend quality/testing Tests that are missing, needs to be created or could be improved. skip-documentation Issues where updating documentation is not relevant skip-manual-testing PRs that do not need to be tested manually skip-releasenotes Issues that do not make sense to list in our release notes solution/studio/designer Issues related to the Altinn Studio Designer solution.
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants