@jetbrains/ring-ui 4.1.3 → 5.0.0-beta.0

package/components/analytics/analytics.test.js

@@ -1,419 +0,0 @@
-import analytics from './analytics';
-import AnalyticsGAPlugin from './analytics__ga-plugin';
-import AnalyticsFUSPlugin from './analytics__fus-plugin';
-import AnalyticsCustomPlugin from './analytics__custom-plugin';
-
-const Analytics = analytics.constructor;
-const TICK_INTERVAL = 10500;
-const MAX_PACK_SIZE = 100;
-const FLUSH_INTERVAL = 10000;
-
-describe('Analytics', () => {
-  it('should be created', () => {
-    analytics.should.exist;
-  });
-
-  it('should export correct interface', () => {
-    analytics.trackPageView.should.exist;
-    analytics.trackEvent.should.exist;
-    analytics.trackShortcutEvent.should.exist;
-    analytics.trackEntityProperties.should.exist;
-    analytics.track.should.exist;
-  });
-
-  describe('ga plugin', () => {
-    let gaPlugin;
-
-    beforeEach(() => {
-      Reflect.deleteProperty(window, 'ga');
-      gaPlugin = new AnalyticsGAPlugin('SOME-ID');
-    });
-
-    it('should init ga', () => {
-      window.ga.should.exist;
-    });
-
-    it('should export interface', () => {
-      gaPlugin.trackPageView.should.exist;
-      gaPlugin.trackEvent.should.exist;
-    });
-
-    it('should send pageview event', () => {
-      const rememberGA = window.ga;
-      window.ga = sandbox.spy();
-      gaPlugin.trackPageView('some-path');
-
-      window.ga.should.have.been.calledWith('send', 'pageview', 'some-path');
-
-      window.ga = rememberGA;
-    });
-
-    it('should send action event', () => {
-      const rememberGA = window.ga;
-      window.ga = sandbox.spy();
-      gaPlugin.trackEvent('some-category', 'some-action');
-
-      window.ga.should.calledWith('send', 'event', {
-        eventCategory: 'some-category',
-        eventAction: 'some-action'
-      });
-
-      window.ga = rememberGA;
-    });
-  });
-
-  describe('ga plugin with no key and in non-development mode', () => {
-    let gaPlugin;
-
-    beforeEach(() => {
-      Reflect.deleteProperty(window, 'ga');
-      gaPlugin = new AnalyticsGAPlugin();
-    });
-
-    it('should not init ga', () => {
-      should.not.exist(window.ga);
-      gaPlugin.trackEvent.should.be.an.instanceof(Function);
-      gaPlugin.trackPageView.should.be.an.instanceof(Function);
-    });
-  });
-
-  describe('fus plugin', () => {
-    let fusPlugin;
-
-    beforeEach(() => {
-      Reflect.deleteProperty(window, 'fus');
-      fusPlugin = new AnalyticsFUSPlugin({
-        productId: 'YTD',
-        productBuild: '2020.1.3',
-        recorderVersion: 1,
-        groups: [{
-          id: 'ring.page.view',
-          version: '1',
-          baseline: 'registered'
-        }, {
-          id: 'yt.issue.view',
-          version: '1',
-          baseline: 'registered'
-        }]
-      });
-    });
-
-    it('should init fus', () => {
-      window.fusra.should.exist;
-    });
-
-    it('should export interface', () => {
-      fusPlugin.trackPageView.should.exist;
-      fusPlugin.trackEvent.should.exist;
-    });
-
-    it('should send pageview event', () => {
-      const rememberFUSra = window.fusra;
-      window.fusra = sandbox.spy();
-      fusPlugin.trackPageView('issues');
-
-      window.fusra.should.have.been.calledWith('event', {
-        groupId: 'ring.page.view',
-        groupVersion: '1',
-        eventId: 'open',
-        eventData: {
-          path: 'issues',
-          browser: sinon.match.any,
-          lang: sinon.match.any,
-          'page-view-duration': sinon.match.any,
-          'pixel-ratio': sinon.match.any,
-          platform: sinon.match.any,
-          screen: sinon.match.any
-        }
-      });
-
-      window.fusra = rememberFUSra;
-    });
-
-    it('should send action event', () => {
-      const rememberGA = window.fusra;
-      window.fusra = sandbox.spy();
-      fusPlugin.trackEvent('yt-issue-view', 'open', {demo: true});
-
-      window.fusra.should.calledWith('event', {
-        groupId: 'yt.issue.view',
-        groupVersion: '1',
-        eventId: 'open',
-        eventData: {demo: true}
-      });
-
-      window.fusra = rememberGA;
-    });
-
-    it('should not send event which was not mentioned in groups', () => {
-      const rememberFUSra = window.fusra;
-      window.fusra = sandbox.spy();
-      fusPlugin.trackEvent('some-category', 'some-action');
-
-      window.fusra.should.not.have.been.called;
-
-      window.fusra = rememberFUSra;
-    });
-  });
-
-  describe('tracking events', () => {
-    let send;
-    let clock;
-    let analyticsInstance;
-    beforeEach(() => {
-      send = sandbox.spy();
-      clock = sandbox.useFakeTimers({toFake: ['setInterval']});
-      analyticsInstance = new Analytics();
-    });
-
-    describe('#enabled', () => {
-
-      let customPlugin;
-      beforeEach(() => {
-        customPlugin = new AnalyticsCustomPlugin(send);
-        analyticsInstance.config([customPlugin]);
-      });
-
-      it('should send request to statistics server on tracking event', () => {
-        analyticsInstance.trackEvent('test-category', 'test-action');
-        clock.tick(TICK_INTERVAL);
-
-        send.should.have.been.calledWith([{
-          category: 'test-category',
-          action: 'test-action'
-        }]);
-      });
-
-      it('should support configuration via method config', () => {
-        const flushingFunction = sandbox.spy();
-        customPlugin.config({
-          send: flushingFunction
-        });
-
-        analyticsInstance.trackEvent('test-category', 'test-action');
-        clock.tick(TICK_INTERVAL);
-
-        send.should.not.have.been.called;
-        flushingFunction.should.have.been.calledWith([{
-          category: 'test-category',
-          action: 'test-action'
-        }]);
-      });
-
-      it('should send request on achieving max pack size', () => {
-        for (let i = 0; i < MAX_PACK_SIZE - 1; ++i) {
-          analyticsInstance.trackEvent(`test-category-${i}`, 'test-action');
-        }
-        customPlugin._data.length.should.equal(MAX_PACK_SIZE - 1);
-
-        analyticsInstance.trackEvent('test-category-100', 'test-action');
-
-        send.should.have.been.called;
-        customPlugin._data.length.should.equal(0);
-      });
-
-      it('should configure max pack size via config', () => {
-        customPlugin.config({
-          send,
-          flushMaxPackSize: MAX_PACK_SIZE + 2
-        });
-
-        for (let i = 0; i < MAX_PACK_SIZE + 1; ++i) {
-          analyticsInstance.trackEvent(`test-category-${i}`, 'test-action');
-        }
-        customPlugin._data.length.should.equal(MAX_PACK_SIZE + 1);
-
-        analyticsInstance.trackEvent('test-category-102', 'test-action');
-
-        send.should.have.been.called;
-        customPlugin._data.length.should.equal(0);
-      });
-
-      it('should remove prohibited symbols', () => {
-        analyticsInstance.trackEvent('t/\\est-c,ate:gory*?', 't/\\est-a,ct:ion*?');
-        clock.tick(TICK_INTERVAL);
-
-        send.should.have.been.calledWith([{
-          category: 't_est-c_ate_gory_',
-          action: 't/_est-a_ct_ion_'
-        }]);
-      });
-
-      it('should track event with additional information', () => {
-        analyticsInstance.trackEvent('test-category', 'test-action', {type: 'test-type'});
-        clock.tick(TICK_INTERVAL);
-
-        send.should.have.been.calledWith([{
-          category: 'test-category',
-          action: 'test-action'
-        }, {
-          category: 'test-category',
-          action: 'test-action__type$test-type'
-        }]);
-      });
-
-      it('should send two events to statistics server on tracking shortcut event', () => {
-        analyticsInstance.trackShortcutEvent('test-category', 'test-action');
-        clock.tick(TICK_INTERVAL);
-
-        send.should.have.been.calledWith([{
-          category: 'test-category',
-          action: 'test-action'
-        }, {
-          category: 'ring-shortcut',
-          action: 'test-category$test-action'
-        }]);
-      });
-
-      describe('trackEntityProperties', () => {
-        it(
-          'should send all enumerated properties to statistics server on tracking entity',
-          () => {
-            const entity = {
-              param1: 'first',
-              param2: 'second',
-              param3: 'third',
-              param4: 'fourth',
-              param5: 'should-be-ignored'
-            };
-            const trackedProperties = ['param1', 'param2', 'param3', 'param4'];
-            analyticsInstance.trackEntityProperties('sample-entity', entity, trackedProperties);
-            clock.tick(TICK_INTERVAL);
-
-            const trackedData = [];
-            trackedProperties.forEach(it => {
-              trackedData.push({
-                category: 'sample-entity',
-                action: `${it}__${entity[it]}`
-              });
-            });
-            send.should.have.been.calledWith(trackedData);
-          }
-        );
-
-        it('should not send any data if no properties requested', () => {
-          const entity = {
-            param1: 'first',
-            param2: 'second'
-          };
-          analyticsInstance.trackEntityProperties('sample-entity', entity, []);
-          clock.tick(TICK_INTERVAL);
-
-          send.should.not.have.been.called;
-        });
-
-        it('should not throw error if there are no some properties', () => {
-          const entity = {
-            param1: 'first',
-            param2: 'second'
-          };
-          analyticsInstance.
-            trackEntityProperties('entity', entity, ['param1', 'nonexistent-property']);
-          clock.tick(TICK_INTERVAL);
-
-          send.should.have.been.calledWith([{
-            category: 'entity',
-            action: 'param1__first'
-          }, {
-            category: 'entity',
-            action: 'nonexistent-property__no-value'
-          }]);
-        });
-
-        it('should work with subproperties', () => {
-          const entity = {
-            property: {
-              subproperty1: 'subproperty1-value',
-              subproperty2: {
-                subsubproperty: 'subsubproperty-value'
-              }
-            },
-            param2: 'second'
-          };
-          const trackedProperties = [
-            'property.subproperty2.subsubproperty',
-            'property.subproperty3.nonexistent'
-          ];
-          analyticsInstance.trackEntityProperties('entity', entity, trackedProperties);
-          clock.tick(TICK_INTERVAL);
-
-          send.should.have.been.calledWith([{
-            category: 'entity',
-            action: 'property-subproperty2-subsubproperty__subsubproperty-value'
-          }, {
-            category: 'entity',
-            action: 'property-subproperty3-nonexistent__no-value'
-          }]);
-        });
-      });
-
-      it('should send request to statistics server on page view', () => {
-        analyticsInstance.trackPageView('test-page');
-        clock.tick(TICK_INTERVAL);
-
-        send.should.have.been.called;
-      });
-
-      it('should send request to statistics server multiple times', () => {
-        //first loop
-        analyticsInstance.trackPageView('test-page');
-        clock.tick(TICK_INTERVAL);
-        send.should.have.been.called;
-
-        //second loop
-        analyticsInstance.trackEvent('test-category', 'test-event');
-        analyticsInstance.trackEvent('test-category-2', 'test-event-2');
-        clock.tick(TICK_INTERVAL);
-        send.should.calledWith([{
-          category: 'test-category',
-          action: 'test-event'
-        }, {
-          category: 'test-category-2',
-          action: 'test-event-2'
-        }
-        ]);
-      });
-
-      describe('flushing restriction', () => {
-        it('flushing should be allowed on second step', () => {
-          let counter = 0;
-          function flushingIsAllowedOnSecondCheck() {
-            ++counter;
-            return counter === 2;
-          }
-
-          customPlugin = new AnalyticsCustomPlugin(
-            send,
-            false,
-            FLUSH_INTERVAL,
-            flushingIsAllowedOnSecondCheck
-          );
-          analyticsInstance.config([customPlugin]);
-
-          analyticsInstance.trackEvent('test-category', 'test-action');
-          clock.tick(TICK_INTERVAL);
-
-          send.should.not.have.been.called;
-          clock.tick(TICK_INTERVAL);
-
-          send.should.have.been.calledWith([{
-            category: 'test-category',
-            action: 'test-action'
-          }]);
-        });
-      });
-    });
-    describe('#disabled', () => {
-      beforeEach(() => {
-        analyticsInstance.config([]);
-      });
-
-      it('should not send request to statistics server', () => {
-        analyticsInstance.trackEvent('test-category', 'test-action');
-        clock.tick(TICK_INTERVAL);
-
-        send.should.not.have.been.called;
-      });
-    });
-  });
-});

