omni-dev 0.24.0

A powerful Git commit message analysis and amendment toolkit
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
//! CLI command for `omni-dev datadog logs search`.

use anyhow::{Context, Result};
use chrono::{DateTime, SecondsFormat, Utc};
use clap::{Parser, ValueEnum};

use crate::cli::datadog::format::{output_as, OutputFormat};
use crate::cli::datadog::helpers::create_client;
use crate::cli::datadog::logs::{render_log_table, LogRow};
use crate::datadog::client::DatadogClient;
use crate::datadog::logs_api::LogsApi;
use crate::datadog::time::parse_time_range;
use crate::datadog::types::{LogEvent, LogSearchResult, SortOrder};

/// Sort order argument for `omni-dev datadog logs search`.
///
/// Wraps [`SortOrder`] so clap can derive a `ValueEnum` impl with the
/// kebab-case strings the CLI exposes (`timestamp-asc`,
/// `timestamp-desc`); the on-the-wire representation lives on
/// [`SortOrder::as_api_str`].
#[derive(Clone, Copy, Debug, ValueEnum, PartialEq, Eq)]
pub enum SortArg {
    /// Oldest first.
    TimestampAsc,
    /// Newest first.
    TimestampDesc,
}

impl SortArg {
    /// Maps the CLI value to the API enum.
    #[must_use]
    pub fn to_sort_order(self) -> SortOrder {
        match self {
            Self::TimestampAsc => SortOrder::TimestampAsc,
            Self::TimestampDesc => SortOrder::TimestampDesc,
        }
    }
}

/// Searches Datadog log events.
#[derive(Parser)]
pub struct SearchCommand {
    /// Search filter (Datadog logs query language; see Datadog docs).
    #[arg(long)]
    pub filter: String,

    /// Start of the time range (relative shorthand like `15m`/`1h`,
    /// `now`, RFC 3339, or Unix epoch seconds).
    #[arg(long, default_value = "15m")]
    pub from: String,

    /// End of the time range; defaults to `now`.
    #[arg(long, default_value = "now")]
    pub to: String,

    /// Maximum events to return. Pass `0` to fetch every match across
    /// pages (capped at 10000); any non-zero value caps the total at
    /// that count, paginating underneath as needed.
    #[arg(long, default_value_t = 100)]
    pub limit: usize,

    /// Sort order for returned events.
    #[arg(long, value_enum, default_value_t = SortArg::TimestampDesc)]
    pub sort: SortArg,

    /// Output format.
    #[arg(short = 'o', long, value_enum, default_value_t = OutputFormat::Table)]
    pub output: OutputFormat,
}

impl SearchCommand {
    /// Executes the search against a freshly-created Datadog client.
    pub async fn execute(self) -> Result<()> {
        let (client, _site) = create_client()?;
        let (from_str, to_str) = resolve_time_range(&self.from, &self.to)?;
        run_search(
            &client,
            &self.filter,
            &from_str,
            &to_str,
            self.limit,
            self.sort.to_sort_order(),
            &self.output,
        )
        .await
    }
}

/// Parses the CLI `--from` / `--to` strings and converts them into
/// RFC 3339 timestamps suitable for the Datadog v2 logs search body.
fn resolve_time_range(from: &str, to: &str) -> Result<(String, String)> {
    let (from_secs, to_secs) =
        parse_time_range(from, Some(to)).context("Failed to parse --from / --to")?;
    Ok((epoch_to_rfc3339(from_secs), epoch_to_rfc3339(to_secs)))
}

/// Renders an epoch-seconds timestamp as `YYYY-MM-DDTHH:MM:SSZ`.
///
/// Falls back to the Unix epoch when `seconds` is outside the
/// chrono-representable range. `parse_time_range` already validates
/// production inputs, so the fallback only fires for direct callers
/// that pass extreme values (e.g. `i64::MAX`).
fn epoch_to_rfc3339(seconds: i64) -> String {
    DateTime::<Utc>::from_timestamp(seconds, 0)
        .unwrap_or_default()
        .to_rfc3339_opts(SecondsFormat::Secs, true)
}

