feat: add self-hosted, doNotTrack-aware, analytics #930

olizilla · 2019-01-09T10:34:39Z

Add analytics via self-hosted countly install.

WIP on #774
see also: ipfs/ipfs-gui#72

TODO:

set up demo countly instance
create analytics bundle
settings toggle, enable, disable
show call to action on status page on first run if doNotTrack is enabled
write tests
hosted countly instance - https://resources.count.ly/docs/installing-countly-server

License: MIT
Signed-off-by: Oli Evans oli@tableflip.io

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

olizilla · 2019-01-31T11:21:38Z

A good first pass at the copy for "what data is collected?"

From the info at https://resources.count.ly/docs/security-faq#section-default-metrics-properties-collected

olizilla · 2019-01-31T11:25:58Z

Tests for the bundle logic are in place 📋 ✅ ✨

https://github.com/ipfs-shipyard/ipfs-webui/blob/186a5086f15cc9d710638184aa5675a38ed0de3f/src/bundles/analytics.test.js

 PASS  src/bundles/analytics.test.js
  ✓ should normalise the doNotTrack state from the navigator.doNotTrack value (6ms)
  ✓ should enable analytics if doNotTrack is falsey
  ✓ should disable analytics if doNotTrack is true (1ms)
  ✓ should enable analytics if doNotTrack is true but user has explicitly enabled it
  ✓ should disable analytics if doNotTrack is falsey but user has explicitly disabled it (1ms)
  ✓ should enable selectAnalyticsAskToEnable if doNotTrack is true and user has not explicity enabled or disabled it
  ✓ should disable selectAnalyticsAskToEnable if doNotTrack is true and user has explicity disabled it (1ms)
  ✓ should disable selectAnalyticsAskToEnable if doNotTrack is true and user has explicity enabled it
  ✓ should disable selectAnalyticsAskToEnable if analytics are enabled
  ✓ should toggle analytics (14ms)

Test Suites: 1 passed, 1 total
Tests:       10 passed, 10 total
Snapshots:   0 total
Time:        1.53s

olizilla · 2019-01-31T11:48:10Z

Call to action on the status page if you have doNotTrack enabled and you haven't yet explicitly opted in or out.

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

fsdiogo

In general LGTM, but please check my suggestions!

public/locales/en/settings.json

src/bundles/analytics.js

src/bundles/analytics.test.js

src/components/analytics-toggle/AnalyticsToggle.js

fsdiogo · 2019-01-31T15:20:58Z

src/components/analytics-toggle/AnalyticsToggle.js

