moonbitstack/moonasgi/client

README
U
AsgiApp
U
AsgiAppInstance
U
AsgiApplication
U
AsgiVersion
U
ConformanceReport
U
Drain
U
Event
U
EventOrderError
U
Extensions
U
Handler
U
Http2HeaderError
U
HttpScope
U
LegacyAsgiApp
U
LifespanHandler
U
LifespanReply
U
LifespanScope
U
Middleware
U
PushPromise
U
Receive
U
Request
U
Response
U
Scope
U
Send
U
StreamHandler
U
StreamingResponse
U
TestClient
U
TestResponse
U
TlsExtension
U
WebSocketHandler
U
WebSocketScope
U
WsAccept
U
WsMessage
U
WsSend
U
WsTestSession
U
ZeroCopySend
V
compose
V
double_to_single_callable
V
guarantee_single_callable
V
headers_from_wire
V
headers_to_wire
V
latin1_decode
V
latin1_encode
V
percent_decode
V
run_conformance
V
run_http
V
run_http_app
V
run_http_scoped
V
run_http_scoped_drain
V
run_http_stream
V
run_legacy
V
run_lifespan
V
to_asgi
V
validate_events
V
validate_http_response
V
validate_inbound
V
validate_lifespan_replies
V
validate_ws_response
V
ws_run
V
ws_run_app

moonbitstack/moonasgi/client does not have a README file

PushPromise

pub(all) struct PushPromise {
  path : String
  headers : Array[(String, String)]
} derive(Eq)

A server-side push promise captured by the TestClient: the pushed path and the request headers the server would send for it (http.response.push).

PushPromise::equal

source

fn PushPromise::equal(PushPromise, PushPromise) -> Bool

PushPromise::header

source

fn PushPromise::header(self : PushPromise, name : String) -> String?

First push-request header matching name.

PushPromise::not_equal

source

fn PushPromise::not_equal(x : PushPromise, y : PushPromise) -> Bool

TestClient

source

pub(all) struct TestClient {
  app : (@moonbitstack/moonasgi/http.Request
Request) -> Array[@moonbitstack/moonasgi/spec.Event
Event]
  root_path : String
  base_headers : Array[(String, String)]
  client : (String, Int)?
  server : (String, Int?)?
  extensions : @moonbitstack/moonasgi/spec.Extensions
Extensions
}

An in-process application driver — the ASGI TestClient — built on the synchronous @http.run_http_app core, so it needs no socket and runs on every backend. It builds a synthetic http scope, feeds the request body in as HttpRequest events, runs the application, and reassembles the outbound stream into a TestResponse. app is the event-emitting application; the new / from_stream constructors adapt a @http.Handler / @http.StreamHandler.

TestClient::delete

source

fn TestClient::delete(self : TestClient, path : String, headers? : Array[(String, String)]) -> TestResponse

DELETE path.

TestClient::from_app

source

fn TestClient::from_app(app : (@moonbitstack/moonasgi/http.Request
Request) -> Array[@moonbitstack/moonasgi/spec.Event
Event], root_path? : String, base_headers? : Array[(String, String)], client? : (String, Int)?, server? : (String, Int?)?, extensions? : @moonbitstack/moonasgi/spec.Extensions
Extensions) -> TestClient

Build a TestClient from a raw event-emitting application (the shape @http.run_http_app drives). Defaults mirror a typical test harness: empty root_path, no base headers, a ("testclient", 50000) client peer, a ("testserver", 80) server, and no advertised extensions.

TestClient::from_stream

source

fn TestClient::from_stream(handler : (@moonbitstack/moonasgi/http.Request
Request) -> @moonbitstack/moonasgi/http.StreamingResponse
StreamingResponse, root_path? : String, base_headers? : Array[(String, String)], client? : (String, Int)?, server? : (String, Int?)?, extensions? : @moonbitstack/moonasgi/spec.Extensions
Extensions) -> TestClient

Build a TestClient from a streaming @http.StreamHandler (multi-chunk body, optional trailers).

TestClient::get

source

fn TestClient::get(self : TestClient, path : String, headers? : Array[(String, String)]) -> TestResponse

GET path.

TestClient::head

source

fn TestClient::head(self : TestClient, path : String, headers? : Array[(String, String)]) -> TestResponse

HEAD path.

TestClient::new

source

