issun-bevy 0.10.0

ISSUN plugins for Bevy ECS
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
//! Metrics systems

use bevy::prelude::*;

use super::events::*;
use super::resources::{MetricsConfig, MetricsHistory, MetricsRegistry};
use super::types::{MetricReport, MetricSnapshot};

use crate::plugins::time::DayChanged;

// ============================================================================
// IssunSet::Input - Periodic Triggers
// ============================================================================

/// Trigger periodic snapshots based on configuration
///
/// Listens for DayChanged events and creates snapshots at configured intervals
pub fn periodic_snapshot_system(
    mut commands: Commands,
    mut messages: MessageReader<DayChanged>,
    config: Res<MetricsConfig>,
) {
    if !config.enable_periodic_snapshots {
        return;
    }

    for msg in messages.read() {
        // Check if it's time for a snapshot (every snapshot_period days)
        if msg.day % config.snapshot_period == 0 {
            let timestamp = std::time::SystemTime::now()
                .duration_since(std::time::UNIX_EPOCH)
                .unwrap()
                .as_secs();

            commands.write_message(CreateSnapshotRequested {
                timestamp,
                label: Some(format!("auto_snapshot_day_{}", msg.day)),
            });
        }
    }
}

/// Trigger periodic reports based on configuration
///
/// Listens for DayChanged events and generates reports at configured intervals
pub fn periodic_report_system(
    mut commands: Commands,
    mut messages: MessageReader<DayChanged>,
    config: Res<MetricsConfig>,
    registry: Res<MetricsRegistry>,
) {
    if !config.enable_auto_report {
        return;
    }

    for msg in messages.read() {
        // Check if it's time for a report (every report_period days)
        if msg.day % config.report_period == 0 {
            let now = std::time::SystemTime::now()
                .duration_since(std::time::UNIX_EPOCH)
                .unwrap()
                .as_secs();

            // Report covers the last period_days
            let period_seconds = (config.report_period as u64) * 24 * 3600;
            let period_start = now.saturating_sub(period_seconds);

            // Get all metric IDs
            let metric_ids = registry
                .all_definitions()
                .iter()
                .map(|def| def.metric_id.clone())
                .collect();

            // Use common aggregations
            let aggregations = vec![
                super::types::AggregationType::Average,
                super::types::AggregationType::Min,
                super::types::AggregationType::Max,
                super::types::AggregationType::P95,
            ];

            commands.write_message(GenerateReportRequested {
                period_start,
                period_end: now,
                metric_ids,
                aggregations,
                label: Some(format!("auto_report_day_{}", msg.day)),
            });
        }
    }
}

// ============================================================================
// IssunSet::Logic - Request Processing
// ============================================================================

/// Process metric definition requests
pub fn process_define_requests(
    mut commands: Commands,
    mut messages: MessageReader<DefineMetricRequested>,
    mut registry: ResMut<MetricsRegistry>,
) {
    for request in messages.read() {
        // Define metric in registry
        registry.define(request.definition.clone());

        // Publish notification
        commands.write_message(MetricDefined {
            definition: request.definition.clone(),
        });
    }
}

/// Process metric recording requests
pub fn process_record_requests(
    mut commands: Commands,
    mut messages: MessageReader<RecordMetricRequested>,
    mut registry: ResMut<MetricsRegistry>,
) {
    for request in messages.read() {
        // Record metric in registry
        match registry.record(request.value.clone()) {
            Ok(_) => {
                // Publish notification
                commands.write_message(MetricRecorded {
                    value: request.value.clone(),
                });
            }
            Err(e) => {
                warn!("Failed to record metric: {}", e);
            }
        }
    }
}

/// Process snapshot creation requests
pub fn process_snapshot_requests(
    mut commands: Commands,
    mut messages: MessageReader<CreateSnapshotRequested>,
    registry: Res<MetricsRegistry>,
    mut history: Option<ResMut<MetricsHistory>>,
) {
    for request in messages.read() {
        // Create snapshot
        let mut snapshot = if let Some(ref label) = request.label {
            MetricSnapshot::with_label(request.timestamp, label.clone())
        } else {
            MetricSnapshot::new(request.timestamp)
        };

        // Add all current values to snapshot
        for (_metric_id, values) in registry.all_values() {
            for value in values {
                snapshot.add_value(value);
            }
        }

        // Store in history if available
        if let Some(ref mut history) = history {
            history.add_snapshot(snapshot.clone());
        }

        // Publish notification
        commands.write_message(SnapshotCreated { snapshot });
    }
}

