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(delegate): make sure concrete fields are included when a polymorphic model field is included in deep nesting #1524

Merged
merged 2 commits into from
Jun 20, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Jun 20, 2024

Fixes #1522

…hic model field is included in deep nesting

Fixes #1522
Copy link
Contributor

coderabbitai bot commented Jun 20, 2024

Walkthrough

Walkthrough

Recent changes enhance the DelegateProxyHandler in delegate.ts of the packages/runtime package to address issues in field value assignment and SelectIncludeHierarchy injection during database operations. Meanwhile, a new regression test case for issue #1522 validates the correct retrieval and inclusion of subclass model fields in nested include statements, ensuring the fetched data meets expected polymorphic requirements.

Changes

Files/Paths Change Summaries
packages/runtime/src/enhancements/delegate.ts Adjusted logic for handling field values and injections in DelegateProxyHandler, focusing on nextValue assignment and SelectIncludeHierarchy.
tests/regression/tests/issue-1522.test.ts Added regression test for issue #1522, including models (Course, Section, Activity, etc.), and database operations.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Concrete model fields returned when base model retrieved in nested include statement (#1522)
Modified nextValue assignment and injection of SelectIncludeHierarchy in DelegateProxyHandler (#1522)

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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: 3

Outside diff range and nitpick comments (3)
packages/runtime/src/enhancements/delegate.ts (3)

Line range hint 286-292: The else clause is unnecessary as the previous branches contain break statements, simplifying the control flow.

- } else {
-   target = thisLayer;
-   base = this.getBaseModel(base.name);
- }

Line range hint 307-307: Avoid using the delete operator for performance reasons. Consider setting the property to undefined instead.

- delete where[field];
+ where[field] = undefined;

Line range hint 960-960: Consider using optional chaining for better readability and to avoid potential runtime errors.

- if (subModelName) {
+ if (subModelName?) {
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a14bf29 and 6a2520e.

Files selected for processing (2)
  • packages/runtime/src/enhancements/delegate.ts (1 hunks)
  • tests/regression/tests/issue-1522.test.ts (1 hunks)
Additional context used
Biome
packages/runtime/src/enhancements/delegate.ts

[error] 92-94: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.


[error] 132-135: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.


[error] 170-173: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.


[error] 286-292: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.


[error] 307-307: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 330-330: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 653-684: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.


[error] 717-717: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 780-780: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 788-788: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 960-960: Change to an optional chain. (lint/complexity/useOptionalChain)

Unsafe fix: Change to an optional chain.

Additional comments not posted (1)
tests/regression/tests/issue-1522.test.ts (1)

1-1: Ensure the loadSchema import is utilized correctly in the script.

tests/regression/tests/issue-1522.test.ts Show resolved Hide resolved
tests/regression/tests/issue-1522.test.ts Show resolved Hide resolved
packages/runtime/src/enhancements/delegate.ts Show resolved Hide resolved
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

Outside diff range and nitpick comments (3)
packages/runtime/src/enhancements/delegate.ts (3)

Line range hint 92-94: Consider removing unnecessary else clauses.

- else {
-   target = thisLayer;
-   base = this.getBaseModel(base.name);
- }

The else clause can be omitted because the preceding branches end with a break or return statement, making the else unnecessary and potentially confusing.

Also applies to: 132-135, 170-173, 286-292, 653-684


Line range hint 307-307: Consider replacing the delete operator with an assignment to undefined.

- delete args[kind][field];
+ args[kind][field] = undefined;

Using delete can lead to performance issues due to changes in the underlying data structure of objects. Assigning undefined is generally more performant and should be preferred unless you need to remove a property completely to free up memory.

Also applies to: 330-330, 717-717, 780-780, 788-788


Line range hint 960-960: Use optional chaining to simplify the code.

- if (subData && typeof subData === 'object') {
+ if (subData?.object) {

This change leverages optional chaining to make the code cleaner and more readable by reducing unnecessary checks.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6a2520e and 0ca4915.

Files selected for processing (1)
  • packages/runtime/src/enhancements/delegate.ts (1 hunks)
Additional context used
Biome
packages/runtime/src/enhancements/delegate.ts

[error] 92-94: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.


[error] 132-135: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.


[error] 170-173: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.


[error] 286-292: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.


[error] 307-307: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 330-330: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 653-684: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.


[error] 717-717: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 780-780: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 788-788: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 960-960: Change to an optional chain. (lint/complexity/useOptionalChain)

Unsafe fix: Change to an optional chain.

packages/runtime/src/enhancements/delegate.ts Show resolved Hide resolved
@ymc9 ymc9 merged commit b34531d into dev Jun 20, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/issue-1522 branch June 20, 2024 05:22
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.

1 participant