alma 0.1.1

A Bevy-native modal text editor with Vim-style navigation.
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
491
492
493
494
495
496
497
498
499
500
501
use super::{
    display::{Operational, write_list},
    effect::PluginRuntimeTraceEffect,
    proposal::PluginRuntimeTraceProposalReceipt,
    workspace::{
        PluginRuntimeTraceWorkspaceIoCompletion, PluginRuntimeTraceWorkspaceObserveTaskOutcome,
    },
};
use crate::ecs::events::edit::PluginBufferEditProposalReceipt;
#[cfg(feature = "plugin-runtime")]
use crate::plugin::WasmtimeWorkspaceObserveTaskScheduleDiscardReport;
use crate::plugin::{
    DrainedPluginEffectReport, PluginEffectDiscardReport, PluginHostImportDiscardReport,
    PluginHostOwnerDiscardReport, PluginIdentity, PluginOperationalEvent,
    PluginOperationalEventKind, PluginWorkspaceIoCancellationReport,
    PluginWorkspaceIoDiscardReport, PluginWorkspaceIoReport,
    PluginWorkspaceObserveTaskCancellationReport, PluginWorkspaceObserveTaskCompletion,
    PluginWorkspaceObserveTaskCompletionShape, PluginWorkspaceObserveTaskDiscardReport,
};
use std::fmt::{Display, Formatter};

/// One redacted event in a future plugin runtime replay trace.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct PluginRuntimeTraceEvent {
    /// Stable identity when the lower boundary can attribute the event.
    identity: Option<PluginIdentity>,
    /// Redacted event payload.
    kind: PluginRuntimeTraceEventKind,
}

impl PluginRuntimeTraceEvent {
    /// Adapts drained effects after the successful guest-return boundary.
    #[must_use]
    pub fn drained_effects(report: &DrainedPluginEffectReport) -> Self {
        Self::scoped(
            report.identity_proof().clone(),
            PluginRuntimeTraceEventKind::EffectsDrained {
                effects: report
                    .buffer_edits()
                    .iter()
                    .map(PluginRuntimeTraceEffect::from)
                    .chain(
                        report
                            .status_messages()
                            .iter()
                            .map(PluginRuntimeTraceEffect::from),
                    )
                    .collect(),
            },
        )
    }

    /// Adapts a failed update discard report.
    #[must_use]
    pub fn update_discarded(report: &PluginHostImportDiscardReport) -> Self {
        Self::discarded_update_work(
            report.effects().identity_proof().clone(),
            report.effects().discarded_effects(),
            report.workspace_io().discarded_requests(),
            report.workspace_observe_tasks().discarded_tasks(),
        )
    }

    /// Adapts discarded owner work after successful guest return.
    #[must_use]
    pub fn owner_work_discarded(report: &PluginHostOwnerDiscardReport) -> Self {
        Self::discarded_update_work(
            report.identity_proof().clone(),
            report.effects().discarded_effects(),
            report.workspace_io().discarded_requests(),
            0,
        )
    }

    /// Adapts an effect discard report when no workspace report is available.
    #[must_use]
    pub fn effects_discarded(report: &PluginEffectDiscardReport) -> Self {
        Self::discarded_update_work(
            report.identity_proof().clone(),
            report.discarded_effects(),
            0,
            0,
        )
    }

    /// Adapts a workspace I/O discard report when no effect report is available.
    #[must_use]
    pub fn workspace_io_discarded(report: &PluginWorkspaceIoDiscardReport) -> Self {
        Self::discarded_update_work(
            report.identity_proof().clone(),
            0,
            report.discarded_requests(),
            0,
        )
    }

    /// Adapts a workspace observation task discard report when no effect report is available.
    #[must_use]
    pub fn workspace_observe_tasks_discarded(
        report: &PluginWorkspaceObserveTaskDiscardReport,
    ) -> Self {
        Self::discarded_update_work(
            report.identity_proof().clone(),
            0,
            0,
            report.discarded_tasks(),
        )
    }

    /// Adapts discarded post-update schedule work.
    #[cfg(feature = "plugin-runtime")]
    #[must_use]
    pub fn workspace_observe_task_schedule_discarded(
        report: &WasmtimeWorkspaceObserveTaskScheduleDiscardReport,
    ) -> Self {
        Self::discarded_update_work(
            report.identity_proof().clone(),
            report.owner_work().effects().discarded_effects(),
            report.owner_work().workspace_io().discarded_requests(),
            report.workspace_observe_tasks().discarded_tasks(),
        )
    }

