posthog-ruby 3.24.0 → 3.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 471bfa76731003cb33a963c903119506339f2e5cc51eb5b326a8af5df7deaabd
-  data.tar.gz: c41215d0fcc1edc5894b513788ca1e5777e98061f6017e80ae845c46c009d906
+  metadata.gz: 2ff857115cd53eb41945a0bad1a05768bb54770b4f5e2d8e8fda17a2bdb8a758
+  data.tar.gz: 910d5e7ade22aa5c3d8fed8794ad4f3b72230f1c649e40de8790b2acc9fa80e9
 SHA512:
-  metadata.gz: f183202aacd689a033e142a57d79355b115306fc39538220c7b002828883d15c8c61cccd29f3a40c7fde95df2ddefd55cebc4f0eab8fdf5cb9a800887b2536bd
-  data.tar.gz: 02123c015cb06e724ab63576948dbf928c7ce1f919772c0e5b70d69d62e2b7ce27ccbbb8a16b24de583c608d8566f5c7da806a2756cf6a182a40d7ced73d466e
+  metadata.gz: 34f457e72fb2c137e38f6188b9fb63dfb9541a21b705f373e1c4d39d4037c70ae2762f48774d9fbdfec015f3c745a6e0d6775e56c57d011b8f57bc5ee99e299c
+  data.tar.gz: dccddee87b9b57ae401a36f31f76685bb353974eb94c390d564582ad79cf4060544ede2b28229f87de486afb68d0f740b28becd8dcd878ab96494b1b0c6958de

data/lib/posthog/client.rb

@@ -44,9 +44,16 @@ module PostHog
       $is_server
       $lib
       $lib_version
+      $release_id
     ].flat_map { |key| [key, key.to_sym] }.freeze
     private_constant :MINIMAL_FLAG_CALLED_EVENT_PROPERTIES
 
+    # Holds the id that `posthog-cli release resolve` prints. Error tracking
+    # links an exception to its release by this id, because a Ruby app has no
+    # build step that could inject it.
+    RELEASE_ID_ENV_VAR = 'POSTHOG_RELEASE_ID'
+    private_constant :RELEASE_ID_ENV_VAR
+
     # Thread-safe tracking of client instances per API key for singleton warnings
     @instances_by_api_key = {}
     @instances_mutex = Mutex.new
@@ -217,6 +224,7 @@ module PostHog
 
       @before_send = opts[:before_send]
       @is_server = opts.fetch(:is_server, true) != false
+      @release_id = normalize_string_option(ENV.fetch(RELEASE_ID_ENV_VAR, nil), blank_as_nil: true)
       @deprecation_emitted_for = Concurrent::Set.new
     end
 
@@ -1137,6 +1145,8 @@ module PostHog
     def enqueue(action)
       return false if @disabled || shutdown?
 
+      # Every event type passes through here, and before_send still sees the id.
+      action = add_release_id(action)
       action = process_before_send(action)
       return false if action.nil? || action.empty?
 
@@ -1168,6 +1178,17 @@ module PostHog
       end
     end
 
+    # A `$release_id` the caller or the request context already set wins.
+    def add_release_id(action)
+      return action if @release_id.nil?
+
+      properties = action[:properties]
+      return action unless properties.is_a?(Hash)
+      return action if properties.key?('$release_id') || properties.key?(:$release_id)
+
+      action.merge(properties: properties.merge('$release_id' => @release_id))
+    end
+
     def normalize_string_option(value, blank_as_nil: false)
       return value unless value.is_a?(String)
 

data/lib/posthog/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 3.24.0
+  version: 3.25.0
 platform: ruby
 authors:
 - ''
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: PostHog library
 test_files: []