Skip to content
This repository has been archived by the owner on Jun 28, 2022. It is now read-only.

go: make longrunning methods use generated longrunning client #1288

Merged
merged 1 commit into from
May 25, 2017
Merged

go: make longrunning methods use generated longrunning client #1288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion src/main/java/com/google/api/codegen/transformer/go/GoGapicSurfaceTransformer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,9 @@ private enum ImportKind {
.put(
ImportContext.CLIENT,
ImportKind.LRO,
ImmutableList.<String>of("cloud.google.com/go/longrunning;;;"))
ImmutableList.<String>of(
"cloud.google.com/go/longrunning;;;",
"cloud.google.com/go/longrunning/autogen;lroauto;;"))
.put(
ImportContext.EXAMPLE,
ImportKind.SERVER_STREAM,
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/com/google/api/codegen/viewmodel/StaticLangClientFileView.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ public String resourceRoot() {

public abstract List<LongRunningOperationDetailView> lroDetailViews();

public boolean hasLongRunningOperations() {
return !lroDetailViews().isEmpty();
}

public static Builder newBuilder() {
return new AutoValue_StaticLangClientFileView.Builder();
}
Expand Down
60 changes: 29 additions & 31 deletions src/main/resources/com/google/api/codegen/go/main.snip
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,13 @@
{@stub.name} {@stub.grpcClientTypeName}
@end

@if view.hasLongRunningOperations
// LROClient is used internally to handle longrunning operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient *lroauto.OperationsClient
@end

// The call options for this service.
CallOptions *{@view.callOptionsTypeName}

Expand Down Expand Up @@ -93,6 +100,13 @@
@end
}
c.SetGoogleClientInfo()
@if view.hasLongRunningOperations

c.LROClient, err = lroauto.NewOperationsClient(ctx, option.WithGRPCConn(conn))
if err != nil {
panic("unexpected error creating LRO client: " + err.Error())
}
@end
return c, nil
}

Expand Down Expand Up @@ -208,8 +222,7 @@
return nil, err
}
return &{@method.operationMethod.clientReturnTypeName}{
lro: longrunning.InternalNewOperation(c.Connection(), resp),
xGoogHeader: c.xGoogHeader,
lro: longrunning.InternalNewOperation(c.LROClient, resp),
}, nil
}
@end
Expand Down Expand Up @@ -328,35 +341,25 @@
@end

@private lroWrapper(view, lro)
@if lro.isEmptyOperation
// {@lro.clientReturnTypeName} manages a long-running operation with no result.
@else
// {@lro.clientReturnTypeName} manages a long-running operation from {@lro.methodName}.
@end

// {@lro.clientReturnTypeName} manages a long-running operation from {@lro.methodName}.
type {@lro.clientReturnTypeName} struct {
lro *longrunning.Operation

// The metadata to be sent with each request.
xGoogHeader []string
}

// {@lro.constructorName} returns a new {@lro.clientReturnTypeName} from a given name.
// The name must be that of a previously created {@lro.clientReturnTypeName}, possibly from a different process.
func (c *{@view.clientTypeName}) {@lro.constructorName}(name string) *{@lro.clientReturnTypeName} {
return &{@lro.clientReturnTypeName}{
lro: longrunning.InternalNewOperation(c.Connection(), &longrunningpb.Operation{Name: name}),
xGoogHeader: c.xGoogHeader,
lro: longrunning.InternalNewOperation(c.LROClient, &longrunningpb.Operation{Name: name}),
}
}