    /// Adapts completed workspace I/O after filesystem-policy execution.
    #[must_use]
    pub fn workspace_io_completed(report: &PluginWorkspaceIoReport) -> Self {
        Self::scoped(
            report.identity_proof().clone(),
            PluginRuntimeTraceEventKind::WorkspaceIoCompleted {
                completions: report
                    .completions()
                    .iter()
                    .map(PluginRuntimeTraceWorkspaceIoCompletion::from)
                    .collect(),
            },
        )
    }

    /// Adapts canceled workspace I/O after revocation or shutdown cleanup.
    #[must_use]
    pub fn workspace_io_canceled(report: &PluginWorkspaceIoCancellationReport) -> Self {
        Self::scoped(
            report.identity_proof().clone(),
            PluginRuntimeTraceEventKind::WorkspaceIoCanceled {
                canceled_batches: report.canceled_batches(),
                canceled_requests: report.canceled_requests(),
            },
        )
    }

    /// Adapts a completed workspace observation task after filesystem-policy execution.
    #[must_use]
    pub fn workspace_observe_task_completed(
        completion: &PluginWorkspaceObserveTaskCompletion,
    ) -> Self {
        let shape = completion.shape();
        Self::scoped(
            shape.identity_proof().clone(),
            PluginRuntimeTraceEventKind::WorkspaceObserveTaskCompleted { completion: shape },
        )
    }

    /// Adapts canceled workspace observation task state after revocation or shutdown cleanup.
    #[must_use]
    pub fn workspace_observe_tasks_canceled(
        report: &PluginWorkspaceObserveTaskCancellationReport,
    ) -> Self {
        Self::scoped(
            report.identity_proof().clone(),
            PluginRuntimeTraceEventKind::WorkspaceObserveTasksCanceled {
                canceled_pending: report.canceled_pending(),
                discarded_retained: report.discarded_retained(),
            },
        )
    }

    /// Adapts an operational runtime event.
    #[must_use]
    pub fn operational(event: &PluginOperationalEvent) -> Self {
        Self {
            identity: event.identity_proof().cloned(),
            kind: PluginRuntimeTraceEventKind::Operational { kind: event.kind() },
        }
    }

    /// Adapts a proposal receipt after an owner boundary decision.
    #[must_use]
    pub fn proposal_receipt(receipt: &PluginBufferEditProposalReceipt) -> Self {
        Self::scoped(
            receipt.source_identity_proof().clone(),
            PluginRuntimeTraceEventKind::ProposalReceipt {
                receipt: PluginRuntimeTraceProposalReceipt::from(receipt),
            },
        )
    }

    /// Returns the attributed plugin identity for display and serialization.
    #[must_use]
    pub fn identity(&self) -> Option<&str> {
        self.identity_proof().map(PluginIdentity::as_str)
    }

    /// Returns the attributed identity proof, if this event has one.
    #[must_use]
    pub const fn identity_proof(&self) -> Option<&PluginIdentity> {
        self.identity.as_ref()
    }

    /// Returns the redacted trace payload.
    #[must_use]
    pub const fn kind(&self) -> &PluginRuntimeTraceEventKind {
        &self.kind
    }

    /// Returns the top-level trace event class.
    #[must_use]
    pub const fn class(&self) -> PluginRuntimeTraceEventClass {
        self.kind.class()
    }

    /// Builds an identity-scoped trace event.
    const fn scoped(identity: PluginIdentity, kind: PluginRuntimeTraceEventKind) -> Self {
        Self {
            identity: Some(identity),
            kind,
        }
    }

    /// Builds a trace event for discarded unpublished update work.
    const fn discarded_update_work(
        identity: PluginIdentity,
        discarded_effects: usize,
        discarded_workspace_requests: usize,
        discarded_workspace_observe_tasks: usize,
    ) -> Self {
        Self::scoped(
            identity,
            PluginRuntimeTraceEventKind::UpdateDiscarded {
                discarded_effects,
                discarded_workspace_requests,
                discarded_workspace_observe_tasks,
            },
        )
    }
}

impl Display for PluginRuntimeTraceEvent {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
        match self.identity() {
            Some(identity) => write!(formatter, "plugin {identity:?} trace {}", self.kind),
            None => write!(formatter, "plugin trace {}", self.kind),
        }
    }
}

impl From<&DrainedPluginEffectReport> for PluginRuntimeTraceEvent {
    fn from(report: &DrainedPluginEffectReport) -> Self {
        Self::drained_effects(report)
    }
}

