chargebee 2.74.0 → 2.76.0

data/spec/chargebee/telemetry_executor_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+module ChargeBee
+  class RecordingTelemetryAdapter
+    include Telemetry::TelemetryAdapter
+
+    attr_reader :events, :start_context, :end_result
+
+    def initialize
+      @events = []
+    end
+
+    def on_request_start(context, request_headers)
+      @events << 'start'
+      @start_context = context
+      request_headers['traceparent'] = '00-test-trace'
+      'span-1'
+    end
+
+    def on_request_end(handle, result)
+      @events << 'end'
+      @end_result = result
+    end
+  end
+end
+
+describe ChargeBee::TelemetryExecutor do
+  let(:env) do
+    ChargeBee::Environment.new(api_key: 'test_key', site: 'acme')
+  end
+
+  it 'skips telemetry when no adapter is configured' do
+    result = ChargeBee::TelemetryExecutor.execute(
+      env,
+      telemetry_resource: 'customer',
+      telemetry_operation: 'list',
+      method: 'get',
+      http_url: 'https://acme.chargebee.com/api/v2/customers',
+    ) do |headers|
+      expect(headers).to be_nil
+      [200, :ok]
+    end
+
+    expect(result).to eq(:ok)
+  end
+
+  it 'skips telemetry when resource or operation metadata is missing' do
+    adapter = ChargeBee::RecordingTelemetryAdapter.new
+    env.telemetry_adapter = adapter
+
+    result = ChargeBee::TelemetryExecutor.execute(
+      env,
+      telemetry_resource: '',
+      telemetry_operation: 'list',
+      method: 'get',
+      http_url: 'https://acme.chargebee.com/api/v2/customers',
+    ) do |_headers|
+      [200, :ok]
+    end
+
+    expect(result).to eq(:ok)
+    expect(adapter.events).to be_empty
+  end
+
+  it 'calls adapter once per request and injects trace headers' do
+    adapter = ChargeBee::RecordingTelemetryAdapter.new
+    env.telemetry_adapter = adapter
+
+    result = ChargeBee::TelemetryExecutor.execute(
+      env,
+      telemetry_resource: 'customer',
+      telemetry_operation: 'list',
+      method: 'get',
+      http_url: 'https://acme.chargebee.com/api/v2/customers',
+    ) do |headers|
+      expect(headers['traceparent']).to eq('00-test-trace')
+      [200, :ok]
+    end
+
+    expect(result).to eq(:ok)
+    expect(adapter.events).to eq(%w[start end])
+    expect(adapter.start_context.span_name).to eq('chargebee.customer.list')
+    expect(adapter.end_result.http_status_code).to eq(200)
+  end
+
+  it 'captures chargebee-* request headers and excludes the PII origin family' do
+    adapter = ChargeBee::RecordingTelemetryAdapter.new
+    env.telemetry_adapter = adapter
+    request_headers = {
+      'chargebee-foo' => 'bar',
+      'Chargebee-Idempotency-Key' => 'idem-key-1',
+      'Authorization' => 'Basic super-secret',
+      'chargebee-request-origin-ip' => '202.170.207.70',
+    }
+
+    ChargeBee::TelemetryExecutor.execute(
+      env,
+      telemetry_resource: 'customer',
+      telemetry_operation: 'list',
+      method: 'get',
+      http_url: 'https://acme.chargebee.com/api/v2/customers',
+      request_headers: request_headers,
+    ) do |_headers|
+      [200, :ok]
+    end
+
+    attrs = adapter.start_context.start_attributes
+    expect(attrs['http.request.header.chargebee-foo']).to eq('bar')
+    expect(attrs['http.request.header.chargebee-idempotency-key']).to eq('idem-key-1')
+    expect(attrs['http.request.header.authorization']).to be_nil
+    expect(attrs['http.request.header.chargebee-request-origin-ip']).to be_nil
+    expect(attrs.to_s).not_to include('202.170.207.70')
+  end
+
+  it 'records chargebee API errors on failure' do
+    adapter = ChargeBee::RecordingTelemetryAdapter.new
+    env.telemetry_adapter = adapter
+    api_error = ChargeBee::InvalidRequestError.new(
+      404,
+      {
+        message: 'Not found',
+        type: 'invalid_request',
+        api_error_code: 'resource_not_found',
+        param: 'customer_id',
+      },
+    )
+
+    expect do
+      ChargeBee::TelemetryExecutor.execute(
+        env,
+        telemetry_resource: 'customer',
+        telemetry_operation: 'retrieve',
+        method: 'get',
+        http_url: 'https://acme.chargebee.com/api/v2/customers/1',
+      ) do |_headers|
+        raise api_error
+      end
+    end.to raise_error(api_error)
+
+    expect(adapter.events).to eq(%w[start end])
+    expect(adapter.end_result.http_status_code).to eq(404)
+    expect(adapter.end_result.error.chargebee_error_code).to eq('resource_not_found')
+    expect(adapter.end_result.end_attributes['error.type']).to eq('invalid_request')
+    expect(adapter.end_result.end_attributes['chargebee.error.type']).to eq('invalid_request')
+    expect(adapter.end_result.end_attributes['error.type']).not_to eq('404')
+  end
+end

