chore: Add gulp task for fixing/formatting + delint existing code

Author: sqrrrl

dist/OAuth2.gs

@@ -48,15 +48,15 @@ function createService(serviceName) {
 /**
  * Returns the redirect URI that will be used for a given script. Often this URI
  * needs to be entered into a configuration screen of your OAuth provider.
- * @param {string} [optScriptId] The script ID of your script, which can be
+ * @param {string=} optScriptId The script ID of your script, which can be
  *     found in the Script Editor UI under "File > Project properties". Defaults
  *     to the script ID of the script being executed.
  * @return {string} The redirect URI.
  */
 function getRedirectUri(optScriptId) {
   var scriptId = optScriptId || ScriptApp.getScriptId();
   return 'https://script.google.com/macros/d/' + encodeURIComponent(scriptId) +
-      '/usercallback';
+    '/usercallback';
 }
 
 /**
@@ -228,7 +228,7 @@ Service_.prototype.setCodeVerififer = function(codeVerifier) {
 };
 
 /**
- * Sets teh code verifier to a randomly generated challenge string.
+ * Sets the code verifier to a randomly generated challenge string.
  * @return {!Service_} This service, for chaining
  */
 Service_.prototype.generateCodeVerifier = function() {
@@ -724,10 +724,35 @@ Service_.prototype.parseToken_ = function(content) {
   } else {
     throw new Error('Unknown token format: ' + this.tokenFormat_);
   }
-  token.granted_time = getTimeInSeconds_(new Date());
+  this.ensureExpiresAtSet_(token);
   return token;
 };
 
+/**
+ * Adds expiresAt annotations on the token if not set.
+ * @param {string} token A token.
+ * @private
+ */
+Service_.prototype.ensureExpiresAtSet_ = function(token) {
+  // handle prior migrations
+  if (token.expiresAt !== undefined) {
+    return;
+  }
+
+  // granted_time was added in prior versions of this library
+  var grantedTime = token.granted_time || getTimeInSeconds_(new Date());
+  var expiresIn = token.expires_in_sec || token.expires_in || token.expires;
+  if (expiresIn) {
+    var expiresAt = grantedTime + Number(expiresIn);
+    token.expiresAt = expiresAt;
+  }
+  var refreshTokenExpiresIn = token.refresh_token_expires_in;
+  if (refreshTokenExpiresIn) {
+    var refreshTokenExpiresAt = grantedTime + Number(refreshTokenExpiresIn);
+    token.refreshTokenExpiresAt = refreshTokenExpiresAt;
+  }
+};
+
 /**
  * Refreshes a token that has expired. This is only possible if offline access
  * was requested when the token was authorized.
@@ -754,6 +779,11 @@ Service_.prototype.refresh = function() {
     if (!newToken.refresh_token) {
       newToken.refresh_token = token.refresh_token;
     }
+    this.ensureExpiresAtSet_(token);
+    // Propagate refresh token expiry if new token omits it
+    if (newToken.refreshTokenExpiresAt === undefined) {
+      newToken.refreshTokenExpiresAt = token.refreshTokenExpiresAt;
+    }
     this.saveToken_(newToken);
   });
 };
@@ -805,6 +835,13 @@ Service_.prototype.isExpired_ = function(token) {
   var now = getTimeInSeconds_(new Date());
 
   // Check the authorization token's expiration.
+  if (token.expiresAt) {
+    if (token.expiresAt - now < Service_.EXPIRATION_BUFFER_SECONDS_) {
+      expired = true;
+    }
+  }
+
+  // Previous code path, provided for migration purpose, can be removed later
   var expiresIn = token.expires_in_sec || token.expires_in || token.expires;
   if (expiresIn) {
     var expiresTime = token.granted_time + Number(expiresIn);
@@ -833,13 +870,14 @@ Service_.prototype.isExpired_ = function(token) {
  */
 Service_.prototype.canRefresh_ = function(token) {
   if (!token.refresh_token) return false;
-  var expiresIn = token.refresh_token_expires_in;
-  if (!expiresIn) {
+  this.ensureExpiresAtSet_(token);
+  if (token.refreshTokenExpiresAt === undefined) {
     return true;
   } else {
-    var expiresTime = token.granted_time + Number(expiresIn);
     var now = getTimeInSeconds_(new Date());
-    return expiresTime - now > Service_.EXPIRATION_BUFFER_SECONDS_;
+    return (
+      token.refreshTokenExpiresAt - now > Service_.EXPIRATION_BUFFER_SECONDS_
+    );
   }
 };
 

gulpfile.js

@@ -59,3 +59,9 @@ gulp.task('lint', () => {
         }
       }));
 });
+
+gulp.task('fix', () => {
+  return gulp.src(['src/*.js', 'samples/*.gs', 'test/**/*.js', '!node_modules/**'])
+      .pipe(eslint({fix: true}))
+      .pipe(eslint.format())
+});

package.json

