connectrpc-testing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ace3966903eb60c52dd074d1204311c7903f41c4a6d726ea3831e844962631cd
+  data.tar.gz: d4e8e92888ba3206f2801bd27a7e1e99a04644cc78fc116167cb899d018ddf1a
+SHA512:
+  metadata.gz: 53a9fbfabd5692eeea6c8b6ca162f29a1e75a72e58bb5ea849d13839f963c8542aca9f5173a3589674a13867cb8aedbba11cef4ff2332bb6003abdc95ef262bf
+  data.tar.gz: 86e731569e68980795a8f608e15b799878bc50a440bbbeb5b24aa87338db0cb121986038adafbf21d1087272d4350d3cfe61b49cfebbdf9aecadcae055d93b47

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,136 @@
+# connectrpc-testing
+
+A synchronous in-process transport for real Connect unary round trips. The
+application supplies a core `Server`, its binding, services and handlers. The
+ordinary core or generated client still encodes requests and decodes responses,
+including protocol errors, metadata, safe unary GET and compression. No sockets are opened.
+
+Add `gem "connectrpc-testing", path: "gems/connectrpc-testing"` to a development
+or test bundle in this repository. For another local application, point `path:`
+at this package and provide the core gem through its own local path. Released
+versions are published to RubyGems.org with the whole
+[release train](../../docs/releasing.md). The runtime dependency is only `connectrpc ~> 0.1.0`; Google protobuf
+and a test framework are application choices.
+
+```ruby
+require "connectrpc/testing"
+require "connectrpc/bindings/google_protobuf" # application's optional binding
+require "echo_connect" # application's generated messages and service
+
+service = Example::V1::EchoService
+binding = ConnectRPC::Bindings::GoogleProtobuf.new
+server = ConnectRPC::Server.new(
+  services: [service::SERVICE], binding: binding,
+  handlers: service.handlers(
+    echo: ->(request, context) {
+      context.response_trailers.add("x-tested", "yes")
+      request
+    },
+    fail: ->(_request, _context) {
+      raise ConnectRPC::Error.new(:invalid_argument, "safe message")
+    }
+  )
+)
+transport = ConnectRPC::Testing::Transport.new(server: server)
+core = ConnectRPC::Client.new(
+  base_url: "https://in-process.invalid", binding: binding, transport: transport
+)
+client = service::Client.new(client: core)
+response = client.echo(Example::V1::EchoMessage.new(name: "hello"), timeout: nil)
+raise "Unexpected response" unless response.message.name == "hello"
+raise "Missing trailer" unless response.trailers["x-tested"] == ["yes"]
+```
+
+The hostname is validated but never resolved. URLs must be absolute HTTP(S) URIs
+without credentials or fragments. Raw URI queries are forwarded to core, including safe unary GET. The literal URI path
+identifies the method: a base URL prefix is retained and will normally produce
+core's unknown-method response. There is no mount-prefix stripping or Rack
+fallthrough. The actual HTTP method and repeated leading header arrays pass to
+core unchanged. Malformed protocol header values retain core classification;
+structurally unsupported Ruby inputs raise `ArgumentError` before dispatch.
+Frozen caller URI, headers and body are supported and preserved.
+
+The private byte reader uses `byteslice` over the original body under core's
+bounded `MessageIO` reads, including multibyte JSON. It does not decode or
+recompress payloads. `TransportRequest.response_limit` caps encoded bytes,
+including error bodies and gzip framing. Core's server materializes a response
+before the transport checks its cap. That check cannot undo the allocation and
+does not establish a total memory bound. Server and Client message and wire
+limits remain separate.
+
+A supplied original `Deadline` is checked before and after dispatch. Immediately
+before dispatch, the transport copies headers and refreshes `connect-timeout-ms`
+from the remaining budget. Core reconstructs its cooperative server deadline
+from rounded/clamped wire milliseconds. The original deadline remains
+authoritative and expiry takes precedence over the response wire cap. The
+Client's omitted timeout remains 30 seconds; `timeout: nil` adds no deadline or
+timeout header. A low-level request with nil deadline can still explicitly
+supply a core timeout header.
+
+Execution is synchronous and cooperative. This transport cannot interrupt a
+blocked handler or codec. It makes no network, DNS, TLS, fiber, backpressure,
+concurrency, lifecycle, retry or cancellation compatibility promise. Use real
+hosts and independent peers for those checks. These round trips are not
+interoperability or official conformance evidence.
+
+From the repository root:
+
+```sh
+mise run testing:setup
+mise run testing:test -- spec/transport_spec.rb
+mise run testing:check
+mise run testing:example
+mise run testing:package
+MISE_RUBY_VERSION=4.0.9 mise run testing:verify
+```
+
+Pinned Ruby and Bundler must already be installed; these tasks never install
+Bundler globally. The independent checksummed bundle, caches and archives use
+`vendor/testing/`; SimpleCov starts before library requires, includes every
+package library file and writes `coverage/testing/<Ruby>/`. `testing:check`
+parses every maintained Ruby file and uses the repository RuboCop policy.
+`testing:package` builds its own core archive, installs only the testing archive
+with normal offline resolution from an adjacent core archive in a fresh external
+GEM_HOME, checks public require without optional bindings/hosts, then installs
+the cached Google dependency closure and runs the generated example in both
+codecs and encodings. Root verification remains independent.
+
+Licensed under the [MIT License](LICENSE). It is released with the whole
+[release train](../../docs/releasing.md); its package tasks never publish it.
+
+See the [supported 0.x contract](../../docs/support.md) for the target support
+profile, matched package versions, compatibility policy and adoption gates.
+
+## 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).
+The server always extracts serialized propagation headers, even while a client
+context is ambient. Direct processing ends with delivery `unobserved`.
+
+## Static signatures
+
+This package owns `sig/` and its discovery manifest. Add
+`library "connectrpc-testing"` 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.
+
+## Explicit unary cancellation
+
+Pass `cancellation: source.token` to core or generated client calls, where
+`source = ConnectRPC::CancellationSource.new`. The source is permanent and
+shareable; only `source.cancel` initiates cancellation. `timeout: nil` keeps no
+RPC deadline or wire timeout. Context offers cooperative `cancelled?`,
+`cancellation_reason` and `check!`. See the [core guide](../../README.md) for
+listener, arbitration and registration lifetime rules.
+
+Testing forwards the read-only cancellation seam into a distinct server Context.
+Completing server processing cannot complete its client or shared source. Checks
+are cooperative; Testing does not interrupt a blocked handler.
+
+## gRPC-Web
+
+Manual encoded TransportRequest values can exercise explicitly enabled binary/text unary gRPC-Web. This adds no Web Client mode, serializer, network or browser conformance claim.
+See the [Web guide](../../docs/grpc-web.md) for protocol, CORS, bounds and completion rules.

