infrastore-server 0.1.1

gRPC server + Rust client for infrastore
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
//! `tonic` service implementation backed by a local `Store`.

use std::path::Path;
use std::sync::Arc;

use chrono::{DateTime, Utc};
use infrastore_core::{
    KeyIdentity, ListFilter, OwnerCategory, Period, Store, TimeSeriesError, TimeSeriesType,
};

/// Parse an ISO-8601 period from a request, mapping failures to an
/// `invalid_argument` status.
fn parse_period(s: &str) -> Result<Period, Status> {
    Period::from_iso8601(s).map_err(|e| Status::invalid_argument(e.to_string()))
}

/// Build a [`ListFilter`] from a `ListReq`, mapping bad enums / periods to
/// `invalid_argument`. Shared by `ListTimeSeries` and `ListKeys`.
fn filter_from_list_req(req: ListReq) -> Result<ListFilter, Status> {
    let mut filter = ListFilter::new();
    if let Some(id) = req.owner_id {
        filter = filter.owner_id(id);
    }
    if let Some(c) = req.owner_category {
        let pb_c = pb::OwnerCategory::try_from(c)
            .map_err(|_| Status::invalid_argument(format!("unknown owner_category {c}")))?;
        filter = filter.owner_category(OwnerCategory::from(pb_c));
    }
    if let Some(t) = req.owner_type {
        filter = filter.owner_type(t);
    }
    if let Some(t) = req.time_series_type {
        let pb_t = pb::TimeSeriesType::try_from(t)
            .map_err(|_| Status::invalid_argument(format!("unknown time_series_type {t}")))?;
        filter = filter.time_series_type(TimeSeriesType::from(pb_t));
    }
    if let Some(name) = req.name {
        filter = filter.name(name);
    }
    if let Some(iso) = req.resolution {
        filter = filter.resolution(parse_period(&iso)?);
    }
    if let Some(iso) = req.interval {
        filter = filter.interval(parse_period(&iso)?);
    }
    if let Some(f) = req.features {
        filter = filter.features(features_from_pb(f).map_err(map_convert_err)?);
    }
    Ok(filter)
}

/// An inclusive-start, exclusive-end UTC time range.
type TimeRange = (DateTime<Utc>, DateTime<Utc>);

/// Parse an optional `(start, end)` RFC3339 range; both must be supplied
/// together or neither. Shared by `GetTimeSeries` and `BulkRead`.
fn parse_time_range(
    start: Option<String>,
    end: Option<String>,
) -> Result<Option<TimeRange>, Status> {
    match (start, end) {
        (Some(s), Some(e)) => {
            let start = DateTime::parse_from_rfc3339(&s)
                .map_err(|err| Status::invalid_argument(format!("start: {err}")))?
                .with_timezone(&Utc);
            let end = DateTime::parse_from_rfc3339(&e)
                .map_err(|err| Status::invalid_argument(format!("end: {err}")))?
                .with_timezone(&Utc);
            Ok(Some((start, end)))
        }
        (None, None) => Ok(None),
        _ => Err(Status::invalid_argument(
            "start_rfc3339 and end_rfc3339 must be supplied together",
        )),
    }
}
use infrastore_proto::convert::{
    features_from_pb, forecast_summary_row_to_pb, full_key_to_pb, key_from_pb, metadata_to_pb,
    requested_type_from_pb, static_summary_row_to_pb, time_series_data_to_get_resp,
};
use infrastore_proto::pb::{
    self, BulkReadReq, BulkReadResp, ConsistencyReq, ConsistencyResp, CountsByTypeResp, CountsReq,
    CountsResp, DetailedCountsResp, EmptyReq, ForecastParamsReq, ForecastParamsResp,
    ForecastSummaryResp, GetReq, GetResp, HasReq, HasResp, IntervalsReq, IntervalsResp, KeyReq,
    KeysReq, KeysResp, ListKeysReq, ListKeysResp, ListOwnerIdsReq, ListOwnerIdsResp, ListReq,
    ListResp, ResolutionsReq, ResolutionsResp, ResolveForecastKeyReq, ResolveForecastKeyResp,
    StaticSummaryResp, TimeSeriesMetadata, VerifyReq, VerifyResp,
    catalog_store_server::{CatalogStore as CatalogStoreSvc, CatalogStoreServer},
};
use tokio::sync::Mutex;
use tonic::{Request, Response, Status};

/// Trait service backed by a `Store`. Read-only RPCs only.
pub struct CatalogStoreService {
    store: Arc<Mutex<Store>>,
}

impl CatalogStoreService {
    pub fn new(store: Store) -> Self {
        Self {
            store: Arc::new(Mutex::new(store)),
        }
    }