/// Process report generation requests
pub fn process_report_requests(
    mut commands: Commands,
    mut messages: MessageReader<GenerateReportRequested>,
    registry: Res<MetricsRegistry>,
    mut history: Option<ResMut<MetricsHistory>>,
) {
    for request in messages.read() {
        // Create report
        let mut report = if let Some(ref label) = request.label {
            MetricReport::with_label(request.period_start, request.period_end, label.clone())
        } else {
            MetricReport::new(request.period_start, request.period_end)
        };

        // Add aggregations
        for metric_id in &request.metric_ids {
            for &aggregation in &request.aggregations {
                if let Some(aggregated) = registry.aggregate(
                    metric_id,
                    aggregation,
                    request.period_start,
                    request.period_end,
                ) {
                    report.add_aggregated(aggregated);
                }
            }
        }

        // Store in history if available
        if let Some(ref mut history) = history {
            history.add_report(report.clone());
        }

        // Publish notification
        commands.write_message(ReportGenerated { report });
    }
}

/// Process metric removal requests
pub fn process_remove_requests(
    mut commands: Commands,
    mut messages: MessageReader<RemoveMetricRequested>,
    mut registry: ResMut<MetricsRegistry>,
) {
    for request in messages.read() {
        // Remove metric
        registry.remove(&request.metric_id);

        // Publish notification
        commands.write_message(MetricRemoved {
            metric_id: request.metric_id.clone(),
        });
    }
}

/// Process clear metrics requests
pub fn process_clear_requests(
    mut commands: Commands,
    mut messages: MessageReader<ClearMetricsRequested>,
    mut registry: ResMut<MetricsRegistry>,
) {
    for _request in messages.read() {
        // Clear metrics
        registry.clear();

        // Publish notification
        let timestamp = std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .unwrap()
            .as_secs();

        commands.write_message(MetricsCleared { timestamp });
    }
}

// ============================================================================
// IssunSet::PostLogic - Observer Event Triggering
// ============================================================================

