che-rest 0.3.4

Typed REST framework and project tooling for che-orm applications
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
493
494
//! Reusable ordinary REST transport for a Tauri/native ModelLogClient.
use crate::RestModelWrite;
use che_orm::{ModelSerializer, OrmError};
use che_sync::{ModelLogTransport, SyncModel, TransportFuture, model_log::*};
use std::collections::BTreeMap;

#[derive(Clone)]
pub struct RestResource {
    model: String,
    resource: String,
    fields: BTreeMap<String, String>,
    page_size_limit: u32,
}
impl RestResource {
    pub fn model_name(&self) -> &str {
        &self.model
    }

    /// Bound downloads for models with large journal entries without changing writes.
    pub fn with_page_size_limit(mut self, limit: u32) -> Result<Self, OrmError> {
        if !(1..=1000).contains(&limit) {
            return Err(OrmError::Configuration(
                "page size limit must be 1..=1000".into(),
            ));
        }
        self.page_size_limit = limit;
        Ok(self)
    }

    pub fn new<M: SyncModel, S: ModelSerializer<Model = M>>(
        resource: &str,
    ) -> Result<Self, OrmError> {
        let resource = resource.trim_matches('/');
        if resource.is_empty()
            || resource
                .split('/')
                .any(|part| part.is_empty() || part == "." || part == "..")
            || resource
                .chars()
                .any(|ch| !ch.is_ascii_alphanumeric() && !matches!(ch, '/' | '_' | '-'))
        {
            return Err(OrmError::Configuration("invalid REST resource path".into()));
        }
        let schema = M::schema();
        let mut fields = BTreeMap::new();
        for sync in M::registered_fields().iter().filter(|field| field.writable) {
            let column = schema
                .columns
                .iter()
                .find(|column| column.name == sync.column)
                .ok_or_else(|| OrmError::Configuration("unknown sync column".into()))?;
            let mappings = S::fields()
                .iter()
                .filter(|field| {
                    !field.read_only
                        && if field.related_model.is_some() {
                            field.source == column.name
                        } else {
                            field.source == column.field_name
                        }
                })
                .collect::<Vec<_>>();
            if mappings.len() != 1 {
                return Err(OrmError::Configuration(format!(
                    "sync field {} needs one writable serializer mapping",
                    sync.name
                )));
            }
            fields.insert(sync.name.into(), mappings[0].name.into());
        }
        Ok(Self {
            model: M::SYNC_NAME.into(),
            resource: resource.into(),
            fields,
            page_size_limit: 1000,
        })
    }
}

pub struct RestModelTransport {
    batched_changes: bool,
    base: String,
    client: reqwest::Client,
    resources: BTreeMap<String, RestResource>,
}
impl RestModelTransport {
    /// Opt in to POST /sync/changes/; requires a server exposing the batch action.
    /// Write payload identity and pending receipts are unchanged.
    pub fn with_batched_changes(mut self) -> Self {
        self.batched_changes = true;
        self
    }
    /// Configure bearer/token authentication and timeouts on `client`. The base
    /// URL includes the API prefix, e.g. https://host/api. Credentials are never
    /// persisted inside the immutable request body.
    pub fn new(
        base: &str,
        client: reqwest::Client,
        resources: Vec<RestResource>,
    ) -> Result<Self, OrmError> {
        let url = reqwest::Url::parse(base)
            .map_err(|error| OrmError::Configuration(error.to_string()))?;
        if !matches!(url.scheme(), "http" | "https")
            || url.query().is_some()
            || url.fragment().is_some()
        {
            return Err(OrmError::Configuration("invalid API base URL".into()));
        }
        let mut mappings = BTreeMap::new();
        for resource in resources {
            if mappings.insert(resource.model.clone(), resource).is_some() {
                return Err(OrmError::Configuration(
                    "duplicate REST model resource".into(),
                ));
            }
        }
        Ok(Self {
            base: base.trim_end_matches('/').into(),
            client,
            resources: mappings,
            batched_changes: false,
        })
    }
}
fn network(error: reqwest::Error) -> OrmError {
    OrmError::Interaction(error.without_url().to_string())
}
async fn decode_response<T: serde::de::DeserializeOwned>(
    response: reqwest::Response,
    context: &str,
) -> Result<T, OrmError> {
    // Reading separately keeps body timeouts distinguishable from malformed JSON.
    let bytes = response.bytes().await.map_err(|error| {
        let reason = if error.is_timeout() {
            "response body timed out".to_owned()
        } else {
            error.without_url().to_string()
        };
        OrmError::Interaction(format!("{context}: {reason}"))
    })?;
    serde_json::from_slice(&bytes)
        .map_err(|error| OrmError::Interaction(format!("{context}: invalid sync JSON: {error}")))
}

