Skip to content

[RFC] make Telemetry UserID be a uuid string #574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 6, 2023
Merged

[RFC] make Telemetry UserID be a uuid string #574

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af7c9e4
[RFC] make Telemetry UserID be a uuid string
savil Feb 2, 2023
9e19455
use v5 uuid
savil Feb 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions internal/telemetry/segment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
package telemetry

import (
"crypto/hmac"
"crypto/sha256"
"encoding/hex"
"fmt"
"io"
"log"
Expand All @@ -12,6 +9,7 @@ import (
"strings"
"time"

"github.com/google/uuid"
"github.com/pkg/errors"
segment "github.com/segmentio/analytics-go"
"go.jetpack.io/devbox/internal/build"
Expand Down Expand Up @@ -117,21 +115,22 @@ func LogShellDurationEvent(eventName string, startTime string) error {
return nil
}

// UserIDFromGithubUsername hashes the github username and produces a 64-char string as userID.
// Returns an empty string if no github username is found.
// UserIDFromGithubUsername returns a uuid string if the user has authenticated with github.
// If not authenticated, or there's an error, then an empty string is returned, which segment
// would treat as logged-out or anonymous user.
func UserIDFromGithubUsername() string {

username, err := openssh.GithubUsernameFromLocalFile()
if err != nil || username == "" {
return ""
}

const salt = "d6134cd5-347d-4b7c-a2d0-295c0f677948"
mac := hmac.New(sha256.New, []byte(salt))

const githubPrefix = "github:"
mac.Write([]byte(githubPrefix + username))

return hex.EncodeToString(mac.Sum(nil))
// We use a version 5 uuid.
// A good comparison of types of uuids is at: https://www.uuidtools.com/uuid-versions-explained
return uuid.NewSHA1(uuid.MustParse(salt), []byte(githubPrefix+username)).String()
}

// timeFromUnixTimestamp is a helper utility that converts the timestamp string
Expand Down