package/components/analytics/analytics__custom-plugin.js

@@ -1,122 +0,0 @@
-import AnalyticsPluginUtils from './analytics__plugin-utils';
-
-const DEFAULT_FLUSH_INTERVAL = 10000;
-const DEFAULT_FLUSH_MAX_PACK_SIZE = 100;
-
-export default class AnalyticsCustomPlugin {
-  constructor(send, isDevelopment, flushInterval, flushingAllowedChecker) {
-    this._data = [];
-    this.config({
-      send,
-      isDevelopment,
-      flushInterval,
-      flushingAllowedChecker
-    });
-  }
-
-  /**
-   * @param config
-   * @property {function} config.send
-   * @property {boolean} config.isDevelopment
-   * @property {number} config.flushInterval
-   * @property {function} config.flushingAllowedChecker
-   * @property {number} config.flushMaxPackSize
-   */
-  config(config) {
-    let checkFlushingAllowed = config.flushingAllowedChecker;
-    if (typeof checkFlushingAllowed !== 'function') {
-      checkFlushingAllowed = () => true;
-    }
-
-    this._flush = () => {
-      if (this._data.length > 0 && checkFlushingAllowed()) {
-        config.send(this._data);
-        this._data = [];
-      }
-    };
-
-    this._isDevelopment = config.isDevelopment;
-    this._flushInterval = config.flushInterval || DEFAULT_FLUSH_INTERVAL;
-    this._flushMaxPackSize = config.flushMaxPackSize || DEFAULT_FLUSH_MAX_PACK_SIZE;
-  }
-
-  trackEvent(category, action) {
-    this._processEvent(category, action);
-  }
-
-  trackPageView(path) {
-    if (this._lastPagePath === path) {
-      return;
-    }
-
-    this._trackPageViewAdditionalInfo(path);
-    this._processEvent('ring-page', path);
-    this._processEvent(
-      'ring-navigator_user-agent',
-      AnalyticsPluginUtils.getUserAgentPresentation()
-    );
-    this._processEvent(
-      'ring-navigator_platform',
-      AnalyticsPluginUtils.npeSaveLowerCase(navigator.platform)
-    );
-    this._processEvent(
-      'ring-navigator_lang',
-      AnalyticsPluginUtils.npeSaveLowerCase(navigator.language)
-    );
-    this._processEvent(
-      'ring-device-pixel-ratio',
-      AnalyticsPluginUtils.getDevicePixelRatioPresentation()
-    );
-    this._processEvent(
-      'ring-screen-width',
-      AnalyticsPluginUtils.getScreenWidthPresentation()
-    );
-  }
-
-  _initSendSchedule() {
-    window.addEventListener('beforeunload', () => {
-      this._trackPageViewAdditionalInfo();
-      return this._flush();
-    });
-
-    setInterval(this._flush, this._flushInterval);
-    this._hasSendSchedule = true;
-  }
-
-  _processEvent(rawCategory, rawAction) {
-    if (!this._hasSendSchedule && this._flush) {
-      this._initSendSchedule();
-    }
-    const category = AnalyticsPluginUtils.reformatString(rawCategory, true);
-    const action = AnalyticsPluginUtils.reformatString(rawAction);
-    if (this._isDevelopment) {
-      console.log('TRACKING DATA = ', category, action); // eslint-disable-line no-console
-    }
-    this._addDataToFlushingPack({category, action});
-  }
-
-  _trackPageViewAdditionalInfo(newPagePath) {
-    const currentTime = (new Date()).getTime();
-    if (this._lastPagePath) {
-      if (this._lastPageViewTime) {
-        const duration = AnalyticsPluginUtils.
-          getPageViewDurationPresentation(currentTime - this._lastPageViewTime);
-        this._processEvent(`ring-pageview-duration_${this._lastPagePath}`, duration);
-      }
-    }
-    this._lastPageViewTime = currentTime;
-    this._lastPagePath = newPagePath;
-  }
-
-  _addDataToFlushingPack(sendingData) {
-    this._data.push(sendingData);
-
-    if (this._data.length >= this._flushMaxPackSize) {
-      this._flush();
-    }
-  }
-
-  get serializeAdditionalInfo() {
-    return true;
-  }
-}

