Ability to specify uuid when capturing events (#68)

* specify uuid

* tidy

* fix

* rename package

* rollback

* rollback all

* init

* fix changelog

* review fixes

---------

Co-authored-by: evgeny.iva <[email protected]>

Author: evgeek

README.md

@@ -62,6 +62,18 @@ 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,7 +9,9 @@ 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
@@ -44,6 +46,7 @@ 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"`
@@ -72,6 +75,7 @@ func (msg Capture) APIfy() APIMessage {
 
 	apified := CaptureInApi{
 		Type:           msg.Type,
+		Uuid:           msg.Uuid,
 		Library:        library,
 		LibraryVersion: libraryVersion,
 		Timestamp:      msg.Timestamp,

cmd/cli/main.go

@@ -91,7 +91,7 @@ func main() {
 			os.Exit(1)
 		}
 
-        return nil
+		return nil
 	}
 
 	err := app.Run(os.Args)

config.go

@@ -3,8 +3,6 @@ package posthog
 import (
 	"net/http"
 	"time"
-
-	"github.com/google/uuid"
 )
 
 // Instances of this type carry the different configuration options that may
@@ -79,12 +77,6 @@ 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
@@ -173,10 +165,6 @@ func makeConfig(c Config) Config {
 		c.RetryAfter = DefaultBacko().Duration
 	}
 
-	if c.uid == nil {
-		c.uid = uid
-	}
-
 	if c.now == nil {
 		c.now = time.Now
 	}
@@ -187,10 +175,3 @@ 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

@@ -0,0 +1,22 @@
+{
+  "api_key": "Csyjlnlun3OzyNJAafdlv",
+  "batch": [
+    {
+      "distinct_id": "123456",
+      "event": "Download",
+      "library": "posthog-go",
+      "library_version": "1.0.0",
+      "properties": {
+        "$lib": "posthog-go",
+        "$lib_version": "1.0.0",
+        "application": "PostHog Go",
+        "platform": "macos",
+        "version": "1.0.0"
+      },
+      "send_feature_flags": false,
+      "timestamp": "2009-11-10T23:00:00Z",
+      "type": "capture",
+      "uuid": "11111111-1111-1111-1111-111111111111"
+    }
+  ]
+}

fixtures/test-enqueue-capture.json

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

fixtures/test-interval-capture.json

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

fixtures/test-many-capture.json

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

fixtures/test-merge-capture.json

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

fixtures/test-timestamp-capture.json

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