grpc.RoundRobin and grpc.WithBalancer no longer exist

[jqll]

We are using this library and seeing these errors:

../google.golang.org/api/option/option.go:153:14: undefined: grpc.RoundRobin
../google.golang.org/api/option/option.go:154:42: undefined: grpc.WithBalancer

Sounds like gRPC removed these legacy APIs: grpc/grpc-go@336cf8d

[menghanl]

gRPC is pined at version v1.20.1, so this shouldn't break until the version is bumped The version specified is actually the mininum required version. But until the gRPC change is released, it should only break users pulling gRPC from head:

google-api-go-client/go.mod

Line 21 in 64f53cc

google.golang.org/grpc v1.20.1

[nolanmar511]

We're not yet using go modules in the test cases which we saw this failure with, so that might explain why pinning within google-api-go-client/go.mod didn't have an effect for our use case.

Is it expected, then, that this change will break users who aren't using go modules?

[dfawley]

This change will break users who are using go modules as well due to MVS.

Unfortunately, these APIs must be removed. They were marked as experimental since v1.0 and have been marked with deprecation tags for 6 months. Removing them is allowed under the grpc-go versioning policy.

[nolanmar511]

@menghanl -- Is it possible to confirm (or check) that using go modules will fix this issue? If so, is that our only work-around.

I'm a bit hesitant to attempt to adopt go modules right now if it won't necessarily provide a fix.

[dfawley]

If you use go modules in your own project, you can pin a specific version, which would work:

https://github.com/golang/go/wiki/Modules#when-should-i-use-the-replace-directive

Alternatively, you could vendor grpc at an older version.

[nolanmar511]

Thanks. I'll work on switching to using go modules. Perhaps my team missed some sign that this was coming, but it's been a difficult surprise for us.

Since it seems like this library now exclusively supports users who also use go modules, it would be nice to see that mentioned on the README.md for this repo. If it's documented somewhere else, a pointer to that documentation would be great.

[max202021]

Any updated on this? it is blocking production google cloud build.

if changing to go Mod is going to take time and can grpc team rollback this commit and make those api available as quick fix?

In my docker file , I have following Lines

RUN go get -v -u go.mongodb.org/mongo-driver/mongo

RUN go get -d -v ./...

RUN go get google.golang.org/api/option

I am getting following error . Everything was working fine 3 days before.

```

Step 9/17 : RUN go get google.golang.org/api/option
---> Running in ec36bafa25aa
# google.golang.org/api/option
../google.golang.org/api/option/option.go:153:14: undefined: grpc.RoundRobin
../google.golang.org/api/option/option.go:154:42: undefined: grpc.WithBalancer
The command '/bin/sh -c go get google.golang.org/api/option' returned a non-zero code: 2

[cosmin8905]

Update:
The issue still appears to be happening:

go get -u google.golang.org/api/option
# google.golang.org/api/option
/Users/cosmin/go/src/google.golang.org/api/option/option.go:153:14: undefined: grpc.RoundRobin
/Users/cosmin/go/src/google.golang.org/api/option/option.go:154:42: undefined: grpc.WithBalancer

[stapelberg]

FYI: to pin gRPC to the latest released version (before the symbols were removed), use:

go mod edit -replace google.golang.org/grpc=google.golang.org/grpc@v1.26.0

[dfawley]

FYI: to pin gRPC to the latest released version (before the symbols were removed), use:

NOTE: this will only work on a top-level go.mod file, i.e. the one that contains the go binary you are building. It does not work in a library's go.mod, so it could not be applied in this repo.

[dfawley]

Sent #442 to remove the usages of the experimental gRPC API. Anyone depending on this experimental API will be broken, but users not depending on them will be unbroken.

[Niek-Okido]

i made line 153 and 154 as command that is the one that causing the issue :
this is not perfect but when you are sure you are not using this function will be no problem so replace the : \go\src\google.golang.org\api\option\option.go with the the text below

kind regards Niek Tuytel

`// Copyright 2017 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Package option contains options for Google API clients.
package option

