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

refactor(summary2): move displayType default to shared default logic #14654

Merged
merged 4 commits into from
Feb 14, 2025

Conversation

Jondyr
Copy link
Member

@Jondyr Jondyr commented Feb 13, 2025

Description

Moves default value for displayType from the nativeselect component to
the shared default config when selecting components to override.


Stack:

⚠️ Part of a stack created by spr. Do not merge manually using the UI - doing so may have unexpected results.

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

Summary by CodeRabbit

  • New Features

    • Updated the display configuration control to reflect the provided selection without a default fallback.
    • Enhanced override functionality by adding tailored configurations for additional component types, including checkboxes and multi-select.
  • Tests

    • Improved test consistency by replacing hardcoded identifiers with a shared constant, ensuring more maintainable and reliable validations.

Adds a new property to overrides for RepeatingGroup and Subform
`display`.
This property has a default value dependent on which component is
targeted. RepeatingGroup is `full` and Subform is `table` (see
layout.schema.v1.json)

commit-id:a7e89d34
Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

📝 Walkthrough

Walkthrough

This pull request updates three areas related to summary override configuration. The Summary2OverrideDisplayType component now directly uses the provided displayType without defaulting to 'list'. Test cases have been refactored to use a new constant, repeatingGroupComponentId, in place of a hardcoded value. In addition, the configuration function is extended to include two new cases—Checkboxes and MultipleSelect—by providing them a default override configuration and corresponding rendering logic. No changes were made to the public exports.

Changes

File(s) Change Summary
frontend/.../OverrideFields/Summary2OverrideDisplayType.tsx Modified StudioNativeSelect’s value prop to use displayType directly, removing the fallback to 'list'.
frontend/.../Override/Summary2Override.test.tsx Introduced repeatingGroupComponentId constant to replace hardcoded IDs and updated test assertions accordingly.
frontend/.../Override/Summary2OverrideEntry.tsx Added cases for Checkboxes and MultipleSelect in defaultOverrideConfig and updated rendering to include Summary2OverrideDisplayType for these types.

Possibly related PRs

Suggested labels

skip-manual-testing

Suggested reviewers

  • mlqn
  • lassopicasso

📜 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 16630f9 and a357afd.

📒 Files selected for processing (3)
  • frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/OverrideFields/Summary2OverrideDisplayType.tsx (1 hunks)
  • frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/Summary2Override.test.tsx (2 hunks)
  • frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/Summary2OverrideEntry.tsx (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/OverrideFields/Summary2OverrideDisplayType.tsx (2)
Learnt from: lassopicasso
PR: Altinn/altinn-studio#14575
File: frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/OverrideFields/Summary2OverrideDisplayType.tsx:47-58
Timestamp: 2025-02-07T09:50:33.290Z
Learning: Avoid suggesting StudioCombobox component in future PRs for the Altinn Studio repository. A new replacement component will be introduced later.
Learnt from: Jondyr
PR: Altinn/altinn-studio#14379
File: frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/Summary2OverrideEntry.tsx:63-70
Timestamp: 2025-01-13T12:44:45.751Z
Learning: In the Altinn Studio codebase, when using StudioProperty.Button component, it's expected to pass `false` as the value prop when no meaningful value is available (e.g., when componentNameType is undefined). This is the intended behavior and should not be changed to handle undefined cases differently.
frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/Summary2OverrideEntry.tsx (1)
Learnt from: lassopicasso
PR: Altinn/altinn-studio#14575
File: frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/OverrideFields/Summary2OverrideDisplayType.tsx:47-58
Timestamp: 2025-02-07T09:50:33.290Z
Learning: Avoid suggesting StudioCombobox component in future PRs for the Altinn Studio repository. A new replacement component will be introduced later.
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Testing
  • GitHub Check: Typechecking and linting
  • GitHub Check: CodeQL
  • GitHub Check: Build environment and run e2e test
🔇 Additional comments (7)
frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/OverrideFields/Summary2OverrideDisplayType.tsx (2)

37-37: LGTM! Aligned with PR objectives.

The removal of the default value for displayType aligns with the PR's goal of moving display type defaults to shared default logic.


37-37: LGTM! Moving default value to shared logic.

The removal of the default value || 'list' aligns with the PR objective of centralizing default values in the shared configuration logic.

frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/Summary2OverrideEntry.tsx (3)

69-71: LGTM! Well-structured default configuration.

The implementation effectively moves the displayType default to shared logic, using case fallthrough for components that share the same default configuration.


69-71: LGTM! Added default configuration for new component types.

The addition of Checkboxes and MultipleSelect cases with a default displayType of 'list' properly centralizes the default configuration logic.


147-149: LGTM! Added rendering logic for new component types.

The new cases correctly map Checkboxes and MultipleSelect components to the Summary2OverrideDisplayType component.

frontend/packages/ux-editor/src/components/config/componentSpecificContent/Summary2/Override/Summary2Override.test.tsx (2)

29-29: LGTM! Improved test maintainability.

The introduction of repeatingGroupComponentId constant and the additional test cases for MultipleSelect enhance code readability and ensure proper coverage of the new default configuration logic.

Also applies to: 195-195, 201-201, 207-217


29-29: LGTM! Test updates properly verify new functionality.

The changes improve code maintainability by:

  1. Centralizing the repeating group ID in a constant
  2. Adding test coverage for the new MultipleSelect default configuration

Also applies to: 195-201, 214-217


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.

@Jondyr Jondyr self-assigned this Feb 13, 2025
@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 13, 2025
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.

👍

Copy link

codecov bot commented Feb 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.76%. Comparing base (16630f9) to head (a357afd).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14654      +/-   ##
==========================================
- Coverage   95.76%   95.76%   -0.01%     
==========================================
  Files        1914     1914              
  Lines       24948    24948              
  Branches     2858     2857       -1     
==========================================
- Hits        23892    23891       -1     
  Misses        798      798              
- Partials      258      259       +1     

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

Moves default value for displayType from the nativeselect component to
the shared default config when selecting components to override.

commit-id:3b4f4086

Co-authored-by: Lars <[email protected]>
Copy link
Contributor

@mlqn mlqn left a comment

Choose a reason for hiding this comment

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

Tested OK! 💯

Base automatically changed from spr/main/a7e89d34 to main February 14, 2025 13:43
@Jondyr Jondyr merged commit 8255827 into main Feb 14, 2025
12 checks passed
@Jondyr Jondyr deleted the spr/main/3b4f4086 branch February 14, 2025 14:07
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 solution/studio/designer Issues related to the Altinn Studio Designer solution. team/studio-domain2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing display property for Subform and RepeatingGroup in Summary2 overrides
3 participants