restify 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85964ce70270ead0fcc3271b733611bcb97f8415e03a91b46cb402032a4c68f5
-  data.tar.gz: 0c99e59283131de272b9a2a1ad23589395bb89e5b8753e330f305e7ec1483685
+  metadata.gz: c32d65b5a967073cd132c4ef1217feac5f5cb4a0939f85169f85342100bac323
+  data.tar.gz: 62a20c92f6fc2d1385a0deda66b45c1f47e160261825c2cef7441da45d1e05d5
 SHA512:
-  metadata.gz: 58bf934808c55172f28ec0673f543531c935b68e8e1f8fcf62435b49dfd7ab2e13522ef6c8b675fbfaf234be7ebfac4fdbfe05d57da4e97288b3876000a2487f
-  data.tar.gz: 4617aa58aa9ba400e1f28a0e5a854c5b56a560abb818432211958295e695feab6fe4bfeb0b5bd6418b231260db778804f4cf5309a34f8d1db9cb501d5f48fe6b
+  metadata.gz: 63e6635b67901b641c942993a158b05a2882298f6d51c909f7a35dbc3c911228091fd8eba961c89a1ff730ee32269e3cf7cd995868a5853495c43804dc931818
+  data.tar.gz: e762a1ecfd02c4f74c913f224e13fd9ae5d7d0d405f8861ad2b809be8c29956ba0b994cbad997801e16416bfa3fa02d7a0308a4b689ed5159cc40a8d7a1d9f6f

data/CHANGELOG.md

@@ -17,6 +17,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Breaks
 
+## 2.0.2 - (2025-05-19)
+
+---
+
+### Fixes
+
+- Restore literal false in parameter expansion (#68)
+
+## 2.0.1 - (2025-02-16)
+
+---
+
+### Fixes
+
+- Restore compatibility with WebMocks Typhoeus instrumentation
+- Catch WebMock exception and bubble them to the request promises
+
 ## 2.0.0 - (2025-02-14)
 
 ---

data/lib/restify/adapter/typhoeus.rb

@@ -23,19 +23,21 @@ module Restify
         tcp_keepintvl: 5,
       }.freeze
 
-      # Patch to store easy handles in the queue, instead of requests.
-      # This improves compatibility with OpenTelemetry instrumentation
-      # for Ethon, that needs the request handle to be constructed in
-      # the current threading context, not the background thread were
-      # Typhoeus is running.
+      # Patch Hydra to restore the correct OpenTelemetry span when
+      # adding the request, so that the Ethon instrumentation can
+      # properly pick up the context where the Restify request
+      # originated from.
+      #
+      # Handle exception from Ethon or WebMock too, and reject the
+      # promise, so that the errors can be handled in user code.
+      # Otherwise, the user would only receive a Promise timeout.
       module EasyOverride
-        def queue(request)
-          request.hydra = self
-          queued_requests << ::Typhoeus::EasyFactory.new(request, self).get
-        end
-
-        def add(handle)
-          multi.add(handle)
+        def add(request)
+          OpenTelemetry::Trace.with_span(request._otel_span) do
+            super(request)
+          rescue Exception => e # rubocop:disable Lint/RescueException
+            request._restify_writer.reject(e)
+          end
         end
       end
 
@@ -78,7 +80,7 @@ module Restify
       private
 
       def convert(request, writer)
-        ::Typhoeus::Request.new(
+        Request.new(
           request.uri,
           **@options,
           method: request.method,
@@ -87,6 +89,9 @@ module Restify
           timeout: request.timeout,
           connecttimeout: request.timeout,
         ).tap do |req|
+          req._otel_span = OpenTelemetry::Trace.current_span
+          req._restify_writer = writer
+
           req.on_complete do |response|
             debug 'request:complete',
               tag: request.object_id,
@@ -177,6 +182,16 @@ module Restify
       def _log_prefix
         "[#{object_id}/#{Thread.current.object_id}]"
       end
+
+      class Request < ::Typhoeus::Request
+        # Keep track of the OTEL span and the restify promise in the
+        # queued Typhoeus request.
+        #
+        # We need to access these to restore the tracing context, or
+        # bubble up exception that happen in the background thread after
+        # queuing, but when Hydra adds the requests to libcurl.
+        attr_accessor :_otel_span, :_restify_writer
+      end
     end
   end
 end

data/lib/restify/relation.rb

@@ -113,8 +113,12 @@ module Restify
 
     def extract!(params)
       @template.variables.each_with_object({}) do |var, hash|
-        if (value = params.delete(var) { params.delete(var.to_sym) { nil } })
-          hash[var] = value
+        sym = var.to_sym
+        if params.key?(var)
+          hash[var] = params.delete(var)
+        end
+        if params.key?(sym)
+          hash[sym] = params.delete(sym)
         end
       end
     end

data/lib/restify/version.rb

@@ -4,7 +4,7 @@ module Restify
   module VERSION
     MAJOR = 2
     MINOR = 0
-    PATCH = 0
+    PATCH = 2
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].compact.join('.').freeze
 

