Skip to main content

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// ── 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// ── No-op stubs when the `desktop` feature is disabled ───────────────────────
85
86#[cfg(not(feature = "desktop"))]
87#[inline(always)]
88pub fn mr_on_new_branch(_mr_id: &str, _title: &str, _branch: &str, _web_url: &str) {}
89
90#[cfg(not(feature = "desktop"))]
91#[inline(always)]
92pub fn mr_updated(_mr_id: &str, _title: &str, _updated_at: Option<&str>, _web_url: &str) {}
93
94#[cfg(not(feature = "desktop"))]
95#[inline(always)]
96pub fn mr_mergeability_changed(_mr_id: &str, _title: &str, _old: &str, _new: &str, _web_url: &str) {
97}
98
99#[cfg(not(feature = "desktop"))]
100#[inline(always)]
101pub fn mr_milestone_changed(_mr_id: &str, _title: &str, _old: &str, _new: &str, _web_url: &str) {}