refactor(api): require resource in CheckResourcePermission #1886
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,12 +33,48 @@ func TestHandler_CheckResourcePermission(t *testing.T) { | |
| wantErr error | ||
| }{ | ||
| { | ||
| name: "should return bad request error if resource is malformed", | ||
| request: connect.NewRequest(&frontierv1beta1.CheckResourcePermissionRequest{ | ||
| Resource: "not-namespace-uuid-format", | ||
| }), | ||
| want: nil, | ||
| wantErr: connect.NewError(connect.CodeInvalidArgument, ErrNamespaceSplitNotation), | ||
| }, | ||
| { | ||
| name: "should return bad request error if resource is missing", | ||
| request: connect.NewRequest(&frontierv1beta1.CheckResourcePermissionRequest{ | ||
| Permission: schema.UpdatePermission, | ||
| }), | ||
| want: nil, | ||
| wantErr: connect.NewError(connect.CodeInvalidArgument, ErrNamespaceSplitNotation), | ||
| }, | ||
| { | ||
| name: "should return bad request error if resource id part is empty", | ||
| request: connect.NewRequest(&frontierv1beta1.CheckResourcePermissionRequest{ | ||
| Resource: "organization:", | ||
| Permission: schema.UpdatePermission, | ||
| }), | ||
| want: nil, | ||
| wantErr: connect.NewError(connect.CodeInvalidArgument, ErrNamespaceSplitNotation), | ||
| }, | ||
| { | ||
| name: "should return bad request error if resource namespace part is empty", | ||
| request: connect.NewRequest(&frontierv1beta1.CheckResourcePermissionRequest{ | ||
| Resource: ":" + testRelationV2.Object.ID, | ||
| Permission: schema.UpdatePermission, | ||
| }), | ||
| want: nil, | ||
| wantErr: connect.NewError(connect.CodeInvalidArgument, ErrNamespaceSplitNotation), | ||
| }, | ||
| { | ||
| name: "should return bad request error if only the removed split fields are sent", | ||
| request: connect.NewRequest(&frontierv1beta1.CheckResourcePermissionRequest{ | ||
| ObjectId: testRelationV2.Object.ID, | ||
| ObjectNamespace: testRelationV2.Object.Namespace, | ||
| Permission: schema.UpdatePermission, | ||
| }), | ||
| want: nil, | ||
| wantErr: connect.NewError(connect.CodeInvalidArgument, ErrNamespaceSplitNotation), | ||
| }, | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| { | ||
| name: "should return user unauthenticated error if CheckAuthz function returns ErrUnauthenticated", | ||
|
|
@@ -91,9 +127,8 @@ func TestHandler_CheckResourcePermission(t *testing.T) { | |
| Return(testPermission, nil) | ||
| }, | ||
| request: connect.NewRequest(&frontierv1beta1.CheckResourcePermissionRequest{ | ||
| Permission: schema.UpdatePermission, | ||
| Resource: schema.JoinNamespaceAndResourceID(testRelationV2.Object.Namespace, testRelationV2.Object.ID), | ||
|
Member
There was a problem hiding this comment. The success cases use canonical namespaces via JoinNamespaceAndResourceID, and none pass a real alias in the resource field. The PR says aliases still work there, so a case with resource set to an alias (e.g. "org:") would lock that promise in and catch any regression in ParseNamespaceAliasIfRequired for this path.
Contributor
Author
There was a problem hiding this comment. Added in f00e7d3 — a unit case now sends |
||
| }), | ||
| want: connect.NewResponse(&frontierv1beta1.CheckResourcePermissionResponse{ | ||
| Status: true, | ||
|
|
@@ -113,15 +148,35 @@ func TestHandler_CheckResourcePermission(t *testing.T) { | |
| Return(testPermission, nil) | ||
| }, | ||
| request: connect.NewRequest(&frontierv1beta1.CheckResourcePermissionRequest{ | ||
| Permission: schema.UpdatePermission, | ||
| Resource: schema.JoinNamespaceAndResourceID(testRelationV2.Object.Namespace, testRelationV2.Object.ID), | ||
| }), | ||
| want: connect.NewResponse(&frontierv1beta1.CheckResourcePermissionResponse{ | ||
| Status: false, | ||
| }), | ||
| wantErr: nil, | ||
| }, | ||
| { | ||
| name: "should resolve a namespace alias in the resource field", | ||
| setup: func(res *mocks.ResourceService, perm *mocks.PermissionService) { | ||
| res.EXPECT().CheckAuthz(mock.AnythingOfType("context.backgroundCtx"), resource.Check{ | ||
| Object: relation.Object{ | ||
| ID: testRelationV2.Object.ID, | ||
| Namespace: schema.OrganizationNamespace, | ||
| }, Permission: schema.UpdatePermission, | ||
| }).Return(true, nil) | ||
| perm.EXPECT().Get(mock.Anything, schema.JoinNamespaceAndResourceID(schema.OrganizationNamespace, schema.UpdatePermission)). | ||
| Return(permission.Permission{Name: schema.UpdatePermission, NamespaceID: schema.OrganizationNamespace}, nil) | ||
| }, | ||
| request: connect.NewRequest(&frontierv1beta1.CheckResourcePermissionRequest{ | ||
| Permission: schema.UpdatePermission, | ||
| Resource: "org:" + testRelationV2.Object.ID, | ||
| }), | ||
| want: connect.NewResponse(&frontierv1beta1.CheckResourcePermissionResponse{ | ||
| Status: true, | ||
| }), | ||
| wantErr: nil, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
|
|
@@ -138,3 +193,54 @@ func TestHandler_CheckResourcePermission(t *testing.T) { | |
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestHandler_BatchCheckPermission(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| setup func(res *mocks.ResourceService, perm *mocks.PermissionService) | ||
| request *connect.Request[frontierv1beta1.BatchCheckPermissionRequest] | ||
| wantErr error | ||
| }{ | ||
| { | ||
| name: "should return bad request error if a body resource is malformed", | ||
| request: connect.NewRequest(&frontierv1beta1.BatchCheckPermissionRequest{ | ||
| Bodies: []*frontierv1beta1.BatchCheckPermissionBody{ | ||
| {Resource: "not-namespace-uuid-format", Permission: schema.UpdatePermission}, | ||
| }, | ||
| }), | ||
| wantErr: connect.NewError(connect.CodeInvalidArgument, ErrNamespaceSplitNotation), | ||
| }, | ||
| { | ||
| name: "should return bad request error if a body resource id part is empty", | ||
| request: connect.NewRequest(&frontierv1beta1.BatchCheckPermissionRequest{ | ||
| Bodies: []*frontierv1beta1.BatchCheckPermissionBody{ | ||
| {Resource: "organization:", Permission: schema.UpdatePermission}, | ||
| }, | ||
| }), | ||
| wantErr: connect.NewError(connect.CodeInvalidArgument, ErrNamespaceSplitNotation), | ||
| }, | ||
| { | ||
| name: "should return bad request error if a body resource namespace part is empty", | ||
| request: connect.NewRequest(&frontierv1beta1.BatchCheckPermissionRequest{ | ||
| Bodies: []*frontierv1beta1.BatchCheckPermissionBody{ | ||
| {Resource: ":" + testRelationV2.Object.ID, Permission: schema.UpdatePermission}, | ||
| }, | ||
| }), | ||
| wantErr: connect.NewError(connect.CodeInvalidArgument, ErrNamespaceSplitNotation), | ||
| }, | ||
| } | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| mockResourceSrv := new(mocks.ResourceService) | ||
| mockPermissionSrv := new(mocks.PermissionService) | ||
| if tt.setup != nil { | ||
| tt.setup(mockResourceSrv, mockPermissionSrv) | ||
| } | ||
|
|
||
| mockDep := &ConnectHandler{resourceService: mockResourceSrv, permissionService: mockPermissionSrv} | ||
| resp, err := mockDep.BatchCheckPermission(context.Background(), tt.request) | ||
| assert.Equal(t, tt.wantErr, err) | ||
| assert.Nil(t, resp) | ||
| }) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This drops the fallback to object_id / object_namespace, so a client sending only those (with no resource) now gets InvalidArgument. That is the intended tightening, but those fields are still in the .proto, so the schema still advertises support the server no longer provides. A clear deprecation note in the proto, or a planned removal, would keep integrations from being surprised at runtime.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Proto will be cleaned up later
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding to that: the fields already carry
deprecated = truein the proto, so the schema does flag it — the generated getters are marked deprecated too. The removal itself rides a later proton sync.