stateknot-runtime 0.1.0-alpha.1

Executable registries and durable graph driving for StateKnot
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
// Copyright 2026 StateKnot contributors
// SPDX-License-Identifier: Apache-2.0

//! Frozen exact-version model and tool provider bindings.

use std::{collections::BTreeMap, fmt, sync::Arc};

use stateknot_core::{CapabilityIdentity, ErasedTool, Model, ModelDescriptor, ToolDescriptor};
use thiserror::Error;

struct ModelProviderBinding {
    descriptor: ModelDescriptor,
    provider: Arc<dyn Model>,
}

/// Startup-only builder for immutable object-safe model provider bindings.
#[derive(Default)]
pub struct ModelProviderRegistryBuilder {
    bindings: BTreeMap<CapabilityIdentity, ModelProviderBinding>,
}

impl ModelProviderRegistryBuilder {
    /// Maximum exact model revisions installed in one process snapshot.
    pub const MAX_BINDINGS: usize = 4096;

    /// Creates an empty model registry builder.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Registers one exact provider binding and freezes its descriptor snapshot.
    ///
    /// # Errors
    ///
    /// Rejects capacity exhaustion or a repeated owner/name/version identity.
    pub fn register(&mut self, provider: Arc<dyn Model>) -> Result<(), ModelProviderRegistryError> {
        if self.bindings.len() == Self::MAX_BINDINGS {
            return Err(ModelProviderRegistryError::TooManyBindings);
        }
        let descriptor = provider.descriptor().clone();
        let identity = descriptor.metadata().identity().clone();
        if self.bindings.contains_key(&identity) {
            return Err(ModelProviderRegistryError::DuplicateIdentity {
                identity: Box::new(identity),
            });
        }
        self.bindings.insert(
            identity,
            ModelProviderBinding {
                descriptor,
                provider,
            },
        );
        Ok(())
    }

    /// Freezes this startup snapshot. An empty registry is valid for tool-only workers.
    #[must_use]
    pub fn build(self) -> ModelProviderRegistry {
        ModelProviderRegistry {
            bindings: Arc::new(self.bindings),
        }
    }
}

impl fmt::Debug for ModelProviderRegistryBuilder {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("ModelProviderRegistryBuilder")
            .field("bindings", &self.bindings.len())
            .finish_non_exhaustive()
    }
}

/// Immutable exact-version model provider registry.
///
/// Lookup starts from the durable descriptor identity, then compares the full
/// durable descriptor against both the startup snapshot and the provider's
/// current descriptor reference. Provider aliases, model-family names, and
/// fallback selection never participate in this recovery boundary.
#[derive(Clone)]
pub struct ModelProviderRegistry {
    bindings: Arc<BTreeMap<CapabilityIdentity, ModelProviderBinding>>,
}

impl ModelProviderRegistry {
    /// Resolves and revalidates the exact durable model descriptor.
    ///
    /// # Errors
    ///
    /// Returns a missing-binding error or fails closed if any descriptor field
    /// differs from the immutable startup snapshot.
    pub fn resolve(
        &self,
        descriptor: &ModelDescriptor,
    ) -> Result<Arc<dyn Model>, ModelProviderRegistryError> {
        let identity = descriptor.metadata().identity();
        let binding = self.bindings.get(identity).ok_or_else(|| {
            ModelProviderRegistryError::MissingBinding {
                identity: Box::new(identity.clone()),
            }
        })?;
        if &binding.descriptor != descriptor || binding.provider.descriptor() != descriptor {
            return Err(ModelProviderRegistryError::DescriptorMismatch {
                identity: Box::new(identity.clone()),
            });
        }
        Ok(Arc::clone(&binding.provider))
    }

    /// Returns the number of exact model revisions.
    #[must_use]
    pub fn len(&self) -> usize {
        self.bindings.len()
    }

    /// Returns whether this worker has no model bindings.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.bindings.is_empty()
    }
}

impl fmt::Debug for ModelProviderRegistry {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("ModelProviderRegistry")
            .field("bindings", &self.bindings.len())
            .finish_non_exhaustive()
    }
}

/// Startup or exact-resolution failure for model providers.
#[derive(Clone, Debug, Eq, Error, PartialEq)]
#[non_exhaustive]
pub enum ModelProviderRegistryError {
    /// The immutable process binding ceiling was reached.
    #[error("model provider registry contains too many bindings")]
    TooManyBindings,
    /// One exact owner/name/version identity was registered twice.
    #[error("model provider identity was registered more than once")]
    DuplicateIdentity {
        /// Repeated exact binding identity.
        identity: Box<CapabilityIdentity>,
    },
    /// No provider implementation owns the durable identity.
    #[error("durable model descriptor has no installed provider binding")]
    MissingBinding {
        /// Missing exact binding identity.
        identity: Box<CapabilityIdentity>,
    },
    /// Installed descriptor bytes differ from the durable invocation snapshot.
    #[error("installed model provider descriptor differs from durable snapshot")]
    DescriptorMismatch {
        /// Conflicting owner/name/version identity.
        identity: Box<CapabilityIdentity>,
    },
}