/// Fetches the search response and emits it in the requested format.
///
/// Split from [`SearchCommand::execute`] so tests can inject a wiremock
/// client and pre-resolved time strings without going through the
/// credential-loading path.
async fn run_search(
    client: &DatadogClient,
    filter: &str,
    from: &str,
    to: &str,
    limit: usize,
    sort: SortOrder,
    output: &OutputFormat,
) -> Result<()> {
    let result: LogSearchResult = LogsApi::new(client)
        .search_all(filter, from, to, limit, sort)
        .await?;
    if output_as(&result, output)? {
        return Ok(());
    }
    let stdout = std::io::stdout();
    let mut handle = stdout.lock();
    let rows: Vec<LogRow<'_>> = result.data.iter().map(log_row).collect();
    render_log_table(&rows, &mut handle)
}

fn log_row(event: &LogEvent) -> LogRow<'_> {
    LogRow {
        timestamp: event.timestamp_label(),
        service: event.service_label(),
        status: event.status_label(),
        message: event.message_label(),
    }
}

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::expect_used)]
mod tests {
    use super::*;
    use crate::datadog::types::LogEventAttributes;

    fn search_body() -> serde_json::Value {
        // No `meta.page.after` so the auto-paginating wrapper terminates
        // after a single request; tests that exercise cursor follow-up
        // live in `LogsApi::search_all` unit tests.
        serde_json::json!({
            "data": [
                {
                    "id": "AAAA",
                    "type": "log",
                    "attributes": {
                        "timestamp": "2026-04-22T10:00:00.000Z",
                        "service": "api",
                        "status": "info",
                        "message": "ok",
                        "tags": ["env:prod"]
                    }
                }
            ],
            "meta": { "page": {} }
        })
    }

    // ── log_row ────────────────────────────────────────────────────

    #[test]
    fn log_row_falls_back_to_dashes_when_attributes_missing() {
        let event = LogEvent {
            id: "x".into(),
            event_type: None,
            attributes: LogEventAttributes::default(),
        };
        let row = log_row(&event);
        assert_eq!(row.timestamp, "-");
        assert_eq!(row.service, "-");
        assert_eq!(row.status, "-");
        assert_eq!(row.message, "");
    }

    #[test]
    fn log_row_uses_attribute_values_when_present() {
        let event = LogEvent {
            id: "x".into(),
            event_type: Some("log".into()),
            attributes: LogEventAttributes {
                timestamp: Some("t".into()),
                service: Some("s".into()),
                status: Some("warn".into()),
                host: None,
                message: Some("m".into()),
                tags: vec![],
            },
        };
        let row = log_row(&event);
        assert_eq!(row.timestamp, "t");
        assert_eq!(row.service, "s");
        assert_eq!(row.status, "warn");
        assert_eq!(row.message, "m");
    }

    // ── time helpers ───────────────────────────────────────────────

    #[test]
    fn epoch_to_rfc3339_uses_z_suffix() {
        assert_eq!(epoch_to_rfc3339(1_700_000_000), "2023-11-14T22:13:20Z");
    }

    #[test]
    fn epoch_to_rfc3339_falls_back_to_unix_epoch_on_out_of_range() {
        // chrono can't represent i64::MAX seconds (year ~292 billion);
        // the fallback produces 1970-01-01T00:00:00Z so the function
        // never panics on extreme inputs.
        assert_eq!(epoch_to_rfc3339(i64::MAX), "1970-01-01T00:00:00Z");
        assert_eq!(epoch_to_rfc3339(i64::MIN), "1970-01-01T00:00:00Z");
    }

    #[test]
    fn resolve_time_range_emits_rfc3339_strings() {
        let (from, to) =
            resolve_time_range("2026-04-22T09:00:00Z", "2026-04-22T10:00:00Z").unwrap();
        assert_eq!(from, "2026-04-22T09:00:00Z");
        assert_eq!(to, "2026-04-22T10:00:00Z");
    }

