Merge branch 'PostHog:master' into master

Author: evgeek

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.2.20
+
+* [Full Changelog](https://github.com/PostHog/posthog-go/compare/v1.2.19...v1.2.20)
+
 ## 1.2.19
 
 * [Full Changelog](https://github.com/PostHog/posthog-go/compare/v1.2.18...v1.2.19)

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"
     }
   ]
 }