Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
// Copyright (c) 2026, Salesforce, Inc.,
// All rights reserved.
// For full license text, see the LICENSE.txt file

use crate::{
    handler::{Handler, IntoHandler},
    hl::{
        bootstrap::{DualFilter, RequestFilter},
        context::{RequestContext, ResponseContext},
        state::{CreateHandler, DoneHandler, EmptyCreateHandler},
        IntoFlow,
    },
};

#[cfg(not(feature = "experimental_websocket"))]
use crate::hl::bootstrap::ResponseFilter;

#[cfg(feature = "experimental_websocket")]
use crate::hl::bootstrap::WebSocketFilter;

/// Builder for constructing HTTP request/response filters with optional WebSocket support.
///
/// Provides a fluent API to configure:
/// - State factory (`on_create`)
/// - Request handler (`on_request`)
/// - Response handler (`on_response`)
/// - Cleanup handler (`on_done`)
/// - WebSocket upstream handler (`on_upgrade_upstream`)
/// - WebSocket downstream handler (`on_upgrade_downstream`)
#[cfg(feature = "experimental_websocket")]
pub struct FilterBuilder<
    Sf = EmptyCreateHandler,
    Req = (),
    Res = (),
    Done = (),
    WsUp = (),
    WsDown = (),
> {
    state_factory: Sf,
    request_filter: Req,
    response_filter: Res,
    done_handler: Done,
    websocket_upstream: WsUp,
    websocket_downstream: WsDown,
}

/// Builder for constructing HTTP request/response filters.
///
/// Provides a fluent API to configure:
/// - State factory (`on_create`)
/// - Request handler (`on_request`)
/// - Response handler (`on_response`)
/// - Cleanup handler (`on_done`)
#[cfg(not(feature = "experimental_websocket"))]
pub struct FilterBuilder<Sf = EmptyCreateHandler, Req = (), Res = (), Done = ()> {
    state_factory: Sf,
    request_filter: Req,
    response_filter: Res,
    done_handler: Done,
}

impl FilterBuilder {
    /// Creates a new `FilterBuilder` with default empty handlers.
    pub fn new() -> Self {
        Self {
            state_factory: EmptyCreateHandler,
            request_filter: (),
            response_filter: (),
            done_handler: (),
            #[cfg(feature = "experimental_websocket")]
            websocket_upstream: (),
            #[cfg(feature = "experimental_websocket")]
            websocket_downstream: (),
        }
    }

    /// Sets the state factory for creating per-request state.
    ///
    /// The factory is called once per HTTP request to initialize state that will be
    /// accessible in request/response handlers and the done handler.
    #[cfg(not(feature = "experimental_websocket"))]
    pub fn on_create<Sf: CreateHandler>(self, state_factory: Sf) -> FilterBuilder<Sf, (), (), ()> {
        FilterBuilder {
            state_factory,
            request_filter: self.request_filter,
            response_filter: self.response_filter,
            done_handler: self.done_handler,
        }
    }

    /// Sets the state factory for creating per-request state.
    ///
    /// The factory is called once per HTTP request to initialize state that will be
    /// accessible in request/response handlers, done handler, and WebSocket handlers.
    #[cfg(feature = "experimental_websocket")]
    pub fn on_create<Sf: CreateHandler>(
        self,
        state_factory: Sf,
    ) -> FilterBuilder<Sf, (), (), (), (), ()> {
        FilterBuilder {
            state_factory,
            request_filter: self.request_filter,
            response_filter: self.response_filter,
            done_handler: self.done_handler,
            websocket_upstream: self.websocket_upstream,
            websocket_downstream: self.websocket_downstream,
        }
    }
}

