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: validation for text key #14669

Merged
merged 6 commits into from
Feb 18, 2025
Merged

fix: validation for text key #14669

merged 6 commits into from
Feb 18, 2025

Conversation

lassopicasso
Copy link
Contributor

@lassopicasso lassopicasso commented Feb 14, 2025

Description

User won't receive an error anymore when updating the text key with uppercase

For some reason code changes show that I removed this, but it doesn't exist in main neither.

image

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

  • Bug Fixes

    • Improved text editing behavior to allow updates when only the letter casing of an entry is modified, preventing incorrect duplicate warnings.
  • Tests

    • Added tests to confirm that case changes in text entries are handled correctly.

Copy link
Contributor

coderabbitai bot commented Feb 14, 2025

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the TextRow and TextList components, specifically affecting the idExists function and the validateNewTextId function. The TextRowProps interface is updated to accept two parameters for ID existence checks, and the logic in both functions is streamlined for clarity. Additionally, a new test case is added to the TextRow test suite to verify that the updateEntryId function is called when the text key is modified with different casing. No existing tests are removed or altered.

Changes

File(s) Change Summary
frontend/.../TextRow.test.tsx Added a new test case to verify updateEntryId is called when the text key changes only in casing.
frontend/.../TextRow.tsx, frontend/.../TextList.tsx Updated idExists method signature to accept two parameters: newTextId and oldTextId. Simplified logic in validateNewTextId to enhance ID validation process.

Possibly related PRs

Suggested labels

area/ui-editor, kind/bug, quality/testing

Suggested reviewers

  • mlqn
  • Jondyr

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/text-editor Area: Related to creating, translating and editing texts. solution/studio/designer Issues related to the Altinn Studio Designer solution. frontend labels Feb 14, 2025
@lassopicasso lassopicasso linked an issue Feb 14, 2025 that may be closed by this pull request
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 (95c2718) to head (adcc32d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14669      +/-   ##
==========================================
- Coverage   95.76%   95.76%   -0.01%     
==========================================
  Files        1914     1914              
  Lines       24949    24947       -2     
  Branches     2857     2856       -1     
==========================================
- Hits        23892    23890       -2     
  Misses        798      798              
  Partials      259      259              

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

@lassopicasso lassopicasso marked this pull request as ready for review February 14, 2025 13:11
Copy link
Member

@Jondyr Jondyr left a comment

Choose a reason for hiding this comment

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

Nice! 🚀
Just a small comment on the diff with main mentioned in the PR summary.

frontend/packages/text-editor/src/TextRow.test.tsx Outdated Show resolved Hide resolved
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 👍

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/text-editor/src/TextList.tsx (1)

34-37: LGTM! The implementation correctly fixes the case sensitivity issue.

The function now properly handles text key validation with different casings, which directly addresses the reported issue. A few suggestions for improvement:

  1. Add JSDoc documentation to clarify the function's purpose and parameters.
  2. Consider a more efficient single-pass implementation.

Here's a suggested improvement with documentation and optimized implementation:

+/**
+ * Checks if a new text ID already exists in the list, excluding the old text ID.
+ * The comparison is case-insensitive.
+ * @param newTextId - The new text ID to check
+ * @param oldTextId - The current text ID to exclude from the check
+ * @returns true if the new text ID exists (case-insensitive), false otherwise
+ */
-const idExists = (newTextId: string, oldTextId: string): boolean =>
-  textIds
-    .filter((textId: string) => textId.toLowerCase() !== oldTextId.toLowerCase())
-    .some((textId: string) => StringUtils.areCaseInsensitiveEqual(textId, newTextId));
+const idExists = (newTextId: string, oldTextId: string): boolean => {
+  const oldTextLower = oldTextId.toLowerCase();
+  return textIds.some((textId: string) => 
+    textId.toLowerCase() !== oldTextLower && 
+    StringUtils.areCaseInsensitiveEqual(textId, newTextId)
+  );
+};
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 433c393 and adcc32d.

📒 Files selected for processing (3)
  • frontend/packages/text-editor/src/TextList.tsx (1 hunks)
  • frontend/packages/text-editor/src/TextRow.test.tsx (1 hunks)
  • frontend/packages/text-editor/src/TextRow.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • frontend/packages/text-editor/src/TextRow.test.tsx
  • frontend/packages/text-editor/src/TextRow.tsx
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: Testing
  • GitHub Check: Typechecking and linting
  • GitHub Check: CodeQL
🔇 Additional comments (1)
frontend/packages/text-editor/src/TextList.tsx (1)

33-33: LGTM! Good use of memoization.

The memoization of text keys is correctly implemented and will prevent unnecessary recalculations when other props change.

@JamalAlabdullah JamalAlabdullah merged commit 64b8511 into main Feb 18, 2025
12 checks passed
@JamalAlabdullah JamalAlabdullah deleted the fix-case-error-text-key branch February 18, 2025 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/text-editor Area: Related to creating, translating and editing texts. 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 text key
3 participants