    #[test]
    fn resolve_time_range_propagates_parse_errors() {
        let err = resolve_time_range("garbage", "now").unwrap_err();
        assert!(err.to_string().contains("Failed to parse"));
    }

    // ── run_search ─────────────────────────────────────────────────

    #[tokio::test]
    async fn run_search_table_path_writes_to_stdout() {
        let server = wiremock::MockServer::start().await;
        wiremock::Mock::given(wiremock::matchers::method("POST"))
            .and(wiremock::matchers::path("/api/v2/logs/events/search"))
            .and(wiremock::matchers::body_json(serde_json::json!({
                "filter": {
                    "query": "service:api status:error",
                    "from": "2026-04-22T09:00:00Z",
                    "to": "2026-04-22T10:00:00Z"
                },
                "page": { "limit": 100 },
                "sort": "-timestamp"
            })))
            .respond_with(wiremock::ResponseTemplate::new(200).set_body_json(search_body()))
            .expect(1)
            .mount(&server)
            .await;

        let client = DatadogClient::new(&server.uri(), "api", "app").unwrap();
        run_search(
            &client,
            "service:api status:error",
            "2026-04-22T09:00:00Z",
            "2026-04-22T10:00:00Z",
            100,
            SortOrder::TimestampDesc,
            &OutputFormat::Table,
        )
        .await
        .unwrap();
    }

    #[tokio::test]
    async fn run_search_json_path_returns_ok() {
        let server = wiremock::MockServer::start().await;
        wiremock::Mock::given(wiremock::matchers::method("POST"))
            .and(wiremock::matchers::path("/api/v2/logs/events/search"))
            .respond_with(wiremock::ResponseTemplate::new(200).set_body_json(search_body()))
            .mount(&server)
            .await;

        let client = DatadogClient::new(&server.uri(), "api", "app").unwrap();
        run_search(
            &client,
            "*",
            "2026-04-22T09:00:00Z",
            "2026-04-22T10:00:00Z",
            10,
            SortOrder::TimestampAsc,
            &OutputFormat::Json,
        )
        .await
        .unwrap();
    }

    #[tokio::test]
    async fn run_search_propagates_api_errors() {
        let server = wiremock::MockServer::start().await;
        wiremock::Mock::given(wiremock::matchers::method("POST"))
            .and(wiremock::matchers::path("/api/v2/logs/events/search"))
            .respond_with(wiremock::ResponseTemplate::new(400).set_body_string("bad"))
            .mount(&server)
            .await;

        let client = DatadogClient::new(&server.uri(), "api", "app").unwrap();
        let err = run_search(
            &client,
            "*",
            "2026-04-22T09:00:00Z",
            "2026-04-22T10:00:00Z",
            10,
            SortOrder::TimestampDesc,
            &OutputFormat::Table,
        )
        .await
        .unwrap_err();
        assert!(err.to_string().contains("400"));
    }

    #[tokio::test]
    async fn run_search_with_zero_limit_auto_paginates_until_no_cursor() {
        // limit == 0 means "fetch every match"; the wrapper requests
        // pages of MAX_PAGE_LIMIT until the API stops returning a
        // cursor.
        let server = wiremock::MockServer::start().await;
        wiremock::Mock::given(wiremock::matchers::method("POST"))
            .and(wiremock::matchers::path("/api/v2/logs/events/search"))
            .and(wiremock::matchers::body_json(serde_json::json!({
                "filter": {
                    "query": "*",
                    "from": "2026-04-22T09:00:00Z",
                    "to": "2026-04-22T10:00:00Z"
                },
                "page": { "limit": 1000 },
                "sort": "-timestamp"
            })))
            .respond_with(
                wiremock::ResponseTemplate::new(200).set_body_json(serde_json::json!({
                    "data": [],
                    "meta": { "page": {} }
                })),
            )
            .expect(1)
            .mount(&server)
            .await;

        let client = DatadogClient::new(&server.uri(), "api", "app").unwrap();
        run_search(
            &client,
            "*",
            "2026-04-22T09:00:00Z",
            "2026-04-22T10:00:00Z",
            0,
            SortOrder::TimestampDesc,
            &OutputFormat::Json,
        )
        .await
        .unwrap();
    }