@@ -38,6 +38,7 @@
     "postversion": "MESSAGE=$(git log -1 --pretty=%B) && cd src/ && clasp version $MESSAGE",
     "dist": "gulp dist",
     "lint": "gulp lint",
+    "lint:fix": "gulp fix",
     "doc": "jsdoc -c jsdoc.json src/*.js README.md",
     "push": "cd src; clasp push",
     "test": "mocha"

samples/.eslintrc.js

@@ -15,8 +15,8 @@
  */
 
 module.exports = {
-  "rules": {
-    "no-unused-vars": "off",
-    "valid-jsdoc": "off"
+  'rules': {
+    'no-unused-vars': 'off',
+    'valid-jsdoc': 'off'
   }
-};
+};

samples/Onshape.gs

@@ -25,7 +25,7 @@ function run() {
     });
     var result = JSON.parse(response.getContentText());
     Logger.log(JSON.stringify(result, null, 2));
-  } else { 
+  } else {
     var authorizationUrl = service.getAuthorizationUrl();
     Logger.log('Open the following URL and re-run the script: %s',
         authorizationUrl);
@@ -78,4 +78,4 @@ function authCallback(request) {
  */
 function logRedirectUri() {
   Logger.log(OAuth2.getRedirectUri());
-}
+}

samples/StackOverflow.gs

@@ -21,7 +21,7 @@ function run() {
   } else {
     var authorizationUrl = service.getAuthorizationUrl();
     Logger.log('Open the following URL and re-run the script: %s',
-      authorizationUrl);
+        authorizationUrl);
   }
 }
 
