Merge pull request #168 from keen/apryka-disable-tracking-option

disable tracking option

Author: apryka

README.md

@@ -524,6 +524,37 @@ Read more:
 - [How not to use Cassandra](https://opencredo.com/how-not-to-use-cassandra-like-an-rdbms-and-what-will-happen-if-you-do/)
 ---
 
+### Tracking Opt-Out
+
+It's easy to build tracking opt-out functionality. If opt-out is set to true no data is recorded.
+
+You can set up opt-out by defining client instance
+
+```javascript
+const client = new KeenTracking({
+  projectId: 'PROJECT_ID',
+  writeKey: 'WRITE_KEY',
+  optOut: true
+});
+```
+
+or by invoking `client.setOptOut(true)` method
+
+```javascript
+client.setOptOut(true);
+```
+
+**Note:** The user can block tracking in the browser by [doNotTrack](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/doNotTrack) setting. We can respect or overwrite this setting by defining client instance
+```javascript
+const client = new KeenTracking({
+  projectId: 'PROJECT_ID',
+  writeKey: 'WRITE_KEY',
+  respectDoNotTrack: true // it's false by default
+});
+```
+
+---
+
 ### Contributing
 
 This is an open source project and we love involvement from the community! Hit us up with pull requests and issues.

dist/keen-tracking.js

@@ -28,6 +28,7 @@ import { cookie } from './utils/cookie';
 import { deepExtend } from './utils/deepExtend';
 import { serializeForm } from './utils/serializeForm';
 import { timer } from './utils/timer';
+import { setOptOut } from './utils/optOut';
 
 // ------------------------
 // Methods
@@ -42,7 +43,8 @@ extend(KeenCore.prototype, {
   deferEvents,
   queueCapacity,
   queueInterval,
-  recordDeferredEvents
+  recordDeferredEvents,
+  setOptOut
 });
 extend(KeenCore.prototype, {
   extendEvent,
@@ -99,6 +101,15 @@ if (typeof webpackKeenGlobals !== 'undefined') {
   keenGlobals = webpackKeenGlobals;
 }
 
+if (localStorage && localStorage.getItem('optout')) {
+  KeenCore.optedOut = true;
+}
+
+if (getBrowserProfile().doNotTrack === '1'
+  || getBrowserProfile().doNotTrack === 'yes') {
+  KeenCore.doNotTrack = true;
+}
+
 export const Keen = KeenCore.extendLibrary(KeenCore); // deprecated, left for backward compatibility
 export const KeenTracking = Keen;
 export default Keen;

dist/keen-tracking.js.map

@@ -12,6 +12,7 @@ export function getBrowserProfile() {
     'platform'   : navigator.platform,
     'useragent'  : navigator.userAgent,
     'version'    : navigator.appVersion,
+    'doNotTrack' : navigator.doNotTrack,
     'screen'     : getScreenProfile(),
     'window'     : getWindowProfile()
   }

dist/keen-tracking.min.js.map

@@ -1,7 +1,8 @@
 import KeenCore from 'keen-core';
 import each from 'keen-core/lib/utils/each';
 import extend from 'keen-core/lib/utils/extend';
-import { queue } from'./utils/queue';
+import { queue } from './utils/queue';
+import { setOptOut } from './utils/optOut';
 import pkg from '../package.json';
 
 KeenCore.helpers = KeenCore.helpers || {};
@@ -13,6 +14,16 @@ KeenCore.on('client', function(client){
     events: [],
     collections: {}
   };
+  
+  if (!client.config.respectDoNotTrack) {
+    this.doNotTrack = false;
+  }
+
+  if (typeof client.config.optOut !== 'undefined') {
+    setOptOut(client.config.optOut);
+    this.optedOut = client.config.optOut;
+  }
+  
   client.queue = queue(client.config.queue);
   client.queue.on('flush', function(){
     client.recordDeferredEvents();

lib/browser.js

@@ -69,12 +69,26 @@ export function recordEvent(eventCollectionOrConfigObject, eventBody, callback){
   }
 
   this.emit('recordEvent', eventCollection, extendedEventsHash);
-
+  
   if (!Keen.enabled) {
     handleValidationError.call(this, 'Keen.enabled is set to false.', callback);
     return false;
   }
 
+  if (Keen.optedOut) {
+    return Promise.resolve({
+      created: false,
+      message: 'Keen.optedOut is set to true.'
+    })
+  }
+
+  if (Keen.doNotTrack) {
+    return Promise.resolve({
+      created: false,
+      message: 'Keen.doNotTrack is set to true.'
+    })
+  }
+
   return send.call(this, { url, extendedEventsHash, callback, configObject, eventCollection });
 }
 
@@ -129,6 +143,20 @@ export function recordEvents(eventsHash, callback){
     return false;
   }
 
+  if (Keen.optedOut) {
+    return Promise.resolve({
+      created: false,
+      message: 'Keen.optedOut is set to true.'
+    })
+  }
+
+  if (Keen.doNotTrack) {
+    return Promise.resolve({
+      created: false,
+      message: 'Keen.doNotTrack is set to true.'
+    })
+  }
+
   return send.call(this, { url, extendedEventsHash, callback });
 }
 

lib/helpers/getBrowserProfile.js

@@ -0,0 +1,8 @@
+export function setOptOut(optOut = true) {
+    if (optOut) {
+        localStorage.setItem('optout', optOut);
+        return;
+    }
+
+    localStorage.removeItem('optout');
+};

lib/index.js

@@ -9,5 +9,14 @@ global.IntersectionObserver.prototype.simulate = function(elements){
 global.navigator = {
   sendBeacon: jest.mock()
 };
+const mockStorage = {};
+const localStorage = {
+  setItem: (key, val) => Object.assign(mockStorage, {[key]: val}),
+  getItem: key => mockStorage[key],
+  removeItem: key => { delete mockStorage[key]; },
+  clear: () => mockStorage,
+};
+global.localStorage = localStorage;
+
 jest.mock('promise-polyfill', () => {});
 jest.mock('promise-polyfill/src/polyfill', () => {});