fix: don't reuse request field numbers when arguments are removed

[endigma]

Summary by CodeRabbit

• Bug Fixes

  • Improved handling of field numbering for GraphQL arguments to ensure removed field numbers are not reused, maintaining consistent and non-overlapping field assignments.

• Tests

  • Added tests to verify that field numbers for removed arguments remain reserved and are not reassigned when arguments are re-added.

Checklist

• I have discussed my proposed changes in an issue and have received approval to proceed.
• I have followed the coding standards of the project.
• Tests or benchmarks have been added or updated.
• Documentation has been updated on https://github.com/wundergraph/cosmo-docs.
• I have read the Contributors Guide.

[coderabbitai]

Walkthrough

The code modifies the logic in the SDL-to-Proto visitor to centralize and simplify field order reconciliation and field number assignment using the lock manager and helper methods. Additionally, the test suite for the ProtoLockManager is updated with a new case to verify that field numbers for arguments are never reused after removal.

Changes

Cohort / File(s)	Change Summary
Visitor Logic Refactor protographic/src/sdl-to-proto-visitor.ts	Refactored to remove unused imports and streamline request message field order reconciliation and field number assignment by delegating these responsibilities to the lock manager and helper methods, eliminating manual field tracking and direct lookups.
ProtoLockManager Tests Update protographic/tests/sdl-to-proto/08-proto-lock-manager.test.ts	Added a test case to confirm that field numbers assigned to arguments are never reused after removal and re-addition, ensuring field indexes are always incremented and reserved numbers are not reassigned.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 1a947b1 and 8634e7d.

📒 Files selected for processing (2)

• protographic/src/sdl-to-proto-visitor.ts (2 hunks)
• protographic/tests/sdl-to-proto/08-proto-lock-manager.test.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: Analyze (go)
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (4)

protographic/tests/sdl-to-proto/08-proto-lock-manager.test.ts (2)

3-3: LGTM: Import addition supports the new test case.

The addition of compileGraphQLToProto import is appropriate for the new integration test that verifies end-to-end field numbering behavior.

---

191-224: Excellent test coverage for argument field number reuse prevention.

This test case comprehensively validates the core functionality described in the PR title - ensuring field numbers are never reused when arguments are temporarily removed and re-added. The test follows a clear three-step verification:

1. Initial compilation assigns field number 1 to the 'name' argument
2. Removal of the argument reserves field number 1
3. Re-addition assigns field number 2, keeping 1 reserved

The test structure is well-organized with descriptive assertions and clear schema definitions that make the test intent obvious.

protographic/src/sdl-to-proto-visitor.ts (2)

847-847: Good refactoring: Centralizes field order reconciliation.

This change delegates field ordering logic to the ProtoLockManager's reconcileMessageFieldOrder method, which is responsible for tracking removed fields and maintaining proper field numbering. This centralization aligns with the PR objective of preventing field number reuse.

---

882-886: Proper field number assignment through helper methods.

The refactored approach uses the getFieldNumber helper method with getNextAvailableFieldNumber as the default, ensuring consistent field numbering logic throughout the codebase. This change supports the core functionality where removed argument field numbers are properly reserved and not reused.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch jesse/eng-7585-fix-index-overlap

---

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

• 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
• 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 explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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.

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.

[Noroth]

lgtm