Rollback capture with empty UUID (#71)

Author: evgeek

README.md

@@ -62,18 +62,6 @@ func main() {
       Properties: posthog.NewProperties().
         Set("$current_url", "https://example.com"),
     })
-    
-    // Capture event with calculated uuid to deduplicate repeated events. 
-    // The library github.com/google/uuid is used
-    key := myEvent.Id + myEvent.Project
-    uid := uuid.NewSHA1(uuid.NameSpaceX500, []byte(key)).String()
-    client.Enqueue(posthog.Capture{
-      Uuid: uid,
-      DistinctId: "test-user",
-      Event:      "$pageview",
-      Properties: posthog.NewProperties().
-        Set("$current_url", "https://example.com"),
-    })
 
     // Check if a feature flag is enabled
     isMyFlagEnabled, err := client.IsFeatureEnabled(

capture.go

@@ -9,9 +9,7 @@ type Capture struct {
 	// This field is exported for serialization purposes and shouldn't be set by
 	// the application, its value is always overwritten by the library.
 	Type string
-	// You don't usually need to specify this field - Posthog will generate it automatically.
-	// Use it only when necessary - for example, to prevent duplicate events.
-	Uuid             string
+
 	DistinctId       string
 	Event            string
 	Timestamp        time.Time
@@ -46,7 +44,6 @@ func (msg Capture) Validate() error {
 
 type CaptureInApi struct {
 	Type           string    `json:"type"`
-	Uuid           string    `json:"uuid"`
 	Library        string    `json:"library"`
 	LibraryVersion string    `json:"library_version"`
 	Timestamp      time.Time `json:"timestamp"`
@@ -75,7 +72,6 @@ func (msg Capture) APIfy() APIMessage {
 
 	apified := CaptureInApi{
 		Type:           msg.Type,
-		Uuid:           msg.Uuid,
 		Library:        library,
 		LibraryVersion: libraryVersion,
 		Timestamp:      msg.Timestamp,

config.go

@@ -3,6 +3,8 @@ package posthog
 import (
 	"net/http"
 	"time"
+
+	"github.com/google/uuid"
 )
 
 // Instances of this type carry the different configuration options that may
@@ -77,6 +79,12 @@ type Config struct {
 	// If not set the client will fallback to use a default retry policy.
 	RetryAfter func(int) time.Duration
 
+	// A function called by the client to generate unique message identifiers.
+	// The client uses a UUID generator if none is provided.
+	// This field is not exported and only exposed internally to let unit tests
+	// mock the id generation.
+	uid func() string
+
 	// A function called by the client to get the current time, `time.Now` is
 	// used by default.
 	// This field is not exported and only exposed internally to let unit tests
@@ -165,6 +173,10 @@ func makeConfig(c Config) Config {
 		c.RetryAfter = DefaultBacko().Duration
 	}
 
+	if c.uid == nil {
+		c.uid = uid
+	}
+
 	if c.now == nil {
 		c.now = time.Now
 	}
@@ -175,3 +187,10 @@ func makeConfig(c Config) Config {
 
 	return c
 }
+
+// This function returns a string representation of a UUID, it's the default
+// function used for generating unique IDs.
+func uid() string {
+	new_uuid, _ := uuid.NewRandom()
+	return new_uuid.String()
+}

fixtures/test-enqueue-capture-with-uuid.json

@@ -15,8 +15,7 @@
       },
       "send_feature_flags": false,
       "timestamp": "2009-11-10T23:00:00Z",
-      "type": "capture",
-      "uuid": ""
+      "type": "capture"
     }
   ]
 }

fixtures/test-enqueue-capture.json

@@ -15,8 +15,7 @@
       },
       "send_feature_flags": false,
       "timestamp": "2009-11-10T23:00:00Z",
-      "type": "capture",
-      "uuid": ""
+      "type": "capture"
     }
   ]
 }

fixtures/test-interval-capture.json

@@ -14,8 +14,7 @@
       },
       "send_feature_flags": false,
       "timestamp": "2009-11-10T23:00:00Z",
-      "type": "capture",
-      "uuid": ""
+      "type": "capture"
     },
     {
       "distinct_id": "123456",
@@ -30,8 +29,7 @@
       },
       "send_feature_flags": false,
       "timestamp": "2009-11-10T23:00:00Z",
-      "type": "capture",
-      "uuid": ""
+      "type": "capture"
     },
     {
       "distinct_id": "123456",
@@ -46,8 +44,7 @@
       },
       "send_feature_flags": false,
       "timestamp": "2009-11-10T23:00:00Z",
-      "type": "capture",
-      "uuid": ""
+      "type": "capture"
     }
   ]
 }

fixtures/test-many-capture.json

