feat: use X-Goog-Api-Key header (#719)

alexander-fenster · JustinBeckwith · commit 35471d0569af · 2019-05-29T17:26:40.000Z
diff --git a/package.json b/package.json
@@ -37,7 +37,7 @@
     "@types/mocha": "^5.2.1",
     "@types/mv": "^2.1.0",
     "@types/ncp": "^2.0.1",
-    "@types/nock": "^10.0.0",
+    "@types/nock": "^10.0.3",
     "@types/node": "^10.5.1",
     "@types/semver": "^6.0.0",
     "@types/sinon": "^7.0.0",
diff --git a/src/auth/oauth2client.ts b/src/auth/oauth2client.ts
@@ -756,7 +756,7 @@ export class OAuth2Client extends AuthClient {
     }
 
     if (this.apiKey) {
-      return {headers: {}};
+      return {headers: {'X-Goog-Api-Key': this.apiKey}};
     }
     let r: GetTokenResponse | null = null;
     let tokens: Credentials | null = null;
@@ -885,9 +885,9 @@ export class OAuth2Client extends AuthClient {
         opts.headers = opts.headers || {};
         opts.headers.Authorization = r.headers.Authorization;
       }
-
       if (this.apiKey) {
-        opts.params = Object.assign(opts.params || {}, {key: this.apiKey});
+        opts.headers = opts.headers || {};
+        opts.headers['X-Goog-Api-Key'] = this.apiKey;
       }
       r2 = await this.transporter.request<T>(opts);
     } catch (e) {
diff --git a/test/test.googleauth.ts b/test/test.googleauth.ts
@@ -242,9 +242,8 @@ describe('googleauth', () => {
   it('should make a request with the api key', async () => {
     const scope = nock(BASE_URL)
       .post(ENDPOINT)
-      .query({key: API_KEY})
-      .reply(uri => {
-        assert(uri.indexOf('key=' + API_KEY) > -1);
+      .reply(function(uri) {
+        assert.strictEqual(this.req.headers['x-goog-api-key'][0], API_KEY);
         return [200, RESPONSE_BODY];
       });
     const client = auth.fromAPIKey(API_KEY);
@@ -257,13 +256,19 @@ describe('googleauth', () => {
     scope.done();
   });
 
+  it('should put the api key in the headers', async () => {
+    const client = auth.fromAPIKey(API_KEY);
+    const headers = await client.getRequestHeaders();
+    assert.strictEqual(headers['X-Goog-Api-Key'], API_KEY);
+  });
+
   it('should make a request while preserving original parameters', async () => {
     const OTHER_QS_PARAM = {test: 'abc'};
     const scope = nock(BASE_URL)
       .post(ENDPOINT)
-      .query({test: OTHER_QS_PARAM.test, key: API_KEY})
-      .reply(uri => {
-        assert(uri.indexOf('key=' + API_KEY) > -1);
+      .query({test: OTHER_QS_PARAM.test})
+      .reply(function(uri) {
+        assert.strictEqual(this.req.headers['x-goog-api-key'][0], API_KEY);
         assert(uri.indexOf('test=' + OTHER_QS_PARAM.test) > -1);
         return [200, RESPONSE_BODY];
       });

Original file line number	Diff line number	Diff line change
`@@ -756,7 +756,7 @@ export class OAuth2Client extends AuthClient {`
`756`	`756`	`}`
`757`	`757`
`758`	`758`	`if (this.apiKey) {`
`759`		`- return {headers: {}};`
	`759`	`+ return {headers: {'X-Goog-Api-Key': this.apiKey}};`
`760`	`760`	`}`
`761`	`761`	`let r: GetTokenResponse \| null = null;`
`762`	`762`	`let tokens: Credentials \| null = null;`
`@@ -885,9 +885,9 @@ export class OAuth2Client extends AuthClient {`
`885`	`885`	`opts.headers = opts.headers \|\| {};`
`886`	`886`	`opts.headers.Authorization = r.headers.Authorization;`
`887`	`887`	`}`
`888`		`-`
`889`	`888`	`if (this.apiKey) {`
`890`		`- opts.params = Object.assign(opts.params \|\| {}, {key: this.apiKey});`
	`889`	`+ opts.headers = opts.headers \|\| {};`
	`890`	`+ opts.headers['X-Goog-Api-Key'] = this.apiKey;`
`891`	`891`	`}`
`892`	`892`	`r2 = await this.transporter.request<T>(opts);`
`893`	`893`	`} catch (e) {`