vyuh 0.2.6

Vyuh web framework for Axum and SQLx with handler-first APIs
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
//! Extractors for extracting data from context in callable handlers.

use super::callables::{DataBox, FromContext, FromContextParts, IntoDataBox, IntoOutput};
use super::specs::{
    ArgPart, CallError, DataValue, IntoArgPart, IntoReturnPart, ReturnPart, TypeSchema,
};
use crate::routes::{BodyBytes, Form, Json, JsonStr, Path, Query};
use crate::validation::{Valid, Validate, ValidationSchema};
use crate::{
    Site,
    auth::{ApiKey, AuthUser},
    site,
};
use schemars::JsonSchema;
use std::borrow::Cow;
use std::sync::Arc;

/// Trait for context types that provide access to a `Site` instance.
pub trait HasSite {
    fn site(&self) -> &Site;
}

/// Trait for types that can be extracted from a `Site`.
pub trait FromSite: Sized + Send {
    fn from_site(site: &Site) -> Result<Self, CallError>;
}

/// Generic implementation: any `T: FromSite` can be extracted from any `C: HasSite`.
impl<C: HasSite, T: FromSite> FromContextParts<C> for T {
    fn from_context_parts(ctx: &C) -> Result<Self, CallError> {
        T::from_site(ctx.site())
    }
}

/// Uniform typed application data flowing through Vyuh handlers.
///
/// `Data<T>` uses `Arc<T>` internally so the same value can be cheaply shared
/// across signal fanout, commands, emitters, tasks, and route handlers.
#[derive(Debug)]
pub struct Data<T: DataValue>(pub Arc<T>);

impl<T: DataValue> Clone for Data<T> {
    fn clone(&self) -> Self {
        Self(Arc::clone(&self.0))
    }
}

impl<T: DataValue> Data<T> {
    pub fn new(inner: T) -> Data<T> {
        Data(Arc::new(inner))
    }

    pub fn from_arc(inner: Arc<T>) -> Data<T> {
        Data(inner)
    }

    pub fn into_inner(self) -> Arc<T> {
        self.0
    }
}

impl<T: DataValue> std::ops::Deref for Data<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<T: DataValue> AsRef<T> for Data<T> {
    fn as_ref(&self) -> &T {
        &self.0
    }
}

impl<T: DataValue> From<Arc<T>> for Data<T> {
    fn from(value: Arc<T>) -> Self {
        Data::from_arc(value)
    }
}

impl<T: DataValue> From<T> for Data<T> {
    fn from(value: T) -> Self {
        Data::new(value)
    }
}

/// `Data<T>` implements `FromContext` directly (not `FromContextParts`).
/// This ensures it can only appear as the last argument in a handler signature,
/// since `impl_context!` requires all but the last arg to impl `FromContextParts`.
impl<C, T> FromContext<C> for Data<T>
where
    C: IntoDataBox + Send + 'static,
    T: DataValue,
{
    fn from_context(ctx: C) -> Result<Self, CallError> {
        // Extract type-erased data from context and downcast to T
        let payload_data = ctx.into_data_box();
        let value = payload_data
            .downcast_arc::<T>()
            .ok_or_else(|| CallError::TypeMismatch)?;
        Ok(Data::from(value))
    }

    /// Returns a deserializer function for JSON data.
    /// This is used by task queues to deserialize string data into typed values.
    fn deserializer() -> Option<fn(&str) -> Result<DataBox, CallError>> {
        Some(|s: &str| {
            let value: T = serde_json::from_str(s).map_err(|_| CallError::DeserializeFailed)?;
            Ok(DataBox::new(value))
        })
    }
}

impl<T: DataValue> IntoArgPart for Data<T> {
    fn into_arg_part() -> ArgPart {
        ArgPart::Body(
            TypeSchema::wrap_unvalidated::<T>(),
            "application/json".into(),
        )
    }
}

impl<T: DataValue> IntoReturnPart for Data<T> {
    fn into_return_part() -> ReturnPart {
        ReturnPart::Body(TypeSchema::wrap::<T>(), "application/json".into())
    }
}

