actix-htmx 0.4.1

Actix Web middleware for use when developing with htmx
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

use crate::{headers::ResponseHeaders, Htmx, TriggerPayload, TriggerType};

use actix_web::http::header::{HeaderName, HeaderValue};
use actix_web::{
    dev::{forward_ready, Service, ServiceRequest, ServiceResponse, Transform},
    Error, HttpMessage,
};
use futures_util::future::LocalBoxFuture;
use indexmap::IndexMap;
use log::warn;
use serde_json::{Map, Value};
use std::future::{ready, Ready};

/// A middleware for Actix Web that handles htmx specific headers and triggers.
///
/// This module provides middleware functionality for using htmx in your Actix Web
/// application. It processes htmx headers and manages various types of triggers that
/// can be used for client-side interactions.
///
/// [`HtmxMiddleware`] injects an Htmx struct into any route that it wraps. This
/// Htmx struct provides helper properties and methods that allow for your application
/// to easily interact with htmx.
///
/// # Example
///
/// ```no_run
/// use actix_web::{web, App, HttpServer, Responder, HttpResponse};
/// use actix_htmx::{Htmx, HtmxMiddleware};
///
/// #[actix_web::main]
/// async fn main() -> std::io::Result<()> {
///     HttpServer::new(|| {
///         App::new()
///            .wrap(HtmxMiddleware)
///             .route("/", web::get().to(index))
///     })
///     .bind("127.0.0.1:8080")?
///     .run()
///     .await
/// }
///
/// async fn index(htmx: Htmx) -> impl Responder {
///     if !htmx.is_htmx {
///         HttpResponse::Ok().body(r##"
///             <!DOCTYPE html>
///             <html>
///                 <head>
///                     <title>htmx example</title>
///                     <script src="https://unpkg.com/htmx.org@2.0.6"></script>
///                 </head>
///                 <body>
///                     <div id="content">
///                         This was not an htmx request! <a href="/" hx-get="/" hx-target="#content">Make it htmx!</a>
///                     </div>
///                 </body>
///             </html>
///         "##)
///     } else {
///         HttpResponse::Ok().body(r##"
///         <div id="content">
///             This was an htmx request! <a href="/">Let's go back to plain old HTML</a>
///         <div>
///         "##)
///     }
/// }
/// ```
///
/// The middleware automatically processes the following htmx headers:
/// - `HX-Trigger`: For standard htmx triggers
/// - `HX-Trigger-After-Settle`: For triggers that fire after the settling phase
/// - `HX-Trigger-After-Swap`: For triggers that fire after content swap
///
pub struct HtmxMiddleware;

impl<S, B> Transform<S, ServiceRequest> for HtmxMiddleware
where
    S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
    S::Future: 'static,
    B: 'static,
{
    type Response = ServiceResponse<B>;
    type Error = Error;
    type Transform = InnerHtmxMiddleware<S>;
    type InitError = ();
    type Future = Ready<Result<Self::Transform, Self::InitError>>;

    fn new_transform(&self, service: S) -> Self::Future {
        ready(Ok(InnerHtmxMiddleware { service }))
    }
}

#[doc(hidden)]
#[non_exhaustive]
pub struct InnerHtmxMiddleware<S> {
    service: S,
}

impl<S, B> Service<ServiceRequest> for InnerHtmxMiddleware<S>
where
    S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
    S::Future: 'static,
    B: 'static,
{
    type Response = ServiceResponse<B>;
    type Error = Error;
    type Future = LocalBoxFuture<'static, Result<Self::Response, Self::Error>>;

    forward_ready!(service);

    fn call(&self, req: ServiceRequest) -> Self::Future {
        let htmx = Htmx::new(&req);

        req.extensions_mut().insert(htmx);

        let fut = self.service.call(req);

        Box::pin(async move {
            let res: ServiceResponse<B> = fut.await?;

            let (req, mut res) = res.into_parts();

            let trigger_json =
                |trigger_map: &IndexMap<String, Option<TriggerPayload>>| -> Option<String> {
                    let mut object = Map::new();
                    for (key, value) in trigger_map.iter() {
                        let json_value = match value {
                            Some(payload) => payload.as_json_value(),
                            None => Value::Null,
                        };
                        object.insert(key.clone(), json_value);
                    }
                    serde_json::to_string(&Value::Object(object)).ok()
                };

            let simple_header = |trigger_map: &IndexMap<String, Option<TriggerPayload>>| -> String {
                trigger_map.keys().cloned().collect::<Vec<_>>().join(",")
            };

            let mut process_trigger_header =
                |header_name: HeaderName,
                 trigger_map: IndexMap<String, Option<TriggerPayload>>,
                 simple: bool| {
                    if trigger_map.is_empty() {
                        return;
                    }

                    let triggers = if simple {
                        simple_header(&trigger_map)
                    } else if let Some(json) = trigger_json(&trigger_map) {
                        json
                    } else {
                        warn!("Failed to serialize HX-Trigger header");
                        return;
                    };

                    if let Ok(value) = HeaderValue::from_str(&triggers) {
                        res.headers_mut().insert(header_name, value);
                    } else {
                        warn!("Failed to parse {} header value: {}", header_name, triggers)
                    }
                };

            if let Some(htmx_response) = req.extensions().get::<Htmx>() {
                process_trigger_header(
                    HeaderName::from_static(ResponseHeaders::HX_TRIGGER),
                    htmx_response.get_triggers(TriggerType::Standard),
                    htmx_response.is_simple_trigger(TriggerType::Standard),
                );
                process_trigger_header(
                    HeaderName::from_static(ResponseHeaders::HX_TRIGGER_AFTER_SETTLE),
                    htmx_response.get_triggers(TriggerType::AfterSettle),
                    htmx_response.is_simple_trigger(TriggerType::AfterSettle),
                );
                process_trigger_header(
                    HeaderName::from_static(ResponseHeaders::HX_TRIGGER_AFTER_SWAP),
                    htmx_response.get_triggers(TriggerType::AfterSwap),
                    htmx_response.is_simple_trigger(TriggerType::AfterSwap),
                );

                let response_headers = htmx_response.get_response_headers();
                response_headers
                    .iter()
                    .for_each(|(key, value)| match key.parse() {
                        Ok(key) => {
                            if let Ok(value) = HeaderValue::from_str(value) {
                                res.headers_mut().insert(key, value);
                            } else {
                                warn!("Failed to parse {} header value: {}", key, value)
                            }
                        }
                        _ => {
                            warn!("Failed to parse header name: {}", key)
                        }
                    });
            }

            Ok(ServiceResponse::new(req, res))
        })
    }
}