data/lib/connectrpc/testing/transport.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module ConnectRPC
+  module Testing
+    class Transport
+      def initialize(server:)
+        raise ArgumentError, "server must be a ConnectRPC::Server" unless server.is_a?(Server)
+
+        @server = server
+      end
+
+      def call(request)
+        validate!(request)
+        CallCancellation.with_request(request) { |outgoing| perform_call(outgoing) }
+      end
+
+      private
+
+      def perform_call(request)
+        request.cancellation ? request.cancellation.check! : request.deadline&.check!
+        response = dispatch(request)
+        request.cancellation ? request.cancellation.check! : request.deadline&.check!
+        Protocol.check_size!(response.body, request.response_limit)
+        response
+      end
+
+      def dispatch(request)
+        headers = request.headers.dup
+        headers["connect-timeout-ms"] = [request.deadline.timeout_ms] if request.deadline
+        @server.call(path: request.url.path, http_method: request.http_method,
+                     headers: headers, input: BytesReader.new(request.body), query: request.url.query || "",
+                     cancellation: request.cancellation)
+      end
+
+      def validate!(request)
+        raise ArgumentError, "request must be a ConnectRPC::TransportRequest" unless request.is_a?(TransportRequest)
+        unless valid_url?(request.url)
+          raise ArgumentError,
+                "url must be an absolute HTTP(S) URI without credentials or fragment"
+        end
+
+        validate_fields!(request)
+        unless request.deadline.nil? || request.deadline.is_a?(Deadline)
+          raise ArgumentError, "deadline must be a ConnectRPC::Deadline or nil"
+        end
+
+        Protocol.limit!(request.response_limit)
+      end
+
+      def validate_fields!(request)
+        unless request.http_method.is_a?(String) && request.body.is_a?(String)
+          raise ArgumentError, "method and body must be Strings"
+        end
+        return if valid_headers?(request.headers)
+
+        raise ArgumentError, "headers must contain lower-case String keys and String arrays"
+      end
+
+      def valid_url?(url)
+        url.is_a?(URI::HTTP) && %w[http https].include?(url.scheme) && url.host && !url.host.empty? &&
+          !url.userinfo && !url.fragment
+      end
+
+      def valid_headers?(headers)
+        headers.is_a?(Hash) && headers.all? do |key, values|
+          key.is_a?(String) && key == key.downcase && values.is_a?(Array) && values.all?(String)
+        end
+      end
+
+      # MessageIO controls read sizes. Offsets are bytes even for UTF-8 JSON.
+      class BytesReader
+        def initialize(bytes)
+          @bytes = bytes
+          @offset = 0
+        end
+
+        def read(length)
+          return if @offset >= @bytes.bytesize
+
+          chunk = @bytes.byteslice(@offset, length)
+          @offset += chunk.bytesize
+          chunk
+        end
+      end
+      private_constant :BytesReader
+    end
+  end
+end

data/lib/connectrpc/testing/version.rb

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

data/lib/connectrpc/testing.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "connectrpc"
+require_relative "testing/version"
+require "uri"
+require_relative "testing/transport"

data/sig/connectrpc-testing.rbs

@@ -0,0 +1,9 @@
+module ConnectRPC
+  module Testing
+    VERSION: String
+    class Transport
+      def initialize: (server: Server) -> void
+      def call: (TransportRequest) -> TransportResponse
+    end
+  end
+end

data/sig/manifest.yaml

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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: connectrpc-testing
+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
+description: Optional synchronous testing transport using an application-owned core
+  Server.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/connectrpc/testing.rb
+- lib/connectrpc/testing/transport.rb
+- lib/connectrpc/testing/version.rb
+- sig/connectrpc-testing.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: In-process transport for real ConnectRPC unary round trips
+test_files: []