data/spec/restify/features/opentelemetry_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restify do
+  subject(:echo) { resource.data }
+
+  let(:resource) { Restify.new('http://localhost:9292/echo').get.value! }
+
+  before do
+    expect(OTLE_EXPORTER.finished_spans).to be_empty
+  end
+
+  describe 'OpenTelemetry' do
+    it 'adds propagation header' do
+      expect(echo).to have_key('HTTP_TRACEPARENT')
+    end
+
+    it 'adds spans' do
+      resource
+
+      spans = OTLE_EXPORTER.finished_spans
+      expect(spans.size).to eq 2
+
+      spans[1].tap do |span|
+        expect(span.instrumentation_scope.name).to eq 'restify'
+        expect(span.instrumentation_scope.version).to eq Restify::VERSION.to_s
+        expect(span.attributes).to eq({
+          'http.request.method' => 'GET',
+          'http.response.status_code' => 200,
+          'server.address' => 'localhost',
+          'server.port' => 9292,
+          'url.full' => 'http://localhost:9292/echo',
+          'url.scheme' => 'http',
+        })
+      end
+
+      # Latest span has to be from the Ethon instrumentation and must
+      # have the Restify span as a parent.
+      spans[0].tap do |span|
+        expect(span.instrumentation_scope.name).to match(/Ethon/)
+        expect(span.parent_span_id).to eq spans[1].span_id
+      end
+    end
+  end
+end

data/spec/restify/features/webmock_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restify do
+  before do
+    WebMock.enable!
+  end
+
+  after do
+    WebMock.disable!(except: %i[net_http])
+  end
+
+  describe 'WebMock' do
+    subject(:resource) { Restify.new('http://www.example.com/base').get.value! }
+
+    it 'can stub requests' do
+      stub_request(:any, 'http://www.example.com/base')
+
+      expect(resource.response.status).to eq(:ok)
+    end
+
+    it 'raises error for not stubbed requests' do
+      expect { resource }.to raise_error WebMock::NetConnectNotAllowedError
+    end
+  end
+end

data/spec/restify/relation_spec.rb

@@ -38,7 +38,7 @@ describe Restify::Relation do
     context 'with false' do
       let(:params) { {id: false} }
 
-      it { expect(expanded.to_s).to eq 'http://test.host/resource/' }
+      it { expect(expanded.to_s).to eq 'http://test.host/resource/false' }
     end
 
     context 'with true' do
@@ -59,6 +59,27 @@ describe Restify::Relation do
       it { expect(expanded.to_s).to eq 'http://test.host/resource/1,2' }
     end
 
+    context 'with nil query parameter' do
+      let(:pattern) { '/resource{?abc}' }
+      let(:params) { {abc: nil} }
+
+      it { expect(expanded.to_s).to eq 'http://test.host/resource' }
+    end
+
+    context 'with false query parameter' do
+      let(:pattern) { '/resource{?abc}' }
+      let(:params) { {abc: false} }
+
+      it { expect(expanded.to_s).to eq 'http://test.host/resource?abc=false' }
+    end
+
+    context 'with true query parameter' do
+      let(:pattern) { '/resource{?abc}' }
+      let(:params) { {abc: true} }
+
+      it { expect(expanded.to_s).to eq 'http://test.host/resource?abc=true' }
+    end
+
     context 'with unknown additional query parameter' do
       let(:pattern) { '/resource{?a,b}' }
       let(:params) { {a: 1, b: 2, c: 3} }