impl Default for FilterBuilder {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(not(feature = "experimental_websocket"))]
impl<Sf, Done> FilterBuilder<Sf, (), (), Done>
where
    Sf: CreateHandler,
{
    /// Sets the request handler.
    ///
    /// The handler is called for each HTTP request and can modify request headers,
    /// body, or return early responses.
    pub fn on_request<I, Req>(
        self,
        request_filter: Req,
    ) -> FilterBuilder<Sf, Req::Handler, (), Done>
    where
        Req: IntoHandler<RequestContext<Sf::State>, I>,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: request_filter.into_handler(),
            response_filter: self.response_filter,
            done_handler: self.done_handler,
        }
    }

    /// Sets the response handler.
    ///
    /// The handler is called for each HTTP response and can modify response headers
    /// or body.
    pub fn on_response<I, Res>(
        self,
        response_filter: Res,
    ) -> FilterBuilder<Sf, (), Res::Handler, Done>
    where
        Res: IntoHandler<ResponseContext<(), Sf::State>, I, Output = ()>,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: self.request_filter,
            response_filter: response_filter.into_handler(),
            done_handler: self.done_handler,
        }
    }
}

#[cfg(feature = "experimental_websocket")]
impl<Sf, Done, WsUp, WsDown> FilterBuilder<Sf, (), (), Done, WsUp, WsDown>
where
    Sf: CreateHandler,
{
    /// Sets the request handler.
    ///
    /// The handler is called for each HTTP request and can modify request headers,
    /// body, or return early responses.
    pub fn on_request<I, Req>(
        self,
        request_filter: Req,
    ) -> FilterBuilder<Sf, Req::Handler, (), Done, WsUp, WsDown>
    where
        Req: IntoHandler<RequestContext<Sf::State>, I>,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: request_filter.into_handler(),
            response_filter: self.response_filter,
            done_handler: self.done_handler,
            websocket_upstream: self.websocket_upstream,
            websocket_downstream: self.websocket_downstream,
        }
    }

    /// Sets the response handler.
    ///
    /// The handler is called for each HTTP response and can modify response headers
    /// or body.
    pub fn on_response<I, Res>(
        self,
        response_filter: Res,
    ) -> FilterBuilder<Sf, (), Res::Handler, Done, WsUp, WsDown>
    where
        Res: IntoHandler<ResponseContext<(), Sf::State>, I, Output = ()>,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: self.request_filter,
            response_filter: response_filter.into_handler(),
            done_handler: self.done_handler,
            websocket_upstream: self.websocket_upstream,
            websocket_downstream: self.websocket_downstream,
        }
    }
}

#[cfg(not(feature = "experimental_websocket"))]
impl<Sf, Req, Done> FilterBuilder<Sf, Req, (), Done>
where
    Sf: CreateHandler,
    Req: Handler<RequestContext<Sf::State>, Output: IntoFlow>,
{
    /// Sets the response handler (when request handler is already set).
    ///
    /// The handler is called after the request handler and can access request data
    /// produced by the request handler.
    pub fn on_response<I, Res>(
        self,
        response_filter: Res,
    ) -> FilterBuilder<Sf, Req, Res::Handler, Done>
    where
        Res: IntoHandler<
            ResponseContext<<Req::Output as IntoFlow>::RequestData, Sf::State>,
            I,
            Output: IntoFlow,
        >,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: self.request_filter,
            response_filter: response_filter.into_handler(),
            done_handler: self.done_handler,
        }
    }
}

#[cfg(feature = "experimental_websocket")]
impl<Sf, Req, Done, WsUp, WsDown> FilterBuilder<Sf, Req, (), Done, WsUp, WsDown>
where
    Sf: CreateHandler,
    Req: Handler<RequestContext<Sf::State>, Output: IntoFlow>,
{
    /// Sets the response handler (when request handler is already set).
    ///
    /// The handler is called after the request handler and can access request data
    /// produced by the request handler.
    pub fn on_response<I, Res>(
        self,
        response_filter: Res,
    ) -> FilterBuilder<Sf, Req, Res::Handler, Done, WsUp, WsDown>
    where
        Res: IntoHandler<
            ResponseContext<<Req::Output as IntoFlow>::RequestData, Sf::State>,
            I,
            Output: IntoFlow,
        >,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: self.request_filter,
            response_filter: response_filter.into_handler(),
            done_handler: self.done_handler,
            websocket_upstream: self.websocket_upstream,
            websocket_downstream: self.websocket_downstream,
        }
    }

    /// Sets the done handler called when the HTTP exchange completes.
    ///
    /// The handler receives the state and can perform cleanup operations like
    /// releasing resources or logging. Called after both request and response processing.
    pub fn on_done<D>(self, done_handler: D) -> FilterBuilder<Sf, Req, (), D, WsUp, WsDown>
    where
        D: DoneHandler<Sf::State>,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: self.request_filter,
            response_filter: self.response_filter,
            done_handler,
            websocket_upstream: self.websocket_upstream,
            websocket_downstream: self.websocket_downstream,
        }
    }
}

