cordis-core 0.0.2

A typed, scope-based plugin runtime inspired by Cordis
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
use std::{
    any::TypeId,
    collections::HashMap,
    future::Future,
    marker::PhantomData,
    ops::Deref,
    sync::{Arc, Weak},
};

use futures::FutureExt;
use tokio_util::sync::CancellationToken;

use crate::{
    Error, Result, ServiceHandle, ServiceKey,
    runtime::{EventCallback, QueryCallback, Runtime},
    scope::ScopeInner,
    service::{ServiceEntry, ServiceId, boxed_service},
};

/// Cheaply clonable access to the shared runtime.
#[derive(Clone)]
pub struct Context {
    pub(crate) runtime: Arc<Runtime>,
    scope_id: u64,
    isolations: Arc<HashMap<TypeId, u64>>,
}

impl Context {
    pub(crate) fn root(runtime: Arc<Runtime>) -> Self {
        Self {
            runtime,
            scope_id: 0,
            isolations: Arc::new(HashMap::new()),
        }
    }

    pub(crate) fn for_scope(runtime: Arc<Runtime>, scope_id: u64) -> Self {
        Self {
            runtime,
            scope_id,
            isolations: Arc::new(HashMap::new()),
        }
    }

    pub fn scope_id(&self) -> u64 {
        self.scope_id
    }

    /// Creates a lightweight child context sharing the same runtime.
    pub fn child(&self) -> Self {
        Self {
            runtime: self.runtime.clone(),
            scope_id: self.runtime.next_id(),
            isolations: self.isolations.clone(),
        }
    }

    /// Creates a child where service `K` resolves in a fresh isolated slot;
    /// all other service types continue to inherit their current slots.
    pub fn isolate<K: ServiceKey>(&self) -> Self {
        let mut isolations = (*self.isolations).clone();
        isolations.insert(TypeId::of::<K>(), self.runtime.next_id());
        Self {
            runtime: self.runtime.clone(),
            scope_id: self.scope_id,
            isolations: Arc::new(isolations),
        }
    }

    fn service_id<K: ServiceKey>(&self) -> ServiceId {
        ServiceId {
            key: TypeId::of::<K>(),
            isolation: self
                .isolations
                .get(&TypeId::of::<K>())
                .copied()
                .unwrap_or(0),
        }
    }

    pub fn get<K: ServiceKey>(&self) -> Result<Arc<K::Value>> {
        let services = self.runtime.services.lock().expect("service lock poisoned");
        let entry = services
            .get(&self.service_id::<K>())
            .filter(|entry| entry.active || entry.owner == self.scope_id)
            .ok_or(Error::MissingService { name: K::NAME })?;
        entry
            .value
            .downcast_ref::<Arc<K::Value>>()
            .cloned()
            .ok_or(Error::ServiceTypeMismatch { name: entry.name })
    }

    pub fn try_get<K: ServiceKey>(&self) -> Option<Arc<K::Value>> {
        let services = self.runtime.services.lock().expect("service lock poisoned");
        let entry = services.get(&self.service_id::<K>())?;
        if !entry.active && entry.owner != self.scope_id {
            return None;
        }
        entry.value.downcast_ref::<Arc<K::Value>>().cloned()
    }

    /// Invokes listeners serially in registration order.
    pub async fn emit<E: Event>(&self, event: E) -> Result<()> {
        self.runtime.emit_serial(event).await
    }

    /// Invokes all listeners concurrently.
    pub async fn parallel<E: Event>(&self, event: E) -> Result<()> {
        self.runtime.emit_parallel(event).await
    }

    /// Runs query handlers in registration order and returns the first answer.
    pub async fn query<Q: Query>(&self, query: Q) -> Result<Option<Q::Response>> {
        self.runtime.query(query).await
    }
}

#[derive(Clone, Copy, Debug)]
pub struct Ready;

#[derive(Clone, Copy, Debug)]
pub struct Fork {
    pub plugin: crate::PluginId,
    pub activation: crate::ActivationId,
}

#[derive(Clone, Copy, Debug)]
pub struct Dispose {
    pub plugin: crate::PluginId,
    pub activation: crate::ActivationId,
}

/// Any thread-safe static value can be used as an event payload.
pub trait Event: Send + Sync + 'static {}
impl<T: Send + Sync + 'static> Event for T {}