+  const items = Array(9).fill(1)
+  return (
+    <React.Fragment>
+      <Checkbox className='dib bg-white pa3' onChange={doToggleAnalytics} checked={analyticsEnabled} label={


Suggested change

<Checkbox className='dib bg-white pa3' onChange={doToggleAnalytics} checked={analyticsEnabled} label={

<Checkbox className='dib pa3' onChange={doToggleAnalytics} checked={analyticsEnabled} label={

I prefer this without the white background to blend with the rest of the Settings, but I'll leave it up to you!

fsdiogo · 2019-01-31T15:37:42Z

src/components/analytics-toggle/AnalyticsToggle.js

+          {t('AnalyticsToggle.label')}
+        </span>
+      } />
+      <div className='f6 charcoal lh-copy mw7'>


Suggested change

<div className='f6 charcoal lh-copy mw7'>

<div className='f6 ml3 charcoal lh-copy mw7'>

Co-Authored-By: olizilla <oli@tableflip.io>

olizilla · 2019-02-13T15:38:01Z

News on this. We're setting up a countly instance at countly.ipfs.io should be ready by next week.

olizilla · 2019-02-20T09:45:33Z

Waiting on DNS for countly.ipfs.io https://github.com/protocol/infra/pull/438

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

olizilla · 2019-02-22T09:37:49Z

I'd like to roll this out today, so please eyeball the code!

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

lidel

LGTM, tiny suggestions below

lidel · 2019-02-22T11:10:48Z

src/bundles/index.js

-  repoStats
+  repoStats,
+  createAnalyticsBundle({
+    countlyAppKey: window.ipfsDesktop ? '47fbb3db3426d2ae32b3b65fe40c564063d8b55d' : '8fa213e6049bff23b08e5f5fbac89e7c27397612',


nit: meaning can be lost/swapped during future refectoring, and it will be awfully hard to detect.
May be safer to move API keys to COUNTLY_APPKEY_DESKTOP / COUNTLY_APPKEY_WEBUI consts

lidel · 2019-02-22T11:27:02Z

public/locales/en/settings.json

+  "AnalyticsToggle": {
+    "label": "Help improve this app by sending anonymous usage data",
+    "summary": "What data is collected?",
+    "paragraph1": "IPFS hosts a <1>Countly</1> instance to record anonymous usage data for this app.",


Perhaps we should clarify we mean Shipyard||Community||Project, not the protocol itself.

Suggested change

"paragraph1": "IPFS hosts a <1>Countly</1> instance to record anonymous usage data for this app.",

"paragraph1": "IPFS Shipyard hosts a <1>Countly</1> instance to record anonymous usage data for this app.",

lidel · 2019-02-22T11:30:32Z

src/bundles/analytics.js

+
+function getDoNotTrack () {
+  if (!root.navigator) return false
+  const value = root.doNotTrack || root.navigator.doNotTrack || root.navigator.msDoNotTrack


hacdias

LGTM! I subscribe @lidel's and @fsdiogo's comments.

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

wip: add countly self-hosted, opt-in analytics

ca74271

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

ghost assigned olizilla Jan 9, 2019

ghost added the status/in-progress In progress label Jan 9, 2019

olizilla added 3 commits January 9, 2019 14:31

wip: allow user to opt in to analytics

f9871ec

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

wip: debug logging for opt-in to analytics

eede7a7

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

wip: honour doNotTrack. add tests

186a508

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

olizilla changed the title ~~wip: add countly self-hosted, opt-in analytics~~ wip: add countly self-hosted, doNotTrack-aware, analytics Jan 31, 2019

olizilla changed the title ~~wip: add countly self-hosted, doNotTrack-aware, analytics~~ wip: add self-hosted, doNotTrack-aware, analytics Jan 31, 2019

olizilla mentioned this pull request Jan 31, 2019

Opt-in error reporting and anonymous usage reporting #774

Closed

feat: call-to-action where doNotTrack is enabled

c7f5a37

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

olizilla changed the title ~~wip: add self-hosted, doNotTrack-aware, analytics~~ feat: add self-hosted, doNotTrack-aware, analytics Jan 31, 2019

Merge remote-tracking branch 'origin/master' into analytics

9d6158e

fsdiogo approved these changes Jan 31, 2019

View reviewed changes

fsdiogo and others added 2 commits February 5, 2019 15:25

Apply suggestions from code review

5282741

Co-Authored-By: olizilla <oli@tableflip.io>

Update src/bundles/analytics.test.js

dd9c2d5

Co-Authored-By: olizilla <oli@tableflip.io>

olizilla mentioned this pull request Feb 14, 2019

chore: add analytics ipfs-cluster/ipfs-cluster-website#62

Merged

olizilla added 5 commits February 21, 2019 14:19

Merge remote-tracking branch 'origin/master' into analytics

0e8be7e

feat: log events

ae87e10

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

Merge remote-tracking branch 'origin/master' into analytics

60a021b

chore: remove duplicate version logging

75f0844

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

fix: better async event recording

6cbbba4

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

olizilla requested review from lidel and alanshaw February 22, 2019 09:16

fix: add link to countly

669df2f

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

olizilla requested a review from hacdias February 22, 2019 10:12

lidel approved these changes Feb 22, 2019

View reviewed changes

hacdias approved these changes Feb 22, 2019

View reviewed changes

fix: state PL is hosting no IPFS

a0a2d36

License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>

olizilla merged commit b3fe232 into master Feb 25, 2019

olizilla deleted the analytics branch February 25, 2019 10:19

ghost removed the status/in-progress In progress label Feb 25, 2019

olizilla mentioned this pull request Feb 26, 2019

Analytics in Go-IPFS #980

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add self-hosted, doNotTrack-aware, analytics #930

feat: add self-hosted, doNotTrack-aware, analytics #930

olizilla commented Jan 9, 2019 •

edited

Loading

olizilla commented Jan 31, 2019 •

edited

Loading

olizilla commented Jan 31, 2019

olizilla commented Jan 31, 2019

fsdiogo left a comment

fsdiogo Jan 31, 2019

fsdiogo Jan 31, 2019

olizilla commented Feb 13, 2019

olizilla commented Feb 20, 2019

olizilla commented Feb 22, 2019

lidel left a comment •

edited

Loading

lidel Feb 22, 2019

lidel Feb 22, 2019 •

edited

Loading

lidel Feb 22, 2019

hacdias left a comment

	<Checkbox className='dib bg-white pa3' onChange={doToggleAnalytics} checked={analyticsEnabled} label={
	<Checkbox className='dib pa3' onChange={doToggleAnalytics} checked={analyticsEnabled} label={

	<div className='f6 charcoal lh-copy mw7'>
	<div className='f6 ml3 charcoal lh-copy mw7'>

	"paragraph1": "IPFS hosts a <1>Countly</1> instance to record anonymous usage data for this app.",
	"paragraph1": "IPFS Shipyard hosts a <1>Countly</1> instance to record anonymous usage data for this app.",

feat: add self-hosted, doNotTrack-aware, analytics #930

feat: add self-hosted, doNotTrack-aware, analytics #930

Conversation

olizilla commented Jan 9, 2019 • edited Loading

olizilla commented Jan 31, 2019 • edited Loading

olizilla commented Jan 31, 2019

olizilla commented Jan 31, 2019

fsdiogo left a comment

Choose a reason for hiding this comment

fsdiogo Jan 31, 2019

Choose a reason for hiding this comment

fsdiogo Jan 31, 2019

Choose a reason for hiding this comment

olizilla commented Feb 13, 2019

olizilla commented Feb 20, 2019

olizilla commented Feb 22, 2019

lidel left a comment • edited Loading

Choose a reason for hiding this comment

lidel Feb 22, 2019

Choose a reason for hiding this comment

lidel Feb 22, 2019 • edited Loading

Choose a reason for hiding this comment

lidel Feb 22, 2019

Choose a reason for hiding this comment

hacdias left a comment

Choose a reason for hiding this comment

olizilla commented Jan 9, 2019 •

edited

Loading

olizilla commented Jan 31, 2019 •

edited

Loading

lidel left a comment •

edited

Loading

lidel Feb 22, 2019 •

edited

Loading