impl<C, E, T> FromContext<C> for Valid<E>
where
    E: FromContext<C> + std::ops::Deref<Target = T>,
    T: Validate,
{
    fn from_context(ctx: C) -> Result<Self, CallError> {
        let extracted = E::from_context(ctx)?;
        extracted
            .validate()
            .map(|()| Valid(extracted))
            .map_err(CallError::Validation)
    }

    fn deserializer() -> Option<fn(&str) -> Result<DataBox, CallError>> {
        E::deserializer()
    }
}

impl<T> super::specs::HasData<T> for Valid<Data<T>> where T: DataValue {}

/// Data<T> can be returned from handlers as an infallible output.
impl<T: DataValue, E> IntoOutput<E> for Data<T> {
    fn into_output(self) -> Result<DataBox, E> {
        Ok(DataBox::from_arc(self.0))
    }
}

impl<T> axum::extract::FromRequest<crate::Site> for Data<T>
where
    T: DataValue,
{
    type Rejection = crate::errors::ErrorReport;

    async fn from_request(
        req: axum::extract::Request,
        state: &crate::Site,
    ) -> Result<Self, Self::Rejection> {
        Json::<T>::from_request(req, state)
            .await
            .map(|Json(value)| Data::new(value))
    }
}

impl<T> axum::response::IntoResponse for Data<T>
where
    T: DataValue,
{
    fn into_response(self) -> axum::response::Response {
        axum::Json(self.0).into_response()
    }
}

// Common axum extractor implementations

impl<T: JsonSchema + Send + 'static> IntoArgPart for Path<T> {
    fn into_arg_part() -> ArgPart {
        ArgPart::Path(TypeSchema::wrap_unvalidated::<T>())
    }
}

impl<T: JsonSchema + Send + 'static> IntoArgPart for Query<T> {
    fn into_arg_part() -> ArgPart {
        ArgPart::Query(TypeSchema::wrap_unvalidated::<T>())
    }
}

impl<T: JsonSchema + Send + 'static> IntoArgPart for Form<T> {
    fn into_arg_part() -> ArgPart {
        ArgPart::Body(
            TypeSchema::wrap_unvalidated::<T>(),
            Cow::Borrowed("application/x-www-form-urlencoded"),
        )
    }
}

impl<T: JsonSchema + Send + 'static> IntoArgPart for Json<T> {
    fn into_arg_part() -> ArgPart {
        ArgPart::Body(
            TypeSchema::wrap_unvalidated::<T>(),
            Cow::Borrowed("application/json"),
        )
    }
}

impl IntoArgPart for BodyBytes {
    fn into_arg_part() -> ArgPart {
        ArgPart::Body(
            TypeSchema::binary_body(),
            Cow::Borrowed("application/octet-stream"),
        )
    }
}

impl<T> IntoArgPart for Valid<Path<T>>
where
    T: JsonSchema + Validate + ValidationSchema + Send + 'static,
{
    fn into_arg_part() -> ArgPart {
        ArgPart::Path(TypeSchema::wrap_valid::<T>())
    }
}

impl<T> IntoArgPart for Valid<Query<T>>
where
    T: JsonSchema + Validate + ValidationSchema + Send + 'static,
{
    fn into_arg_part() -> ArgPart {
        ArgPart::Query(TypeSchema::wrap_valid::<T>())
    }
}

impl<T> IntoArgPart for Valid<Form<T>>
where
    T: JsonSchema + Validate + ValidationSchema + Send + 'static,
{
    fn into_arg_part() -> ArgPart {
        ArgPart::Body(
            TypeSchema::wrap_valid::<T>(),
            Cow::Borrowed("application/x-www-form-urlencoded"),
        )
    }
}

impl<T> IntoArgPart for Valid<Json<T>>
where
    T: JsonSchema + Validate + ValidationSchema + Send + 'static,
{
    fn into_arg_part() -> ArgPart {
        ArgPart::Body(
            TypeSchema::wrap_valid::<T>(),
            Cow::Borrowed("application/json"),
        )
    }
}

impl<T> IntoArgPart for Valid<Data<T>>
where
    T: DataValue + Validate + ValidationSchema,
{
    fn into_arg_part() -> ArgPart {
        ArgPart::Body(
            TypeSchema::wrap_valid::<T>(),
            Cow::Borrowed("application/json"),
        )
    }
}