data/spec/chargebee/telemetry_support_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ChargeBee::Telemetry::TelemetrySupport do
+  describe '.build_request_end_span_attributes' do
+    it 'uses chargebee error type for error.type' do
+      error = ChargeBee::Telemetry::RequestTelemetryError.new(
+        message: 'Not found',
+        chargebee_error_code: 'resource_not_found',
+        chargebee_api_error_type: 'invalid_request',
+      )
+
+      attributes = described_class.build_request_end_span_attributes(404, error)
+
+      expect(attributes[ChargeBee::Telemetry::TelemetryAttributeKeys::HTTP_RESPONSE_STATUS_CODE]).to eq(404)
+      expect(attributes[ChargeBee::Telemetry::TelemetryAttributeKeys::ERROR_TYPE]).to eq('invalid_request')
+      expect(attributes[ChargeBee::Telemetry::TelemetryAttributeKeys::CHARGEBEE_ERROR_TYPE]).to eq('invalid_request')
+    end
+
+    it 'omits error.type when chargebee error classification is unavailable' do
+      error = ChargeBee::Telemetry::RequestTelemetryError.new(message: 'request failed')
+
+      attributes = described_class.build_request_end_span_attributes(500, error)
+
+      expect(attributes[ChargeBee::Telemetry::TelemetryAttributeKeys::HTTP_RESPONSE_STATUS_CODE]).to eq(500)
+      expect(attributes).not_to have_key(ChargeBee::Telemetry::TelemetryAttributeKeys::ERROR_TYPE)
+      expect(attributes).not_to have_key(ChargeBee::Telemetry::TelemetryAttributeKeys::CHARGEBEE_ERROR_TYPE)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargebee
 version: !ruby/object:Gem::Version
-  version: 2.74.0
+  version: 2.76.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-18 00:00:00.000000000 Z
+date: 2026-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -200,10 +200,20 @@ files:
 - lib/chargebee/request.rb
 - lib/chargebee/rest.rb
 - lib/chargebee/result.rb
+- lib/chargebee/telemetry/request_telemetry_context.rb
+- lib/chargebee/telemetry/request_telemetry_error.rb
+- lib/chargebee/telemetry/request_telemetry_result.rb
+- lib/chargebee/telemetry/telemetry_adapter.rb
+- lib/chargebee/telemetry/telemetry_attribute_keys.rb
+- lib/chargebee/telemetry/telemetry_support.rb
+- lib/chargebee/telemetry_executor.rb
 - lib/chargebee/util.rb
 - lib/ssl/ca-certs.crt
 - spec/chargebee/list_result_spec.rb
 - spec/chargebee/native_request_spec.rb
+- spec/chargebee/request_telemetry_spec.rb
+- spec/chargebee/telemetry_executor_spec.rb
+- spec/chargebee/telemetry_support_spec.rb
 - spec/chargebee_spec.rb
 - spec/errors_spec.rb
 - spec/sample_response.rb
@@ -236,6 +246,9 @@ summary: Ruby client for Chargebee API.
 test_files:
 - spec/chargebee/list_result_spec.rb
 - spec/chargebee/native_request_spec.rb
+- spec/chargebee/request_telemetry_spec.rb
+- spec/chargebee/telemetry_executor_spec.rb
+- spec/chargebee/telemetry_support_spec.rb
 - spec/chargebee_spec.rb
 - spec/errors_spec.rb
 - spec/sample_response.rb