honeycomb-beeline 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c117f411dfa05f94d94ae9d313afdc11e1f6c99395b64c4ba6cd5b064e0f5495
-  data.tar.gz: 1379c608d00c04e6ab065f68710c77ce298f081336dbf0291585523343ef0ef1
+  metadata.gz: 6be26f3bc54561c09f8c6c35ab53586a71fd46cbff7a6d926c9e38b4246d9f49
+  data.tar.gz: bd9723d71f943492047ecad4c3634c54520346c6b3bd75a50bfb72498cffb339
 SHA512:
-  metadata.gz: f018311206155ca7155cc737a04e8f72bfea03447647ae7688e834a99dc41a93d8045014e7cba6c1c337779feff9f07ad40301a82eccfe3c677e5868747701ac
-  data.tar.gz: c653b95ca53f6aef8abbdc056d32cd51bf663b0e4960ae8d1d111b60f5f55adf63bd6e9ffbdb79bd8ead78dc399509006851c0f23df2263f550bfbb229b32a7d
+  metadata.gz: cd27f4f6844b6f691343e9fbdc2ea86b92a7a32e44005510d2e7d2270b0afa56a4ff1d7444608872f01cc053037a971d6c17a68d2548b3d3be34c327ed082989
+  data.tar.gz: fd2ce5459d4a2c2762d3c4caf625d120ae3fa15149ec288ee62c4d1eceb4b01618f66465e2e056684c1e2faebf4dceb1351364987c58e3a371ad037e879f262e

data/.circleci/config.yml

@@ -132,10 +132,10 @@ jobs:
           path: coverage
 
 workflows:
-  nightly:
+  weekly:
     triggers:
       - schedule:
-          cron: "0 0 * * *"
+          cron: "0 0 * * 0"
           filters:
             branches:
               only:

data/.gitignore

@@ -13,3 +13,6 @@
 .rspec_status
 
 /examples/**/*.lock
+
+# intentionally omitting lock files
+Gemfile.lock

data/.rubocop.yml

@@ -36,11 +36,7 @@ Metrics/ParameterLists:
   Max: 6
 
 Style/AccessModifierDeclarations:
-  Exclude:
-    - lib/honeycomb/propagation/aws.rb
-    - lib/honeycomb/propagation/w3c.rb
-    - lib/honeycomb/propagation/honeycomb.rb
-    - lib/honeycomb/propagation/default.rb
+  Enabled: false
 
 Style/FrozenStringLiteralComment:
   EnforcedStyle: always

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # beeline-ruby changelog
 