impl From<&PluginHostImportDiscardReport> for PluginRuntimeTraceEvent {
    fn from(report: &PluginHostImportDiscardReport) -> Self {
        Self::update_discarded(report)
    }
}

impl From<&PluginHostOwnerDiscardReport> for PluginRuntimeTraceEvent {
    fn from(report: &PluginHostOwnerDiscardReport) -> Self {
        Self::owner_work_discarded(report)
    }
}

impl From<&PluginEffectDiscardReport> for PluginRuntimeTraceEvent {
    fn from(report: &PluginEffectDiscardReport) -> Self {
        Self::effects_discarded(report)
    }
}

impl From<&PluginWorkspaceIoDiscardReport> for PluginRuntimeTraceEvent {
    fn from(report: &PluginWorkspaceIoDiscardReport) -> Self {
        Self::workspace_io_discarded(report)
    }
}

impl From<&PluginWorkspaceObserveTaskDiscardReport> for PluginRuntimeTraceEvent {
    fn from(report: &PluginWorkspaceObserveTaskDiscardReport) -> Self {
        Self::workspace_observe_tasks_discarded(report)
    }
}

#[cfg(feature = "plugin-runtime")]
impl From<&WasmtimeWorkspaceObserveTaskScheduleDiscardReport> for PluginRuntimeTraceEvent {
    fn from(report: &WasmtimeWorkspaceObserveTaskScheduleDiscardReport) -> Self {
        Self::workspace_observe_task_schedule_discarded(report)
    }
}

impl From<&PluginWorkspaceIoReport> for PluginRuntimeTraceEvent {
    fn from(report: &PluginWorkspaceIoReport) -> Self {
        Self::workspace_io_completed(report)
    }
}

impl From<&PluginWorkspaceIoCancellationReport> for PluginRuntimeTraceEvent {
    fn from(report: &PluginWorkspaceIoCancellationReport) -> Self {
        Self::workspace_io_canceled(report)
    }
}

impl From<&PluginWorkspaceObserveTaskCompletion> for PluginRuntimeTraceEvent {
    fn from(completion: &PluginWorkspaceObserveTaskCompletion) -> Self {
        Self::workspace_observe_task_completed(completion)
    }
}

impl From<&PluginWorkspaceObserveTaskCancellationReport> for PluginRuntimeTraceEvent {
    fn from(report: &PluginWorkspaceObserveTaskCancellationReport) -> Self {
        Self::workspace_observe_tasks_canceled(report)
    }
}

impl From<&PluginOperationalEvent> for PluginRuntimeTraceEvent {
    fn from(event: &PluginOperationalEvent) -> Self {
        Self::operational(event)
    }
}

impl From<&PluginBufferEditProposalReceipt> for PluginRuntimeTraceEvent {
    fn from(receipt: &PluginBufferEditProposalReceipt) -> Self {
        Self::proposal_receipt(receipt)
    }
}

/// Top-level trace event class.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum PluginRuntimeTraceEventClass {
    /// Effects drained into owner requests.
    EffectsDrained,
    /// Unpublished update work was discarded.
    UpdateDiscarded,
    /// Workspace I/O completed after successful guest return.
    WorkspaceIoCompleted,
    /// Workspace I/O canceled before filesystem-policy execution.
    WorkspaceIoCanceled,
    /// Workspace observation task completed for guest polling.
    WorkspaceObserveTaskCompleted,
    /// Workspace observation task state canceled before guest delivery.
    WorkspaceObserveTasksCanceled,
    /// Runtime operational event.
    Operational,
    /// Proposal receipt from an owner decision.
    ProposalReceipt,
}

impl PluginRuntimeTraceEventClass {
    /// Stable trace class text.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::EffectsDrained => "effects-drained",
            Self::UpdateDiscarded => "update-discarded",
            Self::WorkspaceIoCompleted => "workspace-io-completed",
            Self::WorkspaceIoCanceled => "workspace-io-canceled",
            Self::WorkspaceObserveTaskCompleted => "workspace-observe-task-completed",
            Self::WorkspaceObserveTasksCanceled => "workspace-observe-tasks-canceled",
            Self::Operational => "operational",
            Self::ProposalReceipt => "proposal-receipt",
        }
    }
}

impl Display for PluginRuntimeTraceEventClass {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
        formatter.write_str(self.as_str())
    }
}