import (
"net/http"

"golang.org/x/oauth2"
"google.golang.org/api/internal"
"google.golang.org/grpc"

)

// A ClientOption is an option for a Google API client.
type ClientOption interface {
Apply(*internal.DialSettings)
}

// WithTokenSource returns a ClientOption that specifies an OAuth2 token
// source to be used as the basis for authentication.
func WithTokenSource(s oauth2.TokenSource) ClientOption {
return withTokenSource{s}
}

type withTokenSource struct{ ts oauth2.TokenSource }

func (w withTokenSource) Apply(o *internal.DialSettings) {
o.TokenSource = w.ts
}

type withCredFile string

func (w withCredFile) Apply(o *internal.DialSettings) {
o.CredentialsFile = string(w)
}

// WithCredentialsFile returns a ClientOption that authenticates
// API calls with the given service account or refresh token JSON
// credentials file.
func WithCredentialsFile(filename string) ClientOption {
return withCredFile(filename)
}

// WithServiceAccountFile returns a ClientOption that uses a Google service
// account credentials file to authenticate.
//
// Deprecated: Use WithCredentialsFile instead.
func WithServiceAccountFile(filename string) ClientOption {
return WithCredentialsFile(filename)
}

// WithCredentialsJSON returns a ClientOption that authenticates
// API calls with the given service account or refresh token JSON
// credentials.
func WithCredentialsJSON(p []byte) ClientOption {
return withCredentialsJSON(p)
}

type withCredentialsJSON []byte

func (w withCredentialsJSON) Apply(o *internal.DialSettings) {
o.CredentialsJSON = make([]byte, len(w))
copy(o.CredentialsJSON, w)
}

// WithEndpoint returns a ClientOption that overrides the default endpoint
// to be used for a service.
func WithEndpoint(url string) ClientOption {
return withEndpoint(url)
}

type withEndpoint string

func (w withEndpoint) Apply(o *internal.DialSettings) {
o.Endpoint = string(w)
}

// WithScopes returns a ClientOption that overrides the default OAuth2 scopes
// to be used for a service.
func WithScopes(scope ...string) ClientOption {
return withScopes(scope)
}

type withScopes []string

func (w withScopes) Apply(o *internal.DialSettings) {
o.Scopes = make([]string, len(w))
copy(o.Scopes, w)
}

// WithUserAgent returns a ClientOption that sets the User-Agent.
func WithUserAgent(ua string) ClientOption {
return withUA(ua)
}

type withUA string

func (w withUA) Apply(o *internal.DialSettings) { o.UserAgent = string(w) }

// WithHTTPClient returns a ClientOption that specifies the HTTP client to use
// as the basis of communications. This option may only be used with services
// that support HTTP as their communication transport. When used, the
// WithHTTPClient option takes precedent over all other supplied options.
func WithHTTPClient(client *http.Client) ClientOption {
return withHTTPClient{client}
}

type withHTTPClient struct{ client *http.Client }

func (w withHTTPClient) Apply(o *internal.DialSettings) {
o.HTTPClient = w.client
}

// WithGRPCConn returns a ClientOption that specifies the gRPC client
// connection to use as the basis of communications. This option may only be
// used with services that support gRPC as their communication transport. When
// used, the WithGRPCConn option takes precedent over all other supplied
// options.
func WithGRPCConn(conn *grpc.ClientConn) ClientOption {
return withGRPCConn{conn}
}

type withGRPCConn struct{ conn *grpc.ClientConn }

func (w withGRPCConn) Apply(o *internal.DialSettings) {
o.GRPCConn = w.conn
}

// WithGRPCDialOption returns a ClientOption that appends a new grpc.DialOption
// to an underlying gRPC dial. It does not work with WithGRPCConn.
func WithGRPCDialOption(opt grpc.DialOption) ClientOption {
return withGRPCDialOption{opt}
}

type withGRPCDialOption struct{ opt grpc.DialOption }

func (w withGRPCDialOption) Apply(o *internal.DialSettings) {
o.GRPCDialOpts = append(o.GRPCDialOpts, w.opt)
}

