Add ReadBulkRelationships API

internal/services/v1/hash.go

@@ -1,7 +1,9 @@
 package v1
 
 import (
+	"sort"
 	"strconv"
+	"strings"
 
 	v1 "github.com/authzed/authzed-go/proto/authzed/api/v1"
 	"google.golang.org/protobuf/types/known/structpb"
@@ -56,6 +58,50 @@ func computeReadRelationshipsRequestHash(req *v1.ReadRelationshipsRequest) (stri
 	})
 }
 
+func computeReadRelationshipsRequestItemHash(req *v1.ReadBulkRelationshipsRequestItem) (string, error) {
+	osf := req.RelationshipFilter.OptionalSubjectFilter
+	if osf == nil {
+		osf = &v1.SubjectFilter{}
+	}
+
+	srf := "(none)"
+	if osf.OptionalRelation != nil {
+		srf = osf.OptionalRelation.Relation
+	}
+
+	return computeCallHash("v1.readrelationships", nil, map[string]any{
+		"filter-resource-type": req.RelationshipFilter.ResourceType,
+		"filter-relation":      req.RelationshipFilter.OptionalRelation,
+		"filter-resource-id":   req.RelationshipFilter.OptionalResourceId,
+		"subject-type":         osf.SubjectType,
+		"subject-relation":     srf,
+		"subject-resource-id":  osf.OptionalSubjectId,
+		"limit":                req.OptionalLimit,
+	})
+}
+
+func computeReadBulkRelationshipsHash(req *v1.ReadBulkRelationshipsRequest) (string, error) {
+	itemHashes := make([]string, 0, len(req.Items))
+
+	for _, item := range req.Items {
+		if item == nil {
+			continue
+		}
+
+		itemHash, err := computeReadRelationshipsRequestItemHash(item)
+		if err != nil {
+			return "", err
+		}
+		itemHashes = append(itemHashes, itemHash)
+	}
+
+	sort.Strings(itemHashes)
+
+	return computeCallHash("v1.readbulkrelationships", req.Consistency, map[string]any{
+		"items": strings.Join(itemHashes, ","),
+	})
+}
+
 func computeLRRequestHash(req *v1.LookupResourcesRequest) (string, error) {
 	return computeCallHash("v1.lookupresources", req.Consistency, map[string]any{
 		"resource-type": req.ResourceObjectType,

internal/services/v1/hash_test.go

@@ -813,3 +813,148 @@ func TestCheckBulkPermissionsItemWIDHashStability(t *testing.T) {
 		})
 	}
 }