package/components/analytics/analytics__fus-plugin.js

@@ -1,93 +0,0 @@
-import AnalyticsPluginUtils from './analytics__plugin-utils';
-
-/**
- * @name AnalyticsFUSPlugin
- *
- * @param * @param {{
- *   productId: string,
- *   productBuild: string,
- *   recorderVersion: string?,
- *   isDevelopment: boolean?,
- *   groups: object[]?
- * }} config
- * @constructor
- */
-export default class AnalyticsFUSPlugin {
-  constructor({
-    productId,
-    productBuild,
-    recorderVersion = '1',
-    isDevelopment = false,
-    groups = []
-  }) {
-    if (!productId && !isDevelopment) {
-      return;
-    }
-    ((i, s, o, g, r) => {
-      i[r] = i[r] || function addArgumentsToQueueForWaitingTheScriptLoading() {
-        (i[r].query = i[r].query || []).push(arguments);
-      };
-      const script = document.createElement(o);
-      script.async = true;
-      script.src = g;
-      const firstScript = document.getElementsByTagName(o)[0];
-      firstScript.parentNode.insertBefore(script, firstScript);
-    })(window, document, 'script', '//resources.jetbrains.com/storage/fus/api/fus-reporting-api.js', 'fusra');
-    /* global fusra */
-    fusra('init', {
-      recorderCode: productId,
-      recorderVersion,
-      productCode: productId,
-      productBuild,
-      internal: isDevelopment,
-      groups,
-      useForSubdomains: true
-    });
-
-    this._recorderVersion = recorderVersion;
-    this._groups = groups;
-  }
-
-  trackEvent(category, action, additionalInfo) {
-    this._processEvent(category, action, additionalInfo);
-  }
-
-  trackPageView(path) {
-    if (this._lastPagePath === path) {
-      return;
-    }
-
-    this._lastPagePath = path;
-
-    this._processEvent('ring.page.view', 'open', {
-      path,
-      browser: AnalyticsPluginUtils.getUserAgentPresentation(),
-      platform: AnalyticsPluginUtils.npeSaveLowerCase(navigator.platform),
-      lang: AnalyticsPluginUtils.npeSaveLowerCase(navigator.language),
-      ['page-view-duration']: AnalyticsPluginUtils.getPageViewDurationPresentation(),
-      ['pixel-ratio']: AnalyticsPluginUtils.getDevicePixelRatioPresentation(),
-      screen: AnalyticsPluginUtils.getScreenWidthPresentation()
-    });
-  }
-
-  get serializeAdditionalInfo() {
-    return false;
-  }
-
-  _processEvent(category, action, additionalInfo) {
-    const groupId = category.replace(/[-]/g, '.');
-
-    const group = (this._groups || []).filter(
-      currentGroup => currentGroup.id === groupId
-    )[0];
-
-    if (group && window.fusra) {
-      fusra('event', {
-        groupId,
-        groupVersion: group.version || this._recorderVersion,
-        eventId: action,
-        eventData: additionalInfo
-      });
-    }
-  }
-}