#[cfg(not(feature = "experimental_websocket"))]
impl<Sf, Req, Done> FilterBuilder<Sf, Req, (), Done>
where
    Req: Handler<RequestContext<Sf::State>>,
    Sf: CreateHandler,
{
    /// Builds a request-only filter.
    ///
    /// Creates a filter that processes HTTP requests but does not modify responses.
    pub fn build(self) -> RequestFilter<Req, Sf, Done> {
        RequestFilter {
            request_handler: self.request_filter,
            state_factory: self.state_factory,
            done_handler: self.done_handler,
        }
    }
}

#[cfg(not(feature = "experimental_websocket"))]
impl<Sf, Res, Done> FilterBuilder<Sf, (), Res, Done>
where
    Res: Handler<ResponseContext<(), Sf::State>>,
    Sf: CreateHandler,
{
    /// Builds a response-only filter.
    ///
    /// Creates a filter that processes HTTP responses but does not modify requests.
    pub fn build(self) -> ResponseFilter<Res, Sf, Done> {
        ResponseFilter {
            response_handler: self.response_filter,
            state_factory: self.state_factory,
            done_handler: self.done_handler,
        }
    }
}

#[cfg(not(feature = "experimental_websocket"))]
impl<Sf, Req, Res, Done> FilterBuilder<Sf, Req, Res, Done>
where
    Req: Handler<RequestContext<Sf::State>, Output: IntoFlow>,
    Res: Handler<ResponseContext<<Req::Output as IntoFlow>::RequestData, Sf::State>>,
    Sf: CreateHandler,
{
    /// Builds a dual filter that processes both requests and responses.
    ///
    /// Creates a filter that can modify both the HTTP request and response in a single pass.
    pub fn build(self) -> DualFilter<Req, Res, Sf, Done> {
        DualFilter {
            request_handler: self.request_filter,
            response_handler: self.response_filter,
            state_factory: self.state_factory,
            done_handler: self.done_handler,
        }
    }
}

#[cfg(feature = "experimental_websocket")]
impl<Sf, Req, Done, WsUp, WsDown> FilterBuilder<Sf, Req, (), Done, WsUp, WsDown>
where
    Req: Handler<RequestContext<Sf::State>, Output: IntoFlow>,
    Sf: CreateHandler,
{
    /// Builds a request-only filter with WebSocket support.
    pub fn build(self) -> WebSocketFilter<RequestFilter<Req, Sf, Done>, Sf, WsUp, WsDown> {
        let base_filter = RequestFilter {
            request_handler: self.request_filter,
            state_factory: self.state_factory,
            done_handler: self.done_handler,
        };
        WebSocketFilter {
            base_filter,
            websocket_upstream: self.websocket_upstream,
            websocket_downstream: self.websocket_downstream,
            _sf: std::marker::PhantomData,
        }
    }
}

#[cfg(feature = "experimental_websocket")]
impl<Sf, Req, Res, Done, WsUp, WsDown> FilterBuilder<Sf, Req, Res, Done, WsUp, WsDown>
where
    Req: Handler<RequestContext<Sf::State>, Output: IntoFlow>,
    Res: Handler<ResponseContext<<Req::Output as IntoFlow>::RequestData, Sf::State>>,
    Sf: CreateHandler,
{
    /// Builds a dual filter with WebSocket support.
    ///
    /// Creates a filter that processes both HTTP requests and responses,
    /// and can handle WebSocket upgrades.
    pub fn build(self) -> WebSocketFilter<DualFilter<Req, Res, Sf, Done>, Sf, WsUp, WsDown> {
        let base_filter = DualFilter {
            request_handler: self.request_filter,
            response_handler: self.response_filter,
            state_factory: self.state_factory,
            done_handler: self.done_handler,
        };
        WebSocketFilter {
            base_filter,
            websocket_upstream: self.websocket_upstream,
            websocket_downstream: self.websocket_downstream,
            _sf: std::marker::PhantomData,
        }
    }
}