struct ToolProviderBinding {
    descriptor: ToolDescriptor,
    provider: Arc<dyn ErasedTool>,
}

/// Startup-only builder for immutable schema-validated tool bindings.
#[derive(Default)]
pub struct ToolProviderRegistryBuilder {
    bindings: BTreeMap<CapabilityIdentity, ToolProviderBinding>,
}

impl ToolProviderRegistryBuilder {
    /// Maximum exact tool revisions installed in one process snapshot.
    pub const MAX_BINDINGS: usize = 16_384;

    /// Creates an empty tool registry builder.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Registers one already schema-validated erased tool adapter.
    ///
    /// # Errors
    ///
    /// Rejects capacity exhaustion or a repeated owner/name/version identity.
    pub fn register(
        &mut self,
        provider: Arc<dyn ErasedTool>,
    ) -> Result<(), ToolProviderRegistryError> {
        if self.bindings.len() == Self::MAX_BINDINGS {
            return Err(ToolProviderRegistryError::TooManyBindings);
        }
        let descriptor = provider.descriptor().clone();
        let identity = descriptor.metadata().identity().clone();
        if provider.supports_reconciliation() && !descriptor.semantics().supports_status_query() {
            return Err(
                ToolProviderRegistryError::ReconciliationCapabilityMismatch {
                    identity: Box::new(identity),
                },
            );
        }
        if self.bindings.contains_key(&identity) {
            return Err(ToolProviderRegistryError::DuplicateIdentity {
                identity: Box::new(identity),
            });
        }
        self.bindings.insert(
            identity,
            ToolProviderBinding {
                descriptor,
                provider,
            },
        );
        Ok(())
    }

    /// Freezes this startup snapshot. An empty registry is valid for model-only workers.
    #[must_use]
    pub fn build(self) -> ToolProviderRegistry {
        ToolProviderRegistry {
            bindings: Arc::new(self.bindings),
        }
    }
}

impl fmt::Debug for ToolProviderRegistryBuilder {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("ToolProviderRegistryBuilder")
            .field("bindings", &self.bindings.len())
            .finish_non_exhaustive()
    }
}

/// Immutable exact-version tool provider registry.
#[derive(Clone)]
pub struct ToolProviderRegistry {
    bindings: Arc<BTreeMap<CapabilityIdentity, ToolProviderBinding>>,
}

impl ToolProviderRegistry {
    /// Resolves and revalidates the exact durable tool descriptor.
    ///
    /// # Errors
    ///
    /// Returns a missing-binding error or fails closed if any descriptor field
    /// differs from the immutable startup snapshot.
    pub fn resolve(
        &self,
        descriptor: &ToolDescriptor,
    ) -> Result<Arc<dyn ErasedTool>, ToolProviderRegistryError> {
        let identity = descriptor.metadata().identity();
        let binding = self.bindings.get(identity).ok_or_else(|| {
            ToolProviderRegistryError::MissingBinding {
                identity: Box::new(identity.clone()),
            }
        })?;
        if &binding.descriptor != descriptor || binding.provider.descriptor() != descriptor {
            return Err(ToolProviderRegistryError::DescriptorMismatch {
                identity: Box::new(identity.clone()),
            });
        }
        Ok(Arc::clone(&binding.provider))
    }

    /// Returns the number of exact tool revisions.
    #[must_use]
    pub fn len(&self) -> usize {
        self.bindings.len()
    }

    /// Returns whether this worker has no tool bindings.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.bindings.is_empty()
    }
}

impl fmt::Debug for ToolProviderRegistry {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("ToolProviderRegistry")
            .field("bindings", &self.bindings.len())
            .finish_non_exhaustive()
    }
}

/// Startup or exact-resolution failure for tool adapters.
#[derive(Clone, Debug, Eq, Error, PartialEq)]
#[non_exhaustive]
pub enum ToolProviderRegistryError {
    /// The immutable process binding ceiling was reached.
    #[error("tool provider registry contains too many bindings")]
    TooManyBindings,
    /// One exact owner/name/version identity was registered twice.
    #[error("tool provider identity was registered more than once")]
    DuplicateIdentity {
        /// Repeated exact binding identity.
        identity: Box<CapabilityIdentity>,
    },
    /// No executable adapter owns the durable identity.
    #[error("durable tool descriptor has no installed provider binding")]
    MissingBinding {
        /// Missing exact binding identity.
        identity: Box<CapabilityIdentity>,
    },
    /// Installed descriptor bytes differ from the durable invocation snapshot.
    #[error("installed tool provider descriptor differs from durable snapshot")]
    DescriptorMismatch {
        /// Conflicting owner/name/version identity.
        identity: Box<CapabilityIdentity>,
    },
    /// Descriptor status-query semantics and executable provider capability differ.
    #[error("tool reconciliation capability differs from its descriptor declaration")]
    ReconciliationCapabilityMismatch {
        /// Rejected exact binding identity.
        identity: Box<CapabilityIdentity>,
    },
}