package/components/analytics/analytics__ga-plugin.js

@@ -1,53 +0,0 @@
-/**
- *
- * @param {string?} gaId Google Analytics ID (should be undefined in development)
- * @constructor
- */
-export default class AnalyticsGAPlugin {
-  constructor(gaId, isDevelopment, domain) {
-    if (!gaId && !isDevelopment) {
-      return;
-    }
-    ((i, s, o, g, r) => {
-      i.GoogleAnalyticsObject = r;
-      i[r] = i[r] || function addArgumentsToQueueForWaitingTheScriptLoading() {
-        (i[r].q = i[r].q || []).push(arguments);
-      };
-      i[r].l = 1 * new Date();
-      const a = s.createElement(o);
-      const m = s.getElementsByTagName(o)[0];
-      a.async = 1;
-      a.src = g;
-      m.parentNode.insertBefore(a, m);
-    })(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
-    /**
-     * UA-57284711-1 - ga key for development purpose
-     */
-    const key = gaId || 'UA-57284711-1';
-    /* global ga */
-    const gaCookieParams = domain ? {cookieDomain: domain} : {};
-    ga('create', key, (!gaId ? {cookieDomain: 'none'} : gaCookieParams));
-    ga('set', 'anonymizeIp', true);
-    ga('set', 'allowAdFeatures', false);
-  }
-
-  trackEvent(category, action) {
-    if (window.ga) {
-      const eventOptions = {
-        eventCategory: category,
-        eventAction: action
-      };
-      ga('send', 'event', eventOptions);
-    }
-  }
-
-  trackPageView(path) {
-    if (window.ga) {
-      ga('send', 'pageview', path);
-    }
-  }
-
-  get serializeAdditionalInfo() {
-    return true;
-  }
-}