Skip to content
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

Jump to bottom

feat: support usage of consistency parameter #381

Merged
merged 6 commits into from
Sep 6, 2024
Merged

feat: support usage of consistency parameter #381

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f4021d5
feat(query): support usage of consistency parameter
ewanharris Aug 30, 2024
fc22d9c
docs: add consistency param to command examples
ewanharris Sep 2, 2024
12ba9f5
feat(tuple): support consistency in the tuple read command
ewanharris Sep 2, 2024
eb16366
refactor: always request higher consistency on export
ewanharris Sep 3, 2024
616303d
Revert "refactor: always request higher consistency on export"
jimmyjames Sep 3, 2024
5bee68d
Merge branch 'main' into feat/379-consistency
jimmyjames Sep 5, 2024
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
2 changes: 1 addition & 1 deletion cmd/store/export.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func buildStoreData(config fga.ClientConfig, fgaClient client.SdkClient, maxTupl
// get the tuples
maxPages := int(math.Ceil(float64(maxTupleCount) / float64(tuple.DefaultReadPageSize)))

rawTuples, err := tuple.Read(fgaClient, &client.ClientReadRequest{}, maxPages)
rawTuples, err := tuple.Read(fgaClient, &client.ClientReadRequest{}, maxPages, nil)
jimmyjames marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
return nil, fmt.Errorf("unable to read tuples: %w", err)
}
Expand Down
24 changes: 21 additions & 3 deletions cmd/tuple/read.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,14 @@ func (r readResponse) toCsvDTO() ([]readResponseCSVDTO, error) {
return readResponseDTO, nil
}

func read(fgaClient client.SdkClient, user string, relation string, object string, maxPages int) (
func read(
fgaClient client.SdkClient,
user string,
relation string,
object string,
maxPages int,
consistency *openfga.ConsistencyPreference,
) (
*readResponse, error,
) {
body := &client.ClientReadRequest{}
Expand All @@ -104,7 +111,7 @@ func read(fgaClient client.SdkClient, user string, relation string, object strin
body.Object = &object
}

response, err := tuple.Read(fgaClient, body, maxPages)
response, err := tuple.Read(fgaClient, body, maxPages, consistency)
if err != nil {
return nil, err //nolint:wrapcheck
}
Expand Down Expand Up @@ -142,7 +149,12 @@ var readCmd = &cobra.Command{
return fmt.Errorf("failed to parse max pages due to %w", err)
}

response, err := read(fgaClient, user, relation, object, maxPages)
consistency, err := cmdutils.ParseConsistencyFromCmd(cmd)
if err != nil {
return fmt.Errorf("error parsing consistency for check: %w", err)
}

response, err := read(fgaClient, user, relation, object, maxPages, consistency)
if err != nil {
return err
}
Expand Down Expand Up @@ -180,6 +192,12 @@ func init() {
readCmd.Flags().String("output-format", "json", "Specifies the format for data presentation. Valid options: "+
"json, simple-json, csv, and yaml.")
readCmd.Flags().Bool("simple-output", false, "Output data in simpler version. (It can be used by write and delete commands)") //nolint:lll
readCmd.Flags().String(
"consistency",
"",
"Consistency preference for the request. Valid options are HIGHER_CONSISTENCY and MINIMIZE_LATENCY.",
)

_ = readCmd.Flags().MarkDeprecated("simple-output", "the flag \"simple-output\" is deprecated and will be removed"+
" in future releases.\nPlease use the \"--output-format=simple-json\" flag instead.")
}
45 changes: 40 additions & 5 deletions cmd/tuple/read_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,14 @@ func TestReadError(t *testing.T) {

mockFgaClient.EXPECT().Read(context.Background()).Return(mockBody)

_, err := read(mockFgaClient, "user:user1", "reader", "document:doc1", 5)
_, err := read(
mockFgaClient,
"user:user1",
"reader",
"document:doc1",
5,
openfga.CONSISTENCYPREFERENCE_UNSPECIFIED.Ptr(),
)
if err == nil {
t.Error("Expect error but there is none")
}
Expand Down Expand Up @@ -91,7 +98,14 @@ func TestReadEmpty(t *testing.T) {

mockFgaClient.EXPECT().Read(context.Background()).Return(mockBody)

output, err := read(mockFgaClient, "user:user1", "reader", "document:doc1", 5)
output, err := read(
mockFgaClient,
"user:user1",
"reader",
"document:doc1",
5,
openfga.CONSISTENCYPREFERENCE_UNSPECIFIED.Ptr(),
)
if err != nil {
t.Error(err)
}
Expand Down Expand Up @@ -166,7 +180,14 @@ func TestReadSinglePage(t *testing.T) {

mockFgaClient.EXPECT().Read(context.Background()).Return(mockBody)

output, err := read(mockFgaClient, "user:user1", "reader", "document:doc1", 5)
output, err := read(
mockFgaClient,
"user:user1",
"reader",
"document:doc1",
5,
openfga.CONSISTENCYPREFERENCE_UNSPECIFIED.Ptr(),
)
if err != nil {
t.Error(err)
}
Expand Down Expand Up @@ -281,7 +302,14 @@ func TestReadMultiPages(t *testing.T) {
mockFgaClient.EXPECT().Read(context.Background()).Return(mockBody2),
)

output, err := read(mockFgaClient, "user:user1", "reader", "document:doc1", 5)
output, err := read(
mockFgaClient,
"user:user1",
"reader",
"document:doc1",
5,
openfga.CONSISTENCYPREFERENCE_UNSPECIFIED.Ptr(),
)
if err != nil {
t.Error(err)
}
Expand Down Expand Up @@ -356,7 +384,14 @@ func TestReadMultiPagesMaxLimit(t *testing.T) {

mockFgaClient.EXPECT().Read(context.Background()).Return(mockBody)

output, err := read(mockFgaClient, "user:user1", "reader", "document:doc1", 1)
output, err := read(
mockFgaClient,
"user:user1",
"reader",
"document:doc1",
1,
openfga.CONSISTENCYPREFERENCE_UNSPECIFIED.Ptr(),
)
if err != nil {
t.Error(err)
}
Expand Down
11 changes: 10 additions & 1 deletion internal/tuple/read.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,12 @@ import (

const DefaultReadPageSize int32 = 50

func Read(fgaClient client.SdkClient, body *client.ClientReadRequest, maxPages int) (
func Read(
fgaClient client.SdkClient,
body *client.ClientReadRequest,
maxPages int,
consistency *openfga.ConsistencyPreference,
) (
*openfga.ReadResponse, error,
) {
tuples := make([]openfga.Tuple, 0)
Expand All @@ -20,6 +25,10 @@ func Read(fgaClient client.SdkClient, body *client.ClientReadRequest, maxPages i
PageSize: openfga.PtrInt32(DefaultReadPageSize),
}

if consistency != nil && *consistency != openfga.CONSISTENCYPREFERENCE_UNSPECIFIED {
options.Consistency = consistency
}

for {
options.ContinuationToken = &continuationToken

Expand Down
Loading