capture

type CaptureBodyOmission string

type CaptureBodyState string

type CaptureMode string

type CaptureOmission string

type CaptureResponseState string

type CapturedField struct {
	Name   string   `json:"name"`
	Values []string `json:"values"`
}

type CapturedFieldValidationFieldSet struct {
	// Name validates the declared JSON property "name".
	Name foundryvalidation.Field[CapturedField, string]
	// Values validates the declared JSON property "values".
	Values foundryvalidation.Field[CapturedField, []string]
}

type CapturedRequest struct {
	RequestID  attribution.RequestID `json:"request_id"`
	ReceivedAt temporal.DateTime     `json:"received_at"`
	Method     string                `json:"method"`
	// Path is the escaped request path as sent, at most 4 KiB.
	Path string `json:"path"`
	// Route is the matched route ID; null when no route matched.
	Route    value.Nullable[string] `json:"route"`
	ClientIP value.Nullable[string] `json:"client_ip"`
	// Status is the committed response status; null when none was sent.
	Status        value.Nullable[int32] `json:"status"`
	Outcome       observability.Outcome `json:"outcome"`
	ResponseState CaptureResponseState  `json:"response_state"`
	DurationMS    int64                 `json:"duration_ms"`
	Mode          CaptureMode           `json:"mode"`
	BodyState     CaptureBodyState      `json:"body_state"`
	// BodyOmission is set exactly when BodyState is omitted.
	BodyOmission value.Nullable[CaptureBodyOmission] `json:"body_omission"`
	// DeclaredBytes is the request Content-Length; null when absent.
	DeclaredBytes value.Nullable[int64] `json:"declared_bytes"`
	// MeasuredBytes is the body size, known only after the end of the stream.
	MeasuredBytes value.Nullable[int64] `json:"measured_bytes"`
	// ObservedBytes counts body bytes read from the client.
	ObservedBytes int64 `json:"observed_bytes"`
	// DroppedBefore counts captures the writing process lost after its
	// previous stored capture and before this one.
	DroppedBefore int64 `json:"dropped_before"`
}

type CapturedRequestDetail struct {
	Request             CapturedRequest   `json:"request"`
	Headers             []CapturedField   `json:"headers"`
	Query               []CapturedField   `json:"query"`
	ContentType         string            `json:"content_type"`
	ContentEncoding     string            `json:"content_encoding"`
	Body                []byte            `json:"body"`
	ResponseContentType string            `json:"response_content_type"`
	ResponseEncoding    string            `json:"response_encoding"`
	ResponseBytes       int64             `json:"response_bytes"`
	ResponseHead        []byte            `json:"response_head"`
	Omissions           []CaptureOmission `json:"omissions"`
}

type CapturedRequestDetailValidationFieldSet struct {
	// Body validates the declared JSON property "body".
	Body foundryvalidation.Field[CapturedRequestDetail, []byte]
	// ContentEncoding validates the declared JSON property "content_encoding".
	ContentEncoding foundryvalidation.Field[CapturedRequestDetail, string]
	// ContentType validates the declared JSON property "content_type".
	ContentType foundryvalidation.Field[CapturedRequestDetail, string]
	// Headers validates the declared JSON property "headers".
	Headers foundryvalidation.Field[CapturedRequestDetail, []CapturedField]
	// Omissions validates the declared JSON property "omissions".
	Omissions foundryvalidation.Field[CapturedRequestDetail, []CaptureOmission]
	// Query validates the declared JSON property "query".
	Query foundryvalidation.Field[CapturedRequestDetail, []CapturedField]
	// Request validates the declared JSON property "request".
	Request foundryvalidation.Field[CapturedRequestDetail, CapturedRequest]
	// ResponseBytes validates the declared JSON property "response_bytes".
	ResponseBytes foundryvalidation.Field[CapturedRequestDetail, int64]
	// ResponseContentType validates the declared JSON property "response_content_type".
	ResponseContentType foundryvalidation.Field[CapturedRequestDetail, string]
	// ResponseEncoding validates the declared JSON property "response_encoding".
	ResponseEncoding foundryvalidation.Field[CapturedRequestDetail, string]
	// ResponseHead validates the declared JSON property "response_head".
	ResponseHead foundryvalidation.Field[CapturedRequestDetail, []byte]
}

type CapturedRequestFilters struct {
	From  temporal.DateTime                 `query:"from"`
	Until value.Optional[temporal.DateTime] `query:"until"`
	// Method matches the request method exactly.
	Method value.Optional[string] `query:"method"`
	// PathPrefix matches captures whose escaped path starts with this text.
	PathPrefix value.Optional[string]      `query:"path_prefix"`
	Status     value.Optional[int32]       `query:"status"`
	Mode       value.Optional[CaptureMode] `query:"mode"`
}

