PR feedback

Author: JustinBeckwith

ts/lib/auth/computeclient.ts

@@ -16,17 +16,16 @@
 
 import * as request from 'request';
 
-import {RequestCallback, RequestError} from './../transporters';
+import {BodyResponseCallback, RequestError} from './../transporters';
 import Auth2Client from './oauth2client';
 
-export interface Tokens {
+export interface Token {
  expires_in: number;
  expiry_date: number;
 }
 
-export interface RefreshTokenCallback {
- (err: Error, tokens: Tokens, response: request.RequestResponse): void;
-}
+export declare type RefreshTokenCallback =
+ (err: Error, token: Token, response: request.RequestResponse) => void;
 
 export default class Compute extends Auth2Client {
  /**
@@ -63,22 +62,22 @@ export default class Compute extends Auth2Client {
  /**
  * Refreshes the access token.
  * @param {object=} ignored_
- * @param {function=} opt_callback Optional callback.
+ * @param {function=} callback Optional callback.
  */
  protected refreshToken(ignored: any, callback?: RefreshTokenCallback):
  request.Request {
  const uri = this._opts.tokenUrl || Compute._GOOGLE_OAUTH2_TOKEN_URL;
  // request for new token
  return this.transporter.request(
  {method: 'GET', uri: uri, json: true}, (err, body, response) => {
- const tokens = body as Tokens;
- if (!err && tokens && tokens.expires_in) {
- tokens.expiry_date =
- ((new Date()).getTime() + (tokens.expires_in * 1000));
- delete tokens.expires_in;
+ const token = body as Token;
+ if (!err && token && token.expires_in) {
+ token.expiry_date =
+ ((new Date()).getTime() + (token.expires_in * 1000));
+ delete token.expires_in;
  }
  if (callback) {
- callback(err, tokens, response);
+ callback(err, token, response);
  }
  });
  }
@@ -93,7 +92,7 @@ export default class Compute extends Auth2Client {
  */
  protected postRequest(
  err: Error, result: any, response: request.RequestResponse,
- callback: RequestCallback) {
+ callback: BodyResponseCallback) {
  if (response && response.statusCode) {
  let helpfulMessage = null;
  if (response.statusCode === 403) {

ts/lib/auth/googleauth.ts

@@ -23,7 +23,7 @@ import * as util from 'util';
 
 import {DefaultTransporter, Transporter} from '../transporters';
 
-import {RequestCallback} from './../transporters';
+import {BodyResponseCallback} from './../transporters';
 import Compute from './computeclient';
 import IAMAuth from './iam';
 import JWTAccess from './jwtaccess';
@@ -95,7 +95,7 @@ export default class GoogleAuth {
 
  /**
  * Obtains the default project ID for the application..
- * @param {function=} opt_callback Optional callback.
+ * @param {function=} callback Optional callback.
  */
  public getDefaultProjectId(callback: ProjectIdCallback) {
  // In implicit case, supports three environments. In order of precedence,
@@ -161,15 +161,15 @@ export default class GoogleAuth {
 
  /**
  * Obtains the default service-level credentials for the application..
- * @param {function=} opt_callback Optional callback.
+ * @param {function=} callback Optional callback.
  */
  public getApplicationDefault(
- opt_callback: (err: Error, credential: any, projectId: string) => void) {
+ callback?: (err: Error, credential: any, projectId: string) => void) {
  // If we've already got a cached credential, just return it.
  if (this.cachedCredential) {
  setImmediate(() => {
  this.callback(
- opt_callback, null, this.cachedCredential, this._cachedProjectId);
+ callback, null, this.cachedCredential, this._cachedProjectId);
  });
  } else {
  // Inject our own callback routine, which will cache the credential once
@@ -181,12 +181,12 @@ export default class GoogleAuth {
  this.getDefaultProjectId((err2, projectId) => {
  setImmediate(() => {
  // Ignore default project error
- this.callback(opt_callback, null, result, projectId);
+ this.callback(callback, null, result, projectId);
  });
  });
  } else {
  setImmediate(() => {
- this.callback(opt_callback, err, result);
+ this.callback(callback, err, result);
  });
  }
  };
@@ -246,12 +246,12 @@ export default class GoogleAuth {
 
  /**
  * Attempts to load default credentials from the environment variable path..
- * @param {function=} opt_callback Optional callback.
+ * @param {function=} callback Optional callback.
  * @return {boolean} Returns true if the callback has been executed; false otherwise.
  * @api private
  */
  public _tryGetApplicationCredentialsFromEnvironmentVariable(
- opt_callback: (err: Error, result: any) => void) {
+ callback?: (err: Error, result: any) => void) {
  const credentialsPath = this._getEnv('GOOGLE_APPLICATION_CREDENTIALS');
  if (!credentialsPath || credentialsPath.length === 0) {
  return false;
@@ -264,19 +264,19 @@ export default class GoogleAuth {
  'environment variable.',
  err);
  }
- this.callback(opt_callback, wrappedError, result);
+ this.callback(callback, wrappedError, result);
  });
  return true;
  }
 
  /**
  * Attempts to load default credentials from a well-known file location
- * @param {function=} opt_callback Optional callback.
+ * @param {function=} callback Optional callback.
  * @return {boolean} Returns true if the callback has been executed; false otherwise.
  * @api private
  */
  public _tryGetApplicationCredentialsFromWellKnownFile(
- opt_callback?: (err: Error, result: any) => void) {
+ callback?: (err: Error, result?: any) => void) {
  // First, figure out the location of the file, depending upon the OS type.
  let location = null;
  if (this._isWindows()) {
@@ -305,18 +305,18 @@ export default class GoogleAuth {
  return false;
  }
  // The file seems to exist. Try to use it.
- this._getApplicationCredentialsFromFilePath(location, opt_callback);
+ this._getApplicationCredentialsFromFilePath(location, callback);
  return true;
  }
 
  /**
  * Attempts to load default credentials from a file at the given path..
  * @param {string=} filePath The path to the file to read.
- * @param {function=} opt_callback Optional callback.
+ * @param {function=} callback Optional callback.
  * @api private
  */
  public _getApplicationCredentialsFromFilePath(
- filePath: string, opt_callback: (err: Error, result?: any) => void) {
+ filePath: string, callback: (err: Error, result?: any) => void) {
  let error = null;
  // Make sure the path looks like a string.
  if (!filePath || filePath.length === 0) {
@@ -346,27 +346,27 @@ export default class GoogleAuth {
  if (!error) {
  try {
  const stream = this._createReadStream(filePath);
- this.fromStream(stream, opt_callback);
+ this.fromStream(stream, callback);
  } catch (err) {
  error = this.createError(
  util.format('Unable to read the file at %s.', filePath), err);
  }
  }
  if (error) {
- this.callback(opt_callback, error);
+ this.callback(callback, error);
  }
  }
 
  /**
  * Create a credentials instance using the given input options.
  * @param {object=} json The input object.
- * @param {function=} opt_callback Optional callback.
+ * @param {function=} callback Optional callback.
  */
- public fromJSON(json: any, opt_callback: (err: Error, client?: any) => void) {
+ public fromJSON(json: any, callback?: (err: Error, client?: any) => void) {
  let client: UserRefreshClient|JWTClient = null;
  if (!json) {
  this.callback(
- opt_callback,
+ callback,
  new Error(
  'Must pass in a JSON object containing the Google auth settings.'));
  return;
@@ -379,25 +379,24 @@ export default class GoogleAuth {
 
  client.fromJSON(json, (err: Error) => {
  if (err) {
- this.callback(opt_callback, err);
+ this.callback(callback, err);
  } else {
- this.callback(opt_callback, null, client);
+ this.callback(callback, null, client);
  }
  });
  }
 
  /**
  * Create a credentials instance using the given input stream.
  * @param {object=} stream The input stream.
- * @param {function=} opt_callback Optional callback.
+ * @param {function=} callback Optional callback.
  */
  public fromStream(
- stream: stream.Readable,
- opt_callback: (err: Error, result?: any) => void) {
+ stream: stream.Readable, callback?: (err: Error, result?: any) => void) {
  if (!stream) {
  setImmediate(() => {
  this.callback(
- opt_callback,
+ callback,
  new Error(
  'Must pass in a stream containing the Google auth settings.'));
  });
@@ -411,9 +410,9 @@ export default class GoogleAuth {
  stream.on('end', () => {
  try {
  const data = JSON.parse(s);
- this.fromJSON(data, opt_callback);
+ this.fromJSON(data, callback);
  } catch (err) {
- this.callback(opt_callback, err);
+ this.callback(callback, err);
  }
  });
  }
@@ -424,13 +423,13 @@ export default class GoogleAuth {
  * @param {function=} - Optional callback function
  */
  public fromAPIKey(
- apiKey: string, opt_callback: (err: Error, client?: JWTClient) => void) {
+ apiKey: string, callback?: (err: Error, client?: JWTClient) => void) {
  const client = new this.JWTClient();
  client.fromAPIKey(apiKey, (err) => {
  if (err) {
- this.callback(opt_callback, err);
+ this.callback(callback, err);
  } else {
- this.callback(opt_callback, null, client);
+ this.callback(callback, null, client);
  }
  });
  }
@@ -499,7 +498,7 @@ export default class GoogleAuth {
  }
 
  // Executes the given callback if it is not null.
- private callback(c: Function, ...args: any[]) {
+ private callback(c: Function, err?: Error, ...args: any[]) {
  if (c) {
  return c.apply(null, Array.prototype.slice.call(arguments, 1));
  }
@@ -600,7 +599,7 @@ export default class GoogleAuth {
  * @param {function} _callback Callback.
  * @api private
  */
- private _getGCEProjectId(_callback: RequestCallback) {
+ private _getGCEProjectId(_callback: BodyResponseCallback) {
  if (!this.transporter) {
  this.transporter = new DefaultTransporter();
  }

ts/lib/auth/iam.ts

@@ -52,7 +52,7 @@ export default class IAMAuth {
  */
  public getRequestMetadata(
  unused_uri: string,
- metadataFn: (err: Error, metadata: RequestMetadata) => void) {
+ metadataFn: (err: Error, metadata?: RequestMetadata) => void) {
  metadataFn(null, {
  'x-goog-iam-authority-selector': this.selector,
  'x-goog-iam-authorization-token': this.token

ts/lib/auth/jwtaccess.ts

@@ -58,7 +58,7 @@ export default class JWTAccess {
  * request metadata.
  */
  public getRequestMetadata(
- authURI: string, metadataCb: (err: Error, headers: any) => void) {
+ authURI: string, metadataCb: (err: Error, headers?: any) => void) {
  const iat = Math.floor(new Date().getTime() / 1000);
  const exp = iat + 3600; // 3600 seconds = 1 hour
 
@@ -86,10 +86,10 @@ export default class JWTAccess {
  /**
  * Create a JWTAccess credentials instance using the given input options.
  * @param {object=} json The input object.
- * @param {function=} opt_callback Optional callback.
+ * @param {function=} callback Optional callback.
  */
- public fromJSON(json: any, opt_callback: (err: Error) => void) {
- const done = opt_callback || noop;
+ public fromJSON(json: any, callback?: (err: Error) => void) {
+ const done = callback || noop;
  if (!json) {
  done(new Error(
  'Must pass in a JSON object containing the service account auth settings.'));
@@ -115,11 +115,10 @@ export default class JWTAccess {
  /**
  * Create a JWTAccess credentials instance using the given input stream.
  * @param {object=} stream The input stream.
- * @param {function=} opt_callback Optional callback.
+ * @param {function=} callback Optional callback.
  */
- public fromStream(
- stream: stream.Readable, opt_callback: (err: Error) => void) {
- const done = opt_callback || noop;
+ public fromStream(stream: stream.Readable, callback?: (err: Error) => void) {
+ const done = callback || noop;
  if (!stream) {
  setImmediate(() => {
  done(new Error(
@@ -135,7 +134,7 @@ export default class JWTAccess {
  stream.on('end', () => {
  try {
  const data = JSON.parse(s);
- this.fromJSON(data, opt_callback);
+ this.fromJSON(data, callback);
  } catch (err) {
  done(err);
  }