Skip to content

Handle constructor parameters with no matching field#1228

Merged
rrousselGit merged 1 commit intomasterfrom
fix-1216
Apr 5, 2025
Merged

Handle constructor parameters with no matching field#1228
rrousselGit merged 1 commit intomasterfrom
fix-1216

Conversation

@rrousselGit
Copy link
Copy Markdown
Owner

@rrousselGit rrousselGit commented Apr 5, 2025

fixes #1216

Summary by CodeRabbit

  • Bug Fixes

    • Improved the cloning functionality by ensuring that parameters are correctly mapped and validated, resulting in more reliable copy operations.
  • New Features

    • Constructors now support optional parameters with default values for greater flexibility.
    • Introduced new example models that showcase enhanced cloning behavior.
  • Tests

    • Added tests to confirm that the new constructor defaults and improved cloning functionality work as expected.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 5, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates the internal logic of the copyWith implementation and related tests. The changelog notes a bug fix for unmapped constructor parameters. Core model changes now filter cloneable properties to only include those also listed as readable and add a check that throws an error if a required parameter isn’t cloneable. Additionally, test files have been updated to use optional parameters with defaults and include new classes to verify the corrected behavior and error handling.

Changes

Files Change Summary
packages/freezed/CHANGELOG.md
packages/freezed/lib/src/.../models.dart
Updated core functionality for copyWith: changelog notes a fix, and model logic now filters cloneable properties to ensure they are also readable. Validation now throws an error if a required parameter isn’t cloneable.
packages/freezed/test/... Modified tests: Constructors in extend.dart now use optional parameters with defaults; added new classes (Product, CartLine, RequiredCloneable) and tests to verify copyWith behavior and error handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Instance
    participant Validator
    participant ErrorHandler

    User->>Instance: Create CartLine (without defaultAmount)
    Instance->>Instance: Check if defaultAmount is provided
    Instance->>Instance: Use product.price if defaultAmount missing
    Instance-->>User: Return new CartLine instance

    User->>Instance: Invoke copyWith with modifications
    Instance->>Validator: Filter cloneable & readable properties
    alt All required properties valid
        Validator-->>Instance: Properties validated
        Instance-->>User: Return updated instance
    else
        Validator-->>Instance: Detected non-cloneable parameter
        Instance->>ErrorHandler: Trigger error generation
        ErrorHandler-->>User: Throw InvalidGenerationSourceError
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Fix invalid generated code with non-constant default value in copyWith (#1216)

Poem

I'm a rabbit of code, light on my feet,
Hopping over bugs with a rhythmic beat,
My copyWith now dances without a miss,
Filtering properties with a hop and a twist,
Optional defaults make my journey so sweet,
In this code-filled burrow, every fix is a treat! 🐰✨


📜 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 52065e9 and 9f0806b.

📒 Files selected for processing (5)
  • packages/freezed/CHANGELOG.md (1 hunks)
  • packages/freezed/lib/src/models.dart (1 hunks)
  • packages/freezed/test/integration/extend.dart (2 hunks)
  • packages/freezed/test/manual_test.dart (2 hunks)
  • packages/freezed/test/source_gen_src.dart (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@rrousselGit rrousselGit merged commit 33e7ee3 into master Apr 5, 2025
4 of 5 checks passed
@rrousselGit rrousselGit deleted the fix-1216 branch April 5, 2025 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Invalid generated code with non-constant default value

1 participant