// WithGRPCConnectionPool returns a ClientOption that creates a pool of gRPC
// connections that requests will be balanced between.
// This is an EXPERIMENTAL API and may be changed or removed in the future.
func WithGRPCConnectionPool(size int) ClientOption {
return withGRPCConnectionPool(size)
}

type withGRPCConnectionPool int

func (w withGRPCConnectionPool) Apply(o *internal.DialSettings) {
// balancer := grpc.RoundRobin(internal.NewPoolResolver(int(w), o))
// o.GRPCDialOpts = append(o.GRPCDialOpts, grpc.WithBalancer(balancer))
}

// WithAPIKey returns a ClientOption that specifies an API key to be used
// as the basis for authentication.
//
// API Keys can only be used for JSON-over-HTTP APIs, including those under
// the import path google.golang.org/api/....
func WithAPIKey(apiKey string) ClientOption {
return withAPIKey(apiKey)
}

type withAPIKey string

func (w withAPIKey) Apply(o *internal.DialSettings) { o.APIKey = string(w) }

// WithAudiences returns a ClientOption that specifies an audience to be used
// as the audience field ("aud") for the JWT token authentication.
func WithAudiences(audience ...string) ClientOption {
return withAudiences(audience)
}

type withAudiences []string

func (w withAudiences) Apply(o *internal.DialSettings) {
o.Audiences = make([]string, len(w))
copy(o.Audiences, w)
}

// WithoutAuthentication returns a ClientOption that specifies that no
// authentication should be used. It is suitable only for testing and for
// accessing public resources, like public Google Cloud Storage buckets.
// It is an error to provide both WithoutAuthentication and any of WithAPIKey,
// WithTokenSource, WithCredentialsFile or WithServiceAccountFile.
func WithoutAuthentication() ClientOption {
return withoutAuthentication{}
}

type withoutAuthentication struct{}

func (w withoutAuthentication) Apply(o *internal.DialSettings) { o.NoAuth = true }

// WithQuotaProject returns a ClientOption that specifies the project used
// for quota and billing purposes.
//
// For more information please read:
// https://cloud.google.com/apis/docs/system-parameters
func WithQuotaProject(quotaProject string) ClientOption {
return withQuotaProject(quotaProject)
}

type withQuotaProject string

func (w withQuotaProject) Apply(o *internal.DialSettings) {
o.QuotaProject = string(w)
}

// WithRequestReason returns a ClientOption that specifies a reason for
// making the request, which is intended to be recorded in audit logging.
// An example reason would be a support-case ticket number.
//
// For more information please read:
// https://cloud.google.com/apis/docs/system-parameters
func WithRequestReason(requestReason string) ClientOption {
return withRequestReason(requestReason)
}

type withRequestReason string

func (w withRequestReason) Apply(o *internal.DialSettings) {
o.RequestReason = string(w)
}

// WithTelemetryDisabled returns a ClientOption that disables default telemetry (OpenCensus)
// settings on gRPC and HTTP clients.
// An example reason would be to bind custom telemetry that overrides the defaults.
func WithTelemetryDisabled() ClientOption {
return withTelemetryDisabledOption{}
}

type withTelemetryDisabledOption struct{}

func (w withTelemetryDisabledOption) Apply(o *internal.DialSettings) {
o.TelemetryDisabled = true
}
`

[Niek-Okido]

`func (w withGRPCConnectionPool) Apply(o *internal.DialSettings) {

// balancer := grpc.RoundRobin(internal.NewPoolResolver(int(w), o))

// o.GRPCDialOpts = append(o.GRPCDialOpts, grpc.WithBalancer(balancer))

}

`

this is what i did and work for me
on the \go\src\google.golang.org\api\option\option.go file

[chadit]

this also broke the googles own docs api for sheets.
https://developers.google.com/sheets/api/quickstart/go

[Fyb3roptik]

I am unable to switch to Go Modules right now and this has our Production systems down! PLEASE FIX!!!!!

[Fyb3roptik]

I appreciate the quick response from everyone!

[broady]

Quick update... Next steps:

• tag a release of all modules in google-cloud-go
• submit CL 50573
• tag a release of google-api-go-client