Set custom user agent for SDK

In browser environment, the sdk user-agent string is appended to the browser's
own UA string.

docs/developing-sdk.md

@@ -67,7 +67,7 @@ $ // git add, commit, push
 
 #### Release a new version to NPM
 
-1. Update version in `package.json`
+1. Update version in `package.json` and `src/version.js`
 
 1. Update CHANGELOG.md
    - Move everything in Unreleased to the corresponding version section

src/interceptors/endpoint_request.js

@@ -1,9 +1,10 @@
 import axios from 'axios';
+import { sdkUserAgentString } from '../runtime';
 
 // GET requests: `params` includes query params. `queryParams` will be ignored
 // POST requests: `params` includes body params. `queryParams` includes URL query params
 const doRequest = ({ params = {}, queryParams = {}, httpOpts }) => {
-  const { method = 'get' } = httpOpts;
+  const { method = 'get', headers } = httpOpts;
 
   let data = null;
   let query = null;
@@ -18,6 +19,7 @@ const doRequest = ({ params = {}, queryParams = {}, httpOpts }) => {
 
   const req = {
     ...httpOpts,
+    headers: { ...headers, 'User-Agent': sdkUserAgentString },
     method,
     data,
     params: query,

src/multitenant_sdk.js

@@ -12,6 +12,7 @@ import AddMultitenantAuthHeader from './interceptors/add_multitenant_auth_header
 import createSdkFnContextRunner from './sdk_context_runner';
 import memoryStore from './memory_store';
 import contextRunner from './context_runner';
+import { isBrowser } from './runtime';
 
 /* eslint-disable class-methods-use-this */
 
@@ -149,9 +150,6 @@ const validateSdkConfig = sdkConfig => {
     throw new Error('baseUrl must be provided');
   }
 
-  /* global window */
-  const isBrowser = typeof window !== 'undefined' && typeof window.document !== 'undefined';
-
   if (isBrowser) {
     throw new Error('Using the multitenant SDK in browser is not allowed.');
   }

src/runtime.js

@@ -0,0 +1,22 @@
+import sdkVersion from './version';
+
+/* global window, navigator, process */
+const isBrowser = typeof window !== 'undefined' && typeof window.document !== 'undefined';
+const navigatorUserAgent = typeof navigator !== 'undefined' ? navigator.userAgent : '';
+const nodeVersion =
+  typeof process !== 'undefined' && typeof process.versions !== 'undefined'
+    ? process.versions.node
+    : '';
+
+// User-Agent string for the SDK
+// For browsers, append to the browser's user agent string,
+let userAgent = `sharetribe-flex-sdk-js/${sdkVersion}`;
+if (isBrowser && navigatorUserAgent !== '') {
+  userAgent = `${navigatorUserAgent} ${userAgent}`;
+} else if (nodeVersion !== '') {
+  userAgent = `${userAgent} (node/${nodeVersion})`;
+}
+
+const sdkUserAgentString = userAgent;
+
+export { isBrowser, sdkUserAgentString };

src/sdk.js

@@ -32,6 +32,7 @@ import FormatHttpResponse from './interceptors/format_http_response';
 import endpointRequest from './interceptors/endpoint_request';
 import { createDefaultTokenStore } from './token_store';
 import createSdkFnContextRunner from './sdk_context_runner';
+import { isBrowser } from './runtime';
 
 /* eslint-disable class-methods-use-this */
 
@@ -341,9 +342,7 @@ const validateSdkConfig = sdkConfig => {
     throw new Error('assetCdnBaseUrl must be provided');
   }
 
-  /* global window, console */
-  const isBrowser = typeof window !== 'undefined' && typeof window.document !== 'undefined';
-
+  /* global console */
   if (isBrowser && sdkConfig.clientSecret && !sdkConfig.dangerouslyAllowClientSecretInBrowser) {
     /* eslint-disable no-console */
     console.warn(

src/version.js

@@ -0,0 +1,3 @@
+// Update this when updating package.json
+const sdkVersion = '1.17.0';
+export default sdkVersion;