Merge pull request #114 from pubnub/develop

Release 4.18.0

Author: parfeon

.pubnub.yml

@@ -1,11 +1,18 @@
 name: javascript
-version: 4.17.0
+version: 4.18.0
 schema: 1
 scm: github.com/pubnub/javascript
 files:
   - dist/web/pubnub.js
   - dist/web/pubnub.min.js
 changelog:
+  - version: v4.18.0
+    date: 2017-11-20
+    changes:
+      - type: improvement
+        text: keepAlive is now initialized globally instead of per-call, allowing better connection reuse
+      - type: feature
+        text: added sdkName configuration parameter which allow completely override pnsdk in request query
   - version: v4.17.0
     date: 2017-10-19
     changes:

CHANGELOG.md

@@ -1,4 +1,16 @@
 
+## [v4.18.0](https://github.com/pubnub/javascript/tree/v4.18.0)
+  November-20-2017
+
+
+  [Full Changelog](https://github.com/pubnub/javascript/compare/v4.17.0...v4.18.0)
+
+
+- ⭐ keepAlive is now initialized globally instead of per-call, allowing better connection reuse
+- 🌟 added sdkName configuration parameter which allow completely override pnsdk in request query
+
+
+
 ## [v4.17.0](https://github.com/pubnub/javascript/tree/v4.17.0)
   October-19-2017
 

README.md

@@ -19,5 +19,5 @@ please use the [master_3x](https://github.com/pubnub/javascript/tree/master_3x)
 - If you **need help** or have a **general question**, contact <[email protected]>
 
 ## CDN Links
-* https://cdn.pubnub.com/sdk/javascript/pubnub.4.17.0.min.js
-* https://cdn.pubnub.com/sdk/javascript/pubnub.4.17.0.js
+* https://cdn.pubnub.com/sdk/javascript/pubnub.4.18.0.min.js
+* https://cdn.pubnub.com/sdk/javascript/pubnub.4.18.0.js

dist/titanium/pubnub.js

@@ -1,4 +1,4 @@
-/*! 4.17.0 / Consumer  */
+/*! 4.18.0 / Consumer  */
 (function webpackUniversalModuleDefinition(root, factory) {
 	if(typeof exports === 'object' && typeof module === 'object')
 		module.exports = factory();
@@ -429,6 +429,7 @@ return /******/ (function(modules) { // webpackBootstrap
 	    this.secretKey = setup.secretKey || setup.secret_key;
 	    this.subscribeKey = setup.subscribeKey || setup.subscribe_key;
 	    this.publishKey = setup.publishKey || setup.publish_key;
+	    this.sdkName = setup.sdkName;
 	    this.sdkFamily = setup.sdkFamily;
 	    this.partnerId = setup.partnerId;
 	    this.setAuthKey(setup.authKey);
@@ -572,7 +573,7 @@ return /******/ (function(modules) { // webpackBootstrap
 	  }, {
 	    key: 'getVersion',
 	    value: function getVersion() {
-	      return '4.17.0';
+	      return '4.18.0';
 	    }
 	  }, {
 	    key: '_decideUUID',
@@ -2417,6 +2418,10 @@ return /******/ (function(modules) { // webpackBootstrap
 	}
 
 	function generatePNSDK(config) {
+	  if (config.sdkName) {
+	    return config.sdkName;
+	  }
+
 	  var base = 'PubNub-JS-' + config.sdkFamily;
 
 	  if (config.partnerId) {

dist/titanium/pubnub.min.js

@@ -1,4 +1,4 @@
-/*! 4.17.0 / Consumer  */
+/*! 4.18.0 / Consumer  */
 (function webpackUniversalModuleDefinition(root, factory) {
 	if(typeof exports === 'object' && typeof module === 'object')
 		module.exports = factory();
@@ -451,6 +451,7 @@ return /******/ (function(modules) { // webpackBootstrap
 	    this.secretKey = setup.secretKey || setup.secret_key;
 	    this.subscribeKey = setup.subscribeKey || setup.subscribe_key;
 	    this.publishKey = setup.publishKey || setup.publish_key;
+	    this.sdkName = setup.sdkName;
 	    this.sdkFamily = setup.sdkFamily;
 	    this.partnerId = setup.partnerId;
 	    this.setAuthKey(setup.authKey);
@@ -594,7 +595,7 @@ return /******/ (function(modules) { // webpackBootstrap
 	  }, {
 	    key: 'getVersion',
 	    value: function getVersion() {
-	      return '4.17.0';
+	      return '4.18.0';
 	    }
 	  }, {
 	    key: '_decideUUID',
@@ -2439,6 +2440,10 @@ return /******/ (function(modules) { // webpackBootstrap
 	}
 
 	function generatePNSDK(config) {
+	  if (config.sdkName) {
+	    return config.sdkName;
+	  }
+
 	  var base = 'PubNub-JS-' + config.sdkFamily;
 
 	  if (config.partnerId) {

dist/web/pubnub.js

@@ -1,6 +1,6 @@
 {
   "name": "pubnub",
-  "version": "4.17.0",
+  "version": "4.18.0",
   "author": "PubNub <[email protected]>",
   "description": "Publish & Subscribe Real-time Messaging with PubNub",
   "bin": {},

dist/web/pubnub.min.js

@@ -27,6 +27,11 @@ export default class {
   */
   instanceId: string;
 
+  /*
+    If the SDK is running as part of another SDK built atop of it, allow a custom pnsdk with name and version.
+   */
+  sdkName: string;
+
   /*
     keep track of the SDK family for identifier generator
   */
@@ -130,6 +135,7 @@ export default class {
     this.secretKey = setup.secretKey || setup.secret_key;
     this.subscribeKey = setup.subscribeKey || setup.subscribe_key;
     this.publishKey = setup.publishKey || setup.publish_key;
+    this.sdkName = setup.sdkName;
     this.sdkFamily = setup.sdkFamily;
     this.partnerId = setup.partnerId;
     this.setAuthKey(setup.authKey);
@@ -218,7 +224,7 @@ export default class {
   setSendBeaconConfig(val: boolean): this { this._useSendBeacon = val; return this; }
 
   getVersion(): string {
-    return '4.17.0';
+    return '4.18.0';
   }
 
   _decideUUID(providedUUID: string): string {

lib/core/components/config.js

@@ -32,6 +32,10 @@ function decideURL(endpoint, modules, incomingParams) {
 }
 
 function generatePNSDK(config: Config): string {
+  if (config.sdkName) {
+    return config.sdkName;
+  }
+
   let base = `PubNub-JS-${config.sdkFamily}`;
 
   if (config.partnerId) {

lib/core/components/config.js.map

@@ -4,26 +4,25 @@ import superagent from 'superagent';
 import superagentProxy from 'superagent-proxy';
 import AgentKeepAlive from 'agentkeepalive';
 
+let keepAliveAgent: (AgentKeepAlive | AgentKeepAlive.HttpsAgent) = null;
+let keepAliveSecureAgent: (AgentKeepAlive | AgentKeepAlive.HttpsAgent) = null;
+
 superagentProxy(superagent);
 
 export function proxy(superagentConstruct: superagent) {
   return superagentConstruct.proxy(this._config.proxy);
 }
 
 export function keepAlive(superagentConstruct: superagent) {
-  let AgentClass = null;
-  let agent = null;
-
-  if (this._config.secure) {
-    AgentClass = AgentKeepAlive.HttpsAgent;
-  } else {
-    AgentClass = AgentKeepAlive;
-  }
-
-  if (this._config.keepAliveSettings) {
+  let agent = this._config.secure ? keepAliveSecureAgent : keepAliveAgent;
+  if (agent === null) {
+    let AgentClass = this._config.secure ? AgentKeepAlive.HttpsAgent : AgentKeepAlive;
     agent = new AgentClass(this._config.keepAliveSettings);
-  } else {
-    agent = new AgentClass();
+    if (this._config.secure) {
+      keepAliveSecureAgent = agent;
+    } else {
+      keepAliveAgent = agent;
+    }
   }
 
   return superagentConstruct.agent(agent);

lib/core/components/endpoint.js

@@ -10,6 +10,7 @@ import packageJSON from '../../../package.json';
 describe('#components/networking', () => {
   let pubnub;
   let pubnubPartner;
+  let pubnubSDKName;
 
   before(() => {
     nock.disableNetConnect();
@@ -23,6 +24,7 @@ describe('#components/networking', () => {
     nock.cleanAll();
     pubnub = new PubNub({ subscribeKey: 'mySubKey', publishKey: 'myPublishKey', uuid: 'myUUID' });
     pubnubPartner = new PubNub({ subscribeKey: 'mySubKey', publishKey: 'myPublishKey', uuid: 'myUUID', partnerId: 'alligator' });
+    pubnubSDKName = new PubNub({ subscribeKey: 'mySubKey', publishKey: 'myPublishKey', uuid: 'myUUID', sdkName: 'custom-sdk/1.0.0' });
   });
 
   describe('supports user-agent generation with partner', () => {
@@ -39,6 +41,20 @@ describe('#components/networking', () => {
     });
   });
 
+  describe('supports PNSDK generation with custom SDK name', () => {
+    it('returns a correct response object', (done) => {
+      utils.createNock().get('/time/0')
+        .query({ uuid: 'myUUID', pnsdk: 'custom-sdk/1.0.0' })
+        .reply(200, [14570763868573725]);
+
+      pubnubSDKName.time((status) => {
+        assert.equal(status.error, false);
+        assert.equal(status.statusCode, 200);
+        done();
+      });
+    });
+  });
+
   describe('callback handling', () => {
     it('returns a correct status object', (done) => {
       utils.createNock().get('/time/0')

lib/core/components/endpoint.js.map

@@ -0,0 +1,79 @@
+/* global describe, it, before, after */
+
+import superagent from 'superagent';
+import sinon from 'sinon';
+import nock from 'nock';
+import assert from 'assert';
+
+import Networking from '../../src/networking';
+import { del, get, post } from '../../src/networking/modules/web-node';
+import { keepAlive, proxy } from '../../src/networking/modules/node';
+
+describe('keep-alive agent', () => {
+  before(() => nock.disableNetConnect());
+  after(() => nock.enableNetConnect());
+
+  const setupNetwork = (shouldSecure, enableKeepAlive) => {
+    const config = { origin: 'ps.pndsn.com', secure: shouldSecure, keepAlive: enableKeepAlive, logVerbosity: false };
+    const networking = new Networking({ keepAlive, del, get, post, proxy });
+    networking.init(config);
+
+    return networking;
+  };
+
+  it('should not create if \'keepAlive\' is \'false\'', () => {
+    const networking = setupNetwork(false, false);
+    const superagentGetSpy = sinon.spy(superagent, 'get');
+
+    networking.GET({}, { url: '/time/0' }, () => {});
+    assert(superagentGetSpy.called, 'superagent not called with get');
+    assert(superagentGetSpy.returnValues[0], 'request instance not created');
+    assert(!superagentGetSpy.returnValues[0]._agent, 'keep-alive agent should not be created');
+
+    superagentGetSpy.restore();
+  });
+
+  it('should create agent for insecure connection', () => {
+    const networking = setupNetwork(false, true);
+    const superagentGetSpy = sinon.spy(superagent, 'get');
+
+    networking.GET({}, { url: '/time/0' }, () => {});
+    assert(superagentGetSpy.returnValues[0]._agent, 'keep-alive agent not created');
+    assert(superagentGetSpy.returnValues[0]._agent.defaultPort !== 443, 'keep-alive agent should access TLS (80) port');
+
+    superagentGetSpy.restore();
+  });
+
+  it('should re-use created agent for insecure connection', () => {
+    const networking = setupNetwork(false, true);
+    const superagentGetSpy = sinon.spy(superagent, 'get');
+
+    networking.GET({}, { url: '/time/0' }, () => {});
+    networking.GET({}, { url: '/time/0' }, () => {});
+    assert(superagentGetSpy.returnValues[0]._agent === superagentGetSpy.returnValues[1]._agent, 'same user-agent should be used');
+
+    superagentGetSpy.restore();
+  });
+
+  it('should create agent for secure connection', () => {
+    const networking = setupNetwork(true, true);
+    const superagentGetSpy = sinon.spy(superagent, 'get');
+
+    networking.GET({}, { url: '/time/0' }, () => {});
+    assert(superagentGetSpy.returnValues[0]._agent, 'keep-alive agent not created');
+    assert(superagentGetSpy.returnValues[0]._agent.defaultPort === 443, 'keep-alive agent should access SSL (443) port');
+
+    superagentGetSpy.restore();
+  });
+
+  it('should re-use created agent for secure connection', () => {
+    const networking = setupNetwork(true, true);
+    const superagentGetSpy = sinon.spy(superagent, 'get');
+
+    networking.GET({}, { url: '/time/0' }, () => {});
+    networking.GET({}, { url: '/time/0' }, () => {});
+    assert(superagentGetSpy.returnValues[0]._agent === superagentGetSpy.returnValues[1]._agent, 'same user-agent should be used');
+
+    superagentGetSpy.restore();
+  });
+});