Skip to content

fix(AIP-136): support response msg lint with resource singular name #1499

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 14, 2025
Merged

fix(AIP-136): support response msg lint with resource singular name #1499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion rules/aip0136/response_message_name.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,17 @@ var responseMessageName = &lint.MethodRule{
// just exit.
return nil
}
res := utils.GetResource(response)
responseResourceType := res.GetType()
requestResourceType := utils.GetResourceReference(m.GetInputType().FindFieldByName("name")).GetType()
responseResourceType := utils.GetResource(response).GetType()

// Check to see if the custom method uses the resource type name as the target
// field name and use that instead if `name` is not present as well.
// AIP-144 methods recommend this naming style.
resourceFieldType := utils.GetResourceReference(m.GetInputType().FindFieldByName(utils.GetResourceSingular(res))).GetType()
if requestResourceType == "" && resourceFieldType != "" {
requestResourceType = resourceFieldType
}

// Short-circuit: Output type is the resource being operated on
if utils.IsResource(response) && responseResourceType == requestResourceType {
Expand Down
16 changes: 10 additions & 6 deletions rules/aip0136/response_message_name_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,15 @@ func TestResponseMessageName(t *testing.T) {
testName string
MethodName string
RespMessageName string
ReqFieldName string
LRO bool
problems testutils.Problems
}{
{"Valid", "ArchiveBook", "Book", false, testutils.Problems{}},
{"Valid LRO", "ArchiveBook", "Book", true, testutils.Problems{}},
{"Invalid", "ArchiveBook", "Author", false, testutils.Problems{{Message: "not \"Author\"."}}},
{"Invalid LRO", "ArchiveBook", "Author", true, testutils.Problems{{Message: "not \"Author\"."}}},
{"Valid", "ArchiveBook", "Book", "name", false, testutils.Problems{}},
{"ValidResourceField", "ArchiveBook", "Book", "book", false, testutils.Problems{}},
{"Valid LRO", "ArchiveBook", "Book", "name", true, testutils.Problems{}},
{"Invalid", "ArchiveBook", "Author", "name", false, testutils.Problems{{Message: "not \"Author\"."}}},
{"Invalid LRO", "ArchiveBook", "Author", "name", true, testutils.Problems{{Message: "not \"Author\"."}}},
}

for _, test := range tests {
Expand All @@ -123,7 +125,7 @@ func TestResponseMessageName(t *testing.T) {
service Library {
rpc {{.MethodName}}({{.MethodName}}Request) returns ({{ if .LRO }}google.longrunning.Operation{{ else }}{{.RespMessageName}}{{ end }}) {
option (google.api.http) = {
post: "/v1/{name=publishers/*/books/*}:foo"
post: "/v1/{ {{.ReqFieldName}}=publishers/*/books/*}:foo"
body: "*"
};
{{ if .LRO }}
Expand All @@ -139,6 +141,8 @@ func TestResponseMessageName(t *testing.T) {
option (google.api.resource) = {
type: "library.googleapis.com/Book"
pattern: "publishers/{publisher}/books/{book}"
singular: "book"
plural: "books"
};
}

Expand All @@ -152,7 +156,7 @@ func TestResponseMessageName(t *testing.T) {
message {{.MethodName}}Request {
// The book to operate on.
// Format: publishers/{publisher}/books/{book}
string name = 1 [(google.api.resource_reference).type = "library.googleapis.com/Book"];
string {{.ReqFieldName}} = 1 [(google.api.resource_reference).type = "library.googleapis.com/Book"];
}
`, test)
method := file.GetServices()[0].GetMethods()[0]
Expand Down