Merge pull request #139 from fkalny-groupon/main

feat: add userAgent forwarding and tests

.nvmrc

@@ -0,0 +1 @@
+10.24.1

lib/fetch.js

@@ -112,10 +112,19 @@ function unifyAuth(auth) {
   return `${user}:${pass}`;
 }
 
-function buildUserAgent({ clientName, clientVersion, appName, appSha, fqdn }) {
+function buildUserAgent({
+  clientName,
+  clientVersion,
+  appName,
+  appSha,
+  fqdn,
+  userAgent,
+}) {
   return `${clientName || 'noServiceName'}/${
     clientVersion || 'noServiceVersion'
-  } (${appName || 'noAppName'}/${appSha || 'noAppSha'}; ${fqdn || 'noFQDN'})`;
+  } (${appName || 'noAppName'}/${appSha || 'noAppSha'}; ${fqdn || 'noFQDN'}; ${
+    userAgent || 'noUserAgent'
+  })`;
 }
 
 function defaultTimeout(value, defaultValue) {

lib/typedefs.d.ts

@@ -75,6 +75,7 @@ declare namespace Gofer {
     rejectUnauthorized?: boolean;
     secureContext?: SecureContext;
     captureAsyncStack?: boolean;
+    userAgent?: string;
     [opt: string]: any;
   };
 

test/gofer.test.js

@@ -82,6 +82,27 @@ describe('gofer', () => {
     });
   });
 
+  describe('user agent', () => {
+    let gofer;
+    const userAgent = 'some-user-agent (like Firefox/42.0)';
+    before('create Gofer instance', () => {
+      gofer = new Gofer({ globalDefaults: { userAgent } }).with(options);
+    });
+
+    it('passes forward the user agent', function () {
+      if (typeof document !== 'undefined') {
+        return this.skip();
+      }
+
+      return gofer
+        .get('/echo')
+        .json()
+        .then(echo => {
+          assert.include(userAgent, echo.headers['user-agent']);
+        });
+    });
+  });
+
   describe('sub-class', () => {
     function SubGofer(config) {
       Gofer.call(this, config, 'sub', '1.2.3', 'my-sub-client');