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

feat: Subform table hide component selector when column has already one copied #14476

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

lassopicasso
Copy link
Contributor

@lassopicasso lassopicasso commented Jan 21, 2025

Description

This PR handles the issue of missing references to the copied component when creating and saving a new column in a subform table. The component selector is now hidden when reopening a column with a preselected/copied component, while still allowing the user to edit the column's content.

hide-component-selector.mp4

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

Summary by CodeRabbit

  • Tests

    • Enhanced test suite for EditColumnElement component.
    • Added new test cases for component selector rendering.
    • Introduced helper functions to improve test readability.
    • Updated test logic for editing a column to use text input instead of component selection.
  • Refactor

    • Renamed ColumnElementProps to EditColumnElementProps.
    • Updated component prop type definitions.
    • Modified conditional rendering logic for component selection.

Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

📝 Walkthrough

Walkthrough

This pull request introduces significant modifications to the EditColumnElement component and its associated tests within the UX editor package. The changes include the renaming of prop types, the addition of new helper functions, and the enhancement of test coverage with new test cases. Furthermore, the component's conditional rendering logic has been updated to improve clarity and functionality, particularly concerning component selection and editing processes.

Changes

File Change Summary
frontend/packages/ux-editor/.../EditColumnElement.test.tsx - Added renderEditColumnElement and selectComponentSelector helper functions
- Introduced default props object defaultEditColumnProps
- Added new test cases for component selector
- Created new type definitions for props
frontend/packages/ux-editor/.../EditColumnElement.tsx - Renamed ColumnElementProps to EditColumnElementProps
- Added isComponentCopySaved variable
- Updated conditional rendering logic for component selection
frontend/packages/ux-editor/.../ColumnElement.test.tsx - Updated mockTableColumn object to use empty strings for headerContent and cellContent properties
frontend/packages/ux-editor/.../EditSubformTableColumns.test.tsx - Changed column editing logic from component selector to direct text input

Possibly related PRs

Suggested labels

quality/testing, team/studio-domain1, team/studio-core

Suggested reviewers

  • mlqn
  • Annikenkbrathen

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.

@lassopicasso lassopicasso changed the title Subform table hide component selector when column has one copied Subform table hide component selector when column has already one copied Jan 21, 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 Jan 21, 2025
@lassopicasso lassopicasso changed the title Subform table hide component selector when column has already one copied fix: Subform table hide component selector when column has already one copied Jan 21, 2025
@lassopicasso
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@lassopicasso lassopicasso linked an issue Jan 21, 2025 that may be closed by this pull request
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 (2)
frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.test.tsx (1)

84-113: Consider grouping related test helper functions.

The test helper functions are well-implemented, but consider moving selectComponentSelector closer to renderEditColumnElementComponentSelect for better code organization.

frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.tsx (1)

87-98: Consider a more robust condition check.

While the implementation works, checking string length might be fragile. Consider using a more explicit condition:

-  const isComponentCopySaved = sourceColumn.headerContent.length > 0;
+  const isComponentCopySaved = Boolean(sourceColumn.headerContent);

This change:

  • Handles undefined/null values safely
  • Makes the intent clearer
  • Is consistent with boolean conversions
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bf9c119 and 8e0b436.

📒 Files selected for processing (2)
  • frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.test.tsx (2 hunks)
  • frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: Testing
  • GitHub Check: CodeQL
🔇 Additional comments (5)
frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.test.tsx (3)

7-16: LGTM! Well-organized imports.

The imports are properly structured and include all necessary testing utilities and component types.


17-32: LGTM! Well-structured test setup.

The default props and test data are well-defined, providing a solid foundation for testing different scenarios.


34-58: LGTM! Tests effectively cover the component selector visibility logic.

The test cases thoroughly verify the main PR objective:

  1. Component selector is shown when no component is selected
  2. Component selector is hidden when a component is already selected and saved
frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.tsx (2)

Line range hint 27-41: LGTM! Clear and well-typed props interface.

The renaming of ColumnElementProps to EditColumnElementProps improves clarity and better reflects the component's purpose.


93-98: LGTM! Clean implementation of component selector visibility.

The conditional rendering logic effectively implements the PR objective of hiding the component selector when a column already has a copied component.

@lassopicasso lassopicasso changed the title fix: Subform table hide component selector when column has already one copied feat: Subform table hide component selector when column has already one copied Jan 21, 2025
@lassopicasso lassopicasso marked this pull request as ready for review January 21, 2025 14:28
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/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.test.tsx (1)

114-121: Consider enhancing the selectComponentSelector helper function.

While the function works correctly, it could be more reusable by returning the componentSelector for chaining in tests.

 const selectComponentSelector = async () => {
   const user = userEvent.setup();
   const componentSelector = screen.getByRole('combobox', {
     name: textMock('ux_editor.properties_panel.subform_table_columns.choose_component'),
   });
   expect(componentSelector).toBeInTheDocument();
   await user.click(componentSelector);
+  return componentSelector;
 };
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8e0b436 and 3148002.

📒 Files selected for processing (4)
  • frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/ColumnElement.test.tsx (1 hunks)
  • frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.test.tsx (3 hunks)
  • frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.tsx (3 hunks)
  • frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/EditSubformTableColumns.test.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.tsx
🔇 Additional comments (3)
frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/ColumnElement.test.tsx (1)

18-21: LGTM! Test mock data accurately reflects initial column state.

The empty strings in mockTableColumn correctly represent the initial state of a new column before component selection.

frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/ColumnElement/EditColumnElement/EditColumnElement.test.tsx (1)

34-58: LGTM! Test coverage aligns perfectly with PR objective.

The test cases comprehensively verify the component selector's visibility behavior:

  1. Visible when no component is selected
  2. Hidden when a component is already selected and saved
frontend/packages/ux-editor/src/components/Properties/EditSubformTableColumns/EditSubformTableColumns.test.tsx (1)

84-87: Consider adding test coverage for component selection.

While the current test covers title editing, it should also verify component selection for new columns. Consider adding a test case that covers both scenarios:

  1. Editing a column with an existing component (current test)
  2. Editing a new column that requires component selection

Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.69%. Comparing base (d2043cc) to head (3148002).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14476   +/-   ##
=======================================
  Coverage   95.69%   95.69%           
=======================================
  Files        1888     1888           
  Lines       24556    24558    +2     
  Branches     2818     2819    +1     
=======================================
+ Hits        23498    23500    +2     
  Misses        799      799           
  Partials      259      259           

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

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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The selected component does not remain selected
1 participant