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: datamodels with hyphens in name #14455

Merged
merged 3 commits into from
Jan 21, 2025
Merged

Conversation

Jondyr
Copy link
Member

@Jondyr Jondyr commented Jan 20, 2025

Description

Refactoring useValidDataModels slightly to not use metadata to select datamodel.

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

Release Notes

  • Refactor

    • Updated logic for determining the selected data model in the data model utility functions.
    • Simplified parameter handling in data model-related functions.
  • Tests

    • Adjusted test cases for data model utilities to align with new function parameters.
    • Removed a test case that checked for invalid data models in the data model hook.

These changes enhance the efficiency of data model selection and validation, ensuring a more reliable user experience.

Copy link
Contributor

coderabbitai bot commented Jan 20, 2025

📝 Walkthrough

Walkthrough

The pull request focuses on modifying the data model handling logic in the UX editor package. The changes primarily involve updating the getDataModel function in dataModelUtils.ts by replacing the dataModelMetadata parameter with a defaultDataModelName. This modification affects how data models are selected and validated across multiple files, including the useValidDataModels hook and its associated test files. The changes aim to simplify the data model selection process and provide a more straightforward approach to handling default and current data models.

Changes

File Change Summary
frontend/packages/ux-editor/src/utils/dataModelUtils.ts - Updated getDataModel function signature
- Replaced dataModelMetadata with defaultDataModelName
- Modified logic for selecting data models
frontend/packages/ux-editor/src/utils/dataModelUtils.test.ts - Updated test cases to use defaultModel instead of dataModelMetadata
- Simplified function calls in tests
frontend/packages/ux-editor/src/hooks/useValidDataModels.ts - Modified logic for selecting data model
- Now uses dataModel directly instead of dataModelMetadata
frontend/packages/ux-editor/src/hooks/useValidDataModels.test.ts - Removed a test case checking invalid data model behavior

Possibly related PRs

  • feat: Remove featureflag multiple data models per task #14171: The main PR involves changes to the useValidDataModels hook, which is related to the handling of data models. The retrieved PR also deals with data models by removing a feature flag related to multiple data models, indicating a connection in the context of data model management.
  • refactor: Remove useBpmnModeler #14464: This PR refactors the useBpmnModeler, which is related to managing model instances. While it focuses on a different model type (BPMN), the underlying theme of managing models in a React context aligns with the changes in the main PR regarding data model handling.

Suggested Labels

kind/bug, quality/code, team/studio-domain2, skip-manual-testing

Suggested Reviewers

  • github-actions

📜 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 d148615 and 4674647.

📒 Files selected for processing (4)
  • frontend/packages/ux-editor/src/hooks/useValidDataModels.test.ts (0 hunks)
  • frontend/packages/ux-editor/src/hooks/useValidDataModels.ts (1 hunks)
  • frontend/packages/ux-editor/src/utils/dataModelUtils.test.ts (1 hunks)
  • frontend/packages/ux-editor/src/utils/dataModelUtils.ts (1 hunks)
💤 Files with no reviewable changes (1)
  • frontend/packages/ux-editor/src/hooks/useValidDataModels.test.ts
🚧 Files skipped from review as they are similar to previous changes (3)
  • frontend/packages/ux-editor/src/hooks/useValidDataModels.ts
  • frontend/packages/ux-editor/src/utils/dataModelUtils.test.ts
  • frontend/packages/ux-editor/src/utils/dataModelUtils.ts
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: Testing

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 Jan 20, 2025
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: 1

🧹 Nitpick comments (1)
frontend/packages/ux-editor/src/utils/dataModelUtils.ts (1)

144-152: LGTM! Clean refactoring of getDataModel function.

The refactoring improves the handling of data models with hyphens by removing the metadata dependency. The logic is now more straightforward and robust.

Consider adding JSDoc comments to document the parameters and return value:

+/**
+ * Gets the appropriate data model based on validation state and defaults
+ * @param isDataModelValid - Whether the current data model is valid
+ * @param defaultDataModelName - The fallback data model name
+ * @param currentDataModel - The currently selected data model
+ * @returns The resolved data model name
+ */
 export const getDataModel = (
   isDataModelValid: boolean,
   defaultDataModelName: string,
   currentDataModel?: string,
 ): string => {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2f9696e and dab1570.

📒 Files selected for processing (4)
  • frontend/packages/ux-editor/src/hooks/useValidDataModels.test.ts (0 hunks)
  • frontend/packages/ux-editor/src/hooks/useValidDataModels.ts (1 hunks)
  • frontend/packages/ux-editor/src/utils/dataModelUtils.test.ts (1 hunks)
  • frontend/packages/ux-editor/src/utils/dataModelUtils.ts (1 hunks)
💤 Files with no reviewable changes (1)
  • frontend/packages/ux-editor/src/hooks/useValidDataModels.test.ts
⏰ 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/hooks/useValidDataModels.ts (1)

38-38: Verify error handling for undefined dataModel.

The change correctly removes the metadata dependency, but we should ensure proper error handling when dataModel is undefined.

Run this script to check for potential undefined dataModel scenarios:

Copy link

codecov bot commented Jan 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.69%. Comparing base (c07d821) to head (4674647).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14455   +/-   ##
=======================================
  Coverage   95.69%   95.69%           
=======================================
  Files        1889     1889           
  Lines       24573    24573           
  Branches     2822     2822           
=======================================
  Hits        23515    23515           
  Misses        799      799           
  Partials      259      259           

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

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.

Nice 💪 One comment.

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
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 in dev! 🚀

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.

Errors occur when selecting a data model binding with hyphens in its name
3 participants