fn TestClient::new(handler : (@moonbitstack/moonasgi/http.Request
Request) -> @moonbitstack/moonasgi/http.Response
Response, root_path? : String, base_headers? : Array[(String, String)], client? : (String, Int)?, server? : (String, Int?)?, extensions? : @moonbitstack/moonasgi/spec.Extensions
Extensions) -> TestClient

Build a TestClient from a unary @http.Handler.

TestClient::patch

source

fn TestClient::patch(self : TestClient, path : String, body? : Bytes, headers? : Array[(String, String)]) -> TestResponse

PATCH path with body.

TestClient::post

source

fn TestClient::post(self : TestClient, path : String, body? : Bytes, headers? : Array[(String, String)]) -> TestResponse

POST path with body.

TestClient::put

source

fn TestClient::put(self : TestClient, path : String, body? : Bytes, headers? : Array[(String, String)]) -> TestResponse

PUT path with body.

TestClient::request

source

fn TestClient::request(self : TestClient, http_method~ : String, path~ : String, headers? : Array[(String, String)], body? : Bytes, http_version? : String, chunks? : Array[Bytes]) -> TestResponse

Drive one request through the application and capture the response. Splits path into path + query string, merges the client's base_headers before the per-request headers, builds an http scope (carrying the client's root_path / peers / advertised extensions), feeds the body in, runs the app, and reassembles the outbound stream. Pass chunks to stream the request body as several HttpRequest events.

TestClient::websocket

source

fn TestClient::websocket(self : TestClient, path~ : String, handler~ : @moonbitstack/moonasgi/ws.WebSocketHandler
WebSocketHandler, send? : Array[@moonbitstack/moonasgi/ws.WsMessage
WsMessage], headers? : Array[(String, String)], subprotocols? : Array[String], disconnect? : Int?) -> WsTestSession

Drive a @ws.WebSocketHandler through a full connection in-process and capture the result. Opens a WebSocketConnect, feeds each send message in as a WebSocketReceive, then (unless disconnect is None) a WebSocketDisconnect with the given close code, runs the handler through the synchronous @ws.ws_run core, and reassembles the server's outbound frames into a WsTestSession. No socket — testable on every backend, the WebSocket counterpart of request.

TestClient::websocket_app

source

fn TestClient::websocket_app(self : TestClient, path~ : String, app~ : (@moonbitstack/moonasgi/spec.WebSocketScope
WebSocketScope, Array[@moonbitstack/moonasgi/spec.Event
Event]) -> Array[@moonbitstack/moonasgi/spec.Event
Event], send? : Array[@moonbitstack/moonasgi/ws.WsMessage
WsMessage], headers? : Array[(String, String)], subprotocols? : Array[String], disconnect? : Int?) -> WsTestSession

Drive a general (@spec.WebSocketScope, Array[@spec.Event]) -> Array[@spec.Event] application through a full connection in-process. Like websocket, but for an app that consumes the whole inbound stream directly (the @ws.ws_run_app escape hatch) rather than the connect/receive/disconnect fold.

TestResponse

source

pub(all) struct TestResponse {
  status : Int
  headers : Array[(String, String)]
  body : Bytes
  trailers : Array[(String, String)]
  pushes : Array[PushPromise]
  pathsend : String?
  zerocopysend : ZeroCopySend?
  debug : Array[Json]
  early_hints : Array[Array[String]]
} derive(Eq)