+
+func TestReadBulkRelationshipsItemHashStability(t *testing.T) {
+	tcs := []struct {
+		name         string
+		request      *v1.ReadBulkRelationshipsRequestItem
+		expectedHash string
+	}{
+		{
+			"basic read item",
+			&v1.ReadBulkRelationshipsRequestItem{
+				RelationshipFilter: &v1.RelationshipFilter{
+					ResourceType: "someresourcetype",
+				},
+			},
+			"0a0e721527f9e3b2",
+		},
+		{
+			"full read item",
+			&v1.ReadBulkRelationshipsRequestItem{
+				RelationshipFilter: &v1.RelationshipFilter{
+					ResourceType:       "someresourcetype",
+					OptionalResourceId: "foo",
+					OptionalRelation:   "somerelation",
+					OptionalSubjectFilter: &v1.SubjectFilter{
+						SubjectType:       "somesubjectype",
+						OptionalSubjectId: "somesubject",
+						OptionalRelation: &v1.SubjectFilter_RelationFilter{
+							Relation: "subrelation",
+						},
+					},
+				},
+				OptionalLimit: 1000,
+			},
+			"0375e86e0c72f281",
+		},
+		{
+			"different resource type",
+			&v1.ReadBulkRelationshipsRequestItem{
+				RelationshipFilter: &v1.RelationshipFilter{
+					ResourceType:       "someresourcetype2",
+					OptionalResourceId: "foo",
+					OptionalRelation:   "somerelation",
+					OptionalSubjectFilter: &v1.SubjectFilter{
+						SubjectType:       "somesubjectype",
+						OptionalSubjectId: "somesubject",
+						OptionalRelation: &v1.SubjectFilter_RelationFilter{
+							Relation: "subrelation",
+						},
+					},
+				},
+				OptionalLimit: 1000,
+			},
+			"a7d3548f8303f0ba",
+		},
+	}
+
+	for _, tc := range tcs {
+		tc := tc
+		t.Run(tc.name, func(t *testing.T) {
+			verr := tc.request.Validate()
+			require.NoError(t, verr)
+
+			hash, err := computeReadRelationshipsRequestItemHash(tc.request)
+			require.NoError(t, err)
+			require.Equal(t, tc.expectedHash, hash)
+		})
+	}
+}
+
+func TestReadBulkRelationshipsHashStability(t *testing.T) {
+	tcs := []struct {
+		name         string
+		request      *v1.ReadBulkRelationshipsRequest
+		expectedHash string
+	}{
+		{
+			"empty request",
+			&v1.ReadBulkRelationshipsRequest{
+				Items: []*v1.ReadBulkRelationshipsRequestItem{},
+			},
+			"af82b1e607102e94",
+		},
+		{
+			"single item request",
+			&v1.ReadBulkRelationshipsRequest{
+				Items: []*v1.ReadBulkRelationshipsRequestItem{
+					{
+						RelationshipFilter: &v1.RelationshipFilter{
+							ResourceType: "someresourcetype",
+						},
+					},
+				},
+			},
+			"b081a18f9cddfd10",
+		},
+		{
+			"multiple items request",
+			&v1.ReadBulkRelationshipsRequest{
+				Items: []*v1.ReadBulkRelationshipsRequestItem{
+					{
+						RelationshipFilter: &v1.RelationshipFilter{
+							ResourceType: "someresourcetype",
+						},
+					},
+					{
+						RelationshipFilter: &v1.RelationshipFilter{
+							ResourceType: "someresourcetype2",
+						},
+					},
+				},
+			},
+			"05a97a8116abea20",
+		},
+		{
+			"request with consistency",
+			&v1.ReadBulkRelationshipsRequest{
+				Items: []*v1.ReadBulkRelationshipsRequestItem{
+					{
+						RelationshipFilter: &v1.RelationshipFilter{
+							ResourceType: "someresourcetype",
+						},
+					},
+				},
+				Consistency: &v1.Consistency{
+					Requirement: &v1.Consistency_FullyConsistent{
+						FullyConsistent: true,
+					},
+				},
+			},
+			"e92c0be47a00ca39",
+		},
+	}
+
+	for _, tc := range tcs {
+		tc := tc
+		t.Run(tc.name, func(t *testing.T) {
+			verr := tc.request.Validate()
+			require.NoError(t, verr)
+
+			hash, err := computeReadBulkRelationshipsHash(tc.request)
+			require.NoError(t, err)
+			require.Equal(t, tc.expectedHash, hash)
+		})
+	}
+}

internal/services/v1/metadata_test.go

@@ -125,6 +125,25 @@ func TestAllMethodsReturnMetadata(t *testing.T) {
 
 				return trailer
 			},
+			"ReadBulkRelationships": func(t *testing.T, client v1.PermissionsServiceClient) metadata.MD {
+				var trailer metadata.MD
+				_, err := client.ReadBulkRelationships(context.Background(), &v1.ReadBulkRelationshipsRequest{
+					Consistency: &v1.Consistency{
+						Requirement: &v1.Consistency_AtLeastAsFresh{
+							AtLeastAsFresh: zedtoken.MustNewFromRevision(revision),
+						},
+					},
+					Items: []*v1.ReadBulkRelationshipsRequestItem{
+						{
+							RelationshipFilter: &v1.RelationshipFilter{
+								ResourceType: "document",
+							},
+						},
+					},
+				}, grpc.Trailer(&trailer))
+				require.NoError(t, err)
+				return trailer
+			},
 			"LookupResources": func(t *testing.T, client v1.PermissionsServiceClient) metadata.MD {
 				var trailer metadata.MD
 				stream, err := client.LookupResources(ctx, &v1.LookupResourcesRequest{