Skip to content
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

Jump to bottom

chore: add handling for alias events in tracked users report #4899

Merged
merged 3 commits into from
Jul 24, 2024
Merged

chore: add handling for alias events in tracked users report #4899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b48aabd
chore: add handling for alias events in tracked users report
mihir20 Jul 16, 2024
4aed384
addressed comments
mihir20 Jul 19, 2024
343e150
Merge branch 'master' into mihir/pipe-1305
mihir20 Jul 23, 2024
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
21 changes: 20 additions & 1 deletion enterprise/trackedusers/users_reporter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ const (
murmurSeed = 123

trackUsersTable = "tracked_users_reports"

eventTypeAlias = "alias"
)

type UsersReport struct {
Expand Down Expand Up @@ -120,7 +122,7 @@ func (u *UniqueUsersReporter) GenerateReportsFromJobs(jobs []*jobsdb.JobT, sourc
}
userID := gjson.GetBytes(job.EventPayload, "batch.0.userId").String()
anonymousID := gjson.GetBytes(job.EventPayload, "batch.0.anonymousId").String()

eventType := gjson.GetBytes(job.EventPayload, "batch.0.type").String()
if userID == "" && anonymousID == "" {
u.log.Warn("both userID and anonymousID not found in job event payload", obskit.WorkspaceID(job.WorkspaceId),
logger.NewIntField("jobId", job.JobID))
Expand All @@ -143,6 +145,23 @@ func (u *UniqueUsersReporter) GenerateReportsFromJobs(jobs []*jobsdb.JobT, sourc
combinedUserIDAnonymousID := combineUserIDAnonymousID(userID, anonymousID)
workspaceSourceUserIdTypeMap[job.WorkspaceId][sourceID] = u.recordIdentifier(workspaceSourceUserIdTypeMap[job.WorkspaceId][sourceID], combinedUserIDAnonymousID, idTypeIdentifiedAnonymousID)
}

// for alias event we will be adding previousId to identifiedAnonymousID hll,
// so for calculating unique users we do not double count the user
// e.g. we receive events
// {type:track, anonymousID: anon1}
// {type:track, userID: user1}
// {type:track, userID: user2}
// {type:identify, userID: user1, anonymousID: anon1}
// {type:alias, previousId: user2, userID: user1}
// userHLL: {user1, user2}, anonHLL: {anon1}, identifiedAnonHLL: {user1-anon1, user2}
// cardinality: len(userHLL)+len(anonHLL)-len(identifiedAnonHLL): 2+1-2 = 1
if eventType == eventTypeAlias {
previousID := gjson.GetBytes(job.EventPayload, "batch.0.previousId").String()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we only looking at the first entry in batch and not all entries ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each batch will have only have 1 event. Even if on gateway we receive a batch request we break that down and we create a new entry for each event in a batch. and each entry will be like {"batch":[{event...}]}

if previousID != "" && previousID != userID && previousID != anonymousID {
workspaceSourceUserIdTypeMap[job.WorkspaceId][sourceID] = u.recordIdentifier(workspaceSourceUserIdTypeMap[job.WorkspaceId][sourceID], previousID, idTypeIdentifiedAnonymousID)
}
}
}

if len(workspaceSourceUserIdTypeMap) == 0 {
Expand Down
147 changes: 147 additions & 0 deletions enterprise/trackedusers/users_reporter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ var (
WorkspaceId: workspaceID,
}
}
prepareAliasJob = func(sourceID, userID, previousID, workspaceID string) *jobsdb.JobT {
return &jobsdb.JobT{
Parameters: []byte(fmt.Sprintf(`{"source_id":%q}`, sourceID)),
EventPayload: []byte(fmt.Sprintf(`{"batch": [{"previousId":%q,"userId":%q,"type":"alias"}]}`, previousID, userID)),
UserID: uuid.NewString(),
UUID: uuid.New(),
CustomVal: "GW",
WorkspaceId: workspaceID,
}
}
prepareUserReport = func(t *testing.T, sourceID, workspaceID string, noOfUserIDs, noOfAnnID, noOfIdentifiedAnnID int) *UsersReport {
userIDHll, _ := hll.NewHll(hllSettings)
annIDHll, _ := hll.NewHll(hllSettings)
Expand Down Expand Up @@ -195,6 +205,143 @@ func TestUniqueUsersReporter(t *testing.T) {
},
},
},
{
name: "happy case - alias jobs",
jobs: []*jobsdb.JobT{
prepareJob(sampleSourceID, "", "anon_id", sampleWorkspaceID),
prepareJob(sampleSourceID, "user_id", "", sampleWorkspaceID),
prepareJob(sampleSourceID, "user_id", "anon_id", sampleWorkspaceID),
prepareJob(sampleSourceID, "user_id_1", "anon_id_1", sampleWorkspaceID),
prepareJob(sampleSourceID, "user", "ann", sampleWorkspaceID),
prepareJob(sampleSourceID, "user", "ann", sampleWorkspaceID2),
prepareAliasJob(sampleSourceID, "user_id", "user_id_1", sampleWorkspaceID),
},
trackedUsers: []*UsersReport{
{
WorkspaceID: sampleWorkspaceID,
SourceID: sampleSourceID,
UserIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("user_id"), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("user"), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("user_id_1"), murmurSeed))
return &resHll
}(),
AnonymousIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("ann"), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("anon_id"), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("anon_id_1"), murmurSeed))
return &resHll
}(),
IdentifiedAnonymousIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte(
combineUserIDAnonymousID("user_id", "anon_id")), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte(
combineUserIDAnonymousID("user_id_1", "anon_id_1")), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte(
combineUserIDAnonymousID("user", "ann")), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("user_id_1"), murmurSeed))
return &resHll
}(),
},
{
WorkspaceID: sampleWorkspaceID2,
SourceID: sampleSourceID,
UserIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("user"), murmurSeed))
return &resHll
}(),
AnonymousIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("ann"), murmurSeed))
return &resHll
}(),
IdentifiedAnonymousIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte(
combineUserIDAnonymousID("user", "ann")), murmurSeed))
return &resHll
}(),
},
},
},
{
name: "alias jobs with prevID same as userID",
jobs: []*jobsdb.JobT{
prepareJob(sampleSourceID, "", "anon_id", sampleWorkspaceID),
prepareJob(sampleSourceID, "user_id", "", sampleWorkspaceID),
prepareJob(sampleSourceID, "user_id", "anon_id", sampleWorkspaceID),
prepareJob(sampleSourceID, "user_id_1", "anon_id_1", sampleWorkspaceID),
prepareJob(sampleSourceID, "user", "ann", sampleWorkspaceID),
prepareJob(sampleSourceID, "user", "ann", sampleWorkspaceID2),
prepareAliasJob(sampleSourceID, "user_id", "user_id", sampleWorkspaceID),
},
trackedUsers: []*UsersReport{
{
WorkspaceID: sampleWorkspaceID,
SourceID: sampleSourceID,
UserIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("user_id"), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("user"), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("user_id_1"), murmurSeed))
return &resHll
}(),
AnonymousIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("ann"), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("anon_id"), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("anon_id_1"), murmurSeed))
return &resHll
}(),
IdentifiedAnonymousIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte(
combineUserIDAnonymousID("user_id", "anon_id")), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte(
combineUserIDAnonymousID("user_id_1", "anon_id_1")), murmurSeed))
resHll.AddRaw(murmur3.Sum64WithSeed([]byte(
combineUserIDAnonymousID("user", "ann")), murmurSeed))
return &resHll
}(),
},
{
WorkspaceID: sampleWorkspaceID2,
SourceID: sampleSourceID,
UserIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("user"), murmurSeed))
return &resHll
}(),
AnonymousIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte("ann"), murmurSeed))
return &resHll
}(),
IdentifiedAnonymousIDHll: func() *hll.Hll {
resHll, err := hll.NewHll(hllSettings)
require.NoError(t, err)
resHll.AddRaw(murmur3.Sum64WithSeed([]byte(
combineUserIDAnonymousID("user", "ann")), murmurSeed))
return &resHll
}(),
},
},
},
{
name: "happy case - no identified use ids",
jobs: []*jobsdb.JobT{
Expand Down