/// A typed bail/query event.
pub trait Query: Send + Sync + 'static {
    type Response: Send + Sync + 'static;
}

/// Context passed to a plugin. Registrations are automatically owned by its
/// scope and survive when their returned handles are ignored.
#[derive(Clone)]
pub struct PluginContext {
    context: Context,
    scope: Arc<ScopeInner>,
}

impl PluginContext {
    pub(crate) fn new(context: Context, scope: Arc<ScopeInner>) -> Self {
        Self { context, scope }
    }

    pub fn isolate<K: ServiceKey>(&self) -> Self {
        Self {
            context: self.context.isolate::<K>(),
            scope: self.scope.clone(),
        }
    }

    pub fn provide<K: ServiceKey>(&self, value: Arc<K::Value>) -> Result<ServiceHandle<K>> {
        let id = self.context.service_id::<K>();
        let token = self.context.runtime.next_service_generation();
        let generation = self.context.runtime.next_service_generation();
        {
            let mut services = self
                .context
                .runtime
                .services
                .lock()
                .expect("service lock poisoned");
            if services.contains_key(&id) {
                return Err(Error::DuplicateService { name: K::NAME });
            }
            services.insert(
                id,
                ServiceEntry {
                    value: boxed_service::<K>(value),
                    owner: self.scope.id,
                    token,
                    generation,
                    name: K::NAME,
                    active: false,
                },
            );
        }

        let weak = Arc::downgrade(&self.context.runtime);
        let owner = self.scope.id;
        if let Err(error) = self.scope.push(Box::new(move || {
            Box::pin(async move {
                if let Some(runtime) = weak.upgrade() {
                    runtime.remove_service(id, owner, token);
                }
                Ok(())
            })
        })) {
            self.context.runtime.remove_service(id, owner, token);
            return Err(error);
        }

        Ok(ServiceHandle {
            id,
            runtime: Arc::downgrade(&self.context.runtime),
            owner,
            token,
            _key: PhantomData,
        })
    }

    pub fn on<E, H, Fut>(&self, handler: H) -> Result<ListenerHandle>
    where
        E: Event,
        H: Fn(Context, Arc<E>) -> Fut + Send + Sync + 'static,
        Fut: Future<Output = Result<()>> + Send + 'static,
    {
        let event_key = TypeId::of::<E>();
        let context = self.context.clone();
        let callback: Arc<EventCallback> = Arc::new(move |event| {
            let result = event.downcast::<E>();
            let context = context.clone();
            match result {
                Ok(event) => handler(context, event).boxed(),
                Err(_) => {
                    async { Err(Error::Cleanup("event payload type mismatch".into())) }.boxed()
                }
            }
        });
        let id = self
            .context
            .runtime
            .add_listener(event_key, self.scope.id, callback);
        let weak = Arc::downgrade(&self.context.runtime);
        if let Err(error) = self.scope.push(Box::new(move || {
            Box::pin(async move {
                if let Some(runtime) = weak.upgrade() {
                    runtime.remove_listener(event_key, id);
                }
                Ok(())
            })
        })) {
            self.context.runtime.remove_listener(event_key, id);
            return Err(error);
        }
        Ok(ListenerHandle {
            runtime: Arc::downgrade(&self.context.runtime),
            key: event_key,
            id,
            query: false,
        })
    }

    pub fn on_query<Q, H, Fut>(&self, handler: H) -> Result<ListenerHandle>
    where
        Q: Query,
        H: Fn(Context, Arc<Q>) -> Fut + Send + Sync + 'static,
        Fut: Future<Output = Result<Option<Q::Response>>> + Send + 'static,
    {
        let key = TypeId::of::<Q>();
        let context = self.context.clone();
        let callback: Arc<QueryCallback> = Arc::new(move |query| {
            let result = query.downcast::<Q>();
            let context = context.clone();
            match result {
                Ok(query) => handler(context, query)
                    .map(|result| {
                        result.map(|response| {
                            response.map(|value| {
                                Box::new(value) as Box<dyn std::any::Any + Send + Sync>
                            })
                        })
                    })
                    .boxed(),
                Err(_) => {
                    async { Err(Error::Cleanup("query payload type mismatch".into())) }.boxed()
                }
            }
        });
        let id = self
            .context
            .runtime
            .add_query_listener(key, self.scope.id, callback);
        let weak = Arc::downgrade(&self.context.runtime);
        if let Err(error) = self.scope.push(Box::new(move || {
            Box::pin(async move {
                if let Some(runtime) = weak.upgrade() {
                    runtime.remove_query_listener(key, id);
                }
                Ok(())
            })
        })) {
            self.context.runtime.remove_query_listener(key, id);
            return Err(error);
        }
        Ok(ListenerHandle {
            runtime: Arc::downgrade(&self.context.runtime),
            key,
            id,
            query: true,
        })
    }

