aws-sdk-http-async 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88f4f98f87d385599ec9840f68c8dfeeed3646d57ed811794ff42fa1b8f7fa7e
+  data.tar.gz: c6ed9186e2702ea4a6e1e75fd877f0e02733eb84059802e64f8077518e5e706e
+SHA512:
+  metadata.gz: 13317a40574c669968cc4e74c905f9587cc047913d23dea202921b5130a0a0311abc3fa622655756e4fb71171f56c3199b0db87a083feab6f5a5905f9b63d34d
+  data.tar.gz: 32e297220c227f99daec5e30b328a3b7deffc33631cae6ae0f7b0d562fbdf57ca7b136ebf4b03c7a1ff209b1a2fb2375ab95b98040b2b75c12191d0287bb7b59

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+Unreleased Changes
+------------------
+
+0.1.0 (2026-01-19)
+------------------
+
+* Feature - Initial release of async-http handler plugin for aws-sdk-core.

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,382 @@
+# aws-sdk-http-async
+
+Async HTTP handler plugin for the AWS SDK for Ruby, built on `async-http`.
+
+Why? Because Net::HTTP blocks fibers, defeating Falcon's concurrency model.
+For high-throughput AWS APIs (DynamoDB, STS, IAM, Lambda), we need an async-compatible
+transport to restore concurrent I/O without threads.
+
+## Installation
+
+This gem uses async-http when an Async reactor is present (Falcon provides
+this). When no reactor is running, it falls back to Net::HTTP by default so CLI
+tools, tests, and console sessions work without extra setup.
+
+Add to your Gemfile:
+
+```ruby
+gem 'aws-sdk-http-async'
+```
+
+That's it.
+
+### Recommended AWS Client Initialization
+
+Create AWS clients once per process and reuse them (singleton or dependency
+injection). This keeps connection pooling effective and avoids rebuilding
+clients for every request.
+
+#### Singleton Repository Pattern
+
+```ruby
+module Database
+  class DynamodbRepository
+    include Singleton
+
+    INIT_MONITOR = Monitor.new
+
+    def client
+      return @client if defined?(@client) && @client
+
+      INIT_MONITOR.synchronize do
+        return @client if defined?(@client) && @client
+        @client = Aws::DynamoDB::Client.new
+      end
+    end
+  end
+end
+```
+
+Initializer shortcut:
+
+```ruby
+# config/initializers/aws_clients.rb
+DDB = Database::DynamodbRepository.instance unless defined?(DDB)
+```
+
+Usage:
+
+```ruby
+DDB.client.list_tables
+```
+
+#### Dependency Injection Pattern
+
+Alternative dependency injection example (preferred for testing
+if you need to swap clients per context):
+
+```ruby
+class WorldDominationService
+  def initialize(dynamodb:)
+    @dynamodb = dynamodb
+  end
+
+  def list_tables
+    @dynamodb.list_tables
+  end
+end
+
+service = WorldDominationService.new(dynamodb: Aws::DynamoDB::Client.new)
+```
+
+### File Handle Limits (EMFILE)
+
+If you see `Errno::EMFILE` or "Too many open files", raise your file descriptor
+limit.
+
+Recommended `bin/dev` snippet:
+
+```sh
+if command -v ulimit >/dev/null; then
+  current_limit=$(ulimit -n)
+  if [ "$current_limit" -lt 4096 ]; then
+    echo "Warning: ulimit -n is $current_limit. Falcon/Propshaft may hit EMFILE. Trying to raise to 65536..."
+    ulimit -n 65536 || echo "Warning: failed to raise ulimit. Set it manually (ulimit -n 65536) before bin/dev."
+  fi
+fi
+```
+
+You also might want to add the ENV `ULIMIT_NOFILE=65536` to your Dockerfile.
+and/or to your `bin/docker-entrypoint`:
+
+```sh
+if command -v ulimit >/dev/null; then
+  ulimit -n "${ULIMIT_NOFILE:-65536}" || echo "Warning: unable to raise ulimit -n"
+fi
+```
+
+### Advanced Configuration (Force Async Outside Falcon)
+
+To force async execution for all Rake tasks, add this line at the very top of
+your `Rakefile`, before any task definitions or Rails app loading (usually after
+`require_relative '../config/boot'`):
+
+```ruby
+require 'aws-sdk-http-async/rake'
+```
+
+## Configuration
+
+### Fallback Behavior (No Reactor)
+
+Fallback mode is configurable:
+
+```ruby
+# Default: use Net::HTTP when no reactor exists
+Aws.config[:async_http_fallback] = :net_http
+
+# Run the async-http path inside a transient reactor
+Aws.config[:async_http_fallback] = :sync
+
+# Strict mode: raise if no reactor is running
+Aws.config[:async_http_fallback] = :raise
+```
+
+You can also ENV set `AWS_SDK_HTTP_ASYNC_FALLBACK=net_http|sync|raise`.
+
+Event stream operations (e.g., Transcribe/Bedrock streaming) always require an
+Async reactor and will raise `NoReactorError` when none is running.
+
+### Sync vs Async
+
+If you want the async-http path in rake/CLI/tests, wrap the code you run in
+`Sync`:
+
+```ruby
+Sync do
+  client = Aws::DynamoDB::Client.new
+  client.list_tables
+end
+```
+
+`Sync { }` is the recommended wrapper outside Falcon. It is more efficient than
+`Async { }` and returns the block’s value directly.
+
+### Configuration options inherited from Net::HTTP plugin
+
+Supported options (inherited from Net::HTTP plugin):
+
+- `http_open_timeout`
+- `http_read_timeout`
+- `http_idle_timeout` (ignored; async-http manages internally)
+- `ssl_verify_peer`
+- `ssl_ca_store`
+- `ssl_ca_bundle`
+- `ssl_ca_directory`
+- `ssl_cert`
+- `ssl_key`
+- `http_proxy`
+
+Ignored Net::HTTP options:
+
+- `http_continue_timeout`
+- `http_wire_trace`
+
+#### SSL and certificates
+
+If you pass file paths for `ssl_cert` / `ssl_key`, this gem loads them with
+`File.read`, which is **blocking I/O**. For production, prefer pre‑loading at
+boot and passing OpenSSL objects instead:
+
+```ruby
+Aws::DynamoDB::Client.new(
+  ssl_cert: OpenSSL::X509::Certificate.new(File.read('/path/to/cert.pem')),
+  ssl_key: OpenSSL::PKey.read(File.read('/path/to/key.pem'))
+)
+```
+
+Tip: Reuse OpenSSL certificate/key objects across client instances to keep cache keys stable.
+
+#### Proxy Support Notes
+
+`http_proxy` accepts a full URL, e.g.:
+
+```ruby
+Aws::DynamoDB::Client.new(http_proxy: 'http://user:pass@proxy.local:8080')
+```
+
+Limitations:
+
+- Does **not** read `HTTP_PROXY`/`HTTPS_PROXY`/`NO_PROXY` env vars.
+- No PAC or proxy auto‑discovery.
+- HTTPS uses CONNECT; proxy auth must be embedded in the URL.
+- Proxy auth uses HTTP Basic based on `user:pass@` in the proxy URL.
+- HTTPS proxies reuse the same SSL verification options as the target (CA
+store/bundle/dir).
+- All requests for the client go through the configured proxy.
+
+### Plugin options
+
+- `async_http_connection_limit` (default: 10)
+- `async_http_force_accept_encoding` (default: true)
+- `async_http_body_warn_bytes` (default: 5_242_880)
+- `async_http_max_buffer_bytes` (default: 5MB; raise if buffering exceeds this; set to `nil` or `0` for unlimited)
+- `async_http_header_timeout` (default: nil; optional timeout for response headers, applied even for streaming request bodies)
+- `async_http_total_timeout` (default: nil; total request deadline in seconds)
+- `async_http_idle_timeout` (default: 30; used as endpoint timeout when `http_open_timeout` is not set; changing this at runtime requires clearing the client cache)
+- `async_http_max_cached_clients` (default: 100; LRU eviction per reactor when exceeded)
+- `async_http_streaming_uploads` (default: :auto; values: :auto, :force, :off)
+- `async_http_fallback` (default: :net_http; values: :net_http, :sync, :raise)
+- `async_http_client_cache` (default: nil, injectable cache for lifecycle control)
+
+### Timeout semantics
+
+`http_open_timeout` applies to the connection phase. `http_read_timeout` is
+enforced **per read chunk**, not as a total request deadline. For streaming
+uploads, the request body is **not** wrapped by `http_read_timeout` to avoid
+premature upload timeouts. Use `async_http_header_timeout` if you want a timeout
+for waiting on response headers even when the request body is streaming. A
+slow‑loris response that sends a byte before each timeout can remain open
+indefinitely; add your own total deadline if needed. Use
+`async_http_total_timeout` to enforce an overall deadline (upload + headers +
+body).
+
+### Opt-out of auto-patching
+
+If you want to load the handler without global patching:
+
+```ruby
+require 'aws-sdk-http-async/core'
+
+# Explicit plugin usage:
+Aws::DynamoDB::Client.add_plugin(Async::Aws::HttpPlugin)
+# or client = Aws::DynamoDB::Client.new(plugins: [Async::Aws::HttpPlugin])
+```
+
+If you explicitly add the plugin, only the clients you configure are affected.
+
+For the global patcher (default auto‑patch), registration is retroactive for
+already‑loaded AWS service clients. For test isolation, you can undo it:
+
+```ruby
+Async::Aws::Patcher.unpatch(:all)
+```
+
+Note: `unpatch(:all)` only removes the plugin from clients patched by the
+patcher. If you define custom subclasses of AWS service clients, they will
+inherit the plugin from their parent class and are not tracked for removal.
+
+Note: patching scans existing classes at load time; require this gem early in
+boot for best results.
+
+## Cache injection
+
+```ruby
+  cache = Async::Aws::ClientCache.new
+  client = Aws::DynamoDB::Client.new(async_http_client_cache: cache)
+```
+
+Use cache injection only when you want to **control or share** the async‑http
+connection pool yourself. It caches **async‑http client instances** (connection
+pools), not AWS responses. **Most apps should ignore this** and let the gem
+manage its own internal cache. Inject a cache only when you need one of these:
+
+- **Deterministic shutdown** in tests or short‑lived scripts (so servers don’t
+  hang waiting for pooled connections to drain).
+- **One shared pool across many AWS clients** to reduce sockets and improve
+  reuse.
+- **Custom lifecycle hooks** (e.g., you want to clear the pool on reload).
+
+If you inject a cache, call `clear!`/`close!` during shutdown to close pooled
+connections. For cross‑reactor apps, call it inside each reactor to ensure
+clients are closed on their owning reactor. Calling `clear!` outside any
+reactor will force‑close clients, which can interrupt in‑flight requests.
+
+The cache is capped by `async_http_max_cached_clients` using per‑reactor LRU
+eviction. Set it to `nil` or `0` to disable eviction.
+
+Cold‑start behavior: the cache is **not** gated. If multiple fibers hit a
+totally cold cache for the same endpoint at the same time, they may build
+duplicate clients; the extra client is closed immediately. This trades a tiny
+one‑time overhead for simpler, more reliable concurrency.
+
+Memory note: `async_http_max_buffer_bytes` is per request. For high‑concurrency
+or memory‑constrained environments, consider lowering it further to avoid
+aggregate spikes.
+
+## Test Notes
+
+WebMock works for unit tests, but connection pooling can keep sockets open. Use
+`WebMock.disable_net_connect!(allow_localhost: true)` and isolate tests that
+rely on real IO.
+
+### Docker integration tests
+
+RSpec Integration tests run against DynamoDB Local + MinIO,
+and proxy tests use tinyproxy + toxiproxy.
+
+### RSpec/rails test setup
+
+No special setup is required. When no reactor is present, the gem uses Net::HTTP
+by default. Use `Sync { }` if you want tests to exercise the async-http path.
+
+The gem also supplies a simple `async-rake` script for testing async behavior in Rake
+
+## Current Limitations
+
+- **Streaming uploads (`:auto`)** only stream rewindable bodies with known size.
+Non‑rewindable or unknown‑size bodies are buffered for retry safety. Buffering
+is capped by `async_http_max_buffer_bytes` (default: 5MB).
+- **`:force` streaming** raises when retries are enabled for non‑rewindable
+bodies.
+- **Event streams** are delegated to the SDK's native HTTP/2 handler (Async
+clients only).
+- **Multipart uploads** stream when the body is rewindable and size is known
+(File, StringIO, or explicit Content‑Length).
+- **Duplicate headers** are merged with commas (Net::HTTP parity); Set‑Cookie
+and Set‑Cookie2 values are joined with "\n" to preserve cookie boundaries.
+
+### Next Steps
+
+- Native event stream support on async-http HTTP/2 (non‑trivial; SDK’s native handler already works with HTTP/2)
+- Smarter proxy support (env vars, PAC)
+
+See `md-docs/aws-sdk-http-async-rfc.md` for current design notes.
+
+## Development
+
+```bash
+bundle install
+# Do your development stuff.
+bundle exec rake formatter
+bundle exec rspec
+bin/ci
+```
+
+### Release (maintainers)
+
+Quick reference:
+
+```bash
+VERSION=0.1.0
+
+# Build + push (after version bump + changelog)
+gem build aws-sdk-http-async.gemspec
+gem push "aws-sdk-http-async-${VERSION}.gem"
+
+# Tag + push
+git tag -a "v${VERSION}" -m "Release v${VERSION}"
+git push origin main --tags
+```
+
+GitHub release (optional, via `gh`):
+
+```bash
+gh release create "v${VERSION}" \
+  --title "v${VERSION}" \
+  --generate-notes \
+  --assets "aws-sdk-http-async-${VERSION}.gem"
+```
+
+### Requirements
+
+- Ruby 3.4+
+- aws-sdk-core >= 3.241.0
+- async-http >= 0.94.0
+
+No backwards compatibility is maintained for older Ruby/AWS SDK versions.
+
+# Author
+
+Author: [Thomas Witt](https://thomas-witt.com)
+Github: <https://github.com/thomaswitt/aws-sdk-http-async>

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/exe/async-rake

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'async'
+require 'rake'
+require 'aws-sdk-http-async'
+
+Async do
+  Rake.application.run
+end.wait

data/lib/async/aws/auto.rb

@@ -0,0 +1 @@
+require 'aws-sdk-http-async'