If no subfields are set in a map, add the field to fieldMask

[sbansal7]

If no subfields are set, the user might still want to set the default values of the map/object. In this case, add the parent field to fieldMask

References to other Issues or PRs

Fixes #3866

Have you read the Contributing Guidelines?

yes

Brief description of what is fixed or changed

If no subfields are set for a map/object, the user might still want to set the default values of the map/object. In this case, add the parent field to fieldMask

Other comments

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of object lengths in field mask processing.
  • Enhanced test coverage for field mask functionality with refined test cases.

[coderabbitai]

Walkthrough

The code changes involve enhancing the FieldMaskFromRequestBody function to correctly handle cases where a field of type google.protobuf.Empty is present. The logic now ensures that when such a field is set, even if it's an empty object, it is included in the generated field mask. Additionally, the associated tests have been expanded to cover these scenarios, with a specific focus on differentiating between an empty message and a non-empty one.

Changes

Files	Change Summary
runtime/fieldmask.go	Updated logic to handle empty objects in FieldMaskFromRequestBody
runtime/fieldmask_test.go	Expanded test cases to cover new logic for empty objects

Assessment against linked issues

Objective	Addressed	Explanation
#3866: FieldMask does not generate for google.protobuf.Empty	✅

Poem

🐇 In the realm of code, where emptiness lay,
🌟 A rabbit hopped forth, casting shadows away.
📦 For each empty field, a mask now unfurled,
🎉 Patched with care, a message to the world.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f606c69 and 59851bf.

Files selected for processing (2)

• runtime/fieldmask.go (2 hunks)
• runtime/fieldmask_test.go (1 hunks)

Files skipped from review due to trivial changes (1)

• runtime/fieldmask_test.go

Additional comments: 4

runtime/fieldmask.go (4)

• 44-44: The logic to handle objects with non-zero length seems to be correct, as it processes each child of the map. However, it's important to ensure that the error messages are clear and provide enough context for debugging.

• 99-100: The use of fallthrough here is critical to the PR's objective. It ensures that even if a map is empty (zero-length), the parent field's path is still added to the field mask. This change aligns with the user's expectation that an empty object should still be represented in the field mask.

• 100-100: The fallthrough statement leads to the case where len(item.path) > 0. This is a clever way to handle both empty maps and non-empty paths without duplicating code. However, it's important to ensure that this does not introduce any unintended side effects, especially in cases where item.path might be empty. It would be beneficial to add a test case to ensure that an empty item.path does not inadvertently get added to the field mask.

• 96-103: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [44-100]

While the changes to the FieldMaskFromRequestBody function seem to address the issue, it's important to verify that the new logic does not break existing functionality. This can be done by running the full test suite and checking for any regressions.

[johanbrandhorst]

LGTM!

[johanbrandhorst]

Thanks for your contribution!