@segment/analytics.js-integration-fullstory/test/index.test.js

The Fullstory analytics.js integration.

'use strict';

var Analytics = require('@segment/analytics.js-core').constructor;
var integration = require('@segment/analytics.js-integration');
var sandbox = require('@segment/clear-env');
var tester = require('@segment/analytics.js-integration-tester');
var FullStory = require('../lib/');

describe('FullStory', function() {
  var analytics;
  var fullstory;
  var options = {
    org: '1JO',
    debug: false,
    trackAllPages: false,
    trackNamedPages: false,
    trackCategorizedPages: false
  };

  beforeEach(function() {
    analytics = new Analytics();
    fullstory = new FullStory(options);
    analytics.use(FullStory);
    analytics.use(tester);
    analytics.add(fullstory);
  });

  afterEach(function() {
    analytics.restore();
    analytics.reset();
    fullstory.reset();
    sandbox();
  });

  it('should have the right settings', function() {
    analytics.compare(
      FullStory,
      integration('FullStory')
        .option('org', '')
        .option('debug', false)
        .option('trackAllPages', false)
        .option('trackNamedPages', false)
        .option('trackCategorizedPages', false)
    );
  });

  describe('before loading', function() {
    beforeEach(function() {
      analytics.stub(fullstory, 'load');
    });

    describe('#initialize', function() {
      it('should create window.FS and window.FS.clearUserCookie', function() {
        analytics.assert(!window.FS);
        analytics.initialize();
        analytics.assert(window.FS);
        analytics.assert(window.FS.clearUserCookie);
      });

      it('should call #load', function() {
        analytics.initialize();
        analytics.called(fullstory.load);
      });
    });
  });

  describe('after loading', function() {
    beforeEach(function(done) {
      analytics.once('ready', done);
      analytics.initialize();
      analytics.page();
    });

    describe('#identify', function() {
      beforeEach(function() {
        analytics.stub(window.FS, 'identify');
        analytics.stub(window.FS, 'setUserVars');
      });

      it('should default to anonymousId', function() {
        analytics.identify();
        analytics.didNotCall(window.FS.identify);
        analytics.called(window.FS.setUserVars);
        var traits = window.FS.setUserVars.args[0][0];
        analytics.assert(
          traits && traits.hasOwnProperty('segmentAnonymousId_str'),
          'did not set anonymous id correctly'
        );
      });

      it('should only send strings as the id', function() {
        analytics.identify(1);
        analytics.called(window.FS.identify, '1', {}, 'segment');
        analytics.didNotCall(window.FS.setUserVars);
        var traits = window.FS.identify.args[0][0];
        analytics.assert(
          traits && !traits.hasOwnProperty('segmentAnonymousId_str'),
          'did set anonymous id despite user id'
        );
      });

      it('should send an id', function() {
        analytics.identify('id');
        analytics.called(window.FS.identify, 'id', {}, 'segment');
      });

      it('should camel case custom props', function() {
        analytics.identify('id', {
          name: 'Abc123',
          email: 'example@pizza.com',
          'First name': 'Steven',
          lastName: 'Brown'
        });
        analytics.called(
          window.FS.identify,
          'id',
          {
            displayName: 'Abc123',
            email: 'example@pizza.com',
            firstName: 'Steven',
            lastName: 'Brown'
          },
          'segment'
        );
      });

      it('should map name and email', function() {
        analytics.identify('id', { name: 'Test', email: 'test@test.com' });
        analytics.called(
          window.FS.identify,
          'id',
          { displayName: 'Test', email: 'test@test.com' },
          'segment'
        );
      });

      it('should respect existing type tags', function() {
        analytics.identify('id3', {
          my_real: 17,
          my_int_str: 17,
          my_str_int: 'foo',
          my_int_date: 3,
          my_int_bool: 4,
          mystr_real: 'plugh',
          my_reals: [17],
          my_int_strs: [17],
          my_str_ints: ['foo'],
          my_int_dates: [3],
          my_int_bools: [4],
          mystr_reals: ['plugh']
        });
        analytics.called(
          window.FS.identify,
          'id3',
          {
            my_real: 17, // didn't become my_real_real (double tag)
            myInt_str: 17, // all other tests check type mismatch isn't
            myStr_int: 'foo', // "fixed" to e.g. myInt_str_int, but keeps
            myInt_date: 3, // the user's tag (and their mismatch error)
            myInt_bool: 4,
            mystr_real: 'plugh',
            my_reals: [17],
            myInt_strs: [17],
            myStr_ints: ['foo'],
            myInt_dates: [3],
            myInt_bools: [4],
            mystr_reals: ['plugh']
          },
          'segment'
        );
      });
    });

    describe('#track', function() {
      beforeEach(function() {
        analytics.stub(window.FS, 'event');
      });

      it('should send track event name and properties', function() {
        analytics.track('foo', { some_field: 'field_value' });
        analytics.called(
          window.FS.event,
          'foo',
          { some_field: 'field_value' },
          'segment'
        );
      });
    });

    describe('#page', function() {
      beforeEach(function() {
        analytics.stub(window.FS, 'event');
      });

      it('should not track unnamed pages by default', function() {
        analytics.page();
        analytics.didNotCall(window.FS.event);
      });

      it('should track unnamed pages if enabled', function() {
        fullstory.options.trackAllPages = true;
        analytics.page();
        analytics.called(window.FS.event, 'Loaded a Page');
      });

      it('should not track named pages by default', function() {
        analytics.page('Name');
        analytics.didNotCall(window.FS.event);
      });

      it('should track named pages if enabled', function() {
        fullstory.options.trackNamedPages = true;
        analytics.page('Name');
        analytics.called(window.FS.event, 'Viewed Name Page');
      });

      it('should not track categorized pages by default', function() {
        analytics.page('Category', 'Name');
        analytics.didNotCall(window.FS.event);
      });

      it('should track categorized pages if enabled', function() {
        fullstory.options.trackCategorizedPages = true;
        analytics.page('Category', 'Name');
        analytics.called(window.FS.event, 'Viewed Category Page');
      });
    });
  });
});