Merge pull request #139 from segmentio/public-middleware

rm checks to disallow adding middleware post-init

Author: aultimus

HISTORY.md

@@ -1,9 +1,15 @@
+# 3.12.4 / 2020-04-23
+
+- test: add add/apply middleware stress test
+- update tests to not fail when adding middleware post-init
+- rm checks to disallow adding middleware post-init
 
 # v3.11.3 / 2020-04-13
 
 - Transform package.json to strip excess in browserify
 
 # v3.11.0
+
 - feat: use SameSite=Lax by default (#128)
 
 # v3.10.1 / 2019-11-20

lib/analytics.js

@@ -105,11 +105,6 @@ Analytics.prototype.addIntegration = function(Integration) {
  */
 
 Analytics.prototype.addSourceMiddleware = function(middleware) {
-  if (this.initialized)
-    throw new Error(
-      'attempted to add a source middleware after initialization'
-    );
-
   this._sourceMiddlewares.add(middleware);
   return this;
 };
@@ -122,11 +117,6 @@ Analytics.prototype.addSourceMiddleware = function(middleware) {
  */
 
 Analytics.prototype.addIntegrationMiddleware = function(middleware) {
-  if (this.initialized)
-    throw new Error(
-      'attempted to add an integration middleware after initialization'
-    );
-
   this._integrationMiddlewares.add(middleware);
   return this;
 };

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-core",
   "author": "Segment <friends@segment.com>",
-  "version": "3.11.4",
+  "version": "3.12.4",
   "description": "The hassle-free way to integrate analytics into any web application.",
   "keywords": [
     "analytics",

test/analytics.test.js

@@ -2043,19 +2043,13 @@ describe('Analytics', function() {
       }
     });
 
-    it('should throw an error if AJS has already initialized', function() {
+    it('should not throw an error if AJS has already initialized', function() {
       analytics.init();
       try {
         analytics.addIntegrationMiddleware(function() {});
-
-        // This assert should not run.
-        assert(false, 'error was not thrown!');
       } catch (e) {
-        assert(
-          e.message ===
-            'attempted to add an integration middleware after initialization',
-          'wrong error return'
-        );
+        // This assert should not run.
+        assert(false, 'error was thrown!');
       }
     });
 
@@ -2092,19 +2086,13 @@ describe('Analytics', function() {
       }
     });
 
-    it('should throw an error if AJS has already initialized', function() {
+    it('should not throw an error if AJS has already initialized', function() {
       analytics.init();
       try {
         analytics.addSourceMiddleware(function() {});
-
+      } catch (e) {
         // This assert should not run.
         assert(false, 'error was not thrown!');
-      } catch (e) {
-        assert(
-          e.message ===
-            'attempted to add a source middleware after initialization',
-          'wrong error return'
-        );
       }
     });
 

test/middleware.test.js

@@ -345,4 +345,49 @@ describe('SourceMiddlewareChain', function() {
       assert(payload instanceof Facade, 'Payload should still be a facade.');
     });
   });
+
+  it('should be able to add and apply middleware interchangably', function() {
+    chain.add(function(chain) {
+      chain.payload.obj.test.push(1);
+      chain.next(chain.payload);
+    });
+    chain.applyMiddlewares({ test: [] }, 'Test', function(payload) {
+      assert.deepEqual(payload.obj.test, [1]);
+    });
+    chain.add(function(chain) {
+      chain.payload.obj.test.push(2);
+      chain.next(chain.payload);
+    });
+    chain.applyMiddlewares({ test: [] }, 'Test', function(payload) {
+      assert.deepEqual(payload.obj.test, [1, 2]);
+    });
+    chain.add(function(chain) {
+      chain.payload.obj.test.push(3);
+      chain.next(chain.payload);
+    });
+    chain.applyMiddlewares({ test: [] }, 'Test', function(payload) {
+      assert.deepEqual(payload.obj.test, [1, 2, 3]);
+    });
+    chain.add(function(chain) {
+      chain.payload.obj.test.push(4);
+      chain.next(chain.payload);
+    });
+    chain.applyMiddlewares({ test: [] }, 'Test', function(payload) {
+      assert.deepEqual(payload.obj.test, [1, 2, 3, 4]);
+    });
+    chain.add(function(chain) {
+      chain.payload.obj.test.push(5);
+      chain.next(chain.payload);
+    });
+    chain.applyMiddlewares({ test: [] }, 'Test', function(payload) {
+      assert.deepEqual(payload.obj.test, [1, 2, 3, 4, 5]);
+    });
+    chain.add(function(chain) {
+      chain.payload.obj.test.push(6);
+      chain.next(chain.payload);
+    });
+    chain.applyMiddlewares({ test: [] }, 'Test', function(payload) {
+      assert.deepEqual(payload.obj.test, [1, 2, 3, 4, 5, 6]);
+    });
+  });
 });