feat: add self-hosted, doNotTrack-aware, analytics #930
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
ghost
assigned License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
|
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 |
|
Tests for the bundle logic are in place 📋 ✅ ✨ 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
changed the title
olizilla
changed the title
|
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>
olizilla
changed the title
fsdiogo
approved these changes
Jan 31, 2019
| const items = Array(9).fill(1) | ||
| return ( | ||
| <React.Fragment> | ||
| <Checkbox className='dib bg-white pa3' onChange={doToggleAnalytics} checked={analyticsEnabled} label={ |
There was a problem hiding this comment.
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!
| {t('AnalyticsToggle.label')} | ||
| </span> | ||
| } /> | ||
| <div className='f6 charcoal lh-copy mw7'> |
There was a problem hiding this comment.
Suggested change
| <div className='f6 charcoal lh-copy mw7'> | |
| <div className='f6 ml3 charcoal lh-copy mw7'> |
Co-Authored-By: olizilla <oli@tableflip.io>
Co-Authored-By: olizilla <oli@tableflip.io>
|
News on this. We're setting up a countly instance at |
|
Waiting on DNS for countly.ipfs.io https://github.com/protocol/infra/pull/438 |
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
|
I'd like to roll this out today, so please eyeball the code! |
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
lidel
approved these changes
Feb 22, 2019
src/bundles/index.js
Outdated
| repoStats | ||
| repoStats, | ||
| createAnalyticsBundle({ | ||
| countlyAppKey: window.ipfsDesktop ? '47fbb3db3426d2ae32b3b65fe40c564063d8b55d' : '8fa213e6049bff23b08e5f5fbac89e7c27397612', |
There was a problem hiding this comment.
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
public/locales/en/settings.json
Outdated
| "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.", |
There was a problem hiding this comment.
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.", |
|
|
||
| function getDoNotTrack () { | ||
| if (!root.navigator) return false | ||
| const value = root.doNotTrack || root.navigator.doNotTrack || root.navigator.msDoNotTrack |
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add analytics via self-hosted countly install.
WIP on #774
see also: ipfs/ipfs-gui#72
TODO:
License: MIT
Signed-off-by: Oli Evans oli@tableflip.io