@if lro.isEmptyOperation
// Wait blocks until the long-running operation is completed, returning any error encountered.
//
// See documentation of Poll for error-handling information.
func (op *{@lro.clientReturnTypeName}) Wait(ctx context.Context) error {
ctx = insertXGoog(ctx, op.xGoogHeader)
return op.lro.Wait(ctx, nil)
func (op *{@lro.clientReturnTypeName}) Wait(ctx context.Context, opts ...gax.CallOption) error {
return op.lro.Wait(ctx, nil, opts...)
}

// Poll fetches the latest state of the long-running operation.
Expand All @@ -366,18 +369,16 @@
// If Poll fails, the error is returned and op is unmodified. If Poll succeeds and
// the operation has completed with failure, the error is returned and op.Done will return true.
// If Poll succeeds and the operation has completed successfully, op.Done will return true.
func (op *{@lro.clientReturnTypeName}) Poll(ctx context.Context) error {
ctx = insertXGoog(ctx, op.xGoogHeader)
return op.lro.Poll(ctx, nil)
func (op *{@lro.clientReturnTypeName}) Poll(ctx context.Context, opts ...gax.CallOption) error {
return op.lro.Poll(ctx, nil, opts...)
}
@else
// Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
//
// See documentation of Poll for error-handling information.
func (op *{@lro.clientReturnTypeName}) Wait(ctx context.Context) (*{@lro.operationPayloadTypeName}, error) {
func (op *{@lro.clientReturnTypeName}) Wait(ctx context.Context, opts ...gax.CallOption) (*{@lro.operationPayloadTypeName}, error) {
var resp {@lro.operationPayloadTypeName}
ctx = insertXGoog(ctx, op.xGoogHeader)
if err := op.lro.Wait(ctx, &resp); err != nil {
if err := op.lro.Wait(ctx, &resp, opts...); err != nil {
return nil, err
}
return &resp, nil
Expand All @@ -392,10 +393,9 @@
// If Poll succeeds and the operation has completed successfully,
// op.Done will return true, and the response of the operation is returned.
// If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (op *{@lro.clientReturnTypeName}) Poll(ctx context.Context) (*{@lro.operationPayloadTypeName}, error) {
func (op *{@lro.clientReturnTypeName}) Poll(ctx context.Context, opts ...gax.CallOption) (*{@lro.operationPayloadTypeName}, error) {
var resp {@lro.operationPayloadTypeName}
ctx = insertXGoog(ctx, op.xGoogHeader)
if err := op.lro.Poll(ctx, &resp); err != nil {
if err := op.lro.Poll(ctx, &resp, opts...); err != nil {
return nil, err
}
if !op.Done() {
Expand Down Expand Up @@ -436,19 +436,17 @@
// Clients can use Poll or other methods to check whether the cancellation succeeded or whether the operation
// completed despite cancellation. On successful cancellation, the operation is not deleted;
// instead, op.Poll returns an error with code Canceled.
func (op *{@lro.clientReturnTypeName}) Cancel(ctx context.Context) error {
ctx = insertXGoog(ctx, op.xGoogHeader)
return op.lro.Cancel(ctx)
func (op *{@lro.clientReturnTypeName}) Cancel(ctx context.Context, opts ...gax.CallOption) error {
return op.lro.Cancel(ctx, opts...)
}
@end

@if lro.implementsDelete
// Delete deletes a long-running operation.
// This method indicates that the client is no longer interested in the operation result.
// It does not cancel the operation.
func (op *{@lro.clientReturnTypeName}) Delete(ctx context.Context) error {
ctx = insertXGoog(ctx, op.xGoogHeader)
return op.lro.Delete(ctx)
func (op *{@lro.clientReturnTypeName}) Delete(ctx context.Context, opts ...gax.CallOption) error {
return op.lro.Delete(ctx, opts...)
}
@end
@end
Expand Down
61 changes: 28 additions & 33 deletions src/test/java/com/google/api/codegen/testdata/go_main_library.baseline
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"cloud.google.com/go/iam"
"cloud.google.com/go/internal/version"
"cloud.google.com/go/longrunning"
lroauto "cloud.google.com/go/longrunning/autogen"
gax "github.com/googleapis/gax-go"
"golang.org/x/net/context"
"google.golang.org/api/iterator"
Expand Down Expand Up @@ -133,6 +134,11 @@ type Client struct {
client librarypb.LibraryServiceClient
labelerClient taggerpb.LabelerClient

// LROClient is used internally to handle longrunning operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient *lroauto.OperationsClient

// The call options for this service.
CallOptions *CallOptions

Expand Down Expand Up @@ -171,6 +177,11 @@ func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error
labelerClient: taggerpb.NewLabelerClient(conn),
}
c.SetGoogleClientInfo()

c.LROClient, err = lroauto.NewOperationsClient(ctx, option.WithGRPCConn(conn))
if err != nil {
panic("unexpected error creating LRO client: " + err.Error())
}
return c, nil
}

Expand Down Expand Up @@ -685,8 +696,7 @@ func (c *Client) GetBigBook(ctx context.Context, req *librarypb.GetBookRequest,
return nil, err
}
return &GetBigBookOperation{
lro: longrunning.InternalNewOperation(c.Connection(), resp),
xGoogHeader: c.xGoogHeader,
lro: longrunning.InternalNewOperation(c.LROClient, resp),
}, nil
}

Expand All @@ -704,8 +714,7 @@ func (c *Client) GetBigNothing(ctx context.Context, req *librarypb.GetBookReques
return nil, err
}
return &GetBigNothingOperation{
lro: longrunning.InternalNewOperation(c.Connection(), resp),
xGoogHeader: c.xGoogHeader,
lro: longrunning.InternalNewOperation(c.LROClient, resp),
}, nil
}

Expand Down Expand Up @@ -856,27 +865,22 @@ func (it *StringIterator) takeBuf() interface{} {
// GetBigBookOperation manages a long-running operation from GetBigBook.
type GetBigBookOperation struct {
lro *longrunning.Operation

// The metadata to be sent with each request.
xGoogHeader []string
}

// GetBigBookOperation returns a new GetBigBookOperation from a given name.
// The name must be that of a previously created GetBigBookOperation, possibly from a different process.
func (c *Client) GetBigBookOperation(name string) *GetBigBookOperation {
return &GetBigBookOperation{
lro: longrunning.InternalNewOperation(c.Connection(), &longrunningpb.Operation{Name: name}),
xGoogHeader: c.xGoogHeader,
lro: longrunning.InternalNewOperation(c.LROClient, &longrunningpb.Operation{Name: name}),
}
}

// Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
//
// See documentation of Poll for error-handling information.
func (op *GetBigBookOperation) Wait(ctx context.Context) (*librarypb.Book, error) {
func (op *GetBigBookOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*librarypb.Book, error) {
var resp librarypb.Book
ctx = insertXGoog(ctx, op.xGoogHeader)
if err := op.lro.Wait(ctx, &resp); err != nil {
if err := op.lro.Wait(ctx, &resp, opts...); err != nil {
return nil, err
}
return &resp, nil
Expand All @@ -891,10 +895,9 @@ func (op *GetBigBookOperation) Wait(ctx context.Context) (*librarypb.Book, error
// If Poll succeeds and the operation has completed successfully,
// op.Done will return true, and the response of the operation is returned.
// If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (op *GetBigBookOperation) Poll(ctx context.Context) (*librarypb.Book, error) {
func (op *GetBigBookOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*librarypb.Book, error) {
var resp librarypb.Book
ctx = insertXGoog(ctx, op.xGoogHeader)
if err := op.lro.Poll(ctx, &resp); err != nil {
if err := op.lro.Poll(ctx, &resp, opts...); err != nil {
return nil, err
}
if !op.Done() {
Expand Down Expand Up @@ -933,34 +936,28 @@ func (op *GetBigBookOperation) Name() string {
// Clients can use Poll or other methods to check whether the cancellation succeeded or whether the operation
// completed despite cancellation. On successful cancellation, the operation is not deleted;
// instead, op.Poll returns an error with code Canceled.
func (op *GetBigBookOperation) Cancel(ctx context.Context) error {
ctx = insertXGoog(ctx, op.xGoogHeader)
return op.lro.Cancel(ctx)
func (op *GetBigBookOperation) Cancel(ctx context.Context, opts ...gax.CallOption) error {
return op.lro.Cancel(ctx, opts...)
}

// GetBigNothingOperation manages a long-running operation with no result.
// GetBigNothingOperation manages a long-running operation from GetBigNothing.
type GetBigNothingOperation struct {
lro *longrunning.Operation

// The metadata to be sent with each request.
xGoogHeader []string
}

// GetBigNothingOperation returns a new GetBigNothingOperation from a given name.
// The name must be that of a previously created GetBigNothingOperation, possibly from a different process.
func (c *Client) GetBigNothingOperation(name string) *GetBigNothingOperation {
return &GetBigNothingOperation{
lro: longrunning.InternalNewOperation(c.Connection(), &longrunningpb.Operation{Name: name}),
xGoogHeader: c.xGoogHeader,
lro: longrunning.InternalNewOperation(c.LROClient, &longrunningpb.Operation{Name: name}),
}
}

// Wait blocks until the long-running operation is completed, returning any error encountered.
//
// See documentation of Poll for error-handling information.
func (op *GetBigNothingOperation) Wait(ctx context.Context) error {
ctx = insertXGoog(ctx, op.xGoogHeader)
return op.lro.Wait(ctx, nil)
func (op *GetBigNothingOperation) Wait(ctx context.Context, opts ...gax.CallOption) error {
return op.lro.Wait(ctx, nil, opts...)
}

// Poll fetches the latest state of the long-running operation.
Expand All @@ -970,9 +967,8 @@ func (op *GetBigNothingOperation) Wait(ctx context.Context) error {
// If Poll fails, the error is returned and op is unmodified. If Poll succeeds and
// the operation has completed with failure, the error is returned and op.Done will return true.
// If Poll succeeds and the operation has completed successfully, op.Done will return true.
func (op *GetBigNothingOperation) Poll(ctx context.Context) error {
ctx = insertXGoog(ctx, op.xGoogHeader)
return op.lro.Poll(ctx, nil)
func (op *GetBigNothingOperation) Poll(ctx context.Context, opts ...gax.CallOption) error {
return op.lro.Poll(ctx, nil, opts...)
}

// Metadata returns metadata associated with the long-running operation.
Expand Down Expand Up @@ -1004,7 +1000,6 @@ func (op *GetBigNothingOperation) Name() string {
// Delete deletes a long-running operation.
// This method indicates that the client is no longer interested in the operation result.
// It does not cancel the operation.
func (op *GetBigNothingOperation) Delete(ctx context.Context) error {
ctx = insertXGoog(ctx, op.xGoogHeader)
return op.lro.Delete(ctx)
func (op *GetBigNothingOperation) Delete(ctx context.Context, opts ...gax.CallOption) error {
return op.lro.Delete(ctx, opts...)
}