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

feat: support start time parameter on read changes #443

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: support start time parameter on read changes #443

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1f7cbb
feat: support start time parameter on read changes
ryanpq Jan 22, 2025
17d722d
Update README.md
ryanpq Jan 31, 2025
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ type document
| [Write Relationship Tuples](#write-relationship-tuples) | `write` | `--store-id`, `--model-id` | `fga tuple write user:anne can_view document:roadmap --store-id=01H0H015178Y2V4CX10C2KGHF4` |
| [Delete Relationship Tuples](#delete-relationship-tuples) | `delete` | `--store-id`, `--model-id` | `fga tuple delete user:anne can_view document:roadmap --store-id=01H0H015178Y2V4CX10C2KGHF4` |
| [Read Relationship Tuples](#read-relationship-tuples) | `read` | `--store-id`, `--model-id` | `fga tuple read --store-id=01H0H015178Y2V4CX10C2KGHF4 --model-id=01GXSA8YR785C4FYS3C0RTG7B1` |
| [Read Relationship Tuple Changes (Watch)](#read-relationship-tuple-changes-watch) | `changes` | `--store-id`, `--type`, `--continuation-token`, | `fga tuple changes --store-id=01H0H015178Y2V4CX10C2KGHF4 --type=document --continuation-token=M3w=` |
| [Read Relationship Tuple Changes (Watch)](#read-relationship-tuple-changes-watch) | `changes` | `--store-id`, `--type`, `--start-time`, `--continuation-token`, | `fga tuple changes --store-id=01H0H015178Y2V4CX10C2KGHF4 --type=document --start-time=2022-01-01T00:00:00Z --continuation-token=M3w=` |
| [Import Relationship Tuples](#import-relationship-tuples) | `import` | `--store-id`, `--model-id`, `--file` | `fga tuple import --store-id=01H0H015178Y2V4CX10C2KGHF4 --model-id=01GXSA8YR785C4FYS3C0RTG7B1 --file tuples.json` |

##### Write Relationship Tuples
Expand Down Expand Up @@ -896,6 +896,7 @@ fga tuple **changes** --type <type> --store-id=<store-id>
###### Parameters
* `--store-id`: Specifies the store id
* `--type`: Restrict to a specific type (optional)
* `--start-time`: Return changes since a specified time
ryanpq marked this conversation as resolved.
Show resolved Hide resolved
* `--max-pages`: Max number of pages to retrieve (default: 20)
* `--continuation-token`: Continuation token to start changes from

Expand Down
37 changes: 31 additions & 6 deletions cmd/tuple/changes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package tuple
import (
"context"
"fmt"
"time"

openfga "github.com/openfga/go-sdk"
"github.com/openfga/go-sdk/client"
Expand All @@ -32,15 +33,32 @@ import (
var MaxReadChangesPagesLength = 20

func readChanges(
fgaClient client.SdkClient, maxPages int, selectedType string, continuationToken string,
fgaClient client.SdkClient, maxPages int, selectedType string, startTime string, continuationToken string,
) (*openfga.ReadChangesResponse, error) {
changes := []openfga.TupleChange{}
pageIndex := 0

var startTimeObj *time.Time

if startTime != "" {
layout := "2006-01-02T15:04:05Z"

parsedTime, err := time.Parse(layout, startTime)
Copy link
Member

Choose a reason for hiding this comment

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

Should we be using time.RFC3339 here as that's what we use in the go-sdk, or is the 2006-01-02T15:04:05Z07:00 format a little bit too lengthy to write out on the CLI?

Copy link
Author

Choose a reason for hiding this comment

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

The API docs call for ISO8601 which in go requires a layout variable as it differs slightly from RFC3339. The go-sdk expects input to be a time.Time object but since we're taking text input in the CLI this ensures that ISO8601 is properly supported as detailed in the API documentation.

Copy link
Member

Choose a reason for hiding this comment

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

Ahh my bad, I overlooked we were just using that in the tests

if err != nil {
return nil, fmt.Errorf("failed to parse startTime: %w", err)
}

startTimeObj = &parsedTime
}

for {
body := &client.ClientReadChangesRequest{
Type: selectedType,
}
if startTimeObj != nil {
body.StartTime = *startTimeObj
}

options := &client.ClientReadChangesOptions{
ContinuationToken: &continuationToken,
}
Expand All @@ -67,10 +85,11 @@ func readChanges(

// changesCmd represents the changes command.
var changesCmd = &cobra.Command{
Use: "changes",
Short: "Read Relationship Tuple Changes (Watch)",
Long: "Get a list of relationship tuple changes (Writes and Deletes) across time.",
Example: "fga tuple changes --store-id=01H0H015178Y2V4CX10C2KGHF4 --type document --continuation-token=MXw=",
Use: "changes",
Short: "Read Relationship Tuple Changes (Watch)",
Long: "Get a list of relationship tuple changes (Writes and Deletes) across time.",
Example: `fga tuple changes --store-id=01H0H015178Y2V4CX10C2KGHF4 --type document
--start-time 2022-01-01T00:00:00Z --continuation-token=MXw=`,
RunE: func(cmd *cobra.Command, _ []string) error {
clientConfig := cmdutils.GetClientConfig(cmd)

Expand All @@ -89,12 +108,17 @@ var changesCmd = &cobra.Command{
return fmt.Errorf("failed to get tuple changes due to %w", err)
}

startTime, err := cmd.Flags().GetString("start-time")
if err != nil {
return fmt.Errorf("failed to get tuple changes due to %w", err)
}

continuationToken, err := cmd.Flags().GetString("continuation-token")
if err != nil {
return fmt.Errorf("failed to get tuple changes due to %w", err)
}

response, err := readChanges(fgaClient, maxPages, selectedType, continuationToken)
response, err := readChanges(fgaClient, maxPages, selectedType, startTime, continuationToken)
if err != nil {
return err
}
Expand All @@ -105,6 +129,7 @@ var changesCmd = &cobra.Command{

func init() {
changesCmd.Flags().String("type", "", "Type to restrict the changes by.")
changesCmd.Flags().String("start-time", "", "Time to return changes since.")
changesCmd.Flags().Int("max-pages", MaxReadChangesPagesLength, "Max number of pages to get.")
changesCmd.Flags().String("continuation-token", "", "Continuation token to start changes from.")
}
40 changes: 32 additions & 8 deletions cmd/tuple/changes_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func TestReadChangesError(t *testing.T) {

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

_, err := readChanges(mockFgaClient, 5, "document", "")
_, err := readChanges(mockFgaClient, 5, "document", "", "")
if err == nil {
t.Error("Expect error but there is none")
}
Expand Down Expand Up @@ -82,7 +82,7 @@ func TestReadChangesEmpty(t *testing.T) {

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

output, err := readChanges(mockFgaClient, 5, "document", "")
output, err := readChanges(mockFgaClient, 5, "document", "", "")
if err != nil {
t.Error(err)
}
Expand All @@ -102,6 +102,8 @@ func TestReadChangesEmpty(t *testing.T) {
func TestReadChangesSinglePage(t *testing.T) {
t.Parallel()

const layout = "2006-01-02T15:04:05Z"

mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
mockFgaClient := mock_client.NewMockSdkClient(mockCtrl)
Expand Down Expand Up @@ -139,14 +141,20 @@ func TestReadChangesSinglePage(t *testing.T) {

mockBody := mock_client.NewMockSdkClientReadChangesRequestInterface(mockCtrl)

sTime, err := time.Parse(layout, "2022-01-01T00:00:00Z")
if err != nil {
t.Error(err)
}

body := client.ClientReadChangesRequest{
Type: "document",
Type: "document",
StartTime: sTime,
}
mockBody.EXPECT().Body(body).Return(mockRequest)

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

output, err := readChanges(mockFgaClient, 5, "document", "")
output, err := readChanges(mockFgaClient, 5, "document", "2022-01-01T00:00:00Z", "")
if err != nil {
t.Error(err)
}
Expand All @@ -166,6 +174,8 @@ func TestReadChangesSinglePage(t *testing.T) {
func TestReadChangesMultiPages(t *testing.T) {
t.Parallel()

const layout = "2006-01-02T15:04:05Z"

mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()

Expand Down Expand Up @@ -232,8 +242,14 @@ func TestReadChangesMultiPages(t *testing.T) {
mockBody1 := mock_client.NewMockSdkClientReadChangesRequestInterface(mockCtrl)
mockBody2 := mock_client.NewMockSdkClientReadChangesRequestInterface(mockCtrl)

sTime, err := time.Parse(layout, "2022-01-01T00:00:00Z")
if err != nil {
t.Error(err)
}

body := client.ClientReadChangesRequest{
Type: "document",
Type: "document",
StartTime: sTime,
}

gomock.InOrder(
Expand All @@ -246,7 +262,7 @@ func TestReadChangesMultiPages(t *testing.T) {
mockFgaClient.EXPECT().ReadChanges(context.Background()).Return(mockBody2),
)

output, err := readChanges(mockFgaClient, 5, "document", "")
output, err := readChanges(mockFgaClient, 5, "document", "2022-01-01T00:00:00Z", "")
if err != nil {
t.Error(err)
}
Expand All @@ -266,6 +282,8 @@ func TestReadChangesMultiPages(t *testing.T) {
func TestReadChangesMultiPagesLimit(t *testing.T) {
t.Parallel()

const layout = "2006-01-02T15:04:05Z"

mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
mockFgaClient := mock_client.NewMockSdkClient(mockCtrl)
Expand Down Expand Up @@ -303,14 +321,20 @@ func TestReadChangesMultiPagesLimit(t *testing.T) {

mockBody := mock_client.NewMockSdkClientReadChangesRequestInterface(mockCtrl)

sTime, err := time.Parse(layout, "2022-01-01T00:00:00Z")
if err != nil {
t.Error(err)
}

body := client.ClientReadChangesRequest{
Type: "document",
Type: "document",
StartTime: sTime,
}
mockBody.EXPECT().Body(body).Return(mockRequest)

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

output, err := readChanges(mockFgaClient, 1, "document", "")
output, err := readChanges(mockFgaClient, 1, "document", "2022-01-01T00:00:00Z", "")
if err != nil {
t.Error(err)
}
Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ require (
github.com/nwidger/jsoncolor v0.3.2
github.com/oklog/ulid/v2 v2.1.0
github.com/openfga/api/proto v0.0.0-20250107154247-c22e6db5c4f5
github.com/openfga/go-sdk v0.6.4-0.20250107171931-2adebcc8c8bc
github.com/openfga/go-sdk v0.6.4
github.com/openfga/language/pkg/go v0.2.0-beta.2.0.20241115164311-10e575c8e47c
github.com/openfga/openfga v1.8.4
github.com/spf13/cobra v1.8.1
Expand Down
2 changes: 2 additions & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,8 @@ github.com/openfga/api/proto v0.0.0-20250107154247-c22e6db5c4f5 h1:z9jaRoo+NIN1A
github.com/openfga/api/proto v0.0.0-20250107154247-c22e6db5c4f5/go.mod h1:m74TNgnAAIJ03gfHcx+xaRWnr+IbQy3y/AVNwwCFrC0=
github.com/openfga/go-sdk v0.6.4-0.20250107171931-2adebcc8c8bc h1:E7x5UZbNIbcCOhBRD3cqrmQz35qNNceMnZPb6UxZRnw=
github.com/openfga/go-sdk v0.6.4-0.20250107171931-2adebcc8c8bc/go.mod h1:zui7pHE3eLAYh2fFmEMrWg9XbxYns2WW5Xr/GEgili4=
github.com/openfga/go-sdk v0.6.4 h1:VAeH9exZuG1qaBt41+mjIK5RxTtuL9maS4d47YsYGZw=
github.com/openfga/go-sdk v0.6.4/go.mod h1:zui7pHE3eLAYh2fFmEMrWg9XbxYns2WW5Xr/GEgili4=
github.com/openfga/language/pkg/go v0.2.0-beta.2.0.20241115164311-10e575c8e47c h1:1y84C0V4NRfPtRi4MqQ7+gnFtYgeBKPIeIAPLdVJ7j4=
github.com/openfga/language/pkg/go v0.2.0-beta.2.0.20241115164311-10e575c8e47c/go.mod h1:12RMe/HuRNyOzS33RQa53jwdcxE2znr8ycXMlVbgQN4=
github.com/openfga/openfga v1.8.4 h1:OqyRpuxMCxcS7irTFYFkhAIYzmAnczNwxUqjnuZOQyo=
Expand Down
Loading