+## 3.0.1 2023-10-12
+
+### Fixed
+
+- fix: clean invalid UTF8 from trace field values when generating propagation header (#232) | Robb Kidd
+
+### Maintenance
+
+- maint: add local dev notes and fix example (#233) | Jamie Danielson
+- ci: move nightly to weekly (#230) | Vera Reynolds
+- ci: AWS specs updated to use include() instead of match() (#229) | Robb Kidd
+
 ## 3.0.0 2023-06-08
 
 ### ⚠️ Breaking Changes ⚠️

data/DEVELOPING.md

@@ -0,0 +1,31 @@
+# Local Development
+
+## Requirements
+
+Ruby: <https://www.ruby-lang.org/en/documentation/installation/>
+
+Rake:
+
+```shell
+gem install rake
+```
+
+## Install dependencies
+
+```shell
+bundle install
+```
+
+## Run Tests
+
+To run all tests:
+
+```shell
+bundle exec rake test
+```
+
+To run individual tests:
+
+```shell
+bundle exec rake test TEST=spec/honeycomb/trace_spec.rb
+```

data/RELEASING.md

@@ -1,9 +1,13 @@
 # Releasing
 
-- Update the version number in `lib/honeycomb/beeline/version`.
-- Update `CHANGELOG.md` with the changes since the last release.
+- Update the version number in `lib/honeycomb/beeline/version.rb`.
+- Update `CHANGELOG.md` with the changes since the last release. Consider automating with a command such as these two:
+  - `git log $(git describe --tags --abbrev=0)..HEAD --no-merges --oneline > new-in-this-release.log`
+  - `git log --pretty='%C(green)%d%Creset- %s | %an'`
 - Commit changes, push, and open a release preparation pull request for review.
 - Once the pull request is merged, fetch the updated `main` branch.
-- Apply a tag for the new version on the merged commit: vX.Y.Z, for example v1.1.2.
-- Push the new version tag up to the project repository to kick off build and artifact publishing to GitHub and the Gems registry.
+- Apply a tag for the new version on the merged commit (e.g. `git tag -a v2.3.1 -m "v2.3.1"`)
+- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v2.3.1`
+- Ensure that there is a draft GitHub release created as part of CI publish steps (this will also publish to Gems registry).
+- Click "generate release notes" in GitHub for full changelog notes and any new contributors
 - Publish the draft release in GitHub.

data/lib/honeycomb/beeline/version.rb

@@ -3,7 +3,7 @@
 module Honeycomb
   module Beeline
     NAME = "honeycomb-beeline"
-    VERSION = "3.0.0"
+    VERSION = "3.0.1"
     USER_AGENT_SUFFIX = "#{NAME}/#{VERSION}"
   end
 end

data/lib/honeycomb/propagation/default_modern.rb

@@ -20,10 +20,8 @@ module Honeycomb
           [nil, nil, nil, nil]
         end
       end
-      # rubocop:disable Style/AccessModifierDeclarations
       module_function :parse_rack_env
       public :parse_rack_env
-      # rubocop:enable Style/AccessModifierDeclarations
     end
   end
 end

data/lib/honeycomb/propagation/honeycomb.rb

@@ -3,6 +3,7 @@
 require "base64"
 require "json"
 require "uri"
+require "libhoney/cleaner"
 
 module Honeycomb
   # Parsing and propagation for honeycomb trace headers
@@ -41,7 +42,7 @@ module Honeycomb
           when "parent_id"
             parent_span_id = value
           when "context"
-            Base64.decode64(value).tap do |json|
+            Base64.urlsafe_decode64(value).tap do |json|
               trace_fields = JSON.parse json
             rescue JSON::ParserError
               trace_fields = {}
@@ -58,14 +59,17 @@ module Honeycomb
 
     # Serialize trace headers
     module MarshalTraceContext
+      # for cleaning data in trace fields before serializing to prop header value
+      include Libhoney::Cleaner
+      # promote cleaner instance methods to module methods so that self.to_trace_header can use them
+      module_function :clean_data, :clean_string
+
       def to_trace_header
-        context = Base64.urlsafe_encode64(JSON.generate(trace.fields)).strip
-        encoded_dataset = URI.encode_www_form_component(builder.dataset)
         data_to_propogate = [
-          "dataset=#{encoded_dataset}",
+          "dataset=#{encode_dataset(builder.dataset)}",
           "trace_id=#{trace.id}",
           "parent_id=#{id}",
-          "context=#{context}",
+          "context=#{encode_trace_fields(trace.fields)}",
         ]
         "1;#{data_to_propogate.join(',')}"
       end
@@ -77,18 +81,28 @@ module Honeycomb
       end
 
       def self.to_trace_header(propagation_context)
-        fields = propagation_context.trace_fields
-        context = Base64.urlsafe_encode64(JSON.generate(fields)).strip
-        dataset = propagation_context.dataset
-        encoded_dataset = URI.encode_www_form_component(dataset)
         data_to_propogate = [
-          "dataset=#{encoded_dataset}",
+          "dataset=#{encode_dataset(propagation_context.dataset)}",
           "trace_id=#{propagation_context.trace_id}",
           "parent_id=#{propagation_context.parent_id}",
-          "context=#{context}",
+          "context=#{encode_trace_fields(propagation_context.trace_fields)}",
         ]
         "1;#{data_to_propogate.join(',')}"
       end
+
+      def encode_trace_fields(fields)
+        Base64.urlsafe_encode64(
+          JSON.generate(
+            clean_data(fields),
+          ),
+        ).strip
+      end
+      module_function :encode_trace_fields
+
+      def encode_dataset(dataset)
+        URI.encode_www_form_component(dataset)
+      end
+      module_function :encode_dataset
     end
   end
 end

data/lib/honeycomb/propagation/honeycomb_modern.rb

@@ -3,6 +3,7 @@
 require "base64"
 require "json"
 require "uri"
+require "libhoney/cleaner"
 
 module Honeycomb
   # Parsing and propagation for honeycomb trace headers
@@ -39,7 +40,7 @@ module Honeycomb
           when "parent_id"
             parent_span_id = value
           when "context"
-            Base64.decode64(value).tap do |json|
+            Base64.urlsafe_decode64(value).tap do |json|
               trace_fields = JSON.parse json
             rescue JSON::ParserError
               trace_fields = {}
@@ -56,12 +57,16 @@ module Honeycomb
 
     # Serialize trace headers
     module MarshalTraceContext
+      # for cleaning data in trace fields before serializing to prop header value
+      include Libhoney::Cleaner
+      # promote cleaner instance methods to module methods so that self.to_trace_header can use them
+      module_function :clean_data, :clean_string
+
       def to_trace_header
-        context = Base64.urlsafe_encode64(JSON.generate(trace.fields)).strip
         data_to_propogate = [
           "trace_id=#{trace.id}",
           "parent_id=#{id}",
-          "context=#{context}",
+          "context=#{encode_trace_fields(trace.fields)}",
         ]
         "1;#{data_to_propogate.join(',')}"
       end
@@ -73,15 +78,22 @@ module Honeycomb
       end
 
       def self.to_trace_header(propagation_context)
-        fields = propagation_context.trace_fields
-        context = Base64.urlsafe_encode64(JSON.generate(fields)).strip
         data_to_propogate = [
           "trace_id=#{propagation_context.trace_id}",
           "parent_id=#{propagation_context.parent_id}",
-          "context=#{context}",
+          "context=#{encode_trace_fields(propagation_context.trace_fields)}",
         ]
         "1;#{data_to_propogate.join(',')}"
       end
+
+      def encode_trace_fields(fields)
+        Base64.urlsafe_encode64(
+          JSON.generate(
+            clean_data(fields),
+          ),
+        ).strip
+      end
+      module_function :encode_trace_fields
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -260,6 +260,7 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
+- DEVELOPING.md
 - Gemfile
 - LICENSE
 - NOTICE