The materialised result of driving an application in-process: the response status and headers, the body reassembled from every HttpResponseBody chunk, the trailing headers gathered from HttpResponseTrailers, any push promises, the pathsend path if the app used the path-send extension, the last zerocopysend handoff, every debug info payload, and the early_hints (each a 103 message's Link values). The captured, sans-transport analog of what a real client would observe.

TestResponse::equal

source

fn TestResponse::equal(TestResponse, TestResponse) -> Bool

TestResponse::header

source

fn TestResponse::header(self : TestResponse, name : String) -> String?

First response header matching name (ASGI lowercased-name convention).

TestResponse::json

source

fn TestResponse::json(self : TestResponse) -> Json raise

The response body parsed as JSON. Raises @json.ParseError if the body is not valid JSON, mirroring a real client's .json().

TestResponse::not_equal

source

fn TestResponse::not_equal(x : TestResponse, y : TestResponse) -> Bool

TestResponse::text

source

fn TestResponse::text(self : TestResponse) -> String

The response body decoded as UTF-8 (lossy: invalid sequences become the replacement character), for asserting on text responses.

TestResponse::trailer

source

fn TestResponse::trailer(self : TestResponse, name : String) -> String?

First trailing header matching name.

WsTestSession

source

pub(all) struct WsTestSession {
  accepted : Bool
  subprotocol : String?
  accept_headers : Array[(String, String)]
  messages : Array[@moonbitstack/moonasgi/ws.WsMessage
WsMessage]
  closed : Bool
  close_code : Int?
  close_reason : String?
  denial : TestResponse?
} derive(Eq)

The materialised result of driving a WebSocket connection in-process: whether the handshake was accepted, the negotiated subprotocol and accept_headers, every server→client message (messages), whether the server closed and with what close_code / close_reason, and — when the handshake was denied with the websocket.http.response extension — the captured HTTP denial response. The WebSocket analog of TestResponse.

WsTestSession::equal

source

fn WsTestSession::equal(WsTestSession, WsTestSession) -> Bool

WsTestSession::header

source

fn WsTestSession::header(self : WsTestSession, name : String) -> String?

First accept-response header matching name.

WsTestSession::not_equal

source

fn WsTestSession::not_equal(x : WsTestSession, y : WsTestSession) -> Bool

WsTestSession::texts

source

fn WsTestSession::texts(self : WsTestSession) -> Array[String]

The server→client messages that were text frames, decoded to their strings (binary frames are skipped). The ergonomic assertion target for an echo/chat exchange.

ZeroCopySend

source

pub(all) struct ZeroCopySend {
  fd : Int
  offset : Int?
  count : Int?
} derive(Eq)

A http.response.zerocopysend message captured by the TestClient: the open file descriptor the app handed off, and the optional byte offset / count. The sans-transport analog of the server performing the zero-copy send.

ZeroCopySend::equal

source

fn ZeroCopySend::equal(ZeroCopySend, ZeroCopySend) -> Bool

ZeroCopySend::not_equal

source

fn ZeroCopySend::not_equal(x : ZeroCopySend, y : ZeroCopySend) -> Bool

reassemble

source

fn reassemble(events : Array[@moonbitstack/moonasgi/spec.Event
Event]) -> TestResponse

Fold an outbound event stream into a TestResponse: HttpResponseStart sets status/headers, every HttpResponseBody appends to the body, every HttpResponseTrailers appends to the trailers, each HttpResponsePush records a promise, HttpResponsePathSend records the served path, and every HttpResponseEarlyHint records one 103 message's Link values. Other events (websocket, lifespan) are ignored — the http response is what a client observes. 把一串事件拼回一个响应，一致性套件与测试客户端共用。

Source Files

client.mbt

Site source Report issue Packages Build queue Skills Statistics

#PushPromise

#PushPromise::equal

#PushPromise::header

#PushPromise::not_equal

#TestClient

#TestClient::delete

#TestClient::from_app

#TestClient::from_stream

#TestClient::get

#TestClient::head

#TestClient::new

#TestClient::patch

#TestClient::post

#TestClient::put

#TestClient::request

#TestClient::websocket

#TestClient::websocket_app

#TestResponse

#TestResponse::equal

#TestResponse::header

#TestResponse::json

#TestResponse::not_equal

#TestResponse::text

#TestResponse::trailer

#WsTestSession

#WsTestSession::equal

#WsTestSession::header

#WsTestSession::not_equal

#WsTestSession::texts

#ZeroCopySend

#ZeroCopySend::equal

#ZeroCopySend::not_equal

#reassemble

Source Files

PushPromise

PushPromise::equal

PushPromise::header

PushPromise::not_equal

TestClient

TestClient::delete

TestClient::from_app

TestClient::from_stream

TestClient::get

TestClient::head

TestClient::new

TestClient::patch

TestClient::post

TestClient::put

TestClient::request

TestClient::websocket

TestClient::websocket_app

TestResponse

TestResponse::equal

TestResponse::header

TestResponse::json

TestResponse::not_equal

TestResponse::text

TestResponse::trailer

WsTestSession

WsTestSession::equal

WsTestSession::header

WsTestSession::not_equal

WsTestSession::texts

ZeroCopySend

ZeroCopySend::equal

ZeroCopySend::not_equal

reassemble