feat: Add ability to refresh token automatically before expiration. #242

nolanmar511 · 2018-01-10T01:33:40Z

This pull request makes it possible to refresh the token when it is not expired but will expire in some period of time.
This can be used to address the issues described in #133, by allowing users to specify that tokens should be refreshed if they will expire soon. This is also necessary to fix googleapis/cloud-profiler-nodejs#94

For earlier discussion of these changes, see PR #208.

src/auth/computeclient.ts

@@ -33,8 +33,8 @@ export class Compute extends OAuth2Client {
   * Retrieve access token from the metadata server.
   * See: https://developers.google.com/compute/docs/authentication
   */
-  constructor() {
-    super();
+  constructor(refreshTokenEarlyMillis?: number) {


nolanmar511 · 2018-01-10T19:09:16Z

PTAL

src/auth/googleauth.ts

+  /**
+   *  @param {number=} refreshTokenEarlyMillis The token should be refreshed if it will expire within this many milliseconds.
+   */
+  constructor(public refreshTokenEarlyMillis?: number) {}


src/auth/googleauth.ts

@@ -87,6 +87,11 @@ export class GoogleAuth {
   */
  static DefaultTransporter = DefaultTransporter;

+  /**
+   *  @param {number=} refreshTokenEarlyMillis The token should be refreshed if it will expire within this many milliseconds.


src/auth/computeclient.ts

@@ -20,6 +20,8 @@ import {RequestError} from './../transporters';
 import {CredentialRequest, Credentials} from './credentials';
 import {GetTokenResponse, OAuth2Client} from './oauth2client';

+export interface ComputeOptions { refreshTokenEarlyMillis?: number; }


src/auth/refreshclient.ts

+  constructor(
+      clientId?: string, clientSecret?: string, refreshToken?: string,
+      refreshTokenEarlyMillis?: number);
+


test/test.compute.ts

@@ -66,6 +66,19 @@ describe('Compute auth client', () => {
    });
  });

+  it('should refresh if access token has expired', (done) => {


ofrobots

LGTM once nits are addressed.

src/auth/oauth2client.ts

  clientId?: string;
  clientSecret?: string;
  redirectUri?: string;
  authBaseUrl?: string;
  tokenUrl?: string;
 }

+export interface RefreshOptions {
+  // The token should be refreshed if it will expire within this many
+  // milliseconds.


src/auth/computeclient.ts

-import {GetTokenResponse, OAuth2Client} from './oauth2client';
+import {GetTokenResponse, OAuth2Client, RefreshOptions} from './oauth2client';
+
+export interface ComputeOptions extends RefreshOptions {}


src/auth/computeclient.ts

-    super();
+  constructor(options?: ComputeOptions) {
+    options = options || {};
+    super({refreshTokenEarlyMillis: options.refreshTokenEarlyMillis});


src/auth/googleauth.ts

@@ -58,6 +58,8 @@ interface CredentialResult {
  default: {email: string;};
 }

+export interface GoogleAuthOptions extends RefreshOptions {}


src/auth/googleauth.ts

  /**
   * Export DefaultTransporter as a static property of the class.
   */
  static DefaultTransporter = DefaultTransporter;

+  constructor(options?: GoogleAuthOptions) {


src/auth/oauth2client.ts

@@ -936,4 +932,16 @@ export class OAuth2Client extends AuthClient {
    const buffer = new Buffer(b64String, 'base64');
    return buffer.toString('utf8');
  }
+
+  /**
+   * Returns true iff a token is expired or will expire within


test/test.compute.ts

+       compute = new Compute({refreshTokenEarlyMillis: 10000});
+       compute.credentials.access_token = 'initial-access-token';
+       compute.credentials.expiry_date = (new Date()).getTime() + 5000;
+       compute.request({url: 'http://foo'}, () => {


test/test.compute.ts

+               .reply(200, {access_token: 'abc123', expires_in: 10000});
+       compute.credentials.access_token = 'initial-access-token';
+       compute.credentials.expiry_date = (new Date()).getTime() + 11000;
+       compute.request({url: 'http://foo'}, () => {


test/test.jwt.ts

+         };
+
+         createGTokenMock({access_token: 'abc123'});
+         jwt.request({url: 'http://bar'}, () => {


test/test.jwt.ts

+           expiry_date: (new Date()).getTime() + 5000
+         };
+
+         jwt.request({url: 'http://bar'}, () => {


src/auth/oauth2client.ts

+   * refreshTokenEarlyMillis milliseconds.
+   * If there is no expiry time, assumes the token is not expired or expiring.
+   */
+  protected isTokenExpiring(): boolean {


JustinBeckwith · 2018-01-11T03:53:19Z

Does this address #67?

nolanmar511 · 2018-01-11T17:26:09Z

This change does not address #67, though I assume that it would make errors like those in #67 less common.

theacodes · 2018-01-11T17:29:47Z

Somehow the comment about expiry buffer got lost in the fold, but it should be 5 minutes.

See the canonical implementation:
https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/dcbf1e0af0c79f1424f03ad27b071eccfdbc80d3/google/auth/credentials.py#L62
https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/dcbf1e0af0c79f1424f03ad27b071eccfdbc80d3/google/auth/_helpers.py#L25

nolanmar511 · 2018-01-12T18:32:58Z

PTAL

JustinBeckwith · 2018-01-15T19:57:50Z

LGTM! Please rebase to master, and I'll merge this in. Thank you!

…ctions in googleAuth

nolanmar511 · 2018-01-16T16:23:22Z

Just rebased against master.

tnguyen14 · 2018-03-01T23:43:37Z

Is there any update to the docs? How should this change be used?

JustinBeckwith · 2018-03-02T02:15:07Z

Greetings! You can learn how to us this in the reference docs:
https://google.github.io/google-auth-library-nodejs/classes/_auth_googleauth_.googleauth.html#getapplicationdefault

rublev · 2020-04-29T18:59:29Z

Greetings! You can learn how to us this in the reference docs:
https://google.github.io/google-auth-library-nodejs/classes/_auth_googleauth_.googleauth.html#getapplicationdefault

404

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

ofrobots reviewed Jan 10, 2018

View reviewed changes

nolanmar511 force-pushed the early-refresh branch from c5fcb09 to cc95246 Compare January 10, 2018 19:06

ofrobots reviewed Jan 10, 2018

View reviewed changes

nolanmar511 force-pushed the early-refresh branch from 027962d to bb554a9 Compare January 10, 2018 20:21

nolanmar511 mentioned this pull request Jan 10, 2018

feat: Add ability to refresh token automatically before expiration. #227

Closed

nolanmar511 force-pushed the early-refresh branch 2 times, most recently from a47221c to 5338263 Compare January 10, 2018 21:33

ofrobots approved these changes Jan 11, 2018

View reviewed changes

JustinBeckwith changed the title ~~feat: Add abilit to refresh token automatically before expiration.~~ feat: Add ability to refresh token automatically before expiration. Jan 11, 2018

JustinBeckwith suggested changes Jan 11, 2018

View reviewed changes

ofrobots mentioned this pull request Jan 11, 2018

fix: add buffer for expiry_date #248

Closed

nolanmar511 force-pushed the early-refresh branch 3 times, most recently from 31c482c to affe774 Compare January 11, 2018 16:22

nolanmar511 force-pushed the early-refresh branch 3 times, most recently from ed32d20 to 9303172 Compare January 12, 2018 18:32

JustinBeckwith approved these changes Jan 15, 2018

View reviewed changes

nolanmar511 added 3 commits January 16, 2018 08:18

feat: Add abilit to refresh token automatically before expiration.

45eb22c

Use options object to pass in values to Compute and UserRefreshClient

e3d771a

Use options for GoogleAuth

0f8b7fd

nolanmar511 added 7 commits January 16, 2018 08:18

Add more tests

c3b6e50

add interface just containg refreshTokenEarlyMillis

a42ffe7

Rename eagerRefreshThresholdMillis and set default value for that to 1s

f51aea9

Addressed comments

73eb2e1

update test style in test.oauth2.ts

3646005

Increase default eagerRefreshThresholdMillis to 5 minutes

abe3203

Make eagerRefreshThresholdMillis an option which can be passed to fun…

63ab7cc

…ctions in googleAuth

nolanmar511 force-pushed the early-refresh branch from 9303172 to 63ab7cc Compare January 16, 2018 16:18

JustinBeckwith merged commit 7e9a390 into googleapis:master Jan 16, 2018

This was referenced Jan 16, 2018

Larger Safety Windows around Expiration Timestamp? #133

Closed

low error margin on expiry_date => isTokenExpired false negatives #62

Closed

automatic token refresh is not happening in getrequestmetadata #67

Closed

JustinBeckwith mentioned this pull request Feb 2, 2018

oAuth2client: Callback never called with media upload because of retry logic and readStream #171

Closed

ofrobots mentioned this pull request Mar 13, 2018

Occasional stackdriver errors when not debugging googleapis/cloud-debug-nodejs#405

Closed

feat: Add ability to refresh token automatically before expiration. #242

feat: Add ability to refresh token automatically before expiration. #242

Conversation

nolanmar511 commented Jan 10, 2018

This comment was marked as spam.

This comment was marked as spam.

nolanmar511 commented Jan 10, 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.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

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.

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 Jan 11, 2018

nolanmar511 commented Jan 11, 2018

theacodes commented Jan 11, 2018

nolanmar511 commented Jan 12, 2018

JustinBeckwith commented Jan 15, 2018

nolanmar511 commented Jan 16, 2018

tnguyen14 commented Mar 1, 2018

JustinBeckwith commented Mar 2, 2018

rublev commented Apr 29, 2020