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: Update supported component types #14566

Merged
merged 1 commit into from
Feb 4, 2025

Conversation

mlqn
Copy link
Contributor

@mlqn mlqn commented Feb 3, 2025

Description

Updated allowed component types based on JSON schemas.

I’ve changed my mind since my comment in the issue, I now think it’s better to use an excluded component types list, as this will automatically support all future types (Text, Number, Date, Tabs, etc.), while unsupported types will simply be ignored by the app frontend.

Related Issue(s)

Verification

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

Summary by CodeRabbit

  • New Features

    • Enhanced the display of key interactive elements, including improved presentation of instantiation actions and payment information.
  • Refactor

    • Streamlined the selection of components processed for layout rendering, ensuring a more consistent and focused user interface.

Copy link
Contributor

coderabbitai bot commented Feb 3, 2025

📝 Walkthrough

Walkthrough

The changes update the excludedComponents array in the target utilities file. Three components—ComponentType.Grid, ComponentType.Header, and ComponentType.Paragraph—were removed from the array, while ComponentType.InstantiationButton was reintroduced and ComponentType.PaymentDetails was added. The alterations modify which components are excluded from layout processing without changing any type definitions or function implementations.

Changes

File Change Summary
frontend/.../targetUtils.ts Removed ComponentType.Grid, ComponentType.Header, and ComponentType.Paragraph; added ComponentType.InstantiationButton and ComponentType.PaymentDetails to the excludedComponents array.

Suggested labels

skip-manual-testing

Suggested reviewers

  • lassopicasso
  • Jondyr

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 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 7a91386 and 0dceed0.

📒 Files selected for processing (1)
  • frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Summary2Target/targetUtils.ts (1 hunks)
🔇 Additional comments (2)
frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Summary2Target/targetUtils.ts (2)

9-28: LGTM! Changes align with PR objectives.

The modifications to excludedComponents effectively implement the strategy of using an exclusion list to handle component types. This approach will inherently support future component types while explicitly excluding unsupported ones.


9-28: Verify impact on existing layouts.

The changes make Grid, Header, and Paragraph components available while excluding InstantiationButton and PaymentDetails. Please ensure this doesn't affect any existing layouts unexpectedly.

Run this script to check for usage of newly available components:

✅ Verification successful

Verification of layout component changes confirmed.
The shell script results show that key newly available components (specifically Header and Paragraph) are actively used in multiple layout files, and there is no evidence of any usage of the excluded InstantiationButton or PaymentDetails components. This indicates that the changes in targetUtils.ts are consistent with existing layouts and should not unexpectedly affect them.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for usage of newly available components in layouts
# Look for Grid, Header, and Paragraph components in layout files

echo "Searching for usage of newly available components..."
rg -i "\"type\":\s*(\"Grid\"|\"Header\"|\"Paragraph\")" --type json

echo "Checking for InstantiationButton and PaymentDetails components that will now be excluded..."
rg -i "\"type\":\s*(\"InstantiationButton\"|\"PaymentDetails\")" --type json

Length of output: 2754

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@mlqn mlqn linked an issue Feb 3, 2025 that may be closed by this pull request
@github-actions github-actions bot added area/ui-editor Area: Related to the designer tool for assembling app UI in Altinn Studio. solution/studio/designer Issues related to the Altinn Studio Designer solution. frontend labels Feb 3, 2025
@mlqn mlqn force-pushed the 14532-filter-summary2-components branch from fab4eb8 to 0a214a2 Compare February 3, 2025 21:00
Copy link

codecov bot commented Feb 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.71%. Comparing base (2b3dfb4) to head (0dceed0).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14566   +/-   ##
=======================================
  Coverage   95.71%   95.71%           
=======================================
  Files        1903     1903           
  Lines       24795    24795           
  Branches     2840     2840           
=======================================
  Hits        23733    23733           
  Misses        801      801           
  Partials      261      261           

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

@mlqn mlqn force-pushed the 14532-filter-summary2-components branch from 0a214a2 to 0dceed0 Compare February 4, 2025 07:24
@mlqn mlqn changed the title fix: Update allowed component types fix: Update supported component types Feb 4, 2025
@mlqn mlqn marked this pull request as ready for review February 4, 2025 08:11
Copy link
Contributor

@lassopicasso lassopicasso left a comment

Choose a reason for hiding this comment

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

👍

@lassopicasso lassopicasso added the skip-manual-testing PRs that do not need to be tested manually label Feb 4, 2025
@lassopicasso lassopicasso merged commit 06ca4b7 into main Feb 4, 2025
19 checks passed
@lassopicasso lassopicasso deleted the 14532-filter-summary2-components branch February 4, 2025 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ui-editor Area: Related to the designer tool for assembling app UI in Altinn Studio. frontend skip-manual-testing PRs that do not need to be tested manually solution/studio/designer Issues related to the Altinn Studio Designer solution.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Filter Summary2 components
2 participants