Merge pull request guardian#3996 from guardian/rm/more-telemetry

Add telemetry to 'free only' and 'uploaded by me' filters

Author: rhystmills

kahuna/public/js/search/query.js

@@ -11,6 +11,7 @@ import {guDateRange} from '../components/gu-date-range/gu-date-range';
 import template from './query.html';
 import {syntax} from './syntax/syntax';
 import {grStructuredQuery} from './structured-query/structured-query';
+import { sendTelemetryForQuery } from '../services/telemetry';
 
 export var query = angular.module('kahuna.search.query', [
     // Note: temporarily disabled for performance reasons, see above
@@ -180,6 +181,9 @@ query.controller('SearchQueryCtrl', [
           Object.assign(filter, {nonFree: newNonFree, uploadedByMe: false, uploadedBy: undefined});
         }
 
+        const { nonFree, uploadedByMe } = ctrl.filter;
+        sendTelemetryForQuery(ctrl.filter.query, nonFree, uploadedByMe);
+
         $state.go('search.results', filter);
     }));
 
@@ -229,6 +233,9 @@ query.controller('SearchQueryCtrl', [
     function resetQuery() {
         ctrl.filter.query = undefined;
     }
+
+    const { nonFree, uploadedByMe } = ctrl.filter;
+    sendTelemetryForQuery(ctrl.filter.query, nonFree, uploadedByMe);
 }]);
 
 query.directive('searchQuery', [function() {

kahuna/public/js/search/structured-query/structured-query.js

@@ -1,6 +1,5 @@
 import angular from 'angular';
 import Rx from 'rx';
-import { v4 } from 'uuid';
 
 import './structured-query.css';
 
@@ -10,7 +9,6 @@ import {rxUtil} from '../../util/rx';
 
 import {querySuggestions, filterFields} from './query-suggestions';
 import {renderQuery, structureQuery} from './syntax';
-import { sendTelemetryEvent } from '../../services/telemetry';
 
 export const grStructuredQuery = angular.module('gr.structuredQuery', [
     rxUtil.name,
@@ -69,21 +67,6 @@ grStructuredQuery.directive('grStructuredQuery', ['subscribe$', function(subscri
 
             subscribe$(scope, ctrl.newQuery$, query => {
                 ngModelCtrl.$setViewValue(query);
-                const structuredQuery = structureQuery(query);
-                const searchUuid = v4();
-                structuredQuery.forEach(queryComponent => {
-                    // e.g. filter or search:
-                    // search > {type: 'text', value: 'my search'}
-                    // filter > {type: 'filter', filterType: 'inclusion', key: 'is', value: 'cool'}
-                    const { type } = queryComponent;
-                    const formattedType = (type) => {
-                        if (type === 'text') { return 'GRID_SEARCH'; }
-                        if (type === 'filter') { return 'GRID_FILTER'; }
-                        return `GRID_${type.toUpperCase()}`;
-                    };
-                    // In case search is empty, as with a search containing only filters
-                    sendTelemetryEvent(formattedType(type), {...queryComponent, searchUuid: searchUuid}, 1);
-                });
             });
         }
     };

kahuna/public/js/services/telemetry.ts

@@ -1,5 +1,6 @@
 import {UserTelemetryEventSender, IUserTelemetryEvent} from '@guardian/user-telemetry-client';
 import { v4 } from 'uuid';
+import { structureQuery } from '../search/structured-query/syntax';
 
 const getStoredId = (storage: Storage, key: string): string => {
     const maybeId = storage.getItem(key);
@@ -37,3 +38,47 @@ export const sendTelemetryEvent = (type: string, tags?: IUserTelemetryEvent["tag
         tags: {...tags, browserUuid: getBrowserId(), sessionUuid: getSessionId()}
     });
 };
+
+const sendFilterTelemetryEvent = (key: string, value: string, searchUuid: string) => {
+    sendTelemetryEvent('GRID_FILTER', {
+        type: 'filter',
+        filterType: 'inclusion',
+        key: key,
+        value: value,
+        searchUuid: searchUuid
+    }, 1);
+};
+
+export const sendTelemetryForQuery = (query: string, nonFree?: boolean | string, uploadedByMe?: boolean ) => {
+    const structuredQuery = structureQuery(query);
+    const searchUuid = v4();
+    // nonFree is unfortunately either a boolean, stringified boolean, or undefined
+    const freeToUseOnly = (!(nonFree === 'true' || nonFree === true));
+    const uploadedByMeOnly = (uploadedByMe);
+
+    // Only log for true - matching how these filters work in Grid (only applied when true)
+    if (freeToUseOnly) {
+        sendFilterTelemetryEvent('freeToUseOnly', 'true', searchUuid);
+    }
+    if (uploadedByMeOnly) {
+        sendFilterTelemetryEvent('uploadedByMeOnly', 'true', searchUuid);
+    }
+
+    structuredQuery.forEach(queryComponent => {
+        // e.g. filter or search:
+        // search > {type: 'text', value: 'my search'}
+        // filter > {type: 'filter', filterType: 'inclusion', key: 'is', value: 'cool'}
+        const { type } = queryComponent;
+        const formattedType = (type: string) => {
+            if (type === 'text') { return 'GRID_SEARCH'; }
+            if (type === 'filter') { return 'GRID_FILTER'; }
+            return `GRID_${type.toUpperCase()}`;
+        };
+
+        // In case search is empty, as with a search containing only filters
+        sendTelemetryEvent(formattedType(type), {
+            ...queryComponent,
+            searchUuid: searchUuid
+        }, 1);
+    });
+};