ipfs · SgtPooki · Jan 27, 2023 · Dec 16, 2022 · Dec 16, 2022 · Dec 17, 2022
@@ -15,3 +15,6 @@
 /coverage
 /.nyc_output
 /add-on/manifest.json
+
+.DS_Store
+.vscode
@@ -726,5 +726,53 @@
   "page_landingWelcome_projects_title": {
     "message": "Related Projects",
     "description": "Projects section title (page_landingWelcome_projects_title)"
+  },
+  "option_header_telemetry": {
+    "message": "Telemetry",
+    "description": "A section header on the Preferences screen (option_header_telemetry)"
+  },
+  "option_telemetry_disclaimer": {
+    "message": "We're collecting minimal telemetry data to improve and prioritize our work. Please consent to the collection of these metrics to assist in our efforts!",
+    "description": "Disclaimer about telemetry collection in the telemetry section on the Preferences screen (option_telemetry_disclaimer)"
+  },
+  "option_telemetryGroupMinimal_title": {
+    "message": "Minimal metrics: session & companion views",
+    "description": "A title for the 'minimal' grouping of metrics we collect (option_telemetryGroupMinimal_title)"
+  },
+  "option_telemetryGroupMinimal_description": {
+    "message": "We send `session` and `view` events only if ipfs-companion is enabled and your browser is not idle.",
+    "description": "A description for the 'minimal' grouping of metrics we collect (option_telemetryGroupMinimal_description)"
+  },
+  "option_telemetryGroupMinimal_session_description": {
+    "message": "A `session` event - every 60 seconds.",
+    "description": "An explanation of the `session` telemetry we collect (option_telemetryGroupMinimal_session_description)"
+  },
+  "option_telemetryGroupMinimal_view_description": {
+    "message": "A `view` event - only for ipfs-companion pages.",
+    "description": "An explanation of the `session` telemetry we collect (option_telemetryGroupMinimal_session_description)"
+  },
+  "option_telemetryGroupMarketing_title": {
+    "message": "Marketing title",
+    "description": "A title for the 'marketing' grouping of metrics we collect (option_telemetryGroupMarketing_title)"
+  },
+  "option_telemetryGroupMarketing_description": {
+    "message": "Marketing description",
+    "description": "A description for the 'marketing' grouping of metrics we collect (option_telemetryGroupMarketing_description)"
+  },
+  "option_telemetryGroupPerformance_title": {
+    "message": "Performance title",
+    "description": "A title for the 'performance' grouping of metrics we collect (option_telemetryGroupPerformance_title)"
+  },
+  "option_telemetryGroupPerformance_description": {
+    "message": "Performance description",
+    "description": "A description for the 'performance' grouping of metrics we collect (option_telemetryGroupPerformance_description)"
+  },
+  "option_telemetryGroupTracking_title": {
+    "message": "Tracking title",
+    "description": "A title for the 'tracking' grouping of metrics we collect (option_telemetryGroupTracking_title)"
+  },
+  "option_telemetryGroupTracking_description": {
+    "message": "Tracking description",
+    "description": "A description for the 'tracking' grouping of metrics we collect (option_telemetryGroupTracking_description)"
   }
 }
@@ -2,3 +2,4 @@
 <meta charset="utf-8">
 <script src="/dist/bundles/ipfs.bundle.js"></script>
 <script src="/dist/bundles/backgroundPage.bundle.js"></script>
+<body></body>
@@ -6,13 +6,15 @@ import { onInstalled } from '../lib/on-installed.js'
 import { getUninstallURL } from '../lib/on-uninstalled.js'
 import { optionDefaults } from '../lib/options.js'
 import createIpfsCompanion from '../lib/ipfs-companion.js'
