Test telemetry

packages/cli/test/telemetry.test.js

@@ -0,0 +1,116 @@
+'use strict';
+
+require('./setup');
+
+import fs from 'fs-extra';
+import sinon from 'sinon';
+import firebase from 'firebase/app';
+import inquirer from 'inquirer';
+import 'firebase/auth';
+import 'firebase/firestore';
+
+import Telemetry from '../src/telemetry'
+import ProjectFile from '../src/models/files/ProjectFile';
+
+describe.only('telemetry', function() {
+  beforeEach('stub fs-extra functions', function() {
+    this.readJsonStub = sinon.stub(fs, 'readJson').returns({ catch: () => undefined })
+    this.ensureDirStub = sinon.stub(fs, 'ensureDir')
+    this.writeJsonStub = sinon.stub(fs, 'writeJson')
+  });
+
+  afterEach('restore stubs', function() {
+    sinon.restore();
+  });
+
+  describe('#report', function() {
+    beforeEach('stubs sendToFirebase', async function() {
+      this.sendToFirebase = sinon.stub(Telemetry, 'sendToFirebase');
+    });
+
+    context('when interactive mode is not activated', function() {
+      it('does not call sendToFirebase function', async function() {
+        await Telemetry.report('create', {}, false);
+        expect(this.sendToFirebase.getCall(0)).to.be.null;
+      });
+    });
+
+    context('when interactive mode is activated', function() {
+      context('when neither local nor global options are set', function() {
+        context('when the user answers no to telemetry prompt', function() {
+          beforeEach(async function() {
+            this.inquirerPrompt = sinon.stub(inquirer, 'prompt').returns({ telemetry: false });
+          });
+
+          it('does not call sendToFirebase function', async function() {
+            await Telemetry.report('create', {}, true);
+            expect(this.sendToFirebase.getCall(0)).to.be.null;
+          });
+        });
+
+        context('when the user answers yes to telemetry prompt', function() {
+          beforeEach(async function() {
+            this.inquirerPrompt = sinon.stub(inquirer, 'prompt').returns({ telemetry: true });
+          });
+
+          it('prompts for telemetry', async function() {
+            await Telemetry.report('create', {}, true);
+            this.inquirerPrompt.calledOnce.should.be.true
+          });
+
+          it('writes the global file with salt and uuid', async function() {
+            await Telemetry.report('create', {}, true);
+            const [firstArg, secondArg] = this.writeJsonStub.getCall(0).args;
+
+            firstArg.should.match(/telemetry.json/);
+            secondArg.optIn.should.be.true;
+            secondArg.uuid.should.match(/^[a-f0-9\-]+$/);
+            secondArg.salt.should.match(/^[a-f0-9]+$/);
+          });
+
+          describe('sendToFirebase function call', function() {
+            before(function() {
+              this.commandData = { 
+                stringField: 'foo', 
+                numberField: 3,
+                objectField: { stringField: 'foo', arrayField: [1, 2, 3] },
+              };
+            });
+
+            context('when a non-development network is specified', function() {
+              it('conceals all options recursively except for the network name', async function() {
+                await Telemetry.report('create', { network: 'ropsten', ...this.commandData }, true);
+                const [_, commandData] = this.sendToFirebase.getCall(0).args;
+
+                commandData.name.should.eq('create');
+                commandData.network.should.eq('ropsten');
+                shouldConcealOptions(commandData.options);
+              });
+            });
+
+            context('when a dev network is specified', function() {
+              it('changes the network name to development', async function() {
+                await Telemetry.report('create', { network: 'dev-209384093', ...this.commandData }, true);
+                const [_, commandData] = this.sendToFirebase.getCall(0).args;
+
+                commandData.name.should.eq('create');
+                commandData.network.should.eq('development');
+                shouldConcealOptions(commandData.options);
+              });
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
+function shouldConcealOptions(options) {
+  options.stringField.should.match(/^[a-f0-9]{64}$/);
+  options.numberField.should.match(/^[a-f0-9]{64}$/);
+  options.objectField.stringField.should.match(/^[a-f0-9]{64}$/);
+  options.objectField.arrayField[0].should.match(/^[a-f0-9]{64}$/);
+  options.objectField.arrayField[1].should.match(/^[a-f0-9]{64}$/);
+  options.objectField.arrayField[2].should.match(/^[a-f0-9]{64}$/);
+}
+