@@ -37,20 +37,20 @@ function reset() {
  */
 function getService_() {
   return OAuth2.createService('Stack Overflow')
-    // Set the endpoint URLs.
-    .setAuthorizationBaseUrl('https://stackoverflow.com/oauth')
-    .setTokenUrl('https://stackoverflow.com/oauth/access_token/json')
+  // Set the endpoint URLs.
+      .setAuthorizationBaseUrl('https://stackoverflow.com/oauth')
+      .setTokenUrl('https://stackoverflow.com/oauth/access_token/json')
 
-    // Set the client ID and secret.
-    .setClientId(CLIENT_ID)
-    .setClientSecret(CLIENT_SECRET)
+  // Set the client ID and secret.
+      .setClientId(CLIENT_ID)
+      .setClientSecret(CLIENT_SECRET)
 
-    // Set the name of the callback function that should be invoked to
-    // complete the OAuth flow.
-    .setCallbackFunction('authCallback')
+  // Set the name of the callback function that should be invoked to
+  // complete the OAuth flow.
+      .setCallbackFunction('authCallback')
 
-    // Set the property store where authorized tokens should be persisted.
-    .setPropertyStore(PropertiesService.getUserProperties());
+  // Set the property store where authorized tokens should be persisted.
+      .setPropertyStore(PropertiesService.getUserProperties());
 }
 
 /**

samples/Twitter.gs

@@ -22,7 +22,7 @@ function run() {
   } else {
     var authorizationUrl = service.getAuthorizationUrl();
     Logger.log('Open the following URL and re-run the script: %s',
-      authorizationUrl);
+        authorizationUrl);
   }
 }
 
@@ -31,8 +31,8 @@ function run() {
  */
 function reset() {
   getService_().reset();
-  PropertiesService.getUserProperties().deleteProperty("code_challenge");
-  PropertiesService.getUserProperties().deleteProperty("code_verifier");
+  PropertiesService.getUserProperties().deleteProperty('code_challenge');
+  PropertiesService.getUserProperties().deleteProperty('code_verifier');
 }
 
 /**
@@ -42,34 +42,34 @@ function getService_() {
   pkceChallengeVerifier();
   var userProps = PropertiesService.getUserProperties();
   return OAuth2.createService('Twitter')
-    // Set the endpoint URLs.
-    .setAuthorizationBaseUrl('https://twitter.com/i/oauth2/authorize')
-    .setTokenUrl(
-      'https://api.twitter.com/2/oauth2/token?code_verifier=' + userProps.getProperty("code_verifier"))
+  // Set the endpoint URLs.
+      .setAuthorizationBaseUrl('https://twitter.com/i/oauth2/authorize')
+      .setTokenUrl(
+          'https://api.twitter.com/2/oauth2/token?code_verifier=' + userProps.getProperty('code_verifier'))
 
-    // Set the client ID and secret.
-    .setClientId(CLIENT_ID)
-    .setClientSecret(CLIENT_SECRET)
+  // Set the client ID and secret.
+      .setClientId(CLIENT_ID)
+      .setClientSecret(CLIENT_SECRET)
 
-    // Set the name of the callback function that should be invoked to
-    // complete the OAuth flow.
-    .setCallbackFunction('authCallback')
+  // Set the name of the callback function that should be invoked to
+  // complete the OAuth flow.
+      .setCallbackFunction('authCallback')
 
-    // Set the property store where authorized tokens should be persisted.
-    .setPropertyStore(userProps)
+  // Set the property store where authorized tokens should be persisted.
+      .setPropertyStore(userProps)
 
-    // Set the scopes to request (space-separated for Twitter services).
-    .setScope('users.read tweet.read offline.access')
-  
-    // Add parameters in the authorization url
-    .setParam('response_type', 'code')
-    .setParam('code_challenge_method', 'S256')
-    .setParam('code_challenge', userProps.getProperty("code_challenge"))
+  // Set the scopes to request (space-separated for Twitter services).
+      .setScope('users.read tweet.read offline.access')
 
-    .setTokenHeaders({
-      'Authorization': 'Basic ' + Utilities.base64Encode(CLIENT_ID + ':' + CLIENT_SECRET),
-      'Content-Type': 'application/x-www-form-urlencoded'
-    })
+  // Add parameters in the authorization url
+      .setParam('response_type', 'code')
+      .setParam('code_challenge_method', 'S256')
+      .setParam('code_challenge', userProps.getProperty('code_challenge'))
+
+      .setTokenHeaders({
+        'Authorization': 'Basic ' + Utilities.base64Encode(CLIENT_ID + ':' + CLIENT_SECRET),
+        'Content-Type': 'application/x-www-form-urlencoded'
+      });
 }
 
 /**
@@ -97,21 +97,21 @@ function logRedirectUri() {
  */
 function pkceChallengeVerifier() {
   var userProps = PropertiesService.getUserProperties();
-  if (!userProps.getProperty("code_verifier")) {
-    var verifier = "";
-    var possible = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~";
+  if (!userProps.getProperty('code_verifier')) {
+    var verifier = '';
+    var possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~';
 
     for (var i = 0; i < 128; i++) {
       verifier += possible.charAt(Math.floor(Math.random() * possible.length));
     }
 
-    var sha256Hash = Utilities.computeDigest(Utilities.DigestAlgorithm.SHA_256, verifier)
+    var sha256Hash = Utilities.computeDigest(Utilities.DigestAlgorithm.SHA_256, verifier);
 
     var challenge = Utilities.base64Encode(sha256Hash)
-      .replace(/\+/g, '-')
-      .replace(/\//g, '_')
-      .replace(/=+$/, '')
-    userProps.setProperty("code_verifier", verifier)
-    userProps.setProperty("code_challenge", challenge)
+        .replace(/\+/g, '-')
+        .replace(/\//g, '_')
+        .replace(/=+$/, '');
+    userProps.setProperty('code_verifier', verifier);
+    userProps.setProperty('code_challenge', challenge);
   }
 }

src/OAuth2.js

@@ -65,12 +65,12 @@ function getRedirectUri(optScriptId) {
  */
 function getServiceNames(propertyStore) {
   var props = propertyStore.getProperties();
-  return Object.keys(props).filter(function (key) {
+  return Object.keys(props).filter(function(key) {
     var parts = key.split('.');
     return key.indexOf(STORAGE_PREFIX_) == 0 && parts.length > 1 && parts[1];
-  }).map(function (key) {
+  }).map(function(key) {
     return key.split('.')[1];
-  }).reduce(function (result, key) {
+  }).reduce(function(result, key) {
     if (result.indexOf(key) < 0) {
       result.push(key);
     }

test/mocks/utilities.js

@@ -22,14 +22,14 @@ var MockUtilities = function(optCache) {
   this.store = optCache || {};
   this.counter = 0;
 };
-  
+
 MockUtilities.prototype.base64Encode = function(data) {
-return Buffer.from(data).toString('base64');
+  return Buffer.from(data).toString('base64');
 };
 
 MockUtilities.prototype.base64EncodeWebSafe = function(data) {
   return URLSafeBase64.encode(Buffer.from(data));
-}
+};
 
 MockUtilities.prototype.base64DecodeWebSafe = function(data) {
   return URLSafeBase64.decode(data);
@@ -44,17 +44,17 @@ MockUtilities.prototype.newBlob = function(data) {
 };
 
 MockUtilities.prototype.DigestAlgorithm = {
-    SHA_256: 'sha256'
+  SHA_256: 'sha256'
 };
 
 MockUtilities.prototype.Charset = {
-    US_ASCII: 'us_ascii'
+  US_ASCII: 'us_ascii'
 };
 
 MockUtilities.prototype.computeDigest = function(algorithm, data, charSet) {
-    const hash = crypto.createHash(algorithm);
-    hash.update(data);
-    return hash.digest('utf8');
-}
+  const hash = crypto.createHash(algorithm);
+  hash.update(data);
+  return hash.digest('utf8');
+};
 
-module.exports = MockUtilities;
+module.exports = MockUtilities;

test/test.js

@@ -646,7 +646,6 @@ describe('Service', () => {
         expiresAt: ONE_HOUR_LATER_SECONDS,
         refreshTokenExpiresAt: ONE_HOUR_LATER_SECONDS
       };
-      console.log('test')
       assert.isTrue(service.canRefresh_(token));
     });