gitlab_tracker_notify/
lib.rs

1//! Desktop notification plugin for gitlab-tracker.
2//!
3//! Compiled with the `desktop` feature (on by default) to send OS notifications
4//! via `notify-rust`. Build with `--no-default-features` for a zero-dependency
5//! stub suitable for headless / CI environments.
6//!
7//! When the user clicks a notification, the MR URL is opened in the default browser.
8
9// ── Internal helper ───────────────────────────────────────────────────────────
10
11/// Show a notification and, if the user clicks it, open `url` in the default browser.
12/// The D-Bus action wait is performed in a detached thread to avoid blocking the caller.
13#[cfg(feature = "desktop")]
14fn show_with_url(notification: notify_rust::Notification, url: String) {
15    if let Ok(handle) = notification.show() {
16        std::thread::spawn(move || {
17            handle.wait_for_action(|action| {
18                if action == "default" {
19                    let _ = open::that(&url);
20                }
21            });
22        });
23    }
24}
25
26// ── MR notification events ───────────────────────────────────────────────────
27
28/// Notify that an MR has appeared on a branch it was not previously seen on.
29#[cfg(feature = "desktop")]
30pub fn mr_on_new_branch(mr_id: &str, title: &str, branch: &str, web_url: &str) {
31    let notification = notify_rust::Notification::new()
32        .summary("GitLab MR Tracker")
33        .body(&format!(
34            "MR !{} ({}) is now present on branch '{}'!",
35            mr_id, title, branch
36        ))
37        .icon("dialog-information")
38        .action("default", "Open MR")
39        .finalize();
40    show_with_url(notification, web_url.to_owned());
41}
42
43/// Notify that an MR's `updated_at` field has changed (i.e. the MR was modified).
44#[cfg(feature = "desktop")]
45pub fn mr_updated(mr_id: &str, title: &str, updated_at: Option<&str>, web_url: &str) {
46    let notification = notify_rust::Notification::new()
47        .summary(&format!("MR !{} updated", mr_id))
48        .body(&format!(
49            "{}\n{}",
50            title,
51            updated_at.unwrap_or("unknown date")
52        ))
53        .icon("dialog-information")
54        .action("default", "Open MR")
55        .finalize();
56    show_with_url(notification, web_url.to_owned());
57}
58
59/// Notify that an MR's mergeability status has changed.
60/// Accepts string labels so this crate stays independent of gitlab-tracker model types.
61#[cfg(feature = "desktop")]
62pub fn mr_mergeability_changed(mr_id: &str, title: &str, old: &str, new: &str, web_url: &str) {
63    let notification = notify_rust::Notification::new()
64        .summary(&format!("MR !{} — mergeability changed", mr_id))
65        .body(&format!("{}\n{} → {}", title, old, new))
66        .icon("dialog-warning")
67        .action("default", "Open MR")
68        .finalize();
69    show_with_url(notification, web_url.to_owned());
70}
71
72/// Notify that an MR's milestone has changed.
73#[cfg(feature = "desktop")]
74pub fn mr_milestone_changed(mr_id: &str, title: &str, old: &str, new: &str, web_url: &str) {
75    let notification = notify_rust::Notification::new()
76        .summary(&format!("MR !{} — milestone changed", mr_id))
77        .body(&format!("{}\n{} → {}", title, old, new))
78        .icon("dialog-information")
79        .action("default", "Open MR")
80        .finalize();
81    show_with_url(notification, web_url.to_owned());
82}
83
84// ── Tracker ticket notification events ───────────────────────────────────────
85
86/// Notify that a tracked field on a linked tracker ticket has changed.
87///
88/// This is a **single generic entry point** for all ticket field changes.
89/// The `field` parameter is a human-readable label (e.g. `"priority"`, `"status"`),
90/// sourced from [`gitlab_tracker_core::TicketChange::field_label`].
91///
92/// Using one function instead of per-field functions means that adding a new tracked
93/// field in `core` (e.g. `Sprint`) requires **zero changes** to this crate.
94/// The orchestrator maps `TicketChange` variants to this function directly.
95///
96/// # Icon selection
97/// Priority changes use `"dialog-warning"` (yellow); all others use `"dialog-information"`.
98#[cfg(feature = "desktop")]
99pub fn ticket_field_changed(
100    ticket_id: &str,
101    mr_title: &str,
102    field: &str,
103    old: &str,
104    new: &str,
105    ticket_url: &str,
106) {
107    let icon = if field == "priority" {
108        "dialog-warning"
109    } else {
110        "dialog-information"
111    };
112    let notification = notify_rust::Notification::new()
113        .summary(&format!("Ticket #{} — {} changed", ticket_id, field))
114        .body(&format!("{}\n{} → {}", mr_title, old, new))
115        .icon(icon)
116        .action("default", "Open ticket")
117        .finalize();
118    show_with_url(notification, ticket_url.to_owned());
119}
120
121// ── No-op stubs when the `desktop` feature is disabled ───────────────────────
122
123#[cfg(not(feature = "desktop"))]
124#[inline(always)]
125pub fn mr_on_new_branch(_mr_id: &str, _title: &str, _branch: &str, _web_url: &str) {}
126
127#[cfg(not(feature = "desktop"))]
128#[inline(always)]
129pub fn mr_updated(_mr_id: &str, _title: &str, _updated_at: Option<&str>, _web_url: &str) {}
130
131#[cfg(not(feature = "desktop"))]
132#[inline(always)]
133pub fn mr_mergeability_changed(_mr_id: &str, _title: &str, _old: &str, _new: &str, _web_url: &str) {
134}
135
136#[cfg(not(feature = "desktop"))]
137#[inline(always)]
138pub fn mr_milestone_changed(_mr_id: &str, _title: &str, _old: &str, _new: &str, _web_url: &str) {}
139
140#[cfg(not(feature = "desktop"))]
141#[inline(always)]
142pub fn ticket_field_changed(
143    _ticket_id: &str,
144    _mr_title: &str,
145    _field: &str,
146    _old: &str,
147    _new: &str,
148    _ticket_url: &str,
149) {
150}
gitlab_tracker_notify/lib.rs

gitlab_tracker_notify/
lib.rs
