faraday-hedge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9e3815ee4e3c7b0138fbb6281257e326acde2e95e6b3a6df9d18fb19b86d658
+  data.tar.gz: c7b5347f8bfdfc69361509631093e2794c779afd3804dbd29bffa60a82b7847a
+SHA512:
+  metadata.gz: 522cc67bbd621d2ffcdac40780d79ce2f0cf6fef9b9ba5eb46ac6cc31e7581ed848b10a6dfa08d430477417a79d382f9792330c0349df276d2c1b2f5dcf5cdfa
+  data.tar.gz: 188ed7b0722350c3d45dd1f0ca8fd112db4504eda410950275085d36e9c1d7568db45f77612975f600aabb99bbf28727a11f7b0359e99e521109c1e5b2c360bb

data/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["3.0", "3.1", "3.2", "3.3"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# bundler
+Gemfile.lock
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,26 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+We pledge to make participation in our community a harassment-free experience for everyone.
+
+## Our Standards
+Examples of behavior that contributes to a positive environment include:
+- Using welcoming and inclusive language
+- Respecting differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+
+Examples of unacceptable behavior include:
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+
+## Enforcement Responsibilities
+Project maintainers are responsible for clarifying and enforcing standards of acceptable behavior.
+
+## Scope
+This Code of Conduct applies within all project spaces and in public spaces when representing the project.
+
+## Enforcement
+Instances of abusive behavior may be reported to the maintainer listed in the gemspec.
+
+## Attribution
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4.

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing
+
+## Development setup
+- Run `bundle install`
+- Run `bundle exec rspec`
+
+## Release
+1. Update `CHANGELOG.md`
+2. Bump version in `lib/**/version.rb`
+3. Run `bundle exec rake release`

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in faraday-hedge.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 MounirGaiby
+
+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/README.md

@@ -0,0 +1,47 @@
+# Faraday Hedge
+
+Hedged requests middleware for Faraday to reduce tail latency on idempotent methods.
+
+## About
+Faraday Hedge issues a backup request after a small delay and returns the first response. This reduces tail latency when occasional slow requests occur, while keeping overall load bounded.
+
+The middleware defaults to idempotent methods and can be configured to hedge only specific HTTP verbs.
+
+## Use Cases
+- Reduce p99 latency for flaky upstream APIs
+- Protect against tail latency spikes on critical read paths
+- Improve UX for latency-sensitive services
+
+## Compatibility
+- Ruby 3.0+
+- Faraday 1.0+
+
+## Installation
+```ruby
+# Gemfile
+
+gem "faraday-hedge"
+```
+
+## Usage
+```ruby
+conn = Faraday.new do |f|
+  f.request :hedge, delay: 0.05
+  f.adapter :net_http
+end
+```
+
+## Options
+- `delay` (Float) seconds before firing a backup request
+- `max_hedges` (Integer) number of backup requests to allow
+- `methods` (Array) methods eligible for hedging
+- `idempotent_only` (Boolean) restrict hedging to idempotent methods
+
+## Notes
+- Hedging uses background threads.
+- Use conservative delays to avoid excessive duplicate work.
+
+## Release
+```bash
+bundle exec rake release
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "faraday/hedge"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/faraday-hedge.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "faraday/hedge/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "faraday-hedge"
+  spec.version = Faraday::Hedge::VERSION
+  spec.authors = ["MounirGaiby"]
+  spec.email = ["mounirgaiby@gmail.com"]
+
+  spec.summary = "Hedged requests middleware for Faraday to reduce tail latency."
+  spec.description = "Issue a backup request after a delay and return the first response."
+  spec.homepage = "https://github.com/elysium-arc/faraday-hedge"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/elysium-arc/faraday-hedge"
+  spec.metadata["changelog_uri"] = "https://github.com/elysium-arc/faraday-hedge/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", ">= 1.0"
+
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "simplecov", "~> 0.22"
+end

data/lib/faraday/hedge/version.rb

@@ -0,0 +1,5 @@
+module Faraday
+  class Hedge
+    VERSION = "0.1.0"
+  end
+end

data/lib/faraday/hedge.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/hedge/version"
+
+module Faraday
+  class Hedge
+    DEFAULT_DELAY = 0.1
+    DEFAULT_MAX_HEDGES = 1
+
+    def initialize(app, options = {})
+      @app = app
+      @delay = options.fetch(:delay, DEFAULT_DELAY)
+      @max_hedges = options.fetch(:max_hedges, DEFAULT_MAX_HEDGES)
+      @methods = Array(options.fetch(:methods, %i[get head])).map(&:to_sym)
+      @idempotent_only = options.fetch(:idempotent_only, true)
+    end
+
+    def call(env)
+      return @app.call(env) unless hedgeable?(env)
+
+      responses = Queue.new
+      primary_thread = Thread.new { responses << @app.call(env.dup) }
+
+      hedge_thread = Thread.new do
+        sleep @delay
+        # :nocov:
+        return if primary_thread.join(0)
+        # :nocov:
+        responses << @app.call(env.dup)
+      end
+
+      response = responses.pop
+      [primary_thread, hedge_thread].each { |t| t.kill if t.alive? }
+      response
+    end
+
+    private
+
+    def hedgeable?(env)
+      return false if @idempotent_only && !@methods.include?(env.method)
+      @max_hedges > 0
+    end
+  end
+
+  Request.register_middleware(hedge: Faraday::Hedge)
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: faraday-hedge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MounirGaiby
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Issue a backup request after a delay and return the first response.
+email:
+- mounirgaiby@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faraday-hedge.gemspec
+- lib/faraday/hedge.rb
+- lib/faraday/hedge/version.rb
+homepage: https://github.com/elysium-arc/faraday-hedge
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/elysium-arc/faraday-hedge
+  source_code_uri: https://github.com/elysium-arc/faraday-hedge
+  changelog_uri: https://github.com/elysium-arc/faraday-hedge/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Hedged requests middleware for Faraday to reduce tail latency.
+test_files: []