impl ModelLogTransport for RestModelTransport {
    fn id(&self) -> &'static str {
        "che-rest.model.v2"
    }
    fn legacy_payload_key(&self, operation: che_orm::Uuid) -> Option<String> {
        Some(format!("rest-request:{operation}"))
    }
    fn prepare_write(&self, write: &ModelWrite) -> Result<serde_json::Value, OrmError> {
        let resource = self.resources.get(&write.model).ok_or_else(|| {
            OrmError::Configuration(format!("no REST resource for {}", write.model))
        })?;
        let field_name =
            |name: &str| {
                resource.fields.get(name).cloned().ok_or_else(|| {
                    OrmError::Configuration(format!("unknown writable field {name}"))
                })
            };
        let body = write
            .changes
            .as_ref()
            .map(|changes| {
                changes
                    .iter()
                    .map(|(name, value)| Ok((field_name(name)?, value.clone())))
                    .collect::<Result<serde_json::Map<_, _>, OrmError>>()
            })
            .transpose()?
            .map(serde_json::Value::Object)
            .unwrap_or(serde_json::Value::Null);
        let json_null_fields = write
            .changes
            .as_ref()
            .map(|changes| {
                changes
                    .iter()
                    .filter(|(name, value)| {
                        value.is_null() && !write.sql_null_fields.contains(name)
                    })
                    .map(|(name, _)| field_name(name))
                    .collect::<Result<Vec<_>, _>>()
            })
            .transpose()?
            .unwrap_or_default();
        serde_json::to_value(RestModelWrite {
            model: write.model.clone(),
            resource: resource.resource.clone(),
            record_id: write.record_id,
            operation_id: write.operation_id,
            replica_id: write.replica_id,
            base_revision: write.base_revision,
            schema_version: write.schema_version,
            kind: write.kind,
            body,
            json_null_fields,
        })
        .map_err(|error| OrmError::Configuration(error.to_string()))
    }
    fn write<'a>(
        &'a self,
        mutation: &'a ModelWrite,
        payload: &'a serde_json::Value,
    ) -> TransportFuture<'a, ModelWriteResult> {
        Box::pin(async move {
            let response = self
                .send_write(mutation, payload, MODEL_LOG_PROTOCOL)
                .await?;
            let status = response.status();
            if response
                .headers()
                .get("content-type")
                .and_then(|value| value.to_str().ok())
                .and_then(|value| value.split(';').next())
                .map(str::trim)
                != Some("application/vnd.che-sync.v2+json")
            {
                return Err(OrmError::Interaction(format!(
                    "HTTP {status}; Retry-After: {}",
                    response
                        .headers()
                        .get("retry-after")
                        .and_then(|value| value.to_str().ok())
                        .unwrap_or("unspecified")
                )));
            }
            let result: ModelWriteResult = decode_response(
                response,
                &format!(
                    "sync write {} operation {}",
                    mutation.model, mutation.operation_id
                ),
            )
            .await?;
            let expected = match &result {
                ModelWriteResult::Accepted(_) if mutation.kind == ChangeKind::Create => 201,
                ModelWriteResult::Accepted(_) => 200,
                ModelWriteResult::Conflict(_) => 412,
                ModelWriteResult::Rejected { .. } => 400,
            };
            if status.as_u16() != expected {
                return Err(OrmError::Interaction(
                    "HTTP status does not match canonical result".into(),
                ));
            }
            Ok(result)
        })
    }
    fn changes_many<'a>(
        &'a self,
        models: Vec<ModelJournalRequest>,
        limit: u32,
    ) -> TransportFuture<'a, Option<Vec<ModelJournalPage>>> {
        Box::pin(async move {
            if !self.batched_changes {
                return Ok(None);
            }
            if models.is_empty()
                || models.len() > 100
                || limit < models.len() as u32
                || limit > 1000
            {
                return Err(OrmError::Configuration(
                    "invalid batch journal request".into(),
                ));
            }
            // Preserve per-resource download caps with the endpoint's equal quotas.
            let mut cap = 1000;
            for model in &models {
                let resource = self.resources.get(&model.model).ok_or_else(|| {
                    OrmError::Configuration(format!("no REST resource for {}", model.model))
                })?;
                cap = cap.min(resource.page_size_limit);
            }
            let limit = limit.min(cap.saturating_mul(models.len() as u32));
            let response = self
                .client
                .post(format!("{}/sync/changes/", self.base))
                .json(&crate::sync::JournalChangesRequest { models, limit })
                .send()
                .await
                .map_err(network)?
                .error_for_status()
                .map_err(network)?;
            let response: crate::sync::JournalChangesResponse =
                decode_response(response, "batch sync changes").await?;
            Ok(Some(response.models))
        })
    }
    fn changes<'a>(
        &'a self,
        model: &'a str,
        after: i64,
        limit: u32,
    ) -> TransportFuture<'a, ModelChanges> {
        Box::pin(async move {
            let resource = self
                .resources
                .get(model)
                .ok_or_else(|| OrmError::Configuration(format!("no REST resource for {model}")))?;
            let response = self
                .client
                .get(format!("{}/{}/sync/changes/", self.base, resource.resource))
                .query(&[
                    ("after", after.to_string()),
                    ("limit", limit.min(resource.page_size_limit).to_string()),
                ])
                .send()
                .await
                .map_err(network)?
                .error_for_status()
                .map_err(network)?;
            decode_response(response, &format!("sync changes {model} after {after}")).await
        })
    }
}