type CapturedRequestPath struct {
	Request attribution.RequestID `path:"request"`
}

type CapturedRequestValidationFieldSet struct {
	// BodyOmission validates the declared JSON property "body_omission".
	//
	// BodyOmission is set exactly when BodyState is omitted.
	//
	BodyOmission foundryvalidation.Field[CapturedRequest, foundryvalue.Nullable[CaptureBodyOmission]]
	// BodyState validates the declared JSON property "body_state".
	BodyState foundryvalidation.Field[CapturedRequest, CaptureBodyState]
	// ClientIP validates the declared JSON property "client_ip".
	ClientIP foundryvalidation.Field[CapturedRequest, foundryvalue.Nullable[string]]
	// DeclaredBytes validates the declared JSON property "declared_bytes".
	//
	// DeclaredBytes is the request Content-Length; null when absent.
	//
	DeclaredBytes foundryvalidation.Field[CapturedRequest, foundryvalue.Nullable[int64]]
	// DroppedBefore validates the declared JSON property "dropped_before".
	//
	// DroppedBefore counts captures the writing process lost after its
	// previous stored capture and before this one.
	//
	DroppedBefore foundryvalidation.Field[CapturedRequest, int64]
	// DurationMS validates the declared JSON property "duration_ms".
	DurationMS foundryvalidation.Field[CapturedRequest, int64]
	// MeasuredBytes validates the declared JSON property "measured_bytes".
	//
	// MeasuredBytes is the body size, known only after the end of the stream.
	//
	MeasuredBytes foundryvalidation.Field[CapturedRequest, foundryvalue.Nullable[int64]]
	// Method validates the declared JSON property "method".
	Method foundryvalidation.Field[CapturedRequest, string]
	// Mode validates the declared JSON property "mode".
	Mode foundryvalidation.Field[CapturedRequest, CaptureMode]
	// ObservedBytes validates the declared JSON property "observed_bytes".
	//
	// ObservedBytes counts body bytes read from the client.
	//
	ObservedBytes foundryvalidation.Field[CapturedRequest, int64]
	// Outcome validates the declared JSON property "outcome".
	Outcome foundryvalidation.Field[CapturedRequest, observability.Outcome]
	// Path validates the declared JSON property "path".
	//
	// Path is the escaped request path as sent, at most 4 KiB.
	//
	Path foundryvalidation.Field[CapturedRequest, string]
	// ReceivedAt validates the declared JSON property "received_at".
	ReceivedAt foundryvalidation.Field[CapturedRequest, temporal.DateTime]
	// RequestID validates the declared JSON property "request_id".
	RequestID foundryvalidation.Field[CapturedRequest, attribution.RequestID]
	// ResponseState validates the declared JSON property "response_state".
	ResponseState foundryvalidation.Field[CapturedRequest, CaptureResponseState]
	// Route validates the declared JSON property "route".
	//
	// Route is the matched route ID; null when no route matched.
	//
	Route foundryvalidation.Field[CapturedRequest, foundryvalue.Nullable[string]]
	// Status validates the declared JSON property "status".
	//
	// Status is the committed response status; null when none was sent.
	//
	Status foundryvalidation.Field[CapturedRequest, foundryvalue.Nullable[int32]]
}

type Config struct {
	// BodyBytes bounds the request body read before the handler (1 KiB to
	// 8 MiB). A larger body is omitted; the handler still receives every byte.
	BodyBytes int
	// ValueBytes bounds a redacted JSON string or form, query or multipart
	// field value (64 bytes to 1 MiB); longer values read "[omitted N bytes]".
	ValueBytes int
	// ForceRedacted stores every prefix redacted, including prefixes declared
	// with http.FullCaptureBody.
	ForceRedacted bool
	// Rate admits at most this many captures per second per process (1 to
	// 10,000). Refused requests are served normally and counted as lost.
	Rate int
	// Burst is the admission burst (1 to 10,000).
	Burst int
	// QueueRows bounds captures being read, queued or written (1 to 256).
	QueueRows int
	// RetainedBytes bounds memory held by those captures (enough for one
	// capture, up to 1 GiB).
	RetainedBytes int64
	// Retention deletes captures older than this (1 hour to 365 days).
	Retention time.Duration
	// MaxRows keeps about this many newest captures in the table (1,000 to
	// 10,000,000). Pruning catches up every minute while over the cap.
	MaxRows int
}

type Dependencies struct {
	DB *database.DB
	// Schema holds foundry_webhook_captures; it must be a valid identifier.
	Schema string
	// Clock supplies retention cutoffs. Receive times come from the kernel.
	Clock  clock.Clock
	Logger *slog.Logger
}

type PruneCommand struct {
	// contains filtered or unexported fields
}

type Store struct {
	// contains filtered or unexported fields
}