    pub fn from_path(path: &Path) -> Result<Self, TimeSeriesError> {
        let store = Store::open(path, true)?;
        Ok(Self::new(store))
    }

    pub fn into_server(self) -> CatalogStoreServer<Self> {
        CatalogStoreServer::new(self)
    }
}

/// Map a core `TimeSeriesError` onto a tonic `Status`.
fn map_err(e: TimeSeriesError) -> Status {
    match e {
        TimeSeriesError::NotFound => Status::not_found("time series not found"),
        TimeSeriesError::DuplicateTimeSeries => Status::already_exists("duplicate"),
        TimeSeriesError::InvalidParameter(m) => Status::invalid_argument(m),
        TimeSeriesError::IntegrityError(m) => Status::data_loss(m),
        TimeSeriesError::ReadOnlyStore => Status::failed_precondition("store is read-only"),
        TimeSeriesError::ConnectionError(m) => Status::unavailable(m),
        TimeSeriesError::IncompatibleForecast => {
            Status::failed_precondition("incompatible forecast")
        }
        e @ TimeSeriesError::IncompatibleFormat { .. } => {
            Status::failed_precondition(e.to_string())
        }
        TimeSeriesError::Io(e) => Status::internal(format!("io: {e}")),
        TimeSeriesError::Sqlite(e) => Status::internal(format!("sqlite: {e}")),
        TimeSeriesError::Serde(e) => Status::internal(format!("serde: {e}")),
        // `TimeSeriesError` is non_exhaustive; surface future variants as
        // internal rather than failing to compile against a newer core.
        e => Status::internal(e.to_string()),
    }
}

fn map_convert_err(e: infrastore_proto::convert::ConvertError) -> Status {
    Status::invalid_argument(e.to_string())
}

#[tonic::async_trait]
impl CatalogStoreSvc for CatalogStoreService {
    async fn list_time_series(
        &self,
        request: Request<ListReq>,
    ) -> Result<Response<ListResp>, Status> {
        let filter = filter_from_list_req(request.into_inner())?;
        let store = self.store.lock().await;
        let metas = store.list_time_series(filter).map_err(map_err)?;
        Ok(Response::new(ListResp {
            metadata: metas.iter().map(metadata_to_pb).collect(),
        }))
    }

    async fn get_time_series(&self, request: Request<GetReq>) -> Result<Response<GetResp>, Status> {
        let req = request.into_inner();
        let key = req
            .key
            .ok_or_else(|| Status::invalid_argument("missing key"))?;
        let key = key_from_pb(key).map_err(map_convert_err)?;
        let time_range = parse_time_range(req.start_rfc3339, req.end_rfc3339)?;
        let store = self.store.lock().await;
        let data = store.get_time_series(&key, time_range).map_err(map_err)?;
        Ok(Response::new(time_series_data_to_get_resp(&data)))
    }

    async fn get_time_series_keys(
        &self,
        request: Request<KeysReq>,
    ) -> Result<Response<KeysResp>, Status> {
        let req = request.into_inner();
        let owner_category = pb::OwnerCategory::try_from(req.owner_category)
            .map_err(|_| {
                Status::invalid_argument(format!("unknown owner_category {}", req.owner_category))
            })
            .map(OwnerCategory::from)?;
        let store = self.store.lock().await;
        let keys = store
            .get_time_series_keys(req.owner_id, owner_category)
            .map_err(map_err)?;
        Ok(Response::new(KeysResp {
            keys: keys.iter().map(full_key_to_pb).collect(),
        }))
    }

    async fn get_resolutions(
        &self,
        request: Request<ResolutionsReq>,
    ) -> Result<Response<ResolutionsResp>, Status> {
        let req = request.into_inner();
        let ts_type = match req.time_series_type {
            Some(t) => Some(TimeSeriesType::from(
                pb::TimeSeriesType::try_from(t).map_err(|_| {
                    Status::invalid_argument(format!("unknown time_series_type {t}"))
                })?,
            )),
            None => None,
        };
        let store = self.store.lock().await;
        let durations = store.get_resolutions(ts_type).map_err(map_err)?;
        Ok(Response::new(ResolutionsResp {
            resolution: durations.iter().map(|p| p.to_iso8601()).collect(),
        }))
    }

    async fn get_counts(
        &self,
        _request: Request<CountsReq>,
    ) -> Result<Response<CountsResp>, Status> {
        let store = self.store.lock().await;
        let counts = store.get_time_series_counts().map_err(map_err)?;
        Ok(Response::new(CountsResp {
            components_with_time_series: counts.components_with_time_series,
            static_time_series: counts.static_time_series,
            forecasts: counts.forecasts,
        }))
    }

