icydb 0.293.0

IcyDB — A schema-first typed query engine and persistence runtime for Internet Computer canisters
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

//! Product query-reply admission over IC Wire's complete-envelope sizing.
//!
//! Adapters retain exports and transport; this owner selects existing IC byte
//! caps and preserves the small typed result when success cannot be delivered.

use crate::{
    Error, ErrorKind, ErrorOrigin, RuntimeErrorKind, db::EntitySchemaDescription,
    diagnostic::RuntimeBoundaryCode,
};
use serde::Serialize;

pub(crate) const MAX_PUBLIC_QUERY_REPLY_BYTES: usize = icydb_schema::wire::MAX_REPLY_BYTES;
#[cfg(any(target_arch = "wasm32", test))]
pub(crate) const MAX_REPLICATED_QUERY_REPLY_BYTES: usize = 2 * 1024 * 1024;

/// Admit one generated accepted-schema success under the actual message cap.
#[doc(hidden)]
pub fn into_deliverable_schema_reply(
    report: Vec<EntitySchemaDescription>,
) -> Result<Vec<EntitySchemaDescription>, Error> {
    into_deliverable_query_reply(report, RuntimeBoundaryCode::SchemaReplyBytesExceeded)
}

pub(crate) fn into_deliverable_query_reply<T: Serialize>(
    value: T,
    exceeded: RuntimeBoundaryCode,
) -> Result<T, Error> {
    #[cfg(target_arch = "wasm32")]
    let maximum = if ic_platform::ic0::in_replicated_execution() != 0 {
        MAX_REPLICATED_QUERY_REPLY_BYTES
    } else {
        MAX_PUBLIC_QUERY_REPLY_BYTES
    };
    #[cfg(not(target_arch = "wasm32"))]
    let maximum = MAX_PUBLIC_QUERY_REPLY_BYTES;
    into_deliverable_query_reply_with_limit(value, maximum, exceeded)
}

// One exact success-envelope check serves both handlers and both IC contexts.
// Codec admission failures retain the existing SQL Internal/Response contract.
pub(crate) fn into_deliverable_query_reply_with_limit<T: Serialize>(
    value: T,
    maximum: usize,
    exceeded: RuntimeBoundaryCode,
) -> Result<T, Error> {
    let response: Result<&T, Error> = Ok(&value);
    let encoded =
        ic_wire::native::encoded_frame_len(&response, icydb_schema::wire::sizing_limits())
            .map_err(|_| {
                Error::from_kind(
                    ErrorKind::Runtime(RuntimeErrorKind::Internal),
                    ErrorOrigin::Response,
                )
            })?;
    if encoded > maximum {
        return Err(Error::from_runtime_boundary(
            exceeded,
            ErrorOrigin::Response,
        ));
    }
    Ok(value)
}

#[cfg(test)]
mod tests;