connectrpc-rack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89157d4e979bf28657e56b42a59dfc8e904a24dbfb8be4df9c67ad1623604096
+  data.tar.gz: 7e41f28f18a84654ee4777013375f99e24fe1e8882d527142526af5ab22f5f09
+SHA512:
+  metadata.gz: c4aa5acbebf4d24498dec78679c010d989c11907a680f07f0a285b9110555fd2f8bc353b3bffdf235d8810566c8f9e50da54211ef502577e0c836dca584d9e4b
+  data.tar.gz: '08032790182e68bb709634f1bca46d77217488e1622e47f9c1a9371a22ddb05bdd90b09d4e3a48fa210dbd67e97eb029f87ab1cf899de478ef662e4215d0000f'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jim Myhrberg
+
+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,96 @@
+# connectrpc-rack
+
+Optional, experimental Rack middleware for the unofficial Connect unary Ruby gem.
+Requires Ruby >= 3.4, `connectrpc ~> 0.1.0` and `rack >= 3.2.7, < 4`.
+This package uses the [MIT license](LICENSE), copyright 2026 Jim Myhrberg.
+It is released with the whole [release train](../../docs/releasing.md).
+
+See the [supported 0.x contract](../../docs/support.md) for the target support
+profile, matched package versions, compatibility policy and adoption gates.
+
+## Installation and migration
+
+Rack middleware now ships in this separate package. Applications that previously
+used middleware from `connectrpc` must add this dependency to their Gemfile:
+
+```ruby
+gem "connectrpc-rack", "~> 0.1.0"
+```
+
+Keep `require "connectrpc/rack"`, `ConnectRPC::Rack.new(server: server)` and
+`call(env)` unchanged. The entry point loads core normally. Core installed alone
+has no runtime dependencies, loads no Rack, and has no `connectrpc/rack` file.
+This changes installation; Rack already required an explicit optional require.
+
+## Usage
+
+```ruby
+require "connectrpc/rack"
+
+# Build a host-neutral ConnectRPC::Server with your binding and handlers.
+app = ConnectRPC::Rack.new(server: server)
+# Or preserve an existing application's unrelated routes:
+app = ConnectRPC::Rack.new(downstream_app, server: server)
+```
+
+Supply the app to your Rack host. This package does not start a production host.
+It translates `PATH_INFO`, raw `QUERY_STRING`, request headers and `rack.input` into core Server
+calls and returns Rack status, headers and body. Mount prefixes use `SCRIPT_NAME`;
+registered service paths belong to ConnectRPC, including unknown methods.
+Unrelated paths call the downstream app, or return 404 when none was supplied.
+Repeated response metadata and `trailer-*` fields remain Rack 3 arrays. Rack env
+normalization loses the distinction between underscore and hyphen request
+metadata names; native metadata acceptance is unchanged.
+
+The core Server owns unary proto/JSON negotiation, identity/opt-in gzip, bounded
+input/output, typed errors and cooperative deadlines. Synchronous Rack cannot
+interrupt blocked reads or arbitrary handlers or reliably detect disconnects.
+See [design](../../docs/design.md), [examples](../../examples/unary.rb) and the
+[optional Rails adapter](../connectrpc-on-rails/README.md) for native controller execution.
+
+## Development
+
+The independent frozen development bundle reuses existing exact registry pins.
+Run from the repository root:
+
+```sh
+mise run rack:setup
+mise run rack:test
+mise run rack:check
+mise run rack:package
+mise run verify
+mise run rack:verify
+```
+
+Focused specs accept selectors, for example
+`mise run rack:test -- spec/rack_spec.rb`. Bundles, Bundler state, lint cache and
+archives live under `vendor/rack`; coverage is `coverage/rack/<Ruby>/` and starts
+before the middleware require. `rack:package` builds its own core/Rack archives,
+checks exact manifests/dependencies/push hosts, installs core alone and
+then resolves the Rack package offline in a fresh external GEM_HOME. Real Google
+proto/JSON identity/gzip calls, safe errors/details and metadata run under
+Rack::Lint over ephemeral localhost NetHTTP, using installed sources only.
+CI runs Rack specs/package checks on Ruby 3.4.12 and 4.0.9. Final local handoff
+requires both `verify` and `rack:verify`; root verification composition is unchanged.
+
+## RPC observation
+
+Configure `instrumentation:` on the core Client/Server to enable the fixed
+neutral per-call lifecycle or the optional [OpenTelemetry adapter](../connectrpc-otel/README.md).
+A supplied `rack.response_finished` extension takes precedence over body close.
+Without it the observation is only `body_closed`, with no delivery promise.
+Consumers must close bodies or invoke promised callbacks.
+
+## Static signatures
+
+This package owns `sig/` and its discovery manifest. Add
+`library "connectrpc-rack"` to a strict Steep target with this gem installed.
+See the [RBS guide](../../docs/rbs.md) for supported APIs, extension contracts,
+partial records, runtime validation and framework-signature limits.
+`mise run rbs:check` checks application callers for this package; strict core
+source checking is a separate target from backend implementation checking.
+
+## gRPC-Web
+
+Explicitly enabled binary/text unary gRPC-Web runs through this middleware, including the rackup/WEBrick fixture. Streaming is rejected before input. Configure core CORS or keep it nil when outer middleware owns the mount.
+See the [Web guide](../../docs/grpc-web.md) for protocol, CORS, bounds and completion rules.

