gaato/http/cookie - mooncakes.io

README
U
Middleware
Tr
BodyStream
Tr
Transport
- ::is_unsentHttpError::is_unsent
- ::to_reprHttpError::to_repr
- ::to_reprRedirectError::to_repr
- ::equalUrlError::equal
- ::not_equalUrlError::not_equal
- ::to_reprUrlError::to_repr
- ::as_bytesBody::as_bytes
- ::equalBody::equal
- ::is_replayableBody::is_replayable
- ::lengthBody::length
- ::not_equalBody::not_equal
- ::to_reprBody::to_repr
- ::appendHeaders::append
- ::containsHeaders::contains
- ::eachHeaders::each
- ::equalHeaders::equal
- ::from_arrayHeaders::from_array
- ::getHeaders::get
- ::get_allHeaders::get_all
- ::iterHeaders::iter
- ::lengthHeaders::length
- ::newHeaders::new
- ::not_equalHeaders::not_equal
- ::removeHeaders::remove
- ::setHeaders::set
- ::to_reprHeaders::to_repr
- ::equalPhase::equal
- ::not_equalPhase::not_equal
- ::to_reprPhase::to_repr
- ::to_reprRedirectHop::to_repr
- ::body_bytesRequest::body_bytes
- ::body_streamRequest::body_stream
- ::body_textRequest::body_text
- ::deleteRequest::delete
- ::equalRequest::equal
- ::form_bodyRequest::form_body
- ::getRequest::get
- ::headerRequest::header
- ::json_bodyRequest::json_body
- ::newRequest::new
- ::not_equalRequest::not_equal
- ::patchRequest::patch
- ::postRequest::post
- ::putRequest::put
- ::to_reprRequest::to_repr
- ::equalResponse::equal
- ::is_successResponse::is_success
- ::jsonResponse::json
- ::not_equalResponse::not_equal
- ::textResponse::text
- ::to_reprResponse::to_repr
- ::equalResponseHead::equal
- ::not_equalResponseHead::not_equal
- ::to_reprResponseHead::to_repr
- ::equalStreamBody::equal
- ::lengthStreamBody::length
- ::newStreamBody::new
- ::not_equalStreamBody::not_equal
- ::takeStreamBody::take
- ::to_reprStreamBody::to_repr
- ::to_reprStreamRedirectHop::to_repr
- ::append_query_paramsUrl::append_query_params
- ::equalUrl::equal
- ::is_absoluteUrl::is_absolute
- ::merge_query_paramsUrl::merge_query_params
- ::not_equalUrl::not_equal
- ::outputUrl::output
- ::parseUrl::parse
- ::port_or_defaultUrl::port_or_default
- ::query_paramsUrl::query_params
- ::resolveUrl::resolve
- ::same_originUrl::same_origin
- ::to_reprUrl::to_repr
- ::to_stringUrl::to_string
- ::without_fragmentUrl::without_fragment
V
append_query
V
encode_utf8
V
follow_redirects
V
follow_redirects_stream
V
form_urlencode
V
is_idempotent
V
parse_link_next
V
parse_retry_after
V
percent_encode
V
percent_encode_path
V
redirects
V
retry_after_ms
V
send_with

gaato/http/cookie does not have a README file

