Release 2.4.0

Author: Peripheral1994

HISTORY.md

@@ -1,3 +1,7 @@
+2.4.0 / 2017-03-29
+==================
+
+  * Add support for environment option
 
 2.3.0 / 2016-11-07
 ==================

lib/index.js

@@ -16,9 +16,11 @@ var GTM = module.exports = integration('Google Tag Manager')
   .global('dataLayer')
   .global('google_tag_manager')
   .option('containerId', '')
+  .option('environment', '')
   .option('trackNamedPages', true)
   .option('trackCategorizedPages', true)
-  .tag('<script src="//www.googletagmanager.com/gtm.js?id={{ containerId }}&l=dataLayer">');
+  .tag('no-env', '<script src="//www.googletagmanager.com/gtm.js?id={{ containerId }}&l=dataLayer">')
+  .tag('with-env', '<script src="//www.googletagmanager.com/gtm.js?id={{ containerId }}&l=dataLayer&gtm_preview={{ environment }}">');
 
 /**
  * Initialize.
@@ -30,7 +32,12 @@ var GTM = module.exports = integration('Google Tag Manager')
 
 GTM.prototype.initialize = function() {
   push({ 'gtm.start': Number(new Date()), event: 'gtm.js' });
-  this.load(this.ready);
+
+  if (this.options.environment.length) {
+    this.load('with-env', this.options, this.ready);
+  } else {
+    this.load('no-env', this.options, this.ready);
+  }
 };
 
 /**

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-integration-google-tag-manager",
   "description": "The Google Tag Manager analytics.js integration.",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "keywords": [
     "analytics.js",
     "analytics.js-integration",

test/index.test.js

@@ -10,7 +10,8 @@ describe('Google Tag Manager', function() {
   var analytics;
   var gtm;
   var options = {
-    containerId: 'GTM-M8M29T'
+    containerId: 'GTM-M8M29T',
+    environment: ''
   };
 
   beforeEach(function() {
@@ -33,6 +34,7 @@ describe('Google Tag Manager', function() {
       .assumesPageview()
       .global('dataLayer')
       .option('containerId', '')
+      .option('environment', '')
       .option('trackNamedPages', true)
       .option('trackCategorizedPages', true));
   });
@@ -45,6 +47,10 @@ describe('Google Tag Manager', function() {
 
   describe('after loading', function() {
     beforeEach(function(done) {
+      options = {
+        containerId: 'GTM-M8M29T',
+        environment: ''
+      };
       analytics.once('ready', done);
       analytics.initialize();
       analytics.page();
@@ -169,4 +175,19 @@ describe('Google Tag Manager', function() {
       });
     });
   });
+
+  describe('environment options', function() {
+    it('should use the right tag if the environment option is set', function() {
+      gtm.options = {
+        containerId: 'GTM-M8M29T',
+        environment: 'test'
+      };
+
+      var tag = '<script src="http://www.googletagmanager.com/gtm.js?id=' + gtm.options.containerId + '&l=dataLayer&gtm_preview=' + gtm.options.environment + '">';
+      analytics.spy(gtm, 'load');
+      analytics.initialize();
+      analytics.page();
+      analytics.loaded(tag);
+    });
+  });
 });