impl RestModelTransport {
    async fn send_write(
        &self,
        mutation: &ModelWrite,
        payload: &serde_json::Value,
        protocol: u32,
    ) -> Result<reqwest::Response, OrmError> {
        let write: RestModelWrite = serde_json::from_value(payload.clone())
            .map_err(|error| OrmError::Configuration(error.to_string()))?;
        if write.model != mutation.model
            || write.record_id != mutation.record_id
            || write.operation_id != mutation.operation_id
            || write.replica_id != mutation.replica_id
            || write.base_revision != mutation.base_revision
            || write.schema_version != mutation.schema_version
            || write.kind != mutation.kind
        {
            return Err(OrmError::Configuration(
                "REST payload changed operation identity".into(),
            ));
        }
        let method = match write.kind {
            ChangeKind::Create => reqwest::Method::POST,
            ChangeKind::Update => reqwest::Method::PATCH,
            ChangeKind::Delete => reqwest::Method::DELETE,
        };
        let url = if write.kind == ChangeKind::Create {
            format!("{}/{}/", self.base, write.resource)
        } else {
            format!("{}/{}/{}/", self.base, write.resource, write.record_id)
        };
        let response = self
            .client
            .request(method, url)
            .header("x-sync-protocol", protocol)
            .header("x-sync-replica", write.replica_id.to_string())
            .header("idempotency-key", write.operation_id.to_string())
            .header("if-match", format!("\"{}\"", write.base_revision))
            .header("x-sync-version", write.schema_version)
            .header("x-sync-entity", write.record_id.to_string())
            .header(
                "x-sync-json-null-fields",
                serde_json::to_string(&write.json_null_fields)
                    .map_err(|error| OrmError::Configuration(error.to_string()))?,
            )
            .json(&write.body)
            .send()
            .await
            .map_err(network)?;
        Ok(response)
    }
}

