WebRequest class

Represents a unified abstraction over an HTTP request–response interaction.

The WebRequest class serves as a container that binds a ServerHttpRequest and its corresponding ServerHttpResponse, allowing filters, interceptors, and controllers to operate on the same logical web exchange.

Purpose

• Simplifies access to both request and response within the same object.
• Provides lifecycle timing utilities (request start, completion, duration).
• Enables reflective access via the static CLASS constant for runtime type inspection and dependency resolution.

Reflection Support

The static CLASS field exposes the runtime Class metadata used by the JetLeaf reflection system. This allows the framework to dynamically detect, resolve, or inject instances of WebRequest in annotated controller methods.

Example

final webRequest = WebRequest(req, res);
log.info('Started at: ${webRequest.getRequestedAt()}');

await controller.handle(webRequest.getRequest(), webRequest.getResponse());

final duration = webRequest.getDuration();
if (duration != null) {
  log.info('Request completed in ${duration.inMilliseconds} ms');
}

extension TenantAwareWebRequest on WebRequest {
 /// Returns the tenant ID if the underlying [ServerHttpRequest]
 /// is a [CustomHttpRequest].
 ///
 /// If the request type does not match, returns `null`.
 String? getTenantId() {
   final req = getRequest();
   if (req is CustomHttpRequest) {
     return req.tenantId;
   }
   return null;
 }

 /// Convenience method to check whether this request belongs
 /// to a particular tenant.
 bool isTenant(String tenantId) => getTenantId() == tenantId;
}

Notes

• Subclasses of ServerHttpRequest (e.g., IoRequest) may provide their own timing metadata for performance tracing.
• If either timestamp is unavailable, getDuration will return null.
• Equality checks are based on class identity rather than field values.