/// Trigger observer events for custom reactions
///
/// Reads state messages and fires corresponding observer events
pub fn trigger_observer_events(
    mut commands: Commands,
    mut recorded_messages: MessageReader<MetricRecorded>,
    mut snapshot_messages: MessageReader<SnapshotCreated>,
    mut report_messages: MessageReader<ReportGenerated>,
) {
    // Trigger MetricRecordedEvent for each recorded metric
    for msg in recorded_messages.read() {
        commands.trigger(MetricRecordedEvent {
            value: msg.value.clone(),
        });
    }

    // Trigger SnapshotCreatedEvent for each snapshot
    for msg in snapshot_messages.read() {
        commands.trigger(SnapshotCreatedEvent {
            snapshot: msg.snapshot.clone(),
        });
    }

    // Trigger ReportGeneratedEvent for each report
    for msg in report_messages.read() {
        commands.trigger(ReportGeneratedEvent {
            report: msg.report.clone(),
        });
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::plugins::metrics::types::{MetricDefinition, MetricId, MetricType, MetricValue};
    use crate::IssunCorePlugin;

    // Helper to create test app
    fn setup_test_app() -> App {
        let mut app = App::new();
        app.add_plugins(MinimalPlugins);
        app.add_plugins(bevy::state::app::StatesPlugin);
        app.add_plugins(IssunCorePlugin);

        // Add resources
        app.insert_resource(MetricsRegistry::new());
        app.insert_resource(MetricsConfig::default());

        // Add messages
        app.add_message::<DefineMetricRequested>();
        app.add_message::<RecordMetricRequested>();
        app.add_message::<CreateSnapshotRequested>();
        app.add_message::<GenerateReportRequested>();
        app.add_message::<RemoveMetricRequested>();
        app.add_message::<ClearMetricsRequested>();
        app.add_message::<MetricDefined>();
        app.add_message::<MetricRecorded>();
        app.add_message::<SnapshotCreated>();
        app.add_message::<ReportGenerated>();
        app.add_message::<MetricRemoved>();
        app.add_message::<MetricsCleared>();
        app.add_message::<DayChanged>();

        // Add systems
        app.add_systems(
            Update,
            (
                process_define_requests,
                process_record_requests,
                process_snapshot_requests,
                process_report_requests,
                process_remove_requests,
                process_clear_requests,
                trigger_observer_events,
            )
                .chain(),
        );

        app
    }

    #[test]
    fn test_process_define_requests() {
        let mut app = setup_test_app();

        // Send define request
        let definition =
            MetricDefinition::new(MetricId::new("fps"), MetricType::Gauge, "Frames per second");
        app.world_mut()
            .write_message(DefineMetricRequested { definition });

        app.update();

        // Check metric was defined
        let registry = app.world().resource::<MetricsRegistry>();
        assert!(registry.get_definition(&MetricId::new("fps")).is_some());

        // Check notification was published
        let mut messages = app.world_mut().resource_mut::<Messages<MetricDefined>>();
        let events: Vec<_> = messages.drain().collect();
        assert_eq!(events.len(), 1);
    }

    #[test]
    fn test_process_record_requests() {
        let mut app = setup_test_app();

        // Define metric first
        let definition =
            MetricDefinition::new(MetricId::new("fps"), MetricType::Gauge, "Frames per second");
        app.world_mut()
            .resource_mut::<MetricsRegistry>()
            .define(definition);

        // Send record request
        let value = MetricValue::new(MetricId::new("fps"), 60.0, 1000);
        app.world_mut()
            .write_message(RecordMetricRequested { value });

        app.update();

        // Check value was recorded
        let registry = app.world().resource::<MetricsRegistry>();
        let values = registry.get_values(&MetricId::new("fps")).unwrap();
        assert_eq!(values.len(), 1);
        assert_eq!(values[0].value, 60.0);

        // Check notification was published
        let mut messages = app.world_mut().resource_mut::<Messages<MetricRecorded>>();
        let events: Vec<_> = messages.drain().collect();
        assert_eq!(events.len(), 1);
    }

    #[test]
    fn test_process_snapshot_requests() {
        let mut app = setup_test_app();

        // Define and record a metric
        let definition =
            MetricDefinition::new(MetricId::new("fps"), MetricType::Gauge, "Frames per second");
        app.world_mut()
            .resource_mut::<MetricsRegistry>()
            .define(definition);

        let value = MetricValue::new(MetricId::new("fps"), 60.0, 1000);
        app.world_mut()
            .resource_mut::<MetricsRegistry>()
            .record(value)
            .unwrap();

        // Send snapshot request
        app.world_mut().write_message(CreateSnapshotRequested {
            timestamp: 1000,
            label: Some("test".to_string()),
        });

        app.update();

        // Check notification was published
        let mut messages = app.world_mut().resource_mut::<Messages<SnapshotCreated>>();
        let events: Vec<_> = messages.drain().collect();
        assert_eq!(events.len(), 1);
        assert_eq!(events[0].snapshot.values.len(), 1);
    }

    #[test]
    fn test_process_report_requests() {
        let mut app = setup_test_app();

        // Define and record a metric
        let definition =
            MetricDefinition::new(MetricId::new("fps"), MetricType::Gauge, "Frames per second");
        app.world_mut()
            .resource_mut::<MetricsRegistry>()
            .define(definition);

        let value = MetricValue::new(MetricId::new("fps"), 60.0, 1000);
        app.world_mut()
            .resource_mut::<MetricsRegistry>()
            .record(value)
            .unwrap();

        // Send report request
        app.world_mut().write_message(GenerateReportRequested {
            period_start: 1000,
            period_end: 2000,
            metric_ids: vec![MetricId::new("fps")],
            aggregations: vec![super::super::types::AggregationType::Average],
            label: Some("test_report".to_string()),
        });

        app.update();

        // Check notification was published
        let mut messages = app.world_mut().resource_mut::<Messages<ReportGenerated>>();
        let events: Vec<_> = messages.drain().collect();
        assert_eq!(events.len(), 1);
        assert_eq!(events[0].report.aggregated_metrics.len(), 1);
    }

    // Note: Observer events testing requires actual observer registration,
    // which is application-specific. The trigger system is tested by verifying
    // that the trigger_observer_events system runs without panicking.
}