/// Explicit protocol-3 adapter. Its immutable payload namespace is separate
/// from protocol 2; submitted v2 requests must settle before upgrading a client.
pub struct RestObjectTransport(RestModelTransport);
impl RestObjectTransport {
    pub fn new(
        base: &str,
        client: reqwest::Client,
        resources: Vec<RestResource>,
    ) -> Result<Self, OrmError> {
        Ok(Self(RestModelTransport::new(base, client, resources)?))
    }
}
impl ModelLogTransport for RestObjectTransport {
    fn id(&self) -> &'static str {
        "che-rest.object.v3"
    }
    fn prepare_write(&self, write: &ModelWrite) -> Result<serde_json::Value, OrmError> {
        self.0.prepare_write(write)
    }
    fn write<'a>(
        &'a self,
        _: &'a ModelWrite,
        _: &'a serde_json::Value,
    ) -> TransportFuture<'a, ModelWriteResult> {
        Box::pin(async {
            Err(OrmError::Configuration(
                "object transport requires a protocol-3 client".into(),
            ))
        })
    }
    fn changes<'a>(&'a self, _: &'a str, _: i64, _: u32) -> TransportFuture<'a, ModelChanges> {
        Box::pin(async {
            Err(OrmError::Configuration(
                "object transport requires a protocol-3 client".into(),
            ))
        })
    }
    fn object_write<'a>(
        &'a self,
        write: &'a ModelWrite,
        payload: &'a serde_json::Value,
    ) -> TransportFuture<'a, che_sync::object_log::ObjectWriteResult> {
        Box::pin(async move {
            use che_sync::object_log::*;
            let response = self
                .0
                .send_write(write, payload, OBJECT_LOG_PROTOCOL)
                .await?;
            let status = response.status();
            if response
                .headers()
                .get("content-type")
                .and_then(|v| v.to_str().ok())
                .and_then(|v| v.split(';').next())
                .map(str::trim)
                != Some("application/vnd.che-sync.v3+json")
            {
                return Err(OrmError::Interaction(format!(
                    "HTTP {status}; no canonical protocol-3 settlement"
                )));
            }
            let result: ObjectWriteResult = response.json().await.map_err(network)?;
            let outcome = match &result {
                ObjectWriteResult::Acknowledged {
                    operation_id,
                    outcome,
                } => {
                    if *operation_id != write.operation_id {
                        return Err(OrmError::Interaction("wrong settlement operation".into()));
                    }
                    *outcome
                }
                ObjectWriteResult::Canonical(r) => match r {
                    ModelWriteResult::Accepted(_) => WriteOutcome::Accepted,
                    ModelWriteResult::Conflict(_) => WriteOutcome::Conflict,
                    ModelWriteResult::Rejected { .. } => WriteOutcome::Rejected,
                },
            };
            let expected = match outcome {
                WriteOutcome::Accepted if write.kind == ChangeKind::Create => 201,
                WriteOutcome::Accepted => 200,
                WriteOutcome::Conflict => 412,
                WriteOutcome::Rejected => 400,
            };
            if status.as_u16() != expected {
                return Err(OrmError::Interaction(
                    "HTTP status does not match object settlement".into(),
                ));
            }
            Ok(result)
        })
    }
    fn object_changes<'a>(
        &'a self,
        model: &'a str,
        cursor: Option<che_sync::object_log::ObjectCursor>,
        limit: u32,
    ) -> TransportFuture<'a, che_sync::object_log::ObjectChanges> {
        Box::pin(async move {
            let resource = self
                .0
                .resources
                .get(model)
                .ok_or_else(|| OrmError::Configuration("unknown object resource".into()))?;
            self.0
                .client
                .post(format!(
                    "{}/{}/sync/objects/",
                    self.0.base, resource.resource
                ))
                .json(&serde_json::json!({"protocol_version":3,"cursor":cursor,"limit":limit}))
                .send()
                .await
                .map_err(network)?
                .error_for_status()
                .map_err(network)?
                .json()
                .await
                .map_err(network)
        })
    }
}