icydb-model 0.219.1

IcyDB application-model authoring, validation, and code generation
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

//! Module: build::actor::endpoint
//! Responsibility: emit private authorization helpers used by source-declared endpoints.
//! Does not own: endpoint declaration syntax, public wrappers, or private handler bodies.
//! Boundary: package-private actor-codegen support for the public source macro.

use proc_macro2::TokenStream;
use quote::quote;

/// Emit the private controller-authorization helpers used by the fixed wrappers.
pub(crate) fn emit_endpoint_authorization_helpers() -> TokenStream {
    quote! {
        pub(crate) mod endpoint_authorization {
            fn require_controller(
                boundary: ::icydb::diagnostic::RuntimeBoundaryCode,
            ) -> Result<(), ::icydb::Error> {
                let caller = ::icydb::__reexports::ic_cdk::api::msg_caller();
                if !::icydb::__reexports::ic_cdk::api::is_controller(&caller) {
                    return Err(::icydb::Error::from_runtime_boundary(
                        boundary,
                        ::icydb::ErrorOrigin::Interface,
                    ));
                }

                Ok(())
            }

            pub(crate) fn require_sql_controller() -> Result<(), ::icydb::Error> {
                require_controller(
                    ::icydb::diagnostic::RuntimeBoundaryCode::SqlSurfaceControllerRequired,
                )
            }

            pub(crate) fn require_operational_controller() -> Result<(), ::icydb::Error> {
                require_controller(
                    ::icydb::diagnostic::RuntimeBoundaryCode::OperationalSurfaceControllerRequired,
                )
            }

            pub(crate) fn require_schema_controller() -> Result<(), ::icydb::Error> {
                require_controller(
                    ::icydb::diagnostic::RuntimeBoundaryCode::SchemaSurfaceControllerRequired,
                )
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::emit_endpoint_authorization_helpers;

    #[test]
    fn authorization_helpers_preserve_the_three_frozen_controller_boundaries() {
        let tokens = emit_endpoint_authorization_helpers().to_string();

        for boundary in [
            "SqlSurfaceControllerRequired",
            "OperationalSurfaceControllerRequired",
            "SchemaSurfaceControllerRequired",
        ] {
            assert!(tokens.contains(boundary));
        }
        assert!(tokens.contains("ErrorOrigin :: Interface"));
        assert!(tokens.contains("is_controller"));
    }
}