fix: add test for x-goog-api-client header (#556)

Author: Benjamin E. Coe

package.json

@@ -52,7 +52,7 @@
     "predocs-test": "npm run docs"
   },
   "dependencies": {
-    "@google-cloud/common-grpc": "^1.0.0",
+    "@google-cloud/common-grpc": "^1.0.5",
     "@google-cloud/paginator": "^2.0.0",
     "@google-cloud/projectify": "^1.0.0",
     "@google-cloud/promisify": "^1.0.0",
@@ -69,6 +69,7 @@
     "pumpify": "^2.0.0",
     "snakecase-keys": "^3.0.0",
     "stream-events": "^1.0.4",
+    "teeny-request": "^5.2.1",
     "through2": "^3.0.0",
     "type-fest": "^0.7.0"
   },
@@ -100,6 +101,7 @@
     "google-proto-files": "^1.0.0",
     "grpc": "^1.22.2",
     "gts": "^1.0.0",
+    "http2spy": "^1.1.0",
     "intelli-espower-loader": "^1.0.1",
     "jsdoc": "^3.6.2",
     "jsdoc-fresh": "^1.0.1",

src/index.ts

@@ -23,7 +23,7 @@ import * as extend from 'extend';
 import {GoogleAuth} from 'google-auth-library';
 import * as gax from 'google-gax';
 import {ClientReadableStream} from 'grpc';
-import * as request from 'request';
+import {Response} from 'teeny-request';
 
 const pumpify = require('pumpify');
 import * as streamEvents from 'stream-events';
@@ -84,11 +84,7 @@ export interface CreateSinkRequest {
 }
 
 export interface CreateSinkCallback {
-  (
-    err: Error | null,
-    sink?: Sink | null,
-    resp?: LogSink | request.Response
-  ): void;
+  (err: Error | null, sink?: Sink | null, resp?: LogSink | Response): void;
 }
 
 export type GetEntriesResponse = [

src/log.ts

@@ -19,7 +19,7 @@ import {callbackifyAll} from '@google-cloud/promisify';
 import arrify = require('arrify');
 import * as extend from 'extend';
 import {CallOptions} from 'google-gax';
-import {Response} from 'request';
+import {Response} from 'teeny-request';
 
 import {google} from '../proto/logging';
 

src/v2/config_service_v2_client.js

@@ -82,7 +82,7 @@ class ConfigServiceV2Client {
 
     // Determine the client header string.
     const clientHeader = [
-      `gl-node/${process.version}`,
+      `gl-node/${process.versions.node}`,
       `grpc/${gaxGrpc.grpcVersion}`,
       `gax/${gax.version}`,
       `gapic/${VERSION}`,

src/v2/logging_service_v2_client.js

@@ -82,7 +82,7 @@ class LoggingServiceV2Client {
 
     // Determine the client header string.
     const clientHeader = [
-      `gl-node/${process.version}`,
+      `gl-node/${process.versions.node}`,
       `grpc/${gaxGrpc.grpcVersion}`,
       `gax/${gax.version}`,
       `gapic/${VERSION}`,

src/v2/metrics_service_v2_client.js

@@ -81,7 +81,7 @@ class MetricsServiceV2Client {
 
     // Determine the client header string.
     const clientHeader = [
-      `gl-node/${process.version}`,
+      `gl-node/${process.versions.node}`,
       `grpc/${gaxGrpc.grpcVersion}`,
       `gax/${gax.version}`,
       `gapic/${VERSION}`,

system-test/logging.ts

@@ -27,7 +27,7 @@ import {HOST_ADDRESS} from 'gcp-metadata';
 import * as nock from 'nock';
 import {Duplex} from 'stream';
 import * as uuid from 'uuid';
-
+import * as http2spy from 'http2spy';
 import {Logging, Sink} from '../src';
 
 // block all attempts to chat with the metadata server (kokoro runs on GCE)
@@ -219,8 +219,10 @@ describe('Logging', () => {
     // tslint:disable-next-line no-any
     const logs: any[] = [];
 
-    function getTestLog() {
-      const log = logging.log(`system-test-logs-${uuid.v4()}`);
+    function getTestLog(loggingInstnce = null) {
+      const log = (loggingInstnce || logging).log(
+        `system-test-logs-${uuid.v4()}`
+      );
       logs.push(log);
 
       const logEntries = [
@@ -579,6 +581,17 @@ describe('Logging', () => {
       const {log, logEntries} = getTestLog();
       log.warning(logEntries, options, done);
     });
+
+    it('should populate x-goog-api-client header', async () => {
+      const {Logging} = http2spy.require(require.resolve('../src'));
+      const {log, logEntries} = getTestLog(new Logging());
+      await log.write(logEntries[0], options);
+      assert.ok(
+        /gl-node\/[0-9]+\.[\w.-]+ grpc\/[0-9]+\.[\w.-]+ gax\/[0-9]+\.[\w.-]+ gapic\/[0-9]+\.[\w.-]+ gccl\/[0-9]+\.[\w.-]+/.test(
+          http2spy.requests[0]['x-goog-api-client'][0]
+        )
+      );
+    });
   });
 
   function generateName() {