data/lib/connectrpc/rack/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ConnectRPC
+  class Rack
+    VERSION = "0.1.0" # x-release-please-version
+  end
+end

data/lib/connectrpc/rack.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "connectrpc"
+require_relative "rack/version"
+
+begin
+  gem "rack", ">= 3.2.7", "< 4"
+  require "rack"
+rescue LoadError => e
+  raise LoadError, "ConnectRPC Rack integration requires rack >= 3.2.7, < 4: #{e.message}"
+end
+
+module ConnectRPC
+  class Rack
+    def initialize(app = nil, server:)
+      @app = app || ->(_env) { [404, { "content-type" => "text/plain" }, ["Not found"]] }
+      @server = server
+    end
+
+    def call(env) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      transferred = false
+      error = nil
+      path = env.fetch("PATH_INFO", "")
+      return @app.call(env) unless @server.handles?(path)
+
+      headers = request_headers(env)
+      early = @server.cors_response(path: path, http_method: env.fetch("REQUEST_METHOD"), headers: headers)
+      return [early.status, early.headers, [early.body]] if early
+
+      lifecycle = @server.start_call(path: path, headers: headers, http_method: env.fetch("REQUEST_METHOD"))
+      response = @server.call(path: path, http_method: env.fetch("REQUEST_METHOD"), headers: headers,
+                              input: env["rack.input"], query: env.fetch("QUERY_STRING", ""), lifecycle: lifecycle)
+      body = [response.body]
+      if lifecycle
+        callbacks = env["rack.response_finished"]
+        if callbacks
+          callbacks << lambda do |_env, status, _headers, error|
+            lifecycle.finish(delivery: error ? :aborted : :response_finished, error: error, http_status: status)
+          end
+        else
+          body = Body.new(body, lifecycle)
+        end
+      end
+      result = [response.status, response.headers, body]
+      transferred = true
+      result
+    rescue Exception => e # rubocop:disable Lint/RescueException -- observe cancellation, then preserve it
+      error = e
+      raise
+    ensure
+      lifecycle&.finish(delivery: :aborted, error: error) unless transferred
+    end
+
+    class Body
+      def initialize(body, lifecycle)
+        @body = body
+        @lifecycle = lifecycle
+      end
+
+      def each(&) = @body.each(&)
+
+      def close
+        @lifecycle.finish(delivery: :body_closed)
+      end
+
+      def discard(error)
+        @lifecycle.finish(delivery: :aborted, error: error)
+      end
+    end
+    private_constant :Body
+
+    private
+
+    # Rails has not accepted ownership until its final header/body merge returns.
+    # Only our body owns disposal here; response_finished remains host-owned.
+    def transfer_response(env) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      transferred = false
+      error = nil
+      result = call(env)
+      status, headers, body = result
+      response = TransportResponse.new(status: status, headers: headers, body: "")
+      decorated = @server.cors_response(path: env.fetch("PATH_INFO"), http_method: env.fetch("REQUEST_METHOD"),
+                                        headers: request_headers(env), response: response)
+      value = yield result, !decorated.equal?(response)
+      transferred = true
+      value
+    rescue Exception => e # rubocop:disable Lint/RescueException -- preserve the original transfer failure
+      error = e
+      raise
+    ensure
+      body.discard(error) if !transferred && body.is_a?(Body)
+    end
+
+    def request_headers(env)
+      env.each_with_object({}) do |(key, value), result|
+        if key.start_with?("HTTP_")
+          result[key.delete_prefix("HTTP_").tr("_", "-").downcase] = [value]
+        elsif %w[CONTENT_TYPE CONTENT_LENGTH].include?(key)
+          result[key.tr("_", "-").downcase] = [value]
+        end
+      end
+    end
+  end
+end

data/sig/connectrpc-rack.rbs

@@ -0,0 +1,31 @@
+module ConnectRPC
+  class Rack
+    VERSION: String
+    type env = Hash[String, Object]
+    type response_headers = Hash[String, String | Array[String]]
+    type response = [Integer, response_headers, _Body | _CallableBody]
+    interface _Body
+      def each: () { (String) -> void } -> void
+    end
+    interface _Stream
+      def read: (?nil, ?String?) -> String
+              | (Integer?, ?String?) -> String?
+      def write: (String) -> Integer
+      # Protocol::HTTP returns a byte count; ordinary IO returns itself.
+      def <<: (String) -> (Integer | self)
+      def flush: () -> void
+      def close: () -> void
+      def close_read: () -> void
+      def close_write: () -> void
+      def closed?: () -> bool
+    end
+    interface _CallableBody
+      def call: (_Stream) -> void
+    end
+    interface _App
+      def call: (env) -> response
+    end
+    def initialize: (?(_App | ^(env) -> response)?, server: Server) -> void
+    def call: (env) -> response
+  end
+end

data/sig/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: connectrpc

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: connectrpc-rack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jimeh
+bindir: bin
+cert_chain: []
+date: 2026-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: connectrpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Optional, experimental Rack integration for the unofficial ConnectRPC
+  Ruby gem.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/connectrpc/rack.rb
+- lib/connectrpc/rack/version.rb
+- sig/connectrpc-rack.rbs
+- sig/manifest.yaml
+homepage: https://github.com/jimeh/connectrpc-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/jimeh/connectrpc-ruby
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Rack middleware for Connect unary RPCs
+test_files: []