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: case error page id #14665

Merged
merged 6 commits into from
Feb 18, 2025
Merged

fix: case error page id #14665

merged 6 commits into from
Feb 18, 2025

Conversation

lassopicasso
Copy link
Contributor

@lassopicasso lassopicasso commented Feb 14, 2025

Description

Users will no longer receive an error when updating the page ID with different case letters

Replaced the formLayoutSettings.pages.order to get the page names, as the new Navigation structure will likely change this logic.

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

  • Bug Fixes

    • Enhanced page name validation, ensuring that name comparisons are now case-insensitive for more accurate error handling.
    • Improved error handling for empty candidate names in page name checks.
  • Tests

    • Expanded automated testing to verify that names with different letter casing are properly recognized, reinforcing reliability in name uniqueness checks.
    • Updated tests to cover various invalid name scenarios, including empty names and names with invalid characters.

Copy link
Contributor

coderabbitai bot commented Feb 14, 2025

📝 Walkthrough

Walkthrough

This pull request modifies the pageNameExists and getPageNameErrorKey functions in the design view utility. The pageNameExists function's parameters have been restructured to accept an object, and its internal logic has been updated for clarity. The getPageNameErrorKey function has also been adjusted to improve error handling and streamline checks. Additionally, the related test cases in designViewUtils.test.ts have been updated to reflect these changes, including new scenarios for non-unique names. No alterations were made to exported or public entities.

Changes

File(s) Change Summary
frontend/packages/ux-editor/src/.../designViewUtils.ts
frontend/packages/ux-editor/src/.../designViewUtils.test.ts
Restructured parameters for pageNameExists and getPageNameErrorKey functions, updated internal logic, and modified test cases to reflect these changes, including new scenarios for non-unique names.
frontend/packages/ux-editor/src/components/Properties/PageConfigPanel/EditPageId.tsx Updated import from useFormLayoutSettingsQuery to useFormLayoutsQuery, renamed related variables, and modified validation logic for form layouts.

Possibly related PRs

  • fix: replace filename validation messages #14434: The changes in the main PR are related to the modifications in the getPageNameErrorKey function, which also involve updates to error handling for invalid names, similar to the adjustments made in the retrieved PR regarding validation messages.

Suggested labels

kind/bug, added-to-sprint, team/studio-domain1, skip-manual-testing, skip-documentation

Suggested reviewers

  • Jondyr
  • github-actions
  • mlqn

📜 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 4483e78 and 544013b.

📒 Files selected for processing (3)
  • frontend/packages/ux-editor/src/components/Properties/PageConfigPanel/EditPageId.tsx (3 hunks)
  • frontend/packages/ux-editor/src/utils/designViewUtils/designViewUtils.test.ts (6 hunks)
  • frontend/packages/ux-editor/src/utils/designViewUtils/designViewUtils.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/packages/ux-editor/src/utils/designViewUtils/designViewUtils.test.ts
⏰ 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 (4)
frontend/packages/ux-editor/src/utils/designViewUtils/designViewUtils.ts (2)

8-17: LGTM! Well-structured type definition and improved function implementation.

The changes improve type safety and make the code more maintainable:

  • Clear type definition with descriptive field names
  • Case-insensitive comparison prevents the reported issue
  • Efficient filtering of old name before uniqueness check

28-38: LGTM! Enhanced error handling with clear validation flow.

The changes improve the validation logic:

  • Early return for empty name
  • Clear error keys for each validation case
  • Consistent return type (TranslationKey | null)
frontend/packages/ux-editor/src/components/Properties/PageConfigPanel/EditPageId.tsx (2)

9-9: LGTM! Improved form layouts query usage.

The changes correctly update the import and query usage to match the new API.

Also applies to: 23-23


43-44: LGTM! Enhanced validation logic.

The changes improve the validation flow:

  • Correctly passes layout names from formLayouts
  • Returns undefined only when there's no error
✨ 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.

@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 14, 2025
@lassopicasso lassopicasso changed the title Fix case error page fix: case error page id Feb 14, 2025
@lassopicasso lassopicasso marked this pull request as ready for review February 14, 2025 11:33
@lassopicasso lassopicasso linked an issue Feb 14, 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 (1)
frontend/packages/ux-editor/src/utils/designViewUtils/designViewUtils.test.ts (1)

36-43: LGTM! Good test coverage for case-insensitive behavior.

The test case effectively verifies the fix for uppercase letters in page IDs. Consider adding another test case for mixed case variations to ensure comprehensive coverage.

+    it('return null when new name is the same as old name but with mixed case', () => {
+      const mixedCaseName = mockOldName.split('').map((c, i) => 
+        i % 2 === 0 ? c.toUpperCase() : c.toLowerCase()
+      ).join('');
+      const nameErrorkey = getPageNameErrorKey(
+        mixedCaseName,
+        mockOldName,
+        mockLayoutOrder,
+      );
+      expect(nameErrorkey).toEqual(null);
+    });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 502c440 and 4483e78.

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

24-27: LGTM! Consistent case-insensitive comparison.

The implementation correctly uses case-insensitive comparison and aligns well with the existing pageNameExists function which already uses the same approach. This change effectively fixes the issue with uppercase letters in page IDs.

Copy link

codecov bot commented Feb 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.76%. Comparing base (187a0e9) to head (547d45e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14665      +/-   ##
==========================================
- Coverage   95.76%   95.76%   -0.01%     
==========================================
  Files        1914     1914              
  Lines       24950    24949       -1     
  Branches     2857     2857              
==========================================
- Hits        23893    23892       -1     
  Misses        798      798              
  Partials      259      259              

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

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.

Nice work! 💯

Copy link
Contributor

@JamalAlabdullah JamalAlabdullah 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 in dev 👍

@JamalAlabdullah JamalAlabdullah merged commit 95c2718 into main Feb 18, 2025
11 checks passed
@JamalAlabdullah JamalAlabdullah deleted the fix-case-error-page-id branch February 18, 2025 09:37
@coderabbitai coderabbitai bot mentioned this pull request Feb 18, 2025
4 tasks
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.

Error occurs when changing the case of a page id
3 participants