feat: add auto auth features #281

JustinBeckwith · 2018-02-10T04:37:03Z

This adds most of the features available in google-auto-auth.

Resolves #54!

JustinBeckwith · 2018-02-10T04:37:22Z

codecov-io · 2018-02-10T04:38:27Z

Codecov Report

Merging #281 into master will increase coverage by 2.11%.
The diff coverage is 95.58%.

@@            Coverage Diff             @@
##           master     #281      +/-   ##
==========================================
+ Coverage   92.21%   94.33%   +2.11%     
==========================================
  Files          13       14       +1     
  Lines         835      900      +65     
  Branches      178      188      +10     
==========================================
+ Hits          770      849      +79     
+ Misses         65       51      -14

Impacted Files	Coverage Δ
src/auth/envDetect.ts	`93.54% <93.54%> (ø)`
src/auth/googleauth.ts	`93.67% <97.29%> (+7.83%)`	⬆️
src/auth/oauth2client.ts	`93.88% <0%> (+0.35%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4d0c49d...0241109. Read the comment docs.

stephenplusplus · 2018-02-10T04:48:05Z

Nice! Would you mind showing some demos of authing with ADC, a key file, credentials object, pem/p12?

JustinBeckwith · 2018-02-10T05:23:27Z

Sure! Does this cover it?

stephenplusplus · 2018-02-11T20:52:18Z

LGTM. Here's a general look at how this would be used from GC/* libs. Let me know if anything looks wack.

const GoogleAuth = require('google-auth-library').GoogleAuth;

function Service(cfg) {
  // cfg may or may not have a `keyFilename` or `credentials` object:
  this.authClient = new GoogleAuth(cfg);
}

Service.prototype.request = function(reqOpts) {
  this.authClient.authorizeRequest(reqOpts, function(err, authorizedReqOpts) {
    // make request with authorizedReqOpts
  });
};

JustinBeckwith · 2018-02-11T20:56:14Z

Looks great. Only thing to note is that I decided to not support callbacks with new APIs. This is totally up for debate though. Is using promises a showstopper?

stephenplusplus · 2018-02-11T20:57:33Z

Oops. No, not at all, it shouldn't make a difference 👍

ofrobots

Can you add tests?

examples/auto/adc.js

@@ -0,0 +1,32 @@
+// Copyright 2017, Google, Inc.


src/auth/envDetect.ts

+let env: GCPEnv;
+
+export async function getEnv() {
+  if (!env) {


src/auth/googleauth.ts

+  constructor(opts?: GoogleAuthOptions) {
+    opts = opts || {};
+    this._cachedProjectId = opts.projectId || null;
+    this.keyfileName = opts.keyFilename;


src/auth/googleauth.ts

+  /**
+   * Path to a .json, .pem, or .p12 key file
+   */
+  keyFilename?: string;


src/auth/googleauth.ts

+    if (!this.cachedCredential) {
+      if (this.keyfileName) {
+        const filePath = path.resolve(process.cwd(), this.keyfileName);
+        console.log(filePath);


src/auth/googleauth.ts

+  /**
+   * Determine the compute environment in which the code is running.
+   */
+  async getEnv(): Promise<GCPEnv> {


src/auth/googleauth.ts

+      } else if (this.jsonContent) {
+        this.cachedCredential = await this.fromJSON(this.jsonContent);
+      } else {
+        await this.getApplicationDefaultAsync();


JustinBeckwith · 2018-02-17T07:59:21Z

I think this is in it's final form, and ready for a good look over :) @google/google-node-team

examples/authRequest.js

+/**
+ * Import the GoogleAuth library, and create a new GoogleAuth client.
+ */
+const { auth } = require('google-auth-library');


src/auth/envDetect.ts

+    await gcpMetadata.instance('attributes/cluster-name');
+    return true;
+  } catch (e) {
+    console.error(e);


src/auth/googleauth.ts

+  async getClient() {
+    if (!this.cachedCredential) {
+      if (this.keyFilename) {
+        const filePath = path.resolve(process.cwd(), this.keyFilename);


JustinBeckwith requested a review from ofrobots February 10, 2018 04:37

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Feb 10, 2018

JustinBeckwith requested a review from a team February 10, 2018 04:37

stephenplusplus mentioned this pull request Feb 13, 2018

Concerns about PR #34 stephenplusplus/google-auto-auth#35

Closed

ofrobots reviewed Feb 16, 2018

View reviewed changes

JustinBeckwith and others added 2 commits February 16, 2018 23:41

feat: add auto auth features

b507652

shuffle samples about

a03516e

Merge branch 'master' into auto1

4033164

theacodes approved these changes Feb 20, 2018

View reviewed changes

JustinBeckwith added 2 commits February 20, 2018 09:43

Merge branch 'master' into auto1

5e7049f

Merge branch 'master' into auto1

c800934

DominicKramer reviewed Feb 20, 2018

View reviewed changes

examples/authRequest.js

/**

* Import the GoogleAuth library, and create a new GoogleAuth client.

*/

const { auth } = require('google-auth-library');

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

alexander-fenster reviewed Feb 20, 2018

View reviewed changes

src/auth/envDetect.ts Outdated

await gcpMetadata.instance('attributes/cluster-name');

return true;

} catch (e) {

console.error(e);

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

alexander-fenster reviewed Feb 20, 2018

View reviewed changes

src/auth/googleauth.ts Outdated

async getClient() {

if (!this.cachedCredential) {

if (this.keyFilename) {

const filePath = path.resolve(process.cwd(), this.keyFilename);

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

alexander-fenster approved these changes Feb 20, 2018

View reviewed changes

pr feedback

0241109

JustinBeckwith merged commit 64a1bd0 into googleapis:master Feb 20, 2018

kjin mentioned this pull request May 16, 2018

fix: read credentials field before keyFilename #361

Merged

ofrobots mentioned this pull request Jun 21, 2018

GoogleAuth#getProjectId vs. GoogleAuth#getDefaultProjectId #389

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add auto auth features #281

feat: add auto auth features #281

JustinBeckwith commented Feb 10, 2018 •

edited

Loading

JustinBeckwith commented Feb 10, 2018

codecov-io commented Feb 10, 2018 •

edited

Loading

stephenplusplus commented Feb 10, 2018

JustinBeckwith commented Feb 10, 2018

stephenplusplus commented Feb 11, 2018

JustinBeckwith commented Feb 11, 2018

stephenplusplus commented Feb 11, 2018

ofrobots left a comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JustinBeckwith commented Feb 17, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

feat: add auto auth features #281

feat: add auto auth features #281

Conversation

JustinBeckwith commented Feb 10, 2018 • edited Loading

JustinBeckwith commented Feb 10, 2018

codecov-io commented Feb 10, 2018 • edited Loading

Codecov Report

stephenplusplus commented Feb 10, 2018

JustinBeckwith commented Feb 10, 2018

stephenplusplus commented Feb 11, 2018

JustinBeckwith commented Feb 11, 2018

stephenplusplus commented Feb 11, 2018

ofrobots left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JustinBeckwith commented Feb 17, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JustinBeckwith commented Feb 10, 2018 •

edited

Loading

codecov-io commented Feb 10, 2018 •

edited

Loading