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: Make state client versioning the default, remove option #1938

Merged
merged 2 commits into from
Oct 18, 2024
Merged

feat: Make state client versioning the default, remove option #1938

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
d9b9036
feat: Make state client versioning the default, remove option
erezrokah Oct 17, 2024
de604a6
style: Fix lint
erezrokah Oct 17, 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
22 changes: 7 additions & 15 deletions internal/clients/state/v3/state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,21 +36,8 @@ type versionedValue struct {
version uint64
}

func VersionedTable(name string) *schema.Table {
t := table(name)
t.Columns = append(t.Columns, schema.Column{
// Not defined as PrimaryKey to enable single keys if the destination supports PKs
Name: versionColumn,
Type: arrow.PrimitiveTypes.Uint64,
})
return t
}

func NewClient(ctx context.Context, conn *grpc.ClientConn, tableName string) (*Client, error) {
return NewClientWithTable(ctx, conn, table(tableName))
}

func NewClientWithTable(ctx context.Context, conn *grpc.ClientConn, table *schema.Table) (*Client, error) {
table := Table(tableName)
c := &Client{
conn: conn,
client: pb.NewPluginClient(conn),
Expand Down Expand Up @@ -215,7 +202,7 @@ func (c *Client) Close() error {
return nil
}

func table(name string) *schema.Table {
func Table(name string) *schema.Table {
return &schema.Table{
Name: name,
Columns: []schema.Column{
Expand All @@ -228,6 +215,11 @@ func table(name string) *schema.Table {
Name: valueColumn,
Type: arrow.BinaryTypes.String,
},
{
// Not defined as PrimaryKey to enable single keys if the destination supports PKs
Name: versionColumn,
Type: arrow.PrimitiveTypes.Uint64,
},
},
}
}
6 changes: 3 additions & 3 deletions serve/state_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,13 @@ func TestStateOverwriteGetLatest(t *testing.T) {
t.Fatal(err)
}

table := state.VersionedTable("test_no_pk")
table := state.Table("test_no_pk")
// Remove PKs
for i := range table.Columns {
table.Columns[i].PrimaryKey = false
}

stateClient, err := state.NewClientWithTable(ctx, conn, table)
stateClient, err := state.NewClient(ctx, conn, table.Name)
if err != nil {
t.Fatal(err)
}
Expand All @@ -138,7 +138,7 @@ func TestStateOverwriteGetLatest(t *testing.T) {
}
}

stateClient, err = state.NewClientWithTable(ctx, conn, table)
stateClient, err = state.NewClient(ctx, conn, table.Name)
if err != nil {
t.Fatal(err)
}
Expand Down
7 changes: 1 addition & 6 deletions state/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@
Close() error
}

type ClientOptions struct {
Versioned bool
Copy link
Member Author

Choose a reason for hiding this comment

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

This will break compilation for few plugins, I'll fix them once the SDK it released

}
type ClientOptions struct{}

type ConnectionOptions struct {
MaxMsgSizeInBytes int
Expand All @@ -33,7 +31,7 @@
return NewClientWithOptions(ctx, conn, tableName, ClientOptions{})
}

func NewClientWithOptions(ctx context.Context, conn *grpc.ClientConn, tableName string, opts ClientOptions) (Client, error) {

Check failure on line 34 in state/client.go

View workflow job for this annotation

GitHub Actions / Lint with GolangCI 

unused-parameter: parameter 'opts' seems to be unused, consider removing or renaming it as _ (revive)
discoveryClient := pbDiscovery.NewDiscoveryClient(conn)
versions, err := discoveryClient.GetVersions(ctx, &pbDiscovery.GetVersions_Request{})
if err != nil {
Expand All @@ -43,9 +41,6 @@
return nil, fmt.Errorf("please upgrade your state backend plugin. state supporting version 3 plugin has %v", versions.Versions)
}

if opts.Versioned {
return stateV3.NewClientWithTable(ctx, conn, stateV3.VersionedTable(tableName))
}
return stateV3.NewClient(ctx, conn, tableName)
}

Expand Down
Loading