@@ -16,8 +16,7 @@
       },
       "send_feature_flags": false,
       "timestamp": "2015-07-10T23:00:00Z",
-      "type": "capture",
-      "uuid": ""
+      "type": "capture"
     }
   ]
 }

fixtures/test-merge-capture.json

@@ -15,8 +15,7 @@
       },
       "send_feature_flags": false,
       "timestamp": "2015-07-10T23:00:00Z",
-      "type": "capture",
-      "uuid": ""
+      "type": "capture"
     }
   ]
 }

fixtures/test-timestamp-capture.json

@@ -2,7 +2,10 @@ module github.com/posthog/posthog-go
 
 go 1.18
 
-require github.com/urfave/cli v1.22.5
+require (
+	github.com/google/uuid v1.3.0
+	github.com/urfave/cli v1.22.5
+)
 
 require (
 	github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d // indirect

go.mod

@@ -1,6 +1,8 @@
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d h1:U+s90UTSYgptZMwQh2aRr3LuazLJIa+Pg3Kc1ylSYVY=
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
+github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
+github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q=
@@ -10,4 +12,4 @@ github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeV
 github.com/urfave/cli v1.22.5 h1:lNq9sAHXK2qfdI8W+GRItjCEkI+2oR4d+MEHy1CKXoU=
 github.com/urfave/cli v1.22.5/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

go.sum

@@ -152,6 +152,8 @@ func fixture(name string) string {
 	return string(b)
 }
 
+func mockId() string { return "I'm unique" }
+
 func mockTime() time.Time {
 	// time.Unix(0, 0) fails on Circle
 	return time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC)
@@ -189,11 +191,11 @@ func ExampleCapture() {
 		Endpoint:  server.URL,
 		BatchSize: 1,
 		now:       mockTime,
+		uid:       mockId,
 	})
 	defer client.Close()
 
 	client.Enqueue(Capture{
-		Uuid:       "00000000-0000-0000-0000-000000000000",
 		Event:      "Download",
 		DistinctId: "123456",
 		Properties: Properties{
@@ -223,8 +225,7 @@ func ExampleCapture() {
 	//       },
 	//       "send_feature_flags": false,
 	//       "timestamp": "2009-11-10T23:00:00Z",
-	//       "type": "capture",
-	//       "uuid": "00000000-0000-0000-0000-000000000000"
+	//       "type": "capture"
 	//     }
 	//   ]
 	// }
@@ -245,6 +246,7 @@ func TestCaptureNoProperties(t *testing.T) {
 		Endpoint:               server.URL,
 		BatchSize:              1,
 		now:                    mockTime,
+		uid:                    mockId,
 		DefaultEventProperties: NewProperties().Set("service", "api"),
 	})
 	defer client.Close()
@@ -321,9 +323,8 @@ func TestEnqueue(t *testing.T) {
 		},
 
 		"*capture": {
-			strings.TrimSpace(fixture("test-enqueue-capture-with-uuid.json")),
+			strings.TrimSpace(fixture("test-enqueue-capture.json")),
 			&Capture{
-				Uuid:       "11111111-1111-1111-1111-111111111111",
 				Event:      "Download",
 				DistinctId: "123456",
 				Properties: Properties{
@@ -345,6 +346,7 @@ func TestEnqueue(t *testing.T) {
 		Logger:    t,
 		BatchSize: 1,
 		now:       mockTime,
+		uid:       mockId,
 	})
 	defer client.Close()
 
@@ -402,6 +404,7 @@ func TestCaptureWithInterval(t *testing.T) {
 		Verbose:  true,
 		Logger:   t,
 		now:      mockTime,
+		uid:      mockId,
 	})
 	defer client.Close()
 
@@ -438,6 +441,7 @@ func TestCaptureWithTimestamp(t *testing.T) {
 		Logger:    t,
 		BatchSize: 1,
 		now:       mockTime,
+		uid:       mockId,
 	})
 	defer client.Close()
 
@@ -471,6 +475,7 @@ func TestCaptureWithDefaultProperties(t *testing.T) {
 		Logger:                 t,
 		BatchSize:              1,
 		now:                    mockTime,
+		uid:                    mockId,
 	})
 	defer client.Close()
 
@@ -503,6 +508,7 @@ func TestCaptureMany(t *testing.T) {
 		Logger:    t,
 		BatchSize: 3,
 		now:       mockTime,
+		uid:       mockId,
 	})
 	defer client.Close()
 
@@ -1705,6 +1711,7 @@ func TestCaptureSendFlags(t *testing.T) {
 		Logger:    t,
 		BatchSize: 1,
 		now:       mockTime,
+		uid:       mockId,
 
 		PersonalApiKey: "some very secret key",
 	})