be148ec7a7
Go 1.11 on App Engine standard is a "second generation" runtime, and second generation runtimes do not set the appengine build tag. appengine_hook.go was behind the appengine build tag, meaning that AppEngineTokenSource panicked on the go111 runtime, saying, "AppEngineTokenSource can only be used on App Engine." The second gen runtimes should use ComputeTokenSource, which is also what flex does [1]. This commit does two things to remedy the situation: 1. Put the pre-existing implementation of AppEngineTokenSource behind the appengine build tag since it only works on first gen App Engine runtimes. This leaves first gen behavior unchanged. 2. Add a new implementation of AppEngineTokenSource and tag it !appengine. This implementation will therefore be used by second gen App Engine standard runtimes and App Engine flexible. It delegates to ComputeTokenSource. The new AppEngineTokenSource implementation emits a log message informing the user that AppEngineTokenSource is deprecated for second gen runtimes and flex, instructing them to use DefaultTokenSource or ComputeTokenSource instead. The documentation is updated to say the same. In this way users will not break when upgrading from Go 1.9 to Go 1.11 on App Engine but they will be nudged toward the world where App Engine runtimes have less special behavior. findDefaultCredentials still calls AppEngineTokenSource for first gen runtimes and ComputeTokenSource for flex. Fixes #334 Test: I deployed an app that uses AppEngineTokenSource to Go 1.9 and Go 1.11 on App Engine standard and to Go 1.11 on App Engine flexible and it worked in all cases. Also verified that the log message is present on go111 and flex. [1] DefaultTokenSource did use ComputeTokenSource for flex but AppEngineTokenSource did not. AppEngineTokenSource is supported on flex, in the sense that it doesn't panic when used on flex in the way it does when used outside App Engine. However, AppEngineTokenSource makes an API call internally that isn't supported by default on flex, which emits a log instructing the user to enable the compat runtime. The compat runtimes are deprecated and deploys are blocked. This is a bad experience. This commit has the side effect of fixing this. |
||
---|---|---|
amazon | ||
bitbucket | ||
cern | ||
clientcredentials | ||
fitbit | ||
foursquare | ||
github | ||
gitlab | ||
heroku | ||
hipchat | ||
internal | ||
jira | ||
jws | ||
jwt | ||
kakao | ||
mailchimp | ||
mailru | ||
mediamath | ||
microsoft | ||
nokiahealth | ||
odnoklassniki | ||
paypal | ||
slack | ||
spotify | ||
stackoverflow | ||
twitch | ||
uber | ||
vk | ||
yahoo | ||
yandex | ||
.travis.yml | ||
AUTHORS | ||
CONTRIBUTING.md | ||
CONTRIBUTORS | ||
LICENSE | ||
README.md | ||
example_test.go | ||
oauth2.go | ||
oauth2_test.go | ||
token.go | ||
token_test.go | ||
transport.go | ||
transport_test.go |
README.md
OAuth2 for Go
oauth2 package contains a client implementation for OAuth 2.0 spec.
Installation
go get golang.org/x/oauth2
Or you can manually git clone the repository to
$(go env GOPATH)/src/golang.org/x/oauth2
.
See godoc for further documentation and examples.
App Engine
In change 96e89be
(March 2015), we removed the oauth2.Context2
type in favor
of the context.Context
type from
the golang.org/x/net/context
package
This means it's no longer possible to use the "Classic App Engine"
appengine.Context
type with the oauth2
package. (You're using
Classic App Engine if you import the package "appengine"
.)
To work around this, you may use the new "google.golang.org/appengine"
package. This package has almost the same API as the "appengine"
package,
but it can be fetched with go get
and used on "Managed VMs" and well as
Classic App Engine.
See the new appengine
package's readme
for information on updating your app.
If you don't want to update your entire app to use the new App Engine packages,
you may use both sets of packages in parallel, using only the new packages
with the oauth2
package.
import (
"golang.org/x/net/context"
"golang.org/x/oauth2"
"golang.org/x/oauth2/google"
newappengine "google.golang.org/appengine"
newurlfetch "google.golang.org/appengine/urlfetch"
"appengine"
)
func handler(w http.ResponseWriter, r *http.Request) {
var c appengine.Context = appengine.NewContext(r)
c.Infof("Logging a message with the old package")
var ctx context.Context = newappengine.NewContext(r)
client := &http.Client{
Transport: &oauth2.Transport{
Source: google.AppEngineTokenSource(ctx, "scope"),
Base: &newurlfetch.Transport{Context: ctx},
},
}
client.Get("...")
}
Report Issues / Send Patches
This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.
The main issue tracker for the oauth2 repository is located at https://github.com/golang/oauth2/issues.