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

Support expandable in initial form data #21153

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

bramkragten
Copy link
Member

@bramkragten bramkragten commented Jun 24, 2024

Proposed change

Needed for: home-assistant/core#118369

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue or discussion:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Summary by CodeRabbit

  • New Features
    • Added support for expandable fields in forms, ensuring initial data is computed recursively for these fields.

Copy link
Contributor

coderabbitai bot commented Jun 24, 2024

Walkthrough

Walkthrough

The recent update enhances the computeInitialHaFormData function to support an "expandable" field type. This involves recursively processing these fields to compute their initial data. Additionally, the function's declaration has been modified to accept read-only schema arrays, improving flexibility and usage within different contexts and enforcing immutability constraints when necessary.

Changes

File Path Change Summary
src/components/ha-form/compute-initial-ha-form-data.ts Updated computeInitialHaFormData to handle "expandable" field types recursively; changed parameter type to support readonly arrays

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FormComponent
    participant computeInitialHaFormData
    
    User ->> FormComponent: Load form
    FormComponent ->> computeInitialHaFormData: Call with schema
    computeInitialHaFormData -->> computeInitialHaFormData: Process schema
    alt contains expandable field
        computeInitialHaFormData -->> computeInitialHaFormData: Recursively process expandable field
    end
    computeInitialHaFormData -->> FormComponent: Return initial data
    FormComponent -->> User: Render form with initial data
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between d00b3cf and f800720.

Files selected for processing (1)
  • src/components/ha-form/compute-initial-ha-form-data.ts (2 hunks)
Additional context used
Biome
src/components/ha-form/compute-initial-ha-form-data.ts

[error] 6-6: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.


[error] 8-8: Excessive complexity detected. (lint/complexity/noExcessiveCognitiveComplexity)

Please refactor this function to reduce its complexity score from 120 to the max allowed complexity 15.

Additional comments not posted (2)
src/components/ha-form/compute-initial-ha-form-data.ts (2)

5-5: Expandable support in function signature.

The update to the function signature to accept both mutable and immutable arrays (HaFormSchema[] | readonly HaFormSchema[]) is a good practice for ensuring that the function can handle both types of inputs. This change increases the flexibility of the function without affecting existing functionality.


39-40: Recursive handling of 'expandable' field type.

The addition of logic to recursively compute initial data for fields marked as "expandable" is well-implemented. This recursive approach is suitable for nested data structures and aligns with the requirements of expandable elements.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

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: 2

@@ -2,7 +2,7 @@ import type { Selector } from "../../data/selector";
import type { HaFormSchema } from "./types";

export const computeInitialHaFormData = (
schema: HaFormSchema[]
schema: HaFormSchema[] | readonly HaFormSchema[]
): Record<string, any> => {
const data = {};
schema.forEach((field) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Reduce cognitive complexity.

The function computeInitialHaFormData has a cognitive complexity score of 120, which is significantly higher than the maximum allowed score of 15. This high complexity can make the function hard to understand and maintain. Consider refactoring the function to simplify its logic, possibly by breaking it down into smaller helper functions or by simplifying conditional branches.

Tools
Biome

[error] 8-8: Excessive complexity detected. (lint/complexity/noExcessiveCognitiveComplexity)

Please refactor this function to reduce its complexity score from 120 to the max allowed complexity 15.

@@ -2,7 +2,7 @@
import type { HaFormSchema } from "./types";

export const computeInitialHaFormData = (
schema: HaFormSchema[]
schema: HaFormSchema[] | readonly HaFormSchema[]
Copy link
Contributor

Choose a reason for hiding this comment

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

Specify a more precise type than any.

The use of any in the function's return type can disable type checking, which is not ideal in TypeScript. Consider specifying a more detailed type for better type safety and easier maintenance.

- ): Record<string, any> => {
+ ): Record<string, unknown> => {

Committable suggestion was skipped due to low confidence.

@bramkragten bramkragten merged commit 00f325e into dev Jun 24, 2024
14 checks passed
@bramkragten bramkragten deleted the support-expandable-in-initial-form-data branch June 24, 2024 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants