posthog-ruby 3.12.1 → 3.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f51843606a47a924b1a6b772f02c61c90e9446c16827b3d5b28d92d7fdade73a
-  data.tar.gz: 4cfbb395d74bf0f9630b35fafafc6f4eedcdbce9e32a0a8825880f461b581fd9
+  metadata.gz: 333bb9ea61d04be7324d0c46eb5dbfa2938a583f8fd88bba845ee6300d219702
+  data.tar.gz: eeceaa50cc3defed270dc48ad6863e555d3068a21929c0157f03743b943fdde2
 SHA512:
-  metadata.gz: 9978900c0f4091624f901a72396f4b2915cc4532503d1bd3a17c7f7e27a142463f5dbbe8e40d621cb52ae95871055f720d5a1a7a5e4652f266604a7311e2dd68
-  data.tar.gz: a815192b4521d259e0f2b8c3adba4c1ef2ef2b30748b4ca56c38f5b4d2b3633b1d500d7b06fe1f51d7e4046d3df618c82e2f5a0ed84ed12eb2f87d94f57dc7b8
+  metadata.gz: a35cbbd21df7355144bf1f1c6f25e36fc1ab3341d09a326941f8d4f41b7e40766019a4935e6930f8874bf18fe9bf4b0a265879c8f6e87f5a4eb930ddac33c923
+  data.tar.gz: 9269f70dd837716bcbf638e626a6928dcc32f7f9c3e4e49b53777cac2d4347b050b65d1393c70ff750cdee8a25baad5607467b2da4454d272a0fd1ad6f4b311d

data/lib/posthog/client.rb

@@ -181,8 +181,10 @@ module PostHog
     end
 
     # @!macro common_attrs
-    #   @option attrs [String] :message_id ID that uniquely
-    #     identifies a message across the API. (optional)
+    #   @option attrs [String] :message_id Deprecated. Use `:uuid` instead. If `:uuid` is absent or
+    #     invalid and `:message_id` is a valid UUID, it is sent as `uuid` for backwards compatibility.
+    #     If neither value is valid, the SDK generates a `uuid`. SDK metadata is sent as `$lib` and
+    #     `$lib_version` properties.
     #   @option attrs [Time] :timestamp When the event occurred (optional)
     #   @option attrs [String] :distinct_id The ID for this user in your database
 
@@ -949,9 +951,6 @@ module PostHog
       action = process_before_send(action)
       return false if action.nil? || action.empty?
 
-      # add our request id for tracing purposes
-      action[:messageId] ||= uid
-
       if @sync_mode
         send_sync(action)
         return true

data/lib/posthog/field_parser.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 require 'posthog/logging'
 
 module PostHog
@@ -25,7 +27,6 @@ module PostHog
         event = fields[:event]
         properties = fields[:properties] || {}
         groups = fields[:groups]
-        uuid = fields[:uuid]
         check_presence!(event, 'event')
         check_is_hash!(properties, 'properties')
 
@@ -36,8 +37,6 @@ module PostHog
 
         isoify_dates! properties
 
-        common['uuid'] = uuid if valid_uuid_for_event_props? uuid
-
         common.merge(
           {
             type: 'capture',
@@ -130,12 +129,13 @@ module PostHog
       #
       # - "timestamp"
       # - "distinct_id"
-      # - "message_id"
+      # - "message_id" (deprecated; normalized to "uuid" when it is a valid UUID)
       # - "send_feature_flags"
+      #
+      # A new "uuid" is generated when neither "uuid" nor "message_id" is valid.
       def parse_common_fields(fields)
         timestamp = fields[:timestamp] || Time.new
         distinct_id = fields[:distinct_id]
-        message_id = fields[:message_id].to_s if fields[:message_id]
         send_feature_flags = fields[:send_feature_flags]
 
         check_timestamp! timestamp
@@ -151,13 +151,12 @@ module PostHog
 
         parsed = {
           timestamp: datetime_in_iso8601(timestamp),
-          library: 'posthog-ruby',
-          library_version: PostHog::VERSION.to_s,
-          messageId: message_id,
           distinct_id: distinct_id,
           properties: properties
         }
 
+        parsed['uuid'] = normalized_uuid(fields)
+
         if send_feature_flags && fields[:feature_variants]
           feature_variants = fields[:feature_variants]
           active_feature_variants = {}
@@ -190,6 +189,16 @@ module PostHog
         raise ArgumentError, "#{name} must be a Hash" unless obj.is_a? Hash
       end
 
+      def normalized_uuid(fields)
+        uuid = fields[:uuid]
+        return uuid if uuid && valid_uuid_for_event_props?(uuid)
+
+        message_id = fields[:message_id]
+        return message_id if message_id && valid_uuid_for_event_props?(message_id)
+
+        SecureRandom.uuid
+      end
+
       # @param [Object] uuid - the UUID to validate, user provided, so we don't know the type
       # @return [TrueClass, FalseClass] - true if the UUID is valid or absent, false otherwise
       def valid_uuid_for_event_props?(uuid)

data/lib/posthog/utils.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'securerandom'
-
 module PostHog
   class InconclusiveMatchError < StandardError
   end
@@ -60,16 +58,6 @@ module PostHog
       hash.replace isoify_dates hash
     end
 
-    # public: Returns a uid string
-    #
-    def uid
-      arr = SecureRandom.random_bytes(16).unpack('NnnnnN')
-      arr[2] = (arr[2] & 0x0fff) | 0x4000
-      arr[3] = (arr[3] & 0x3fff) | 0x8000
-
-      '%08x-%04x-%04x-%04x-%04x%08x' % arr # rubocop:disable Style/FormatStringToken, Style/FormatString
-    end
-
     def datetime_in_iso8601(datetime)
       case datetime
       when Time

data/lib/posthog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PostHog
-  VERSION = '3.12.1'
+  VERSION = '3.12.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 3.12.1
+  version: 3.12.2
 platform: ruby
 authors:
 - ''