#[cfg(test)]
mod tests {
    use stateknot_core::{
        BoxFuture, BoxStream, ModelContext, ModelError, ModelEvent, ModelRequest, ModelResponse,
        ToolContext, ToolError, ToolInput, ToolResult,
    };

    use super::*;

    struct TestModel {
        descriptor: ModelDescriptor,
    }

    impl Model for TestModel {
        fn descriptor(&self) -> &ModelDescriptor {
            &self.descriptor
        }

        fn invoke(
            &self,
            _: ModelContext,
            _: ModelRequest,
        ) -> BoxFuture<'_, Result<ModelResponse, ModelError>> {
            unimplemented!("provider registry tests never dispatch")
        }

        fn stream(
            &self,
            _: ModelContext,
            _: ModelRequest,
        ) -> BoxStream<'_, Result<ModelEvent, ModelError>> {
            unimplemented!("provider registry tests never dispatch")
        }
    }

    struct TestTool {
        descriptor: ToolDescriptor,
    }

    impl ErasedTool for TestTool {
        fn descriptor(&self) -> &ToolDescriptor {
            &self.descriptor
        }

        fn supports_reconciliation(&self) -> bool {
            true
        }

        fn call(
            &self,
            _: ToolContext,
            _: ToolInput,
        ) -> BoxFuture<'_, Result<ToolResult, ToolError>> {
            unimplemented!("provider registry tests never dispatch")
        }
    }

    fn model_descriptor(name: &str) -> ModelDescriptor {
        let fixture: serde_json::Value = serde_json::from_str(include_str!(
            "../../stateknot-core/tests/fixtures/core-model-descriptor-v1.json"
        ))
        .unwrap();
        let mut descriptor = fixture["descriptors"]["valid"][0].clone();
        descriptor["metadata"]["identity"]["capability"]["name"] =
            serde_json::Value::String(name.to_owned());
        serde_json::from_value(descriptor).unwrap()
    }

    fn tool_descriptor(name: &str) -> ToolDescriptor {
        let fixture: serde_json::Value = serde_json::from_str(include_str!(
            "../../stateknot-core/tests/fixtures/core-tool-v1.json"
        ))
        .unwrap();
        let mut descriptor = fixture["descriptors"]["valid"][0].clone();
        descriptor["metadata"]["identity"]["capability"]["name"] =
            serde_json::Value::String(name.to_owned());
        serde_json::from_value(descriptor).unwrap()
    }

    fn tool_descriptor_without_status_query(name: &str) -> ToolDescriptor {
        let mut descriptor = serde_json::to_value(tool_descriptor(name)).unwrap();
        descriptor["semantics"]["status_query"] = serde_json::Value::Bool(false);
        serde_json::from_value(descriptor).unwrap()
    }

    #[test]
    fn model_registry_rejects_duplicates_and_descriptor_substitution() {
        let primary = model_descriptor("models.primary");
        let alternate = model_descriptor("models.alternate");
        let mut builder = ModelProviderRegistryBuilder::new();
        builder
            .register(Arc::new(TestModel {
                descriptor: primary.clone(),
            }))
            .unwrap();
        assert!(matches!(
            builder.register(Arc::new(TestModel {
                descriptor: primary.clone()
            })),
            Err(ModelProviderRegistryError::DuplicateIdentity { .. })
        ));
        let registry = builder.build();
        assert!(registry.resolve(&primary).is_ok());
        assert!(matches!(
            registry.resolve(&alternate),
            Err(ModelProviderRegistryError::MissingBinding { .. })
        ));
    }

    #[test]
    fn tool_registry_rejects_duplicates_and_missing_exact_versions() {
        let primary = tool_descriptor("payments.capture");
        let alternate = tool_descriptor("payments.refund");
        let mut builder = ToolProviderRegistryBuilder::new();
        builder
            .register(Arc::new(TestTool {
                descriptor: primary.clone(),
            }))
            .unwrap();
        assert!(matches!(
            builder.register(Arc::new(TestTool {
                descriptor: primary.clone()
            })),
            Err(ToolProviderRegistryError::DuplicateIdentity { .. })
        ));
        let registry = builder.build();
        assert!(registry.resolve(&primary).is_ok());
        assert!(matches!(
            registry.resolve(&alternate),
            Err(ToolProviderRegistryError::MissingBinding { .. })
        ));
    }

    #[test]
    fn tool_registry_rejects_undeclared_reconciliation_implementations() {
        let mut builder = ToolProviderRegistryBuilder::new();
        assert!(matches!(
            builder.register(Arc::new(TestTool {
                descriptor: tool_descriptor_without_status_query("payments.unreconciled"),
            })),
            Err(ToolProviderRegistryError::ReconciliationCapabilityMismatch { .. })
        ));
    }
}