+import { trackView } from '../lib/telemetry.js'
 
 // register lifecycle hooks early, otherwise we miss first install event
 browser.runtime.onInstalled.addListener(onInstalled)
 browser.runtime.setUninstallURL(getUninstallURL(browser))
 
 // init add-on after all libs are loaded
 document.addEventListener('DOMContentLoaded', async () => {
+  trackView('background')
   // setting debug namespaces require page reload to get applied
   const debugNs = (await browser.storage.local.get({ logNamespaces: optionDefaults.logNamespaces })).logNamespaces
   if (debugNs !== localStorage.debug) {

@@ -1,6 +1,7 @@
 'use strict'
 /* eslint-env browser, webextensions */
 import browser from 'webextension-polyfill'
+import { trackView } from '../../lib/telemetry.js'
 
 export default function createWelcomePageStore (i18n, runtime) {
   return function welcomePageStore (state, emitter) {
@@ -9,6 +10,7 @@ export default function createWelcomePageStore (i18n, runtime) {
     state.webuiRootUrl = null
     let port
     emitter.on('DOMContentLoaded', async () => {
+      trackView('welcome')
       emitter.emit('render')
       port = runtime.connect({ name: 'browser-action-port' })
       port.onMessage.addListener(async (message) => {

@@ -23,6 +23,7 @@ import createRuntimeChecks from './runtime-checks.js'
 import { createContextMenus, findValueForContext, contextMenuCopyAddressAtPublicGw, contextMenuCopyRawCid, contextMenuCopyCanonicalAddress, contextMenuViewOnGateway, contextMenuCopyPermalink, contextMenuCopyCidAddress } from './context-menus.js'
 import { registerSubdomainProxy } from './http-proxy.js'
 import { runPendingOnInstallTasks } from './on-installed.js'
+import { handleConsentFromState, startSession, endSession } from './telemetry.js'
 const log = debug('ipfs-companion:main')
 log.error = debug('ipfs-companion:main:error')
 
@@ -33,6 +34,7 @@ export default async function init () {
   // INIT
   // ===================================================================
   let ipfs // ipfs-api instance
+  /** @type {ReturnType<initState>} */
   let state // avoid redundant API reads by utilizing local cache of various states
   let dnslinkResolver
   let ipfsPathValidator
@@ -57,6 +59,7 @@ export default async function init () {
     notify = createNotifier(getState)
 
     if (state.active) {
+      startSession()
       // It's ok for this to fail, node might be unavailable or mis-configured
       try {
         ipfs = await initIpfsClient(browser, state)
@@ -556,6 +559,7 @@ export default async function init () {
           await registerSubdomainProxy(getState, runtime)
           shouldRestartIpfsClient = true
           shouldStopIpfsClient = !state.active
+          state.active ? startSession() : endSession()
           break
         case 'ipfsNodeType':
           if (change.oldValue !== braveNodeType && change.newValue === braveNodeType) {
@@ -622,6 +626,7 @@ export default async function init () {
           break
       }
     }
+    handleConsentFromState(state)
 
     if ((state.active && shouldRestartIpfsClient) || shouldStopIpfsClient) {
       try {

@@ -3,6 +3,8 @@
 import { isIPv4, isIPv6 } from 'is-ip'
 import isFQDN from 'is-fqdn'
 
+// console.log('igniteMetrics: ', igniteMetrics)
+
 export const optionDefaults = Object.freeze({
   active: true, // global ON/OFF switch, overrides everything else
   ipfsNodeType: 'external',
@@ -31,7 +33,11 @@ export const optionDefaults = Object.freeze({
   importDir: '/ipfs-companion-imports/%Y-%M-%D_%h%m%s/',
   useLatestWebUI: false,
   dismissedUpdate: null,
-  openViaWebUI: true
+  openViaWebUI: true,
+  telemetryGroupMinimal: true,
+  telemetryGroupMarketing: false,
+  telemetryGroupPerformance: false,
+  telemetryGroupTracking: false
 })
 
 function buildDefaultIpfsNodeConfig () {

@@ -1,9 +1,34 @@
 'use strict'
 /* eslint-env browser, webextensions */
-
+// @ts-check
 import { safeURL, isHostname } from './options.js'
 
+/**
+ * @typedef {object} CompanionState
+ * @extends {typeof import('./options').optionDefaults}
+ * @property {number} peerCount
+ * @property {URL} pubGwURL
+ * @property {string} pubGwURLString
+ * @property {URL} pubSubdomainGwURL
+ * @property {string} pubSubdomainGwURLString
+ * @property {boolean} redirect
+ * @property {URL} apiURL
+ * @property {string} apiURLString
+ * @property {URL} gwURL
+ * @property {string} gwURLString
+ * @property {boolean|string} dnslinkPolicy
+ * @property {(url: string|URL) => boolean} activeIntegrations
+ * @property {boolean} localGwAvailable
+ * @property {string} webuiRootUrl
+ */
+
 export const offlinePeerCount = -1
+/**
+ *
+ * @param {typeof import('./options').optionDefaults} options
+ * @param {Partial<typeof import('./options').optionDefaults>} overrides
+ * @returns {CompanionState}
+ */
 export function initState (options, overrides) {
   // we store options and some pregenerated values to avoid async storage
   // reads and minimize performance impact on overall browsing experience

@@ -0,0 +1,60 @@
+
+import { MetricsProvider } from '@ipfs-shipyard/ignite-metrics/vanilla'
+
+let metricsProvider = null
+export function getMetricsProviderInstance () {
+  if (metricsProvider != null) {
+    return metricsProvider
+  }
+  metricsProvider = new MetricsProvider({ appKey: '393f72eb264c28a1b59973da1e0a3938d60dc38a', autoTrack: false })
+
+  return metricsProvider
+}
+
+/**
+ * @param {ReturnType<import('./state').initState>['options']} state
+ * @returns {string[]}
+ */
+function mapStateToConsent (stateOptions) {
+  const obj = {
+    minimal: stateOptions?.telemetryGroupMinimal || false,
+    marketing: stateOptions?.telemetryGroupMarketing || false,
+    performance: stateOptions?.telemetryGroupPerformance || false,
+    tracking: stateOptions?.telemetryGroupTracking || false
+  }
+
+  const enabledConsentGroups = Object.keys(obj).filter(key => obj[key] === true)
+  console.log('enabledConsentGroups: ', enabledConsentGroups)
+  return enabledConsentGroups
+}
+function logConsent () {
+  console.log('checkConsent(\'minimal\'): ', getMetricsProviderInstance().checkConsent('minimal'))
+  console.log('checkConsent(\'marketing\'): ', getMetricsProviderInstance().checkConsent('marketing'))
+  console.log('checkConsent(\'performance\'): ', getMetricsProviderInstance().checkConsent('performance'))
+  console.log('checkConsent(\'tracking\'): ', getMetricsProviderInstance().checkConsent('tracking'))
+}
+/**
+ *
+ * @param {ReturnType<import('./state')['initState']>} state
+ * @returns {void}
+ */
+export function handleConsentFromState (state) {
+  console.log('handleConsentFromState', state)
+  getMetricsProviderInstance().updateConsent(mapStateToConsent(state))
+  logConsent()
+}
+
+export function handleConsentUpdate (consent) {
+  console.log('handleConsentUpdate', consent)
+  getMetricsProviderInstance().updateConsent(consent)
+}
+
+// const ignoredViewsRegex = [/^ipfs:\/\/.*/]
+const ignoredViewsRegex = []
+export function trackView (view) {
+  console.log('trackView called for view: ', view)
+  getMetricsProviderInstance().metricsService.track_pageview(view, ignoredViewsRegex)
+}
+
+export const startSession = (...args) => getMetricsProviderInstance().startSession(...args)
+export const endSession = (...args) => getMetricsProviderInstance().endSession(...args)
@@ -0,0 +1,43 @@
+'use strict'
+/* eslint-env browser, webextensions */
+
+import browser from 'webextension-polyfill'
+import html from 'choo/html/index.js'
+import switchToggle from '../../pages/components/switch-toggle.js'
+
+export default function telemetryForm ({
+  onOptionChange,
+  ...stateOptions
+}) {
+  // const onTelemetryChange = (key) => {
+
+  // }
+  return html`
+    <form>
+      <fieldset class="mb3 pa1 pa4-ns pa3 bg-snow-muted charcoal">
+        <h2 class="ttu tracked f6 fw4 teal mt0-ns mb3-ns mb1 mt2 ">${browser.i18n.getMessage('option_header_telemetry')}</h2>
+        <div class="mb2">
+          <p>${browser.i18n.getMessage('option_telemetry_disclaimer')}</p>
+          <p>
+            <a class="link underline hover-aqua" href="https://github.com/ipfs/ipfs-gui/issues/125" target="_blank">
+              ${browser.i18n.getMessage('option_legend_readMore')}
+            </a>
+          </p>
+        </div>
+        <div class="flex-row-ns pb0-ns">
+          <label for="telemetryGroupMinimal">
+            <dl>
+              <dt>${browser.i18n.getMessage('option_telemetryGroupMinimal_title')}</dt>
+              <dd>
+                <p>${browser.i18n.getMessage('option_telemetryGroupMinimal_description')}</p>
+                <p>${browser.i18n.getMessage('option_telemetryGroupMinimal_session_description')}</p>
+                <p>${browser.i18n.getMessage('option_telemetryGroupMinimal_view_description')}</p>
+              </dd>
+            </dl>
+          </label>
+          <div class="self-center-ns">${switchToggle({ id: 'telemetryGroupMinimal', checked: stateOptions.telemetryGroupMinimal, onchange: onOptionChange('telemetryGroupMinimal') })}</div>
+        </div>
+      </fieldset>
+    </form>
+  `
+}
@@ -9,7 +9,9 @@ import dnslinkForm from './forms/dnslink-form.js'
 import gatewaysForm from './forms/gateways-form.js'
 import apiForm from './forms/api-form.js'
 import experimentsForm from './forms/experiments-form.js'
+import telemetryForm from './forms/telemetry-form.js'
 import resetForm from './forms/reset-form.js'
+import { trackView } from '../lib/telemetry.js'
 
 // Render the options page:
 // Passed current app `state` from the store and `emit`, a function to create
@@ -102,6 +104,13 @@ export default function optionsPage (state, emit) {
     logNamespaces: state.options.logNamespaces,
     onOptionChange
   })}
+  ${telemetryForm({
+    telemetryGroupMinimal: state.options.telemetryGroupMinimal,
+    telemetryGroupMarketing: state.options.telemetryGroupMarketing,
+    telemetryGroupPerformance: state.options.telemetryGroupPerformance,
+    telemetryGroupTracking: state.options.telemetryGroupTracking,
+    onOptionChange
+  })}
   ${resetForm({
     onOptionsReset
   })}

@@ -4,6 +4,7 @@
 import browser from 'webextension-polyfill'
 import { optionDefaults } from '../lib/options.js'
 import createRuntimeChecks from '../lib/runtime-checks.js'
+import { trackView } from '../lib/telemetry.js'
 
 // The store contains and mutates the state for the app
 export default function optionStore (state, emitter) {
@@ -12,11 +13,15 @@ export default function optionStore (state, emitter) {
   const updateStateOptions = async () => {
     const runtime = await createRuntimeChecks(browser)
     state.withNodeFromBrave = runtime.brave && await runtime.brave.getIPFSEnabled()
+    /**
+     * FIXME: Why are we setting `state.options` when state is supposed to extend options?
+     */
     state.options = await getOptions()
     emitter.emit('render')
   }
 
   emitter.on('DOMContentLoaded', async () => {
+    trackView('options')
     updateStateOptions()
     browser.storage.onChanged.addListener(updateStateOptions)
   })

@@ -7,6 +7,7 @@ import { browserActionFilesCpImportCurrentTab } from '../../lib/ipfs-import.js'
 import { ipfsContentPath } from '../../lib/ipfs-path.js'
 import { welcomePage, optionsPage } from '../../lib/constants.js'
 import { contextMenuViewOnGateway, contextMenuCopyAddressAtPublicGw, contextMenuCopyPermalink, contextMenuCopyRawCid, contextMenuCopyCanonicalAddress, contextMenuCopyCidAddress } from '../../lib/context-menus.js'
+import { trackView } from '../../lib/telemetry.js'
 
 // The store contains and mutates the state for the app
 export default (state, emitter) => {
@@ -38,6 +39,7 @@ export default (state, emitter) => {
   let port
 
   emitter.on('DOMContentLoaded', async () => {
+    trackView('browser-action')
     // initial render with status stub
     emitter.emit('render')
     // initialize connection to the background script which will trigger UI updates

@@ -12,6 +12,7 @@ import { formatImportDirectory } from '../lib/ipfs-import.js'
 import all from 'it-all'
 import drop from 'drag-and-drop-files'
 import { filesize } from 'filesize'
+import { trackView } from '../lib/telemetry.js'
 
 document.title = browser.i18n.getMessage('quickImport_page_title')
 
@@ -48,6 +49,7 @@ function quickImportStore (state, emitter) {
   let port
 
   emitter.on('DOMContentLoaded', async () => {
+    trackView('quick-import')
     // initialize connection to the background script which will trigger UI updates
     port = browser.runtime.connect({ name: 'browser-action-port' })
     port.onMessage.addListener(async (message) => {