Google Git
Sign in
go / oauth2 / 5a69e67f3fa6ce11b512c271912d08ac74da7c7f
commit5a69e67f3fa6ce11b512c271912d08ac74da7c7f[log] [tgz]
authorMichael Traver <mtraver@google.com>Wed Oct 31 18:52:15 2018 +0000
committerBrad Fitzpatrick <bradfitz@golang.org>Thu Nov 01 15:54:53 2018 +0000
tree7f9a40a94cc42ee2b115818ab8b7051a0af1026f
parent8527f56f71077909d6ead7facfe18fbf05ebdf83 [diff]
appengine: implement AppEngineTokenSource for 2nd gen runtimes

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.

Change-Id: Iab63547b410535db60dcf204782d5b6b599a4e0c
GitHub-Last-Rev: 5779afb167d6abe13c29bb9632c9ac516a817e49
GitHub-Pull-Request: golang/oauth2#341
Reviewed-on: https://go-review.googlesource.com/c/146177
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
8 files changed
tree: 7f9a40a94cc42ee2b115818ab8b7051a0af1026f
  1. amazon/
  2. bitbucket/
  3. cern/
  4. clientcredentials/
  5. facebook/
  6. fitbit/
  7. foursquare/
  8. github/
  9. gitlab/
  10. google/
  11. heroku/
  12. hipchat/
  13. instagram/
  14. internal/
  15. jira/
  16. jws/
  17. jwt/
  18. kakao/
  19. linkedin/
  20. mailchimp/
  21. mailru/
  22. mediamath/
  23. microsoft/
  24. nokiahealth/
  25. odnoklassniki/
  26. paypal/
  27. slack/
  28. spotify/
  29. stackoverflow/
  30. twitch/
  31. uber/
  32. vk/
  33. yahoo/
  34. yandex/
  35. .travis.yml
  36. AUTHORS
  37. CONTRIBUTING.md
  38. CONTRIBUTORS
  39. example_test.go
  40. LICENSE
  41. oauth2.go
  42. oauth2_test.go
  43. README.md
  44. token.go
  45. token_test.go
  46. transport.go
  47. transport_test.go
README.md

OAuth2 for Go

Build Status GoDoc

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.