    async fn get_forecast_parameters(
        &self,
        request: Request<ForecastParamsReq>,
    ) -> Result<Response<ForecastParamsResp>, Status> {
        let req = request.into_inner();
        let resolution = req.resolution.as_deref().map(parse_period).transpose()?;
        let interval = req.interval.as_deref().map(parse_period).transpose()?;
        let store = self.store.lock().await;
        let params = store
            .get_forecast_parameters(resolution, interval)
            .map_err(map_err)?;
        Ok(Response::new(ForecastParamsResp {
            horizon: params.horizon.map(|p| p.to_iso8601()),
            interval: params.interval.map(|p| p.to_iso8601()),
            count: params.count.map(|c| c as u64),
            resolution: params.resolution.map(|p| p.to_iso8601()),
            initial_timestamp_rfc3339: params.initial_timestamp.map(|t| t.to_rfc3339()),
        }))
    }

    async fn has_time_series(&self, request: Request<HasReq>) -> Result<Response<HasResp>, Status> {
        let req = request.into_inner();
        let key = req
            .key
            .ok_or_else(|| Status::invalid_argument("missing key"))?;
        let key = key_from_pb(key).map_err(map_convert_err)?;
        let store = self.store.lock().await;
        let present = store.has_time_series(&key).map_err(map_err)?;
        Ok(Response::new(HasResp { present }))
    }

    async fn verify_integrity(
        &self,
        _request: Request<VerifyReq>,
    ) -> Result<Response<VerifyResp>, Status> {
        let store = self.store.lock().await;
        let report = store.verify_integrity().map_err(map_err)?;
        Ok(Response::new(VerifyResp {
            errors: report.errors,
        }))
    }

    // ---- Additive read RPCs (Phase 4.4) ----

    async fn list_keys(
        &self,
        request: Request<ListKeysReq>,
    ) -> Result<Response<ListKeysResp>, Status> {
        let req = request.into_inner();
        let filter = filter_from_list_req(req.filter.unwrap_or_default())?;
        let store = self.store.lock().await;
        let rows = if req.with_hash {
            store
                .list_keys_with_hash(filter)
                .map_err(map_err)?
                .into_iter()
                .map(|(k, h)| pb::list_keys_resp::Row {
                    key: Some(full_key_to_pb(&k)),
                    data_hash: Some(h.to_vec()),
                })
                .collect()
        } else {
            store
                .list_keys(filter)
                .map_err(map_err)?
                .into_iter()
                .map(|k| pb::list_keys_resp::Row {
                    key: Some(full_key_to_pb(&k)),
                    data_hash: None,
                })
                .collect()
        };
        Ok(Response::new(ListKeysResp { rows }))
    }

    async fn get_metadata(
        &self,
        request: Request<KeyReq>,
    ) -> Result<Response<TimeSeriesMetadata>, Status> {
        let key = request
            .into_inner()
            .key
            .ok_or_else(|| Status::invalid_argument("missing key"))?;
        let key = key_from_pb(key).map_err(map_convert_err)?;
        let store = self.store.lock().await;
        let meta = store.get_metadata(&key).map_err(map_err)?;
        Ok(Response::new(metadata_to_pb(&meta)))
    }

    async fn bulk_read(
        &self,
        request: Request<BulkReadReq>,
    ) -> Result<Response<BulkReadResp>, Status> {
        let req = request.into_inner();
        let time_range = parse_time_range(req.start_rfc3339, req.end_rfc3339)?;
        let keys = req
            .keys
            .into_iter()
            .map(key_from_pb)
            .collect::<Result<Vec<_>, _>>()
            .map_err(map_convert_err)?;
        let refs: Vec<&KeyIdentity> = keys.iter().collect();
        let store = self.store.lock().await;
        let datas = store.bulk_read_range(&refs, time_range).map_err(map_err)?;
        Ok(Response::new(BulkReadResp {
            items: datas.iter().map(time_series_data_to_get_resp).collect(),
        }))
    }

    async fn get_detailed_counts(
        &self,
        _request: Request<EmptyReq>,
    ) -> Result<Response<DetailedCountsResp>, Status> {
        let store = self.store.lock().await;
        let c = store.time_series_counts_detailed().map_err(map_err)?;
        Ok(Response::new(DetailedCountsResp {
            components_with_time_series: c.components_with_time_series,
            supplemental_attributes_with_time_series: c.supplemental_attributes_with_time_series,
            static_time_series_count: c.static_time_series_count,
            forecast_count: c.forecast_count,
        }))
    }

    async fn get_counts_by_type(
        &self,
        _request: Request<EmptyReq>,
    ) -> Result<Response<CountsByTypeResp>, Status> {
        let store = self.store.lock().await;
        let entries = store
            .counts_by_type()
            .map_err(map_err)?
            .into_iter()
            .map(|(t, n)| pb::counts_by_type_resp::Entry {
                time_series_type: pb::TimeSeriesType::from(t) as i32,
                count: n,
            })
            .collect();
        Ok(Response::new(CountsByTypeResp { entries }))
    }