    // ── SearchCommand::execute error paths ─────────────────────────

    #[tokio::test]
    async fn search_command_execute_errors_when_credentials_missing() {
        use crate::datadog::test_support::{with_empty_home, EnvGuard};
        let guard = EnvGuard::take();
        let _dir = with_empty_home(&guard);

        let cmd = SearchCommand {
            filter: "*".into(),
            from: "15m".into(),
            to: "now".into(),
            limit: 10,
            sort: SortArg::TimestampDesc,
            output: OutputFormat::Table,
        };
        let err = cmd.execute().await.unwrap_err();
        assert!(err.to_string().contains("not configured"));
    }

    #[tokio::test]
    async fn search_command_execute_end_to_end_via_api_url_override() {
        use std::fs;

        use crate::datadog::auth::{DATADOG_API_KEY, DATADOG_API_URL, DATADOG_APP_KEY};
        use crate::datadog::test_support::{with_empty_home, EnvGuard};

        let server = wiremock::MockServer::start().await;
        wiremock::Mock::given(wiremock::matchers::method("POST"))
            .and(wiremock::matchers::path("/api/v2/logs/events/search"))
            .respond_with(wiremock::ResponseTemplate::new(200).set_body_json(search_body()))
            .expect(1)
            .mount(&server)
            .await;

        let guard = EnvGuard::take();
        let dir = with_empty_home(&guard);
        let omni_dir = dir.path().join(".omni-dev");
        fs::create_dir_all(&omni_dir).unwrap();
        fs::write(
            omni_dir.join("settings.json"),
            r#"{"env":{"DATADOG_API_KEY":"api","DATADOG_APP_KEY":"app","DATADOG_SITE":"datadoghq.com"}}"#,
        )
        .unwrap();
        std::env::set_var(DATADOG_API_KEY, "api");
        std::env::set_var(DATADOG_APP_KEY, "app");
        std::env::set_var(DATADOG_API_URL, server.uri());

        let cmd = SearchCommand {
            filter: "*".into(),
            from: "2026-04-22T09:00:00Z".into(),
            to: "2026-04-22T10:00:00Z".into(),
            limit: 10,
            sort: SortArg::TimestampDesc,
            output: OutputFormat::Json,
        };
        cmd.execute().await.unwrap();
    }

    #[tokio::test]
    async fn search_command_execute_propagates_time_range_parse_errors() {
        use std::fs;

        use crate::datadog::auth::{DATADOG_API_KEY, DATADOG_APP_KEY};
        use crate::datadog::test_support::{with_empty_home, EnvGuard};

        // Provide credentials so we get past create_client and reach the
        // time-range parse step; --from is intentionally garbage.
        let guard = EnvGuard::take();
        let dir = with_empty_home(&guard);
        let omni_dir = dir.path().join(".omni-dev");
        fs::create_dir_all(&omni_dir).unwrap();
        fs::write(
            omni_dir.join("settings.json"),
            r#"{"env":{"DATADOG_API_KEY":"api","DATADOG_APP_KEY":"app","DATADOG_SITE":"datadoghq.com"}}"#,
        )
        .unwrap();
        std::env::set_var(DATADOG_API_KEY, "api");
        std::env::set_var(DATADOG_APP_KEY, "app");

        let cmd = SearchCommand {
            filter: "*".into(),
            from: "garbage-time".into(),
            to: "now".into(),
            limit: 10,
            sort: SortArg::TimestampDesc,
            output: OutputFormat::Table,
        };
        let err = cmd.execute().await.unwrap_err();
        assert!(err.to_string().contains("Failed to parse"));
    }
}