Skip to content

refactor(frontier): remove deprecated fields from list member request messages#483

Open
rohilsurana wants to merge 3 commits intomainfrom
refactor/deprecate-permission-filter-list-org-users
Open

refactor(frontier): remove deprecated fields from list member request messages#483
rohilsurana wants to merge 3 commits intomainfrom
refactor/deprecate-permission-filter-list-org-users

Conversation

@rohilsurana
Copy link
Copy Markdown
Member

@rohilsurana rohilsurana commented Apr 23, 2026

Summary

  • Remove permission_filter field from ListOrganizationUsersRequest and ListProjectUsersRequest, reserve field ids
  • Remove with_roles field from ListOrganizationUsersRequest, ListProjectUsersRequest, ListProjectServiceUsersRequest, ListProjectGroupsRequest, and ListGroupUsersRequest, reserve field ids

Test plan

  • Verify buf lint passes
  • Verify downstream services compile against updated proto

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 23, 2026

📝 Walkthrough

Walkthrough

The PR removes several previously-available role/filter fields from Frontier protobuf request messages and reserves their tag numbers. Changes:

  • ListOrganizationUsersRequest: removed permission_filter (tag 2, deprecated) and with_roles (tag 3); reserved 2, 3 added.
  • ListProjectUsersRequest: removed permission_filter (tag 2) and with_roles (tag 3); reserved 2, 3 added.
  • ListProjectServiceUsersRequest: removed with_roles (tag 3); reserved 3 added.
  • ListProjectGroupsRequest: removed with_roles (tag 2); reserved 2 added.
  • ListGroupUsersRequest: removed with_roles (tag 3); reserved 3 added.

Suggested reviewers

  • rsbh
  • whoAbhishekSah
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: removing deprecated fields from list member request messages in the frontier proto.
Description check ✅ Passed The description is directly related to the changeset, detailing which deprecated fields are being removed and the corresponding reserved field IDs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 23, 2026

The latest Buf updates on your PR. Results from workflow Validate / validate (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed⏩ skipped✅ passed✅ passedApr 27, 2026, 6:16 AM

@rohilsurana rohilsurana marked this pull request as ready for review April 23, 2026 09:25
@rohilsurana rohilsurana requested a review from Copilot April 23, 2026 13:45
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Removes the deprecated permission_filter field from ListOrganizationUsersRequest in the Frontier API proto and reserves its field number to prevent reuse, aligning clients toward role_filters.

Changes:

  • Removed deprecated permission_filter from ListOrganizationUsersRequest.
  • Reserved protobuf field number 2 to avoid tag reuse.
  • Keeps role_filters as the supported filtering mechanism for organization user listing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread raystack/frontier/v1beta1/frontier.proto Outdated
@rohilsurana rohilsurana changed the title refactor(frontier): remove deprecated permission_filter from ListOrganizationUsersRequest refactor(frontier): remove deprecated fields from list member request messages Apr 27, 2026
Copy link
Copy Markdown

@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.

🧹 Nitpick comments (1)
raystack/frontier/v1beta1/frontier.proto (1)

1605-1605: Also reserve the removed field names, not just the tag numbers.

When removing protobuf fields, it is a best practice to reserve both the field tag numbers and field names. Reserving only the numbers prevents tag reuse but still allows field names to be reintroduced with a new tag, creating confusion in text-format representations (TextProto/JSON). The same applies to the parallel changes in ListProjectUsersRequest (Line 1868), ListProjectServiceUsersRequest (Line 1883), ListProjectGroupsRequest (Line 1898), and ListGroupUsersRequest (Line 2128).

Suggested change for Line 1605 (apply the analogous edit to each of the other four messages)
-  reserved 2, 3;
+  reserved 2, 3;
+  reserved "permission_filter", "with_roles";

For the other messages that only dropped with_roles:

-  reserved 3;
+  reserved 3;
+  reserved "with_roles";
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@raystack/frontier/v1beta1/frontier.proto` at line 1605, The proto messages
that removed the with_roles field reserve only the tag numbers (e.g., the line
containing "reserved 2, 3;") but must also reserve the removed field names to
prevent reuse; update the reserved declarations in the affected messages (e.g.,
the message where you saw "reserved 2, 3;" and the messages
ListProjectUsersRequest, ListProjectServiceUsersRequest,
ListProjectGroupsRequest, and ListGroupUsersRequest) to include the string names
of the removed fields (for example include "with_roles" in the reserved clause)
so both tag numbers and field names are reserved.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@raystack/frontier/v1beta1/frontier.proto`:
- Line 1605: The proto messages that removed the with_roles field reserve only
the tag numbers (e.g., the line containing "reserved 2, 3;") but must also
reserve the removed field names to prevent reuse; update the reserved
declarations in the affected messages (e.g., the message where you saw "reserved
2, 3;" and the messages ListProjectUsersRequest, ListProjectServiceUsersRequest,
ListProjectGroupsRequest, and ListGroupUsersRequest) to include the string names
of the removed fields (for example include "with_roles" in the reserved clause)
so both tag numbers and field names are reserved.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2e586aed-ea12-4538-8fca-3ca9cb343563

📥 Commits

Reviewing files that changed from the base of the PR and between b8c338d and ac87821.

📒 Files selected for processing (1)
  • raystack/frontier/v1beta1/frontier.proto

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.

2 participants