    pub fn defer<F, Fut>(&self, cleanup: F) -> Result<()>
    where
        F: FnOnce() -> Fut + Send + 'static,
        Fut: Future<Output = Result<()>> + Send + 'static,
    {
        self.scope.push(Box::new(move || Box::pin(cleanup())))
    }

    pub fn manage<R: Resource>(&self, resource: R) -> Result<()> {
        let resource = Arc::new(std::sync::Mutex::new(Some(resource)));
        let start_resource = resource.clone();
        self.scope.on_commit(Box::new(move || {
            Box::pin(async move {
                let resource = start_resource
                    .lock()
                    .expect("resource lock poisoned")
                    .take()
                    .ok_or_else(|| Error::cleanup("resource already consumed"))?;
                let result = resource.start().await;
                *start_resource.lock().expect("resource lock poisoned") = Some(resource);
                result
            })
        }))?;

        self.scope.push(Box::new(move || {
            Box::pin(async move {
                let resource = resource.lock().expect("resource lock poisoned").take();
                if let Some(resource) = resource {
                    resource.cancel();
                    Box::new(resource).dispose().await?;
                }
                Ok(())
            })
        }))
    }

    /// Registers a cooperative task. It is spawned only when the activation
    /// commits. Disposal waits five seconds, then aborts an unresponsive task.
    pub fn spawn<F, Fut>(&self, task: F) -> Result<TaskHandle>
    where
        F: FnOnce(CancellationToken) -> Fut + Send + 'static,
        Fut: Future<Output = Result<()>> + Send + 'static,
    {
        let token = CancellationToken::new();
        let join = Arc::new(std::sync::Mutex::new(None));
        let start_join = join.clone();
        let child = token.child_token();
        self.scope.on_commit(Box::new(move || {
            Box::pin(async move {
                let future = std::panic::AssertUnwindSafe(task(child))
                    .catch_unwind()
                    .map(|result| match result {
                        Ok(result) => result,
                        Err(payload) => Err(Error::panic(payload)),
                    });
                *start_join.lock().expect("task lock poisoned") = Some(tokio::spawn(future));
                Ok(())
            })
        }))?;

        let cleanup_token = token.clone();
        self.scope.push(Box::new(move || {
            Box::pin(async move {
                cleanup_token.cancel();
                let join = join.lock().expect("task lock poisoned").take();
                if let Some(mut join) = join {
                    match tokio::time::timeout(std::time::Duration::from_secs(5), &mut join).await {
                        Ok(result) => result??,
                        Err(_) => {
                            join.abort();
                            let _ = join.await;
                            return Err(Error::TaskTimeout { seconds: 5 });
                        }
                    }
                }
                Ok(())
            })
        }))?;
        Ok(TaskHandle { token })
    }
}

impl Deref for PluginContext {
    type Target = Context;
    fn deref(&self) -> &Self::Target {
        &self.context
    }
}

/// Non-owning early-cancellation handle. `Drop` intentionally does nothing.
pub struct ListenerHandle {
    runtime: Weak<Runtime>,
    key: TypeId,
    id: u64,
    query: bool,
}

impl ListenerHandle {
    pub fn cancel(&self) -> bool {
        self.runtime.upgrade().is_some_and(|runtime| {
            if self.query {
                runtime.remove_query_listener(self.key, self.id)
            } else {
                runtime.remove_listener(self.key, self.id)
            }
        })
    }
}

pub struct TaskHandle {
    token: CancellationToken,
}
impl TaskHandle {
    pub fn cancel(&self) {
        self.token.cancel();
    }
}

pub trait Resource: Send + Sync + 'static {
    fn start(&self) -> impl Future<Output = Result<()>> + Send {
        async { Ok(()) }
    }

    fn cancel(&self) {}

    fn dispose(self: Box<Self>) -> impl Future<Output = Result<()>> + Send;
}