pub struct Cookie {
  name : String
  value : String
  domain : String
  host_only : Bool
  path : String
  expires_ms : Int64?
  secure : Bool
  http_only : Bool
  same_site : SameSite?
  creation_ms : Int64
  last_access_ms : Int64
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A stored cookie, with the fields of the RFC 6265 §5.3 storage model.

domain is the request host for a host-only cookie and the Domain attribute otherwise. expires_ms is None for a session cookie. Times are Unix milliseconds from the jar's clock; last_access_ms is when the cookie was last stored or sent.

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

Compares every field.

fn Cookie::is_expired(self : Cookie, now_ms : Int64) -> Bool

Whether the cookie has expired at now_ms.

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

Compares every field.

fn Cookie::to_repr(Cookie) -> @moonbitlang/core/debug.Repr
Repr

Debug representation of every field.

CookieJar

source

pub struct CookieJar {
  // private fields
}

An RFC 6265 cookie store for an HTTP client: store takes the Set-Cookie headers of a response, header_for builds the Cookie header of a request.

It is a client's jar, not a browser's: HttpOnly cookies are sent like any other, and SameSite is kept but not enforced, since a client has no notion of a cross-site request. Without the Public Suffix List it rejects only a Domain of a single label (com, localhost); pass is_public_suffix to reject more. An IP-address host only gets host-only cookies. Hosts must arrive in ASCII form, so a Domain with other characters is ignored.

test {
  let jar = @cookie.CookieJar::new(@mock.FakeClock::new())
  jar.store(
    @http.Headers::from_array([("Set-Cookie", "sid=1; Path=/; Secure")]),
    "https://example.com/login",
  )
  assert_eq(jar.header_for("https://example.com/"), Some("sid=1"))
  assert_eq(jar.header_for("http://example.com/"), None)
}

CookieJar::attach

source

fn CookieJar::attach(self : CookieJar, request : @gaato/http.Request
Request) -> @gaato/http.Request
Request

Returns request with the jar's Cookie header for its URL added, or request itself when no cookie matches or it already carries a Cookie header, which is left exactly as the caller set it. The headers are copied, so request is not changed.

Middleware does not wrap Transport::send_stream; a streaming caller sends jar.attach(request) and then calls jar.store(head.headers, request.url) with the ResponseHead it gets.

CookieJar::clear

source

fn CookieJar::clear(self : CookieJar) -> Unit

Removes every cookie.

CookieJar::clear_domain

source

fn CookieJar::clear_domain(self : CookieJar, domain : String) -> Unit

Removes the cookies whose domain is domain or one of its subdomains.

CookieJar::clear_session

source

fn CookieJar::clear_session(self : CookieJar) -> Unit

Removes the session cookies (those without Expires or Max-Age), as RFC 6265 §5.3 does when a session ends.

CookieJar::header_for

source

fn CookieJar::header_for(self : CookieJar, request_url : String) -> String?

Returns the Cookie header value for a request to request_url, or None when no cookie matches, and marks the cookies sent as accessed. Longer paths come first, then earlier-created cookies (RFC 6265 §5.4).

CookieJar::iter

source

fn CookieJar::iter(self : CookieJar) -> Iter[Cookie]

Iterates over a snapshot of the stored cookies, grouped by domain. Expired cookies not yet evicted are included; see remove_expired.

CookieJar::length

source

fn CookieJar::length(self : CookieJar) -> Int

The number of cookies stored, expired ones not yet evicted included.

CookieJar::new

source

fn CookieJar::new(clock : &@gaato/http/clock.Clock
Clock, max_per_domain? : Int, max_total? : Int, is_public_suffix? : (String) -> Bool) -> CookieJar

Creates an empty jar that reads the time from clock.

max_per_domain (default 50) and max_total (default 3000) bound how many cookies it keeps; a cookie past either evicts expired cookies first, then the least recently accessed (RFC 6265 §5.3). Negative limits count as 0. is_public_suffix names further domains a cookie may not be set for, such as a Public Suffix List lookup; single-label domains are always refused.

CookieJar::remove_expired

source

fn CookieJar::remove_expired(self : CookieJar) -> Unit

Removes the cookies that have expired by the clock's current time.

CookieJar::store

source

fn CookieJar::store(self : CookieJar, headers : @gaato/http.Headers
Headers, request_url : String) -> Unit

Stores every Set-Cookie of a response to request_url, in order. Values the RFC 6265 algorithms ignore, and every value when the URL has no host, are skipped.

SameSite

source

pub(all) enum SameSite {
  Strict
  Lax
  NoRestriction
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A cookie's SameSite attribute (RFC 6265bis). NoRestriction is SameSite=None.

SameSite::equal

source

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

Compares attribute values.

SameSite::not_equal

source

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

Compares attribute values.

SameSite::to_repr

source

fn SameSite::to_repr(SameSite) -> @moonbitlang/core/debug.Repr
Repr

Debug representation of the attribute value.

cookies

source

fn cookies(jar : CookieJar) -> (async (@gaato/http.Request
Request, async (@gaato/http.Request
Request) -> @gaato/http.Response
Response raise @gaato/http.HttpError
HttpError) -> @gaato/http.Response
Response raise @gaato/http.HttpError
HttpError)

A middleware step that sends jar's cookies with each request (see CookieJar::attach) and stores the Set-Cookie headers of its response. Nothing is stored when the request fails.

Place it inside the redirect step, between @http.redirects and the transport: @http.send_with(transport, [@http.redirects(),@cookie.cookies(jar)], request). The redirect step then sends every hop through it, so each hop's Set-Cookie is stored before the next hop is sent and each hop carries the cookies of its own URL. Placed outside, it would see only the first URL and the final response: cookies set by an intermediate response would be lost, and the first URL's cookies would look like a header the caller set, kept on same-origin hops.

test {
  let jar = @cookie.CookieJar::new(@mock.FakeClock::new())
  let _ : @http.Middleware = @cookie.cookies(jar)
}

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Cookie

#Cookie::equal

#Cookie::is_expired

#Cookie::not_equal

#Cookie::to_repr

#CookieJar

#CookieJar::attach

#CookieJar::clear

#CookieJar::clear_domain

#CookieJar::clear_session

#CookieJar::header_for

#CookieJar::iter

#CookieJar::length

#CookieJar::new

#CookieJar::remove_expired

#CookieJar::store

#SameSite

#SameSite::equal

#SameSite::not_equal

#SameSite::to_repr

#cookies

Source Files

Cookie

Cookie::equal

Cookie::is_expired

Cookie::not_equal

Cookie::to_repr

CookieJar

CookieJar::attach

CookieJar::clear

CookieJar::clear_domain

CookieJar::clear_session

CookieJar::header_for

CookieJar::iter

CookieJar::length

CookieJar::new

CookieJar::remove_expired

CookieJar::store

SameSite

SameSite::equal

SameSite::not_equal

SameSite::to_repr

cookies