    async fn list_owner_ids(
        &self,
        request: Request<ListOwnerIdsReq>,
    ) -> Result<Response<ListOwnerIdsResp>, Status> {
        let req = request.into_inner();
        let category = pb::OwnerCategory::try_from(req.owner_category)
            .map_err(|_| {
                Status::invalid_argument(format!("unknown owner_category {}", req.owner_category))
            })
            .map(OwnerCategory::from)?;
        let ts_type = match req.time_series_type {
            Some(t) => Some(TimeSeriesType::from(
                pb::TimeSeriesType::try_from(t).map_err(|_| {
                    Status::invalid_argument(format!("unknown time_series_type {t}"))
                })?,
            )),
            None => None,
        };
        let resolution = req.resolution.as_deref().map(parse_period).transpose()?;
        let store = self.store.lock().await;
        let ids = store
            .list_owner_ids(category, ts_type, resolution)
            .map_err(map_err)?;
        Ok(Response::new(ListOwnerIdsResp { owner_id: ids }))
    }

    async fn get_intervals(
        &self,
        request: Request<IntervalsReq>,
    ) -> Result<Response<IntervalsResp>, Status> {
        let req = request.into_inner();
        let ts_type = match req.time_series_type {
            Some(t) => Some(TimeSeriesType::from(
                pb::TimeSeriesType::try_from(t).map_err(|_| {
                    Status::invalid_argument(format!("unknown time_series_type {t}"))
                })?,
            )),
            None => None,
        };
        let store = self.store.lock().await;
        let intervals = store.get_intervals(ts_type).map_err(map_err)?;
        Ok(Response::new(IntervalsResp {
            interval: intervals.iter().map(|p| p.to_iso8601()).collect(),
        }))
    }

    async fn get_static_summary(
        &self,
        _request: Request<EmptyReq>,
    ) -> Result<Response<StaticSummaryResp>, Status> {
        let store = self.store.lock().await;
        let rows = store.static_summary().map_err(map_err)?;
        Ok(Response::new(StaticSummaryResp {
            rows: rows.iter().map(static_summary_row_to_pb).collect(),
        }))
    }

    async fn get_forecast_summary(
        &self,
        _request: Request<EmptyReq>,
    ) -> Result<Response<ForecastSummaryResp>, Status> {
        let store = self.store.lock().await;
        let rows = store.forecast_summary().map_err(map_err)?;
        Ok(Response::new(ForecastSummaryResp {
            rows: rows.iter().map(forecast_summary_row_to_pb).collect(),
        }))
    }

    async fn check_static_consistency(
        &self,
        request: Request<ConsistencyReq>,
    ) -> Result<Response<ConsistencyResp>, Status> {
        let resolution = request
            .into_inner()
            .resolution
            .as_deref()
            .map(parse_period)
            .transpose()?;
        let store = self.store.lock().await;
        let rows = store
            .check_static_consistency(resolution)
            .map_err(map_err)?
            .into_iter()
            .map(|c| pb::consistency_resp::Row {
                resolution: c.resolution.to_iso8601(),
                initial_timestamp_rfc3339: c.initial_timestamp.to_rfc3339(),
                length: c.length as u64,
            })
            .collect();
        Ok(Response::new(ConsistencyResp { rows }))
    }

    async fn resolve_forecast_key(
        &self,
        request: Request<ResolveForecastKeyReq>,
    ) -> Result<Response<ResolveForecastKeyResp>, Status> {
        let req = request.into_inner();
        let category = pb::OwnerCategory::try_from(req.owner_category)
            .map_err(|_| {
                Status::invalid_argument(format!("unknown owner_category {}", req.owner_category))
            })
            .map(OwnerCategory::from)?;
        let resolution = req.resolution.as_deref().map(parse_period).transpose()?;
        let interval = req.interval.as_deref().map(parse_period).transpose()?;
        let features = match req.features {
            Some(f) => features_from_pb(f).map_err(map_convert_err)?,
            None => infrastore_core::Features::new(),
        };
        let requested = requested_type_from_pb(
            req.requested
                .ok_or_else(|| Status::invalid_argument("missing requested type"))?,
        )
        .map_err(map_convert_err)?;
        let store = self.store.lock().await;
        let key = store
            .resolve_forecast_key(
                req.owner_id,
                category,
                &req.name,
                resolution,
                interval,
                features,
                requested,
            )
            .map_err(map_err)?;
        Ok(Response::new(ResolveForecastKeyResp {
            key: Some(full_key_to_pb(&key)),
        }))
    }
}