/// Redacted plugin runtime trace payload.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum PluginRuntimeTraceEventKind {
    /// Effects drained into typed owner requests.
    EffectsDrained {
        /// Ordered drained effects.
        effects: Vec<PluginRuntimeTraceEffect>,
    },
    /// Unpublished update work was discarded.
    UpdateDiscarded {
        /// Editor effects discarded.
        discarded_effects: usize,
        /// Workspace I/O requests discarded.
        discarded_workspace_requests: usize,
        /// Workspace observation task requests discarded.
        discarded_workspace_observe_tasks: usize,
    },
    /// Workspace I/O report after filesystem-policy execution.
    WorkspaceIoCompleted {
        /// Ordered workspace completions.
        completions: Vec<PluginRuntimeTraceWorkspaceIoCompletion>,
    },
    /// Workspace I/O removed before filesystem-policy execution.
    WorkspaceIoCanceled {
        /// Queued sealed batches removed.
        canceled_batches: usize,
        /// Workspace operations removed.
        canceled_requests: usize,
    },
    /// Workspace observation task result retained for guest polling.
    WorkspaceObserveTaskCompleted {
        /// Identity-scoped redacted completion shape.
        completion: PluginWorkspaceObserveTaskCompletionShape,
    },
    /// Workspace observation task state removed before guest delivery.
    WorkspaceObserveTasksCanceled {
        /// Pending reads removed before filesystem policy.
        canceled_pending: usize,
        /// Retained outcomes discarded before guest delivery.
        discarded_retained: usize,
    },
    /// Operational event projection.
    Operational {
        /// Closed operational event kind.
        kind: PluginOperationalEventKind,
    },
    /// Proposal receipt projection.
    ProposalReceipt {
        /// Redacted receipt.
        receipt: PluginRuntimeTraceProposalReceipt,
    },
}

impl PluginRuntimeTraceEventKind {
    /// Returns the top-level trace event class.
    #[must_use]
    pub const fn class(&self) -> PluginRuntimeTraceEventClass {
        match self {
            Self::EffectsDrained { .. } => PluginRuntimeTraceEventClass::EffectsDrained,
            Self::UpdateDiscarded { .. } => PluginRuntimeTraceEventClass::UpdateDiscarded,
            Self::WorkspaceIoCompleted { .. } => PluginRuntimeTraceEventClass::WorkspaceIoCompleted,
            Self::WorkspaceIoCanceled { .. } => PluginRuntimeTraceEventClass::WorkspaceIoCanceled,
            Self::WorkspaceObserveTaskCompleted { .. } => {
                PluginRuntimeTraceEventClass::WorkspaceObserveTaskCompleted
            }
            Self::WorkspaceObserveTasksCanceled { .. } => {
                PluginRuntimeTraceEventClass::WorkspaceObserveTasksCanceled
            }
            Self::Operational { .. } => PluginRuntimeTraceEventClass::Operational,
            Self::ProposalReceipt { .. } => PluginRuntimeTraceEventClass::ProposalReceipt,
        }
    }
}

impl Display for PluginRuntimeTraceEventKind {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::EffectsDrained { effects } => {
                write!(formatter, "effects-drained effects=[")?;
                write_list(formatter, effects)?;
                formatter.write_str("]")
            }
            Self::UpdateDiscarded {
                discarded_effects,
                discarded_workspace_requests,
                discarded_workspace_observe_tasks,
            } => write!(
                formatter,
                "update-discarded effects={discarded_effects} workspace_io={discarded_workspace_requests} workspace_observe_tasks={discarded_workspace_observe_tasks}"
            ),
            Self::WorkspaceIoCompleted { completions } => {
                write!(formatter, "workspace-io-completed completions=[")?;
                write_list(formatter, completions)?;
                formatter.write_str("]")
            }
            Self::WorkspaceIoCanceled {
                canceled_batches,
                canceled_requests,
            } => write!(
                formatter,
                "workspace-io-canceled batches={canceled_batches} requests={canceled_requests}"
            ),
            Self::WorkspaceObserveTaskCompleted { completion } => {
                let task_id = completion.task_id();
                let outcome =
                    PluginRuntimeTraceWorkspaceObserveTaskOutcome::from(completion.outcome_shape());
                write!(
                    formatter,
                    "workspace-observe-task-completed task_id={task_id} outcome={outcome}"
                )
            }
            Self::WorkspaceObserveTasksCanceled {
                canceled_pending,
                discarded_retained,
            } => write!(
                formatter,
                "workspace-observe-tasks-canceled pending={canceled_pending} retained={discarded_retained}"
            ),
            Self::Operational { kind } => write!(formatter, "operational {}", Operational(kind)),
            Self::ProposalReceipt { receipt } => write!(formatter, "proposal-receipt {receipt}"),
        }
    }
}