impl<T: JsonSchema + Send + 'static> IntoArgPart for axum::extract::Path<T> {
    fn into_arg_part() -> ArgPart {
        ArgPart::Path(TypeSchema::wrap::<T>())
    }
}

impl<T: JsonSchema + Send + 'static> IntoArgPart for axum::extract::Query<T> {
    fn into_arg_part() -> ArgPart {
        ArgPart::Query(TypeSchema::wrap::<T>())
    }
}

impl<T: JsonSchema + Send + 'static> IntoArgPart for axum_extra::extract::Query<T> {
    fn into_arg_part() -> ArgPart {
        ArgPart::Query(TypeSchema::wrap::<T>())
    }
}

impl<T: JsonSchema + Send + 'static> IntoArgPart for axum::extract::Json<T> {
    fn into_arg_part() -> ArgPart {
        ArgPart::Body(TypeSchema::wrap::<T>(), Cow::Borrowed("application/json"))
    }
}

impl<T: Clone + Send + Sync + 'static> IntoArgPart for axum::extract::State<T> {
    fn into_arg_part() -> ArgPart {
        ArgPart::Zone // State is not documented in OpenAPI
    }
}

impl IntoReturnPart for axum::response::Response {
    fn into_return_part() -> ReturnPart {
        ReturnPart::Unknown
    }
}

impl<T: JsonSchema + Send + 'static> IntoReturnPart for axum::extract::Json<T> {
    fn into_return_part() -> ReturnPart {
        ReturnPart::Body(TypeSchema::wrap::<T>(), Cow::Borrowed("application/json"))
    }
}

impl<T: JsonSchema + Send + 'static> IntoReturnPart for Json<T> {
    fn into_return_part() -> ReturnPart {
        ReturnPart::Body(TypeSchema::wrap::<T>(), Cow::Borrowed("application/json"))
    }
}

impl IntoReturnPart for axum::http::StatusCode {
    fn into_return_part() -> ReturnPart {
        ReturnPart::Empty
    }
}

impl<T: IntoReturnPart> IntoReturnPart for (axum::http::StatusCode, T) {
    fn into_return_part() -> ReturnPart {
        T::into_return_part()
    }
}

impl IntoReturnPart for axum::response::Html<String> {
    fn into_return_part() -> ReturnPart {
        ReturnPart::Body(TypeSchema::wrap::<String>(), "text/html".into())
    }
}

impl IntoReturnPart for () {
    fn into_return_part() -> ReturnPart {
        ReturnPart::Empty
    }
}

impl<T, E> IntoReturnPart for Result<T, E>
where
    T: IntoReturnPart,
    E: Send,
{
    fn into_return_part() -> ReturnPart {
        T::into_return_part()
    }
}

impl<T> IntoReturnPart for Option<T>
where
    T: IntoReturnPart,
{
    fn into_return_part() -> ReturnPart {
        T::into_return_part()
    }
}

impl<'a> IntoReturnPart for JsonStr {
    fn into_return_part() -> ReturnPart {
        ReturnPart::Body(TypeSchema::wrap::<String>(), "application/json".into())
    }
}

impl IntoArgPart for AuthUser {
    fn into_arg_part() -> ArgPart {
        ArgPart::Security {
            scheme: "bearerAuth".into(),
            join_all: true,
            scopes: Vec::new(),
        }
    }
}

impl IntoArgPart for ApiKey {
    fn into_arg_part() -> ArgPart {
        ArgPart::Security {
            scheme: "apiKeyAuth".into(),
            join_all: true,
            scopes: Vec::new(),
        }
    }
}

impl IntoArgPart for site::Site {
    fn into_arg_part() -> ArgPart {
        ArgPart::Ignore
    }
}

impl FromSite for site::Site {
    fn from_site(site: &site::Site) -> Result<Self, CallError> {
        Ok(site.clone())
    }
}

impl<C: HasSite> FromContext<C> for site::Site {
    fn from_context(ctx: C) -> Result<Self, CallError> {
        Ok(ctx.site().clone())
    }
}