feat(createClient): Add Contentful User Agent

Author: Khaledgarbaya

lib/contentful-management.js

@@ -7,13 +7,12 @@
 import axios from 'axios'
 import cloneDeep from 'lodash/cloneDeep'
 import assign from 'lodash/assign'
-import {createHttpClient} from 'contentful-sdk-core'
-import version from '../version'
+import {createHttpClient, getUserAgentHeader} from 'contentful-sdk-core'
 import createContentfulApi from './create-contentful-api'
-
+import version from '../version'
 /**
  * @typedef {ContentfulManagement} ContentfulManagement
- * @property {function(params: {accessToken: string, insecure?: boolean, host?: string, hostUpload?: string, httpAgent?: Object, httpsAgent?: Object, headers?: Object, proxy?:Object}): ClientAPI} createClient - Create a client instance, this is the entry point to the library
+ * @property {function(params: {accessToken: string, insecure?: boolean, host?: string, hostUpload?: string, httpAgent?: Object, httpsAgent?: Object, headers?: Object, proxy?:Object, application?: string, integration?: string}): ClientAPI} createClient - Create a client instance, this is the entry point to the library
  *
  * @example
  * // require contentful-management
@@ -28,10 +27,16 @@ export function createClient (params) {
     defaultHostname: 'api.contentful.com',
     defaultHostnameUpload: 'upload.contentful.com'
   }
+  const userAgentHeader = getUserAgentHeader(`contentful-management.js/${version}`,
+    params.application,
+    params.integration
+  )
+
   const requiredHeaders = {
     'Content-Type': 'application/vnd.contentful.management.v1+json',
-    'X-Contentful-User-Agent': 'contentful-management.js/' + version
+    'X-Contentful-User-Agent': userAgentHeader
   }
+
   params = assign(defaultParameters, cloneDeep(params))
 
   if (!params.accessToken) {

package.json

@@ -19,8 +19,8 @@
     "clean": "rimraf dist && rimraf coverage",
     "build": "npm run clean && npm run build:ci",
     "build:ci": "npm run vendor:version && npm run build:standalone",
-    "build:standalone": "BABEL_ENV=webpack webpack && BABEL_ENV=webpack NODE_ENV=production webpack -p",
-    "build:standalone:log": "BABEL_ENV=webpack npm run build && BABEL_ENV=webpack NODE_ENV=production webpack -p --json --profile > webpack-build-log.json",
+    "build:standalone": "BABEL_ENV=webpack webpack && BABEL_ENV=webpack NODE_ENV=production webpack",
+    "build:standalone:log": "BABEL_ENV=webpack npm run build && BABEL_ENV=webpack NODE_ENV=production webpack --json --profile > webpack-build-log.json",
     "docs:build": "esdoc -c esdoc.json",
     "docs:dev": "npm run build && npm run docs:build",
     "docs:watch": "watchy -w lib npm run docs:dev",
@@ -33,8 +33,8 @@
     "test:only": "BABEL_ENV=test babel-node ./test/runner",
     "test:debug": "BABEL_ENV=test babel-node debug ./test/runner",
     "test:integration": "BABEL_ENV=test babel-node ./test/integration/integration-tests.js",
-    "test:browser-local": "BABEL_ENV=test ./node_modules/.bin/karma start karma.conf.local.js",
-    "test:browser-remote": "BABEL_ENV=test ./node_modules/.bin/karma start karma.conf.saucelabs.js",
+    "test:browser-local": "BABEL_ENV=test karma start karma.conf.local.js",
+    "test:browser-remote": "BABEL_ENV=test karma start karma.conf.saucelabs.js",
     "test:simulate-ci": "trevor",
     "vendor:version": "echo \"module.exports = '`cat package.json|json version`'\" > version.js",
     "browser-coverage": "npm run test:cover && opener coverage/lcov-report/index.html",
@@ -55,9 +55,10 @@
   ],
   "dependencies": {
     "axios": "~0.15.3",
-    "contentful-sdk-core": "^3.9.0",
+    "contentful-sdk-core": "^3.10.1",
     "es6-promise": "^4.0.5",
-    "lodash": "^4.17.4"
+    "lodash": "^4.17.4",
+    "platform": "1.3.3"
   },
   "devDependencies": {
     "babel-cli": "^6.7.5",

test/unit/contentful-management-test.js

@@ -1,7 +1,7 @@
 import test from 'tape'
 import sinon from 'sinon'
 import {createClient, __RewireAPI__ as createClientRewireApi} from '../../lib/contentful-management'
-
+import version from '../../version'
 test('Throws if no accessToken is defined', (t) => {
   t.throws(() => {
     createClient({space: 'spaceid'})
@@ -10,7 +10,6 @@ test('Throws if no accessToken is defined', (t) => {
 })
 
 test('Passes along HTTP client parameters', (t) => {
-  createClientRewireApi.__Rewire__('version', 'version')
   createClientRewireApi.__Rewire__('axios', {create: sinon.stub()})
 
   const createHttpClientStub = sinon.stub()
@@ -19,10 +18,28 @@ test('Passes along HTTP client parameters', (t) => {
 
   const client = createClient({accessToken: 'accesstoken'})
   t.ok(createHttpClientStub.args[0][1].headers['Content-Type'], 'sets the content type')
-  t.equals(createHttpClientStub.args[0][1].headers['X-Contentful-User-Agent'], 'contentful-management.js/version', 'sets the user agent header')
   t.ok(client, 'returns a client')
   createClientRewireApi.__ResetDependency__('createHttpClient')
   createClientRewireApi.__ResetDependency__('wrapHttpClient')
   createClientRewireApi.__ResetDependency__('createContentfulApi')
   t.end()
 })
+
+test('Generate the correct User Agent Header', (t) => {
+  createClientRewireApi.__Rewire__('axios', {create: sinon.stub()})
+
+  const createHttpClientStub = sinon.stub()
+  createClientRewireApi.__Rewire__('createHttpClient', createHttpClientStub)
+  createClientRewireApi.__Rewire__('createContentfulApi', sinon.stub().returns({}))
+  createClient({accessToken: 'accesstoken', application: 'myApplication/1.1.1', integration: 'myIntegration/1.0.0'})
+  const headerParts = createHttpClientStub.args[0][1].headers['X-Contentful-User-Agent'].split('; ')
+  t.equal(headerParts.length, 5)
+  t.equal(headerParts[0], 'app myApplication/1.1.1')
+  t.equal(headerParts[1], 'integration myIntegration/1.0.0')
+  t.equal(headerParts[2], `sdk contentful-management.js/${version}`)
+
+  createClientRewireApi.__ResetDependency__('createHttpClient')
+  createClientRewireApi.__ResetDependency__('wrapHttpClient')
+  createClientRewireApi.__ResetDependency__('createContentfulApi')
+  t.end()
+})

webpack.config.js

@@ -8,6 +8,7 @@ var plugins = [
     'caching': true
   }),
   new webpack.optimize.OccurrenceOrderPlugin(),
+  new webpack.IgnorePlugin(/vertx/),
   new webpack.DefinePlugin({
     'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV)
   })
@@ -51,6 +52,7 @@ module.exports = [
     module: {
       loaders: loaders
     },
+    devtool: 'source-map',
     plugins: plugins
   },
   {
@@ -66,6 +68,7 @@ module.exports = [
     module: {
       loaders: loaders
     },
+    devtool: 'source-map',
     plugins: plugins
   }
 ]

yarn.lock

@@ -1379,14 +1379,15 @@ content-type@~1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/content-type/-/content-type-1.0.2.tgz#b7d113aee7a8dd27bd21133c4dc2529df1721eed"
 
-contentful-sdk-core@^3.7.0:
-  version "3.7.0"
-  resolved "https://registry.yarnpkg.com/contentful-sdk-core/-/contentful-sdk-core-3.7.0.tgz#1573d6e04d55d6e414a271e8759a986af95e322b"
+contentful-sdk-core@^3.10.1:
+  version "3.10.1"
+  resolved "https://registry.yarnpkg.com/contentful-sdk-core/-/contentful-sdk-core-3.10.1.tgz#9a9149711fbe628a8deeae405681c64dc371fcaa"
   dependencies:
     axios "^0.15.3"
     es6-promise "^4.0.5"
     lodash "^4.17.4"
     npmlog "^4.0.2"
+    platform "1.3.3"
     qs "^6.1.0"
 
 contentful-sdk-jsdoc@^1.2.2:
@@ -4118,6 +4119,10 @@ pkg-dir@^1.0.0:
   dependencies:
     find-up "^1.0.0"
 
+[email protected]:
+  version "1.3.3"
+  resolved "https://registry.yarnpkg.com/platform/-/platform-1.3.3.tgz#646c77011899870b6a0903e75e997e8e51da7461"
+
 pluralize@^1.2.1:
   version "1.2.1"
   resolved "https://registry.yarnpkg.com/pluralize/-/pluralize-1.2.1.tgz#d1a21483fd22bb41e58a12fa3421823140897c45"