This repository was archived by the owner on Dec 15, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 402
send GitHub username with usage metrics #1651
Open
annthurium
wants to merge
10
commits into
master
Choose a base branch
from
tt-18-aug-username
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
Personally, I think identifiable metrics need to be opt-in if you want to keep trust in the metrics package (and by extension Atom itself). I imagine people won't be happy if they discover it switched to sending non-anonymous data without their explicit acceptance. |
@Aerijo Since this is a sensitive topic, we're going to discuss this at a maintainer's meeting sometime in the next couple of weeks. We'll let you know in advance that this in on the agenda. Looking forward to hearing your perspective there. |
heads up - we will be discussing this at the maintainers' meeting tomorrow. If you have thoughts, please come weigh in. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Rationale
In order to plan a good roadmap for Atom's future, we need to have solid info about how users are interacting with Atom.
In the past we have anonymized all usage metrics. Keeping the data anonymized impairs our ability to answer questions like:
These questions are important. Therefore, we are introducing a change to pass the GitHub username with our usage metrics, if the user has authenticated with the GitHub package.
You do not have to authenticate with GitHub to use Atom, or the GitHub package. Some functionality does require authenticating, though.
If users don't want their GitHub username to be included in usability metrics, they can opt-out of sending their usage stats to GitHub. Or they can choose not to authenticate.
Approach
Use graphQL to fetch the GitHub username and send it to the
metrics
package. Themetrics
package exposes a service to do so in atom/metrics#97 which must be merged before this pull request. TheObserveModel
decorator wraps the login component so that we can re-fetch the data anytime the user performs a new login action.Alternate Approaches
We could send the authentication token to the metrics back end and do the username lookup there. However, anytime you're sending tokens around, that's a security risk. Also, the approach I chose is more
Test Plan
ReporterProxy
sends the username tometrics
getGitHubUser
handles graphql errors gracefullygetGitHubUser
extracts the username from the responseGitHubPackage
when user re-authenticates.