#[cfg(not(feature = "experimental_websocket"))]
impl<Sf, Req, Res, Done> FilterBuilder<Sf, Req, Res, Done>
where
    Req: Handler<RequestContext<Sf::State>, Output: IntoFlow>,
    Res: Handler<ResponseContext<<Req::Output as IntoFlow>::RequestData, Sf::State>>,
    Sf: CreateHandler,
{
    /// Sets the done handler called when the HTTP exchange completes.
    ///
    /// The handler receives the state and can perform cleanup operations like
    /// releasing resources or logging. Called after both request and response processing.
    pub fn on_done<D>(self, done_handler: D) -> FilterBuilder<Sf, Req, Res, D>
    where
        D: DoneHandler<Sf::State>,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: self.request_filter,
            response_filter: self.response_filter,
            done_handler,
        }
    }
}

#[cfg(feature = "experimental_websocket")]
impl<Sf, Req, Res, Done, WsUp, WsDown> FilterBuilder<Sf, Req, Res, Done, WsUp, WsDown>
where
    Req: Handler<RequestContext<Sf::State>, Output: IntoFlow>,
    Res: Handler<ResponseContext<<Req::Output as IntoFlow>::RequestData, Sf::State>>,
    Sf: CreateHandler,
{
    /// Sets the done handler called when the HTTP exchange completes.
    ///
    /// The handler receives the state and can perform cleanup operations like
    /// releasing resources or logging. Called after both request and response processing.
    pub fn on_done<D>(self, done_handler: D) -> FilterBuilder<Sf, Req, Res, D, WsUp, WsDown>
    where
        D: DoneHandler<Sf::State>,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: self.request_filter,
            response_filter: self.response_filter,
            done_handler,
            websocket_upstream: self.websocket_upstream,
            websocket_downstream: self.websocket_downstream,
        }
    }
}

#[cfg(feature = "experimental_websocket")]
impl<Sf, Req, Res, Done, WsUp, WsDown> FilterBuilder<Sf, Req, Res, Done, WsUp, WsDown>
where
    Sf: CreateHandler,
{
    /// Adds an upstream (client→server) WebSocket frame handler.
    pub fn on_upgrade_upstream<WsUpHnd, I>(
        self,
        websocket_upstream: WsUpHnd,
    ) -> FilterBuilder<Sf, Req, Res, Done, WsUpHnd::Handler, WsDown>
    where
        WsUpHnd: crate::handler::IntoHandler<
            crate::extract::context::UpgradeUpstreamContext<Sf::State>,
            I,
            Output = Result<(), crate::BoxError>,
        >,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: self.request_filter,
            response_filter: self.response_filter,
            done_handler: self.done_handler,
            websocket_upstream: websocket_upstream.into_handler(),
            websocket_downstream: self.websocket_downstream,
        }
    }

    /// Adds a downstream (server→client) WebSocket frame handler.
    pub fn on_upgrade_downstream<WsDownHnd, I>(
        self,
        websocket_downstream: WsDownHnd,
    ) -> FilterBuilder<Sf, Req, Res, Done, WsUp, WsDownHnd::Handler>
    where
        WsDownHnd: crate::handler::IntoHandler<
            crate::extract::context::UpgradeDownstreamContext<Sf::State>,
            I,
            Output = Result<(), crate::BoxError>,
        >,
    {
        FilterBuilder {
            state_factory: self.state_factory,
            request_filter: self.request_filter,
            response_filter: self.response_filter,
            done_handler: self.done_handler,
            websocket_upstream: self.websocket_upstream,
            websocket_downstream: websocket_downstream.into_handler(),
        }
    }
}