feat(analytics): support explicit count values in Count method #3619
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,223 @@ | ||
| package posthog | ||
|
|
||
| import ( | ||
| "context" | ||
| "sync" | ||
| "testing" | ||
|
|
||
| "github.com/google/uuid" | ||
| "github.com/rs/zerolog" | ||
|
|
||
| "github.com/hatchet-dev/hatchet/pkg/analytics" | ||
| ) | ||
|
|
||
| var testLogger = zerolog.Nop() | ||
|
|
||
| type countCall struct { | ||
| Resource analytics.Resource | ||
| Action analytics.Action | ||
| TenantID uuid.UUID | ||
| TokenID *uuid.UUID | ||
| Count int64 | ||
| Properties analytics.Properties | ||
| } | ||
|
|
||
| type countRecorder struct { | ||
| mu sync.Mutex | ||
| calls []countCall | ||
| } | ||
|
|
||
| func (r *countRecorder) record(resource analytics.Resource, action analytics.Action, tenantID uuid.UUID, tokenID *uuid.UUID, count int64, properties analytics.Properties) { | ||
| r.mu.Lock() | ||
| defer r.mu.Unlock() | ||
| r.calls = append(r.calls, countCall{ | ||
| Resource: resource, | ||
| Action: action, | ||
| TenantID: tenantID, | ||
| TokenID: tokenID, | ||
| Count: count, | ||
| Properties: properties, | ||
| }) | ||
| } | ||
|
|
||
| func (r *countRecorder) getCalls() []countCall { | ||
| r.mu.Lock() | ||
| defer r.mu.Unlock() | ||
| cp := make([]countCall, len(r.calls)) | ||
| copy(cp, r.calls) | ||
| return cp | ||
| } | ||
|
|
||
| func TestCount_DefaultToOne(t *testing.T) { | ||
| rec := &countRecorder{} | ||
| agg := analytics.NewAggregator(&testLogger, true, 50, 0, rec.record) | ||
| agg.Start() | ||
| p := &PosthogAnalytics{ | ||
| aggregator: agg, | ||
| } | ||
|
|
||
| ctx := context.Background() | ||
| p.Count(ctx, analytics.Event, analytics.Create) | ||
|
|
||
| agg.Shutdown() | ||
|
|
||
| calls := rec.getCalls() | ||
| if len(calls) != 1 { | ||
| t.Fatalf("expected 1 call, got %d", len(calls)) | ||
| } | ||
| if calls[0].Count != 1 { | ||
| t.Errorf("expected count 1, got %d", calls[0].Count) | ||
| } | ||
| } | ||
|
|
||
| func TestCount_SinglePropertyFallbackToOne(t *testing.T) { | ||
| rec := &countRecorder{} | ||
| agg := analytics.NewAggregator(&testLogger, true, 50, 0, rec.record) | ||
| agg.Start() | ||
| p := &PosthogAnalytics{ | ||
| aggregator: agg, | ||
| } | ||
|
|
||
| ctx := context.Background() | ||
| p.Count(ctx, analytics.Event, analytics.Create, analytics.Props( | ||
| "has_priority", true, | ||
| )) | ||
|
|
||
| agg.Shutdown() | ||
|
|
||
| calls := rec.getCalls() | ||
| if len(calls) != 1 { | ||
| t.Fatalf("expected 1 call, got %d", len(calls)) | ||
| } | ||
| if calls[0].Count != 1 { | ||
| t.Errorf("expected count 1, got %d", calls[0].Count) | ||
| } | ||
| } | ||
|
|
||
| func TestCount_ExplicitCountFromLastProperties(t *testing.T) { | ||
| rec := &countRecorder{} | ||
| agg := analytics.NewAggregator(&testLogger, true, 50, 0, rec.record) | ||
| agg.Start() | ||
| p := &PosthogAnalytics{ | ||
| aggregator: agg, | ||
| } | ||
|
|
||
| ctx := context.Background() | ||
| p.Count(ctx, analytics.Event, analytics.Create, | ||
| analytics.Props("has_priority", true), | ||
| analytics.Props("count", int64(5)), | ||
| ) | ||
|
|
||
| agg.Shutdown() | ||
|
|
||
| calls := rec.getCalls() | ||
| if len(calls) != 1 { | ||
| t.Fatalf("expected 1 call, got %d", len(calls)) | ||
| } | ||
| if calls[0].Count != 5 { | ||
| t.Errorf("expected count 5, got %d", calls[0].Count) | ||
| } | ||
| } | ||
|
|
||
| func TestCount_SumMultipleInt64Values(t *testing.T) { | ||
| rec := &countRecorder{} | ||
| agg := analytics.NewAggregator(&testLogger, true, 50, 0, rec.record) | ||
| agg.Start() | ||
| p := &PosthogAnalytics{ | ||
| aggregator: agg, | ||
| } | ||
|
|
||
| ctx := context.Background() | ||
| p.Count(ctx, analytics.Event, analytics.Create, | ||
| analytics.Props("has_priority", true), | ||
| analytics.Props("count", int64(2), "other_count", int64(3)), | ||
| ) | ||
|
|
||
| agg.Shutdown() | ||
|
|
||
| calls := rec.getCalls() | ||
| if len(calls) != 1 { | ||
| t.Fatalf("expected 1 call, got %d", len(calls)) | ||
| } | ||
| if calls[0].Count != 5 { | ||
| t.Errorf("expected count 5 (sum of 2+3), got %d", calls[0].Count) | ||
| } | ||
| } | ||
|
|
||
| func TestCount_IgnoresNonInt64Values(t *testing.T) { | ||
| rec := &countRecorder{} | ||
| agg := analytics.NewAggregator(&testLogger, true, 50, 0, rec.record) | ||
| agg.Start() | ||
| p := &PosthogAnalytics{ | ||
| aggregator: agg, | ||
| } | ||
|
|
||
| ctx := context.Background() | ||
| p.Count(ctx, analytics.Event, analytics.Create, | ||
| analytics.Props("has_priority", true), | ||
| analytics.Props("count", int64(2), "name", "test", "active", true), | ||
| ) | ||
|
|
||
| agg.Shutdown() | ||
|
|
||
| calls := rec.getCalls() | ||
| if len(calls) != 1 { | ||
| t.Fatalf("expected 1 call, got %d", len(calls)) | ||
| } | ||
| if calls[0].Count != 2 { | ||
| t.Errorf("expected count 2, got %d", calls[0].Count) | ||
| } | ||
| } | ||
|
|
||
| func TestCount_NilLastPropertiesFallbackToOne(t *testing.T) { | ||
| rec := &countRecorder{} | ||
| agg := analytics.NewAggregator(&testLogger, true, 50, 0, rec.record) | ||
| agg.Start() | ||
| p := &PosthogAnalytics{ | ||
| aggregator: agg, | ||
| } | ||
|
|
||
| ctx := context.Background() | ||
| p.Count(ctx, analytics.Event, analytics.Create, | ||
| analytics.Props("has_priority", true), | ||
| nil, | ||
| ) | ||
|
|
||
| agg.Shutdown() | ||
|
|
||
| calls := rec.getCalls() | ||
| if len(calls) != 1 { | ||
| t.Fatalf("expected 1 call, got %d", len(calls)) | ||
| } | ||
| if calls[0].Count != 1 { | ||
| t.Errorf("expected count 1, got %d", calls[0].Count) | ||
| } | ||
| } | ||
|
|
||
| func TestCount_FirstPropertyPassedToAggregator(t *testing.T) { | ||
| rec := &countRecorder{} | ||
| agg := analytics.NewAggregator(&testLogger, true, 50, 0, rec.record) | ||
| agg.Start() | ||
| p := &PosthogAnalytics{ | ||
| aggregator: agg, | ||
| } | ||
|
|
||
| ctx := context.Background() | ||
| p.Count(ctx, analytics.Event, analytics.Create, | ||
| analytics.Props("has_priority", true, "source", "api"), | ||
| analytics.Props("count", int64(10)), | ||
| ) | ||
|
|
||
| agg.Shutdown() | ||
|
|
||
| calls := rec.getCalls() | ||
| if len(calls) != 1 { | ||
| t.Fatalf("expected 1 call, got %d", len(calls)) | ||
| } | ||
| if calls[0].Properties["has_priority"] != true { | ||
| t.Error("expected has_priority=true in properties") | ||
| } | ||
| if calls[0].Properties["source"] != "api" { | ||
| t.Error("expected source=api in properties") | ||
| } | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tbh I still think we should be passing in a structured type to determine/override this value, where necessary instead of relying on a positional arg in the varadic params.
Like, it's more explicit that way i.e
versus:
where the latter could be error prone as well since it means we'd need to document this positional behaviour.
This typed-approach also means we can extend supported operations i.e
Then if we have other metric types (i.e a gauge or whatever) we can extend this approach to suit.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough,
will move with original approach of using structured property, which ig will also solve to other concerns automatically.