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

Migrate Beam Go to use the new Opaque Protocol Buffers #33434

Merged
merged 5 commits into from
Jan 16, 2025
Merged

Migrate Beam Go to use the new Opaque Protocol Buffers #33434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f6c471
Update Go genproto script with newer versions, and generate hybrid pr…
lostluck Dec 20, 2024
d9a7ed4
Generated hybrid protos for Go SDK.
lostluck Dec 20, 2024
25ed914
Run open2opaque and fix the compile errors.
lostluck Dec 20, 2024
4371f24
actually remove the license porting code
lostluck Dec 20, 2024
ea6948f
re-run open2opaque after rebase
lostluck Jan 15, 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
2 changes: 1 addition & 1 deletion sdks/go/cmd/beamctl/cmd/artifact.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ func listFn(cmd *cobra.Command, args []string) error {
}

for _, a := range md.GetManifest().GetArtifact() {
cmd.Println(a.Name)
cmd.Println(a.GetName())
}
return nil
}
2 changes: 1 addition & 1 deletion sdks/go/container/boot.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ func main() {

enableGoogleCloudProfiler := strings.Contains(options, enableGoogleCloudProfilerOption)
if enableGoogleCloudProfiler {
err := configureGoogleCloudProfilerEnvVars(ctx, logger, info.Metadata)
err := configureGoogleCloudProfilerEnvVars(ctx, logger, info.GetMetadata())
if err != nil {
logger.Printf(ctx, "could not configure Google Cloud Profiler variables, got %v", err)
}
Expand Down
38 changes: 19 additions & 19 deletions sdks/go/container/boot_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ import (
)

func TestEnsureEndpointsSet_AllSet(t *testing.T) {
provisionInfo := &fnpb.ProvisionInfo{
LoggingEndpoint: &pipepb.ApiServiceDescriptor{Url: "testLoggingEndpointUrl"},
ArtifactEndpoint: &pipepb.ApiServiceDescriptor{Url: "testArtifactEndpointUrl"},
ControlEndpoint: &pipepb.ApiServiceDescriptor{Url: "testControlEndpointUrl"},
}
provisionInfo := fnpb.ProvisionInfo_builder{
LoggingEndpoint: pipepb.ApiServiceDescriptor_builder{Url: "testLoggingEndpointUrl"}.Build(),
ArtifactEndpoint: pipepb.ApiServiceDescriptor_builder{Url: "testArtifactEndpointUrl"}.Build(),
ControlEndpoint: pipepb.ApiServiceDescriptor_builder{Url: "testControlEndpointUrl"}.Build(),
}.Build()
*loggingEndpoint = ""
*artifactEndpoint = ""
*controlEndpoint = ""
Expand All @@ -53,11 +53,11 @@ func TestEnsureEndpointsSet_AllSet(t *testing.T) {
}

func TestEnsureEndpointsSet_OneMissing(t *testing.T) {
provisionInfo := &fnpb.ProvisionInfo{
LoggingEndpoint: &pipepb.ApiServiceDescriptor{Url: "testLoggingEndpointUrl"},
ArtifactEndpoint: &pipepb.ApiServiceDescriptor{Url: "testArtifactEndpointUrl"},
ControlEndpoint: &pipepb.ApiServiceDescriptor{Url: ""},
}
provisionInfo := fnpb.ProvisionInfo_builder{
LoggingEndpoint: pipepb.ApiServiceDescriptor_builder{Url: "testLoggingEndpointUrl"}.Build(),
ArtifactEndpoint: pipepb.ApiServiceDescriptor_builder{Url: "testArtifactEndpointUrl"}.Build(),
ControlEndpoint: pipepb.ApiServiceDescriptor_builder{Url: ""}.Build(),
}.Build()
*loggingEndpoint = ""
*artifactEndpoint = ""
*controlEndpoint = ""
Expand Down Expand Up @@ -85,7 +85,7 @@ func TestGetGoWorkerArtifactName_NoArtifacts(t *testing.T) {

func TestGetGoWorkerArtifactName_OneArtifact(t *testing.T) {
artifact := constructArtifactInformation(t, artifact.URNGoWorkerBinaryRole, "test/path", "sha")
artifacts := []*pipepb.ArtifactInformation{&artifact}
artifacts := []*pipepb.ArtifactInformation{artifact}

val, err := getGoWorkerArtifactName(context.Background(), &tools.Logger{}, artifacts)
if err != nil {
Expand All @@ -99,7 +99,7 @@ func TestGetGoWorkerArtifactName_OneArtifact(t *testing.T) {
func TestGetGoWorkerArtifactName_MultipleArtifactsFirstIsWorker(t *testing.T) {
artifact1 := constructArtifactInformation(t, artifact.URNGoWorkerBinaryRole, "test/path", "sha")
artifact2 := constructArtifactInformation(t, "other role", "test/path2", "sha")
artifacts := []*pipepb.ArtifactInformation{&artifact1, &artifact2}
artifacts := []*pipepb.ArtifactInformation{artifact1, artifact2}

val, err := getGoWorkerArtifactName(context.Background(), &tools.Logger{}, artifacts)
if err != nil {
Expand All @@ -113,7 +113,7 @@ func TestGetGoWorkerArtifactName_MultipleArtifactsFirstIsWorker(t *testing.T) {
func TestGetGoWorkerArtifactName_MultipleArtifactsSecondIsWorker(t *testing.T) {
artifact1 := constructArtifactInformation(t, "other role", "test/path", "sha")
artifact2 := constructArtifactInformation(t, artifact.URNGoWorkerBinaryRole, "test/path2", "sha")
artifacts := []*pipepb.ArtifactInformation{&artifact1, &artifact2}
artifacts := []*pipepb.ArtifactInformation{artifact1, artifact2}

val, err := getGoWorkerArtifactName(context.Background(), &tools.Logger{}, artifacts)
if err != nil {
Expand All @@ -127,7 +127,7 @@ func TestGetGoWorkerArtifactName_MultipleArtifactsSecondIsWorker(t *testing.T) {
func TestGetGoWorkerArtifactName_MultipleArtifactsLegacyWay(t *testing.T) {
artifact1 := constructArtifactInformation(t, "other role", "test/path", "sha")
artifact2 := constructArtifactInformation(t, "other role", "worker", "sha")
artifacts := []*pipepb.ArtifactInformation{&artifact1, &artifact2}
artifacts := []*pipepb.ArtifactInformation{artifact1, artifact2}

val, err := getGoWorkerArtifactName(context.Background(), &tools.Logger{}, artifacts)
if err != nil {
Expand All @@ -141,7 +141,7 @@ func TestGetGoWorkerArtifactName_MultipleArtifactsLegacyWay(t *testing.T) {
func TestGetGoWorkerArtifactName_MultipleArtifactsNoneMatch(t *testing.T) {
artifact1 := constructArtifactInformation(t, "other role", "test/path", "sha")
artifact2 := constructArtifactInformation(t, "other role", "test/path2", "sha")
artifacts := []*pipepb.ArtifactInformation{&artifact1, &artifact2}
artifacts := []*pipepb.ArtifactInformation{artifact1, artifact2}

_, err := getGoWorkerArtifactName(context.Background(), &tools.Logger{}, artifacts)
if err == nil {
Expand Down Expand Up @@ -193,16 +193,16 @@ func TestCopyExe(t *testing.T) {
}
}

func constructArtifactInformation(t *testing.T, roleUrn string, path string, sha string) pipepb.ArtifactInformation {
func constructArtifactInformation(t *testing.T, roleUrn string, path string, sha string) *pipepb.ArtifactInformation {
t.Helper()

typePayload, _ := proto.Marshal(&pipepb.ArtifactFilePayload{Path: path, Sha256: sha})
typePayload, _ := proto.Marshal(pipepb.ArtifactFilePayload_builder{Path: path, Sha256: sha}.Build())

return pipepb.ArtifactInformation{
return pipepb.ArtifactInformation_builder{
RoleUrn: roleUrn,
TypeUrn: artifact.URNFileArtifact,
TypePayload: typePayload,
}
}.Build()
}

func TestConfigureGoogleCloudProfilerEnvVars(t *testing.T) {
Expand Down
22 changes: 11 additions & 11 deletions sdks/go/container/pool/workerpool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,24 +80,24 @@ func (s *Process) StartWorker(_ context.Context, req *fnpb.StartWorkerRequest) (
s.mu.Lock()
defer s.mu.Unlock()
if s.workers == nil {
return &fnpb.StartWorkerResponse{
return fnpb.StartWorkerResponse_builder{
Error: "worker pool shutting down",
}, nil
}.Build(), nil
}

if _, ok := s.workers[req.GetWorkerId()]; ok {
return &fnpb.StartWorkerResponse{
return fnpb.StartWorkerResponse_builder{
Error: fmt.Sprintf("worker with ID %q already exists", req.GetWorkerId()),
}, nil
}.Build(), nil
}
if req.GetLoggingEndpoint() == nil {
return &fnpb.StartWorkerResponse{Error: fmt.Sprintf("Missing logging endpoint for worker %v", req.GetWorkerId())}, nil
return fnpb.StartWorkerResponse_builder{Error: fmt.Sprintf("Missing logging endpoint for worker %v", req.GetWorkerId())}.Build(), nil
}
if req.GetControlEndpoint() == nil {
return &fnpb.StartWorkerResponse{Error: fmt.Sprintf("Missing control endpoint for worker %v", req.GetWorkerId())}, nil
return fnpb.StartWorkerResponse_builder{Error: fmt.Sprintf("Missing control endpoint for worker %v", req.GetWorkerId())}.Build(), nil
}
if req.GetLoggingEndpoint().Authentication != nil || req.GetControlEndpoint().Authentication != nil {
return &fnpb.StartWorkerResponse{Error: "[BEAM-10610] Secure endpoints not supported."}, nil
if req.GetLoggingEndpoint().HasAuthentication() || req.GetControlEndpoint().HasAuthentication() {
return fnpb.StartWorkerResponse_builder{Error: "[BEAM-10610] Secure endpoints not supported."}.Build(), nil
}

ctx := grpcx.WriteWorkerID(s.root, req.GetWorkerId())
Expand All @@ -118,7 +118,7 @@ func (s *Process) StartWorker(_ context.Context, req *fnpb.StartWorkerRequest) (
cmd.Env = nil // Use the current environment.

if err := cmd.Start(); err != nil {
return &fnpb.StartWorkerResponse{Error: fmt.Sprintf("Unable to start boot for worker %v: %v", req.GetWorkerId(), err)}, nil
return fnpb.StartWorkerResponse_builder{Error: fmt.Sprintf("Unable to start boot for worker %v: %v", req.GetWorkerId(), err)}.Build(), nil
}
return &fnpb.StartWorkerResponse{}, nil
}
Expand All @@ -137,9 +137,9 @@ func (s *Process) StopWorker(_ context.Context, req *fnpb.StopWorkerRequest) (*f
delete(s.workers, req.GetWorkerId())
return &fnpb.StopWorkerResponse{}, nil
}
return &fnpb.StopWorkerResponse{
return fnpb.StopWorkerResponse_builder{
Error: fmt.Sprintf("no worker with id %q running", req.GetWorkerId()),
}, nil
}.Build(), nil

}

Expand Down
60 changes: 30 additions & 30 deletions sdks/go/container/pool/workerpool_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ func TestProcess(t *testing.T) {
t.Skip("Binary `true` doesn't exist, skipping tests.")
}

endpoint := &pipepb.ApiServiceDescriptor{
endpoint := pipepb.ApiServiceDescriptor_builder{
Url: "localhost:0",
}
secureEndpoint := &pipepb.ApiServiceDescriptor{
}.Build()
secureEndpoint := pipepb.ApiServiceDescriptor_builder{
Url: "localhost:0",
Authentication: &pipepb.AuthenticationSpec{
Authentication: pipepb.AuthenticationSpec_builder{
Urn: "beam:authentication:oauth2_client_credentials_grant:v1",
},
}
}.Build(),
}.Build()

ctx, cancelFn := context.WithCancel(context.Background())
t.Cleanup(cancelFn)
Expand All @@ -54,60 +54,60 @@ func TestProcess(t *testing.T) {
errExpected bool
}{
{
req: &fnpb.StartWorkerRequest{
req: fnpb.StartWorkerRequest_builder{
WorkerId: "Worker1",
ControlEndpoint: endpoint,
LoggingEndpoint: endpoint,
},
}.Build(),
}, {
req: &fnpb.StartWorkerRequest{
req: fnpb.StartWorkerRequest_builder{
WorkerId: "Worker2",
ControlEndpoint: endpoint,
LoggingEndpoint: endpoint,
},
}.Build(),
}, {
req: &fnpb.StartWorkerRequest{
req: fnpb.StartWorkerRequest_builder{
WorkerId: "Worker1",
ControlEndpoint: endpoint,
LoggingEndpoint: endpoint,
},
}.Build(),
errExpected: true, // Repeated start
}, {
req: &fnpb.StartWorkerRequest{
req: fnpb.StartWorkerRequest_builder{
WorkerId: "missingControl",
LoggingEndpoint: endpoint,
},
}.Build(),
errExpected: true,
}, {
req: &fnpb.StartWorkerRequest{
req: fnpb.StartWorkerRequest_builder{
WorkerId: "missingLogging",
ControlEndpoint: endpoint,
},
}.Build(),
errExpected: true,
}, {
req: &fnpb.StartWorkerRequest{
req: fnpb.StartWorkerRequest_builder{
WorkerId: "secureLogging",
LoggingEndpoint: secureEndpoint,
ControlEndpoint: endpoint,
},
}.Build(),
errExpected: true,
}, {
req: &fnpb.StartWorkerRequest{
req: fnpb.StartWorkerRequest_builder{
WorkerId: "secureControl",
LoggingEndpoint: endpoint,
ControlEndpoint: secureEndpoint,
},
}.Build(),
errExpected: true,
},
}
for _, test := range startTests {
resp, err := server.StartWorker(ctx, test.req)
if test.errExpected {
if err != nil || resp.Error == "" {
if err != nil || resp.GetError() == "" {
t.Errorf("Expected error starting %v: err: %v, resp: %v", test.req.GetWorkerId(), err, resp)
}
} else {
if err != nil || resp.Error != "" {
if err != nil || resp.GetError() != "" {
t.Errorf("Unexpected error starting %v: err: %v, resp: %v", test.req.GetWorkerId(), err, resp)
}
}
Expand All @@ -117,29 +117,29 @@ func TestProcess(t *testing.T) {
errExpected bool
}{
{
req: &fnpb.StopWorkerRequest{
req: fnpb.StopWorkerRequest_builder{
WorkerId: "Worker1",
},
}.Build(),
}, {
req: &fnpb.StopWorkerRequest{
req: fnpb.StopWorkerRequest_builder{
WorkerId: "Worker1",
},
}.Build(),
errExpected: true,
}, {
req: &fnpb.StopWorkerRequest{
req: fnpb.StopWorkerRequest_builder{
WorkerId: "NonExistent",
},
}.Build(),
errExpected: true,
},
}
for _, test := range stopTests {
resp, err := server.StopWorker(ctx, test.req)
if test.errExpected {
if err != nil || resp.Error == "" {
if err != nil || resp.GetError() == "" {
t.Errorf("Expected error starting %v: err: %v, resp: %v", test.req.GetWorkerId(), err, resp)
}
} else {
if err != nil || resp.Error != "" {
if err != nil || resp.GetError() != "" {
t.Errorf("Unexpected error starting %v: err: %v, resp: %v", test.req.GetWorkerId(), err, resp)
}
}
Expand Down
24 changes: 12 additions & 12 deletions sdks/go/container/tools/buffered_logging_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,11 @@ func TestBufferedLogger(t *testing.T) {

received := catcher.msgs[0].GetLogEntries()[0]

if got, want := received.Message, "test message"; got != want {
if got, want := received.GetMessage(), "test message"; got != want {
t.Errorf("got message %q, want %q", got, want)
}

if got, want := received.Severity, fnpb.LogEntry_Severity_DEBUG; got != want {
if got, want := received.GetSeverity(), fnpb.LogEntry_Severity_DEBUG; got != want {
t.Errorf("got severity %v, want %v", got, want)
}
})
Expand Down Expand Up @@ -96,11 +96,11 @@ func TestBufferedLogger(t *testing.T) {
received := catcher.msgs[0].GetLogEntries()

for i, message := range received {
if got, want := message.Message, messages[i]; got != want {
if got, want := message.GetMessage(), messages[i]; got != want {
t.Errorf("got message %q, want %q", got, want)
}

if got, want := message.Severity, fnpb.LogEntry_Severity_DEBUG; got != want {
if got, want := message.GetSeverity(), fnpb.LogEntry_Severity_DEBUG; got != want {
t.Errorf("got severity %v, want %v", got, want)
}
}
Expand All @@ -125,11 +125,11 @@ func TestBufferedLogger(t *testing.T) {

received := catcher.msgs[0].GetLogEntries()[0]

if got, want := received.Message, "test error"; got != want {
if got, want := received.GetMessage(), "test error"; got != want {
t.Errorf("got message %q, want %q", got, want)
}

if got, want := received.Severity, fnpb.LogEntry_Severity_ERROR; got != want {
if got, want := received.GetSeverity(), fnpb.LogEntry_Severity_ERROR; got != want {
t.Errorf("got severity %v, want %v", got, want)
}
})
Expand Down Expand Up @@ -158,11 +158,11 @@ func TestBufferedLogger(t *testing.T) {
received := catcher.msgs[0].GetLogEntries()

for i, message := range received {
if got, want := message.Message, messages[i]; got != want {
if got, want := message.GetMessage(), messages[i]; got != want {
t.Errorf("got message %q, want %q", got, want)
}

if got, want := message.Severity, fnpb.LogEntry_Severity_ERROR; got != want {
if got, want := message.GetSeverity(), fnpb.LogEntry_Severity_ERROR; got != want {
t.Errorf("got severity %v, want %v", got, want)
}
}
Expand All @@ -177,11 +177,11 @@ func TestBufferedLogger(t *testing.T) {

received := catcher.msgs[0].GetLogEntries()[0]

if got, want := received.Message, "foo bar"; got != want {
if got, want := received.GetMessage(), "foo bar"; got != want {
t.Errorf("l.Printf(\"foo %%v\", \"bar\"): got message %q, want %q", got, want)
}

if got, want := received.Severity, fnpb.LogEntry_Severity_DEBUG; got != want {
if got, want := received.GetSeverity(), fnpb.LogEntry_Severity_DEBUG; got != want {
t.Errorf("l.Printf(\"foo %%v\", \"bar\"): got severity %v, want %v", got, want)
}
})
Expand Down Expand Up @@ -229,11 +229,11 @@ func TestBufferedLogger(t *testing.T) {
messages = append(messages, lastMessage)

for i, message := range received {
if got, want := message.Message, messages[i]; got != want {
if got, want := message.GetMessage(), messages[i]; got != want {
t.Errorf("got message %q, want %q", got, want)
}

if got, want := message.Severity, fnpb.LogEntry_Severity_DEBUG; got != want {
if got, want := message.GetSeverity(), fnpb.LogEntry_Severity_DEBUG; got != want {
t.Errorf("got severity %v, want %v", got, want)
}
}
Expand Down
Loading
Loading