@@ -119,6 +140,38 @@ describe Restify::Relation do
 
       it { expect { expanded }.to raise_exception TypeError, /Can't convert Hash into String./ }
     end
+
+    context 'with string-keyed params' do
+      context 'with value' do
+        let(:params) { {'id' => 1} }
+
+        it { expect(expanded.to_s).to eq 'http://test.host/resource/1' }
+      end
+    end
+
+    context 'with mixed-keyed params' do
+      context 'non-overlapping' do
+        let(:params) { {'id' => 1, q: 2} }
+
+        it { expect(expanded.to_s).to eq 'http://test.host/resource/1?q=2' }
+      end
+
+      context 'overlapping (1)' do
+        let(:params) { {'id' => 1, id: 2} }
+
+        it 'prefers symbol value' do
+          expect(expanded.to_s).to eq 'http://test.host/resource/2'
+        end
+      end
+
+      context 'overlapping (2)' do
+        let(:params) { {id: 2, 'id' => 1} }
+
+        it 'prefers symbol value' do
+          expect(expanded.to_s).to eq 'http://test.host/resource/2'
+        end
+      end
+    end
   end
 
   shared_examples 'non-data-request' do |method|

data/spec/spec_helper.rb

@@ -30,6 +30,7 @@ if ENV['ADAPTER']
   end
 end
 
+require_relative 'support/opentelemetry'
 require_relative 'support/stub_server'
 
 RSpec.configure do |config|

data/spec/support/opentelemetry.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'opentelemetry/sdk'
+require 'opentelemetry/instrumentation/ethon'
+
+OTLE_EXPORTER = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new
+span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(OTLE_EXPORTER)
+
+OpenTelemetry::SDK.configure do |c|
+  c.error_handler = ->(exception:, message:) { raise(exception || message) }
+  c.logger = Logger.new($stderr, level: ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym)
+  c.add_span_processor span_processor
+
+  c.use 'OpenTelemetry::Instrumentation::Ethon'
+end
+
+RSpec.configure do |config|
+  config.around do |example|
+    OTLE_EXPORTER.reset
+
+    original_propagation = OpenTelemetry.propagation
+    propagator = OpenTelemetry::Trace::Propagation::TraceContext.text_map_propagator
+    OpenTelemetry.propagation = propagator
+
+    example.run
+  ensure
+    OpenTelemetry.propagation = original_propagation
+  end
+end

data/spec/support/stub_server.rb

@@ -18,6 +18,10 @@ module Stub
   # If no stub is found a special HTTP 599 error code will be returned.
   class Handler
     def call(env)
+      if env['REQUEST_URI'] == '/echo'
+        return [200, {'content-type': 'application/json'}, [env.to_json]]
+      end
+
       signature = WebMock::RequestSignature.new(
         env['REQUEST_METHOD'].downcase,
         "http://stubserver#{env['REQUEST_URI']}",

data/vendor/bundle/ruby/3.4.0/bundler/gems/my-rubocop-3bcd2110ca87/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jan Graichen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/vendor/bundle/ruby/3.4.0/bundler/gems/my-rubocop-3bcd2110ca87/README.md

@@ -0,0 +1,23 @@
+# Shared RuboCop Configuration
+
+Shared RuboCop configuration and defaults for my libraries and projects.
+
+## Usage
+
+```ruby
+# Gemfile
+
+gem 'rubocop-config', github: 'jgraichen/rubocop-config', tag: 'v13', require: false
+```
+
+```yaml
+# .rubocop.yml
+
+inherit_gem:
+  rubocop-config: default.yml
+
+AllCops:
+  TargetRubyVersion: 3.1
+  SuggestExtensions: False
+  NewCops: enable
+```

data/vendor/bundle/ruby/3.4.0/gems/activesupport-8.0.2/CHANGELOG.md

@@ -0,0 +1,255 @@
+## Rails 8.0.2 (March 12, 2025) ##
+
+*   No changes.
+
+
+## Rails 8.0.2 (March 12, 2025) ##
+
+*   Fix setting `to_time_preserves_timezone` from `new_framework_defaults_8_0.rb`.
+
+    *fatkodima*
+
+*   Fix Active Support Cache `fetch_multi` when local store is active.
+
+    `fetch_multi` now properly yield to the provided block for missing entries
+    that have been recorded as such in the local store.
+
+    *Jean Boussier*
+
+*   Fix execution wrapping to report all exceptions, including `Exception`.
+
+    If a more serious error like `SystemStackError` or `NoMemoryError` happens,
+    the error reporter should be able to report these kinds of exceptions.
+
+    *Gannon McGibbon*
+
+*   Fix `RedisCacheStore` and `MemCacheStore` to also handle connection pool related errors.
+
+    These errors are rescued and reported to `Rails.error`.
+
+    *Jean Boussier*
+
+*   Fix `ActiveSupport::Cache#read_multi` to respect version expiry when using local cache.
+
+    *zzak*
+
+*   Fix `ActiveSupport::MessageVerifier` and `ActiveSupport::MessageEncryptor` configuration of `on_rotation` callback.
+
+    ```ruby
+    verifier.rotate(old_secret).on_rotation { ... }
+    ```
+
+    Now both work as documented.
+
+    *Jean Boussier*
+
+*   Fix `ActiveSupport::MessageVerifier` to always be able to verify both URL-safe and URL-unsafe payloads.
+
+    This is to allow transitioning seemlessly from either configuration without immediately invalidating
+    all previously generated signed messages.
+
+    *Jean Boussier*, *Florent Beaurain*, *Ali Sepehri*
+
+*   Fix `cache.fetch` to honor the provided expiry when `:race_condition_ttl` is used.
+
+    ```ruby
+    cache.fetch("key", expires_in: 1.hour, race_condition_ttl: 5.second) do
+      "something"
+    end
+    ```
+
+    In the above example, the final cache entry would have a 10 seconds TTL instead
+    of the requested 1 hour.
+
+    *Dhia*
+
+*   Better handle procs with splat arguments in `set_callback`.
+
+    *Radamés Roriz*
+
+*   Fix `String#mb_chars` to not mutate the receiver.
+
+    Previously it would call `force_encoding` on the receiver,
+    now it dups the receiver first.
+
+    *Jean Boussier*
+
+*   Improve `ErrorSubscriber` to also mark error causes as reported.
+
+    This avoid some cases of errors being reported twice, notably in views because of how
+    errors are wrapped in `ActionView::Template::Error`.
+
+    *Jean Boussier*
+
+*   Fix `Module#module_parent_name` to return the correct name after the module has been named.
+
+    When called on an anonymous module, the return value wouldn't change after the module was given a name
+    later by being assigned to a constant.
+
+    ```ruby
+    mod = Module.new
+    mod.module_parent_name # => "Object"
+    MyModule::Something = mod
+    mod.module_parent_name # => "MyModule"
+    ```
+
+    *Jean Boussier*
+
+
+## Rails 8.0.1 (December 13, 2024) ##
+
+*   Fix a bug in `ERB::Util.tokenize` that causes incorrect tokenization when ERB tags are preceeded by multibyte characters.
+
+    *Martin Emde*
+
+*   Restore the ability to decorate methods generated by `class_attribute`.
+
+    It always has been complicated to use Module#prepend or an alias method chain
+    to decorate methods defined by `class_attribute`, but became even harder in 8.0.
+
+    This capability is now supported for both reader and writer methods.
+
+    *Jean Boussier*
+
+
+## Rails 8.0.0.1 (December 10, 2024) ##
+
+*   No changes.
+
+
+## Rails 8.0.0 (November 07, 2024) ##
+
+*   No changes.
+
+
+## Rails 8.0.0.rc2 (October 30, 2024) ##
+
+*   No changes.
+
+
+## Rails 8.0.0.rc1 (October 19, 2024) ##
+
+*   Remove deprecated support to passing an array of strings to `ActiveSupport::Deprecation#warn`.
+
+    *Rafael Mendonça França*
+
+*   Remove deprecated support to setting `attr_internal_naming_format` with a `@` prefix.
+
+    *Rafael Mendonça França*
+
+*   Remove deprecated `ActiveSupport::ProxyObject`.
+
+    *Rafael Mendonça França*
+
+*   Don't execute i18n watcher on boot. It shouldn't catch any file changes initially,
+    and unnecessarily slows down boot of applications with lots of translations.
+
+    *Gannon McGibbon*, *David Stosik*
+
+*   Fix `ActiveSupport::HashWithIndifferentAccess#stringify_keys` to stringify all keys not just symbols.
+
+    Previously:
+
+    ```ruby
+    { 1 => 2 }.with_indifferent_access.stringify_keys[1] # => 2
+    ```
+
+    After this change:
+
+    ```ruby
+    { 1 => 2 }.with_indifferent_access.stringify_keys["1"] # => 2
+    ```
+
+    This change can be seen as a bug fix, but since it behaved like this for a very long time, we're deciding
+    to not backport the fix and to make the change in a major release.
+
+    *Jean Boussier*
+
+## Rails 8.0.0.beta1 (September 26, 2024) ##
+
+*   Include options when instrumenting `ActiveSupport::Cache::Store#delete` and `ActiveSupport::Cache::Store#delete_multi`.
+
+    *Adam Renberg Tamm*
+
+*   Print test names when running `rails test -v` for parallel tests.
+
+    *John Hawthorn*, *Abeid Ahmed*
+
+*   Deprecate `Benchmark.ms` core extension.
+
+    The `benchmark` gem will become bundled in Ruby 3.5
+
+    *Earlopain*
+
+*   `ActiveSupport::TimeWithZone#inspect` now uses ISO 8601 style time like `Time#inspect`
+
+    *John Hawthorn*
+
+*   `ActiveSupport::ErrorReporter#report` now assigns a backtrace to unraised exceptions.
+
+    Previously reporting an un-raised exception would result in an error report without
+    a backtrace. Now it automatically generates one.
+
+    *Jean Boussier*
+
+*   Add `escape_html_entities` option to `ActiveSupport::JSON.encode`.
+
+    This allows for overriding the global configuration found at
+    `ActiveSupport.escape_html_entities_in_json` for specific calls to `to_json`.
+
+    This should be usable from controllers in the following manner:
+    ```ruby
+    class MyController < ApplicationController
+      def index
+        render json: { hello: "world" }, escape_html_entities: false
+      end
+    end
+    ```
+
+    *Nigel Baillie*
+
+*   Raise when using key which can't respond to `#to_sym` in `EncryptedConfiguration`.
+
+    As is the case when trying to use an Integer or Float as a key, which is unsupported.
+
+    *zzak*
+
+*   Deprecate addition and since between two `Time` and `ActiveSupport::TimeWithZone`.
+
+    Previously adding time instances together such as `10.days.ago + 10.days.ago` or `10.days.ago.since(10.days.ago)` produced a nonsensical future date. This behavior is deprecated and will be removed in Rails 8.1.
+
+    *Nick Schwaderer*
+
+*   Support rfc2822 format for Time#to_fs & Date#to_fs.
+
+    *Akshay Birajdar*
+
+*   Optimize load time for `Railtie#initialize_i18n`. Filter `I18n.load_path`s passed to the file watcher to only those
+    under `Rails.root`. Previously the watcher would grab all available locales, including those in gems
+    which do not require a watcher because they won't change.
+
+    *Nick Schwaderer*
+
+*   Add a `filter` option to `in_order_of` to prioritize certain values in the sorting without filtering the results
+    by these values.
+
+    *Igor Depolli*
+
+*   Improve error message when using `assert_difference` or `assert_changes` with a
+    proc by printing the proc's source code (MRI only).
+
+    *Richard Böhme*, *Jean Boussier*
+
+*   Add a new configuration value `:zone` for `ActiveSupport.to_time_preserves_timezone` and rename the previous `true` value to `:offset`. The new default value is `:zone`.
+
+    *Jason Kim*, *John Hawthorn*
+
+*   Align instrumentation `payload[:key]` in ActiveSupport::Cache to follow the same pattern, with namespaced and normalized keys.
+
+    *Frederik Erbs Spang Thomsen*
+
+*   Fix `travel_to` to set usec 0 when `with_usec` is `false` and the given argument String or DateTime.
+
+    *mopp*
+
+Please check [7-2-stable](https://github.com/rails/rails/blob/7-2-stable/activesupport/CHANGELOG.md) for previous changes.

data/vendor/bundle/ruby/3.4.0/gems/activesupport-8.0.2/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.