gitflow-gitlab 2.0.0

gf 的 GitLab 适配器,基于 glab CLI 提供 Issue/MR/Release/Review 等能力。GitLab adapter for gf via glab CLI.
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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
//! GitLab Review 提供者实现。
//!
//! 通过 `glab mr approve` / `glab mr revoke` / `glab mr note` CLI 实现
//! [`ReviewProvider`] trait,支持 MR 审查的评论、批准、要求修改及提交审查。
//! 所有方法通过 `tokio::process::Command` 调用 `glab`,捕获 stdout 并解析 JSON。
//!
//! glab 的审查命令与 gh 不同:
//! - 批准使用 `glab mr approve`
//! - 撤回使用 `glab mr revoke`
//! - 评论使用 `glab mr note`
//!
//! 由于 glab 不提供统一的 `review --json` 输出,本模块在审查操作后
//! 构造符合 [`ReviewData`] 的返回值。

use async_trait::async_trait;
use chrono::{DateTime, Utc};
use gitflow_core::{
    CoreError, Result,
    review::{ReviewData, ReviewProvider, ReviewState},
    types::UserSummary,
};
use serde::Deserialize;
use tracing::debug;

use crate::{
    commit::encode_project_path,
    error::parse_glab_error,
    runner::{CommandRunner, RealCommandRunner},
};

/// GitLab Review 提供者,通过 `glab` CLI 操作。
///
/// # Examples
///
/// ```no_run
/// use gitflow_gitlab::GitLabReviewProvider;
///
/// let provider = GitLabReviewProvider::new("gitlab-org/gitlab");
/// ```
#[derive(Debug, Clone)]
pub struct GitLabReviewProvider<R: CommandRunner = RealCommandRunner> {
    /// GitLab `namespace/project`。
    repo: String,
    /// 用于执行 `glab` CLI 命令的 runner。
    runner: R,
}

impl GitLabReviewProvider<RealCommandRunner> {
    /// 创建新的 GitLab Review 提供者。
    ///
    /// `repo` 格式为 `namespace/project`。
    #[must_use]
    pub fn new(repo: impl Into<String>) -> GitLabReviewProvider<RealCommandRunner> {
        GitLabReviewProvider {
            repo: repo.into(),
            runner: RealCommandRunner,
        }
    }

    /// Create a new provider from a shared [`Session`].
    ///
    /// This enables state reuse across multiple operations in workflow chains.
    #[must_use]
    pub fn with_session(session: &gitflow_core::Session) -> Self {
        Self {
            repo: session.repo.clone(),
            runner: RealCommandRunner,
        }
    }
}

impl<R: CommandRunner> GitLabReviewProvider<R> {
    /// 使用自定义 [`CommandRunner`] 创建提供者。
    ///
    /// 主要用于测试,可注入模拟 runner 以控制 `glab` CLI 的输出。
    /// `repo` 格式为 `namespace/project`。
    #[must_use]
    pub fn with_runner(repo: impl Into<String>, runner: R) -> Self {
        Self {
            repo: repo.into(),
            runner,
        }
    }
}

// ── 中间 API 响应类型 ──────────────────────────────────────────────

/// `glab mr note --output json` 返回的 JSON 结构(用于获取审查评论 ID)。
#[derive(Debug, Clone, Deserialize)]
struct NoteApiResponse {
    id: u64,
    #[serde(default)]
    body: String,
    #[serde(default)]
    author: Option<ApiUser>,
    #[serde(default)]
    created_at: Option<DateTime<Utc>>,
}

/// JSON 输出中的用户信息。
#[derive(Debug, Clone, Deserialize)]
struct ApiUser {
    username: String,
    #[serde(default)]
    id: u64,
}

impl From<&ApiUser> for UserSummary {
    fn from(u: &ApiUser) -> Self {
        Self {
            login: u.username.clone(),
            id: u.id.to_string(),
        }
    }
}

/// `glab mr view --output json` 返回的 JSON 结构(用于获取当前用户信息)。
#[derive(Debug, Clone, Deserialize)]
struct MrViewResponse {
    #[serde(default)]
    author: Option<ApiUser>,
}

// ── trait 实现 ──────────────────────────────────────────────────────

#[async_trait]
impl<R: CommandRunner + 'static> ReviewProvider for GitLabReviewProvider<R> {
    /// 在指定 MR 上添加审查评论。
    ///
    /// 调用 `glab api --method POST` 发布 note 评论并构造 [`ReviewData`]。
    async fn comment(&self, pr_number: u64, body: &str) -> Result<ReviewData> {
        let note = self.post_note(pr_number, body).await?;
        let author = note.author.as_ref().map_or_else(
            || UserSummary {
                login: "unknown".into(),
                id: "0".to_string(),
            },
            UserSummary::from,
        );

        Ok(ReviewData {
            id: note.id,
            state: ReviewState::Commented,
            body: Some(note.body),
            author,
            submitted_at: note.created_at,
        })
    }

    /// 批准指定 MR。
    ///
    /// 调用 `glab mr approve` 批准 MR,然后构造 [`ReviewData`]。
    async fn approve(&self, pr_number: u64, body: Option<&str>) -> Result<ReviewData> {
        debug!(repo = %self.repo, number = pr_number, "spawning `glab mr approve`");

        let pr_number_str = pr_number.to_string();
        let mut cmd_args: Vec<&str> = vec!["mr", "approve", &pr_number_str];

        if let Some(b) = body {
            cmd_args.push("--comment");
            cmd_args.push(b);
        }

        let output = self
            .runner
            .run("glab", &cmd_args)
            .await
            .map_err(|e| CoreError::Platform(format!("Failed to spawn glab: {e}")))?;

        if !output.status.success() {
            return Err(parse_glab_error(&output.stderr).into());
        }

        let message = String::from_utf8_lossy(&output.stdout).trim().to_string();
        let author = self.get_current_user().await.unwrap_or(UserSummary {
            login: "unknown".into(),
            id: "0".to_string(),
        });

        Ok(ReviewData {
            id: 0,
            state: ReviewState::Approved,
            body: if message.is_empty() {
                body.map(String::from)
            } else {
                Some(message)
            },
            author,
            // `glab mr approve` returns no timestamp of its own, but approval
            // is a synchronous action happening at this exact instant — this
            // is NOT backfilling an unknown historical value (the #380/#366
            // bug class), so Utc::now() is correct here and intentionally
            // stays a plain value, not a fallback (#380 design §3.3).
            submitted_at: Some(Utc::now()),
        })
    }

    /// 对指定 MR 要求修改。
    ///
    /// glab 没有直接的 "request changes" 命令,通过 `glab api --method POST`
    /// 发布包含要求修改意见的 note 评论,并标记为 `ChangesRequested` 状态。
    async fn request_changes(&self, pr_number: u64, body: &str) -> Result<ReviewData> {
        let changes_body = format!("Changes requested:\n\n{body}");
        let note = self.post_note(pr_number, &changes_body).await?;
        let author = note.author.as_ref().map_or_else(
            || UserSummary {
                login: "unknown".into(),
                id: "0".to_string(),
            },
            UserSummary::from,
        );

        Ok(ReviewData {
            id: note.id,
            state: ReviewState::ChangesRequested,
            body: Some(note.body),
            author,
            submitted_at: note.created_at,
        })
    }

    /// 提交指定 MR 的审查。
    ///
    /// 根据 `event` 参数分别调用 `glab mr approve`、`glab mr revoke` 或
    /// `glab mr note` 实现不同的审查操作。
    async fn submit_review(
        &self,
        pr_number: u64,
        event: ReviewState,
        body: Option<&str>,
    ) -> Result<ReviewData> {
        debug!(repo = %self.repo, number = pr_number, ?event, "spawning `glab mr review`");

        match event {
            ReviewState::Approved => self.approve(pr_number, body).await,
            ReviewState::ChangesRequested => {
                self.request_changes(pr_number, body.unwrap_or("Changes requested."))
                    .await
            }
            ReviewState::Commented => {
                self.comment(pr_number, body.unwrap_or("Review comment."))
                    .await
            }
        }
    }
}

impl<R: CommandRunner> GitLabReviewProvider<R> {
    /// 在指定 MR 上发布一条 note(内部辅助方法)。
    ///
    /// 调用 `glab api --method POST
    /// /projects/{repo-encoded}/merge_requests/{pr_number}/notes`,
    /// 其中 `{repo-encoded}` 为全量 URL 编码的项目路径
    /// (如 `group/subgroup/project` → `group%2Fsubgroup%2Fproject`)。
    ///
    /// # Errors
    ///
    /// 当 MR 不存在或 `glab` CLI 调用失败时返回错误。
    async fn post_note(&self, pr_number: u64, body: &str) -> Result<NoteApiResponse> {
        debug!(repo = %self.repo, number = pr_number, "spawning `glab api` POST mr note");

        let encoded_path = encode_project_path(&self.repo);
        let api_path = format!("/projects/{encoded_path}/merge_requests/{pr_number}/notes");
        let body_arg = format!("body={body}");

        let output = self
            .runner
            .run(
                "glab",
                &["api", "--method", "POST", &api_path, "-f", &body_arg],
            )
            .await
            .map_err(|e| CoreError::Platform(format!("Failed to spawn glab api: {e}")))?;

        if !output.status.success() {
            return Err(parse_glab_error(&output.stderr).into());
        }

        serde_json::from_slice(&output.stdout).map_err(CoreError::Serialization)
    }

    /// 获取当前登录用户信息(内部辅助方法)。
    async fn get_current_user(&self) -> Result<UserSummary> {
        let output = self
            .runner
            .run(
                "glab",
                &["mr", "list", "--output", "json", "--per-page", "1"],
            )
            .await
            .map_err(|e| CoreError::Platform(format!("Failed to spawn glab: {e}")))?;

        if !output.status.success() {
            return Ok(UserSummary {
                login: "unknown".into(),
                id: "0".to_string(),
            });
        }

        let mrs: Vec<MrViewResponse> =
            serde_json::from_slice(&output.stdout).map_err(CoreError::Serialization)?;

        if let Some(mr) = mrs.into_iter().next()
            && let Some(author) = mr.author
        {
            return Ok(UserSummary::from(&author));
        }

        Ok(UserSummary {
            login: "unknown".into(),
            id: "0".to_string(),
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::runner::{MockCommandRunner, SequencedMockCommandRunner};

    #[test]
    fn test_should_construct_gitlab_review_provider() {
        let provider = GitLabReviewProvider::new("gitlab-org/gitlab");
        assert_eq!(provider.repo, "gitlab-org/gitlab");
    }

    #[test]
    fn test_should_construct_gitlab_review_provider_from_string() {
        let repo = String::from("gitlab-org/gitlab");
        let provider = GitLabReviewProvider::new(repo);
        assert_eq!(provider.repo, "gitlab-org/gitlab");
    }

    #[test]
    fn test_should_deserialize_note_api_response() {
        let json = br#"{
            "id": 2001,
            "body": "Looks great, LGTM!",
            "author": {"username": "reviewer", "id": 42},
            "created_at": "2026-05-20T14:30:00Z"
        }"#;

        let note: NoteApiResponse = serde_json::from_slice(json).expect("valid NoteApiResponse");
        assert_eq!(note.id, 2001);
        assert_eq!(note.body, "Looks great, LGTM!");
        assert_eq!(note.author.as_ref().map(|a| &*a.username), Some("reviewer"));
    }

    #[test]
    fn test_should_deserialize_note_without_author() {
        let json = br#"{
            "id": 2002,
            "body": "Anonymous comment",
            "author": null,
            "created_at": "2026-05-21T09:00:00Z"
        }"#;

        let note: NoteApiResponse = serde_json::from_slice(json).expect("valid NoteApiResponse");
        assert!(note.author.is_none());
    }

    #[test]
    fn test_should_convert_note_to_review_data() {
        let note = NoteApiResponse {
            id: 100,
            body: "LGTM".into(),
            author: Some(ApiUser {
                username: "reviewer".into(),
                id: 5,
            }),
            created_at: Some("2026-01-01T00:00:00Z".parse().expect("valid date")),
        };

        let author = note
            .author
            .as_ref()
            .map(UserSummary::from)
            .expect("has author");
        let review = ReviewData {
            id: note.id,
            state: ReviewState::Commented,
            body: Some(note.body),
            author,
            submitted_at: note.created_at,
        };

        assert_eq!(review.id, 100);
        assert_eq!(review.state, ReviewState::Commented);
        assert_eq!(review.author.login, "reviewer");
        assert!(review.submitted_at.is_some());
    }

    #[test]
    fn test_should_debug_format_provider() {
        let provider = GitLabReviewProvider::new("gitlab-org/gitlab");
        let debug = format!("{provider:?}");
        assert!(debug.contains("GitLabReviewProvider"));
        assert!(debug.contains("gitlab-org/gitlab"));
    }

    #[test]
    fn test_should_clone_gitlab_review_provider() {
        let original = GitLabReviewProvider::new("owner/repo");
        let cloned = original.clone();
        assert_eq!(original.repo, cloned.repo);
    }

    // --- Failure-path tests using an injected MockCommandRunner ---

    #[tokio::test]
    async fn test_should_fail_when_review_comment_glab_fails() {
        let runner = MockCommandRunner::failure(r#"{"message": "Forbidden"}"#, 256);
        let provider = GitLabReviewProvider::with_runner("owner/repo", runner);
        let result = provider.comment(7, "fix this").await;
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn test_should_post_review_note_via_glab_api() {
        let runner = MockCommandRunner::success(
            r#"{"id":99,"body":"fix this","author":{"username":"alice","id":1},"created_at":"2026-08-18T00:00:00Z"}"#,
        );
        let provider = GitLabReviewProvider::with_runner("owner/repo", runner.clone());

        let review = provider.comment(7, "fix this").await.expect("should post");

        assert_eq!(review.id, 99);
        assert_eq!(review.author.login, "alice");
        assert_eq!(review.body.as_deref(), Some("fix this"));
        assert_eq!(
            runner.recorded_calls()[0].1,
            vec![
                "api",
                "--method",
                "POST",
                "/projects/owner%2Frepo/merge_requests/7/notes",
                "-f",
                "body=fix this",
            ]
            .into_iter()
            .map(String::from)
            .collect::<Vec<_>>()
        );
    }

    #[tokio::test]
    async fn test_should_encode_nested_group_repo_path_for_review_note() {
        let runner = MockCommandRunner::success(
            r#"{"id":99,"body":"fix this","author":{"username":"alice","id":1},"created_at":"2026-08-18T00:00:00Z"}"#,
        );
        let provider = GitLabReviewProvider::with_runner("group/subgroup/project", runner.clone());

        let review = provider.comment(7, "fix this").await.expect("should post");

        assert_eq!(review.id, 99);
        assert_eq!(
            runner.recorded_calls()[0].1,
            vec![
                "api",
                "--method",
                "POST",
                "/projects/group%2Fsubgroup%2Fproject/merge_requests/7/notes",
                "-f",
                "body=fix this",
            ]
            .into_iter()
            .map(String::from)
            .collect::<Vec<_>>()
        );
    }

    #[tokio::test]
    async fn test_should_request_changes_via_glab_api() {
        let runner = MockCommandRunner::success(
            r#"{"id":100,"body":"Changes requested:\n\nredo it","author":{"username":"alice","id":1},"created_at":"2026-08-18T00:00:00Z"}"#,
        );
        let provider = GitLabReviewProvider::with_runner("owner/repo", runner.clone());

        let review = provider
            .request_changes(7, "redo it")
            .await
            .expect("should post");

        assert_eq!(review.id, 100);
        assert_eq!(review.state, ReviewState::ChangesRequested);
        assert_eq!(
            review.body.as_deref(),
            Some("Changes requested:\n\nredo it")
        );
        assert_eq!(
            runner.recorded_calls()[0].1,
            vec![
                "api",
                "--method",
                "POST",
                "/projects/owner%2Frepo/merge_requests/7/notes",
                "-f",
                "body=Changes requested:\n\nredo it",
            ]
            .into_iter()
            .map(String::from)
            .collect::<Vec<_>>()
        );
    }

    #[test]
    fn test_should_deserialize_mr_view_response() {
        let json = br#"{
            "author": {"username": "maintainer", "id": 99}
        }"#;

        let mr: MrViewResponse = serde_json::from_slice(json).expect("valid MrViewResponse");
        assert!(mr.author.is_some());
        let author = mr.author.as_ref().expect("author present");
        assert_eq!(author.username, "maintainer");
        assert_eq!(author.id, 99);
    }

    #[test]
    fn test_should_deserialize_mr_view_response_without_author() {
        let json = br#"{"author": null}"#;

        let mr: MrViewResponse = serde_json::from_slice(json).expect("valid MrViewResponse");
        assert!(mr.author.is_none());
    }

    #[test]
    fn test_should_deserialize_note_without_created_at() {
        let json = br#"{
            "id": 3001,
            "body": "No timestamp",
            "author": null,
            "created_at": null
        }"#;

        let note: NoteApiResponse = serde_json::from_slice(json).expect("valid NoteApiResponse");
        assert!(note.created_at.is_none());
        assert!(note.author.is_none());
    }

    #[test]
    fn test_should_convert_api_user_to_user_summary() {
        let user = ApiUser {
            username: "reviewer".into(),
            id: 42,
        };
        let summary: UserSummary = (&user).into();
        assert_eq!(summary.login, "reviewer");
        assert_eq!(summary.id, "42");
    }

    #[test]
    fn test_should_convert_api_user_with_zero_id_to_user_summary() {
        let user = ApiUser {
            username: "bot".into(),
            id: 0,
        };
        let summary: UserSummary = (&user).into();
        assert_eq!(summary.login, "bot");
        assert_eq!(summary.id, "0");
    }

    // --- approve() tests: --repo dropped, glab auto-detects from git remote ---

    #[tokio::test]
    async fn test_should_approve_mr_without_repo_flag() {
        // Sequenced: first `glab mr approve` succeeds, then `glab mr list` (get_current_user).
        let runner = SequencedMockCommandRunner::from_results(&[
            (true, "Approved MR #7"),
            (true, r#"[{"author":{"username":"alice","id":1}}]"#),
        ]);
        let provider = GitLabReviewProvider::with_runner("owner/repo", runner.clone());

        let review = provider
            .approve(7, Some("LGTM"))
            .await
            .expect("should approve");

        assert_eq!(review.state, ReviewState::Approved);
        assert_eq!(review.author.login, "alice");

        let calls = runner.recorded_calls();
        // First call: `glab mr approve <num> --comment <body>` — NO --repo.
        assert_eq!(
            calls[0].1,
            vec!["mr", "approve", "7", "--comment", "LGTM"]
                .into_iter()
                .map(String::from)
                .collect::<Vec<_>>()
        );
        // Second call: `glab mr list --output json --per-page 1` — NO --repo.
        assert_eq!(
            calls[1].1,
            vec!["mr", "list", "--output", "json", "--per-page", "1"]
                .into_iter()
                .map(String::from)
                .collect::<Vec<_>>()
        );
    }

    #[tokio::test]
    async fn test_should_approve_nested_group_mr_without_repo_flag() {
        // Regression: 3-segment path (iproost/proxy/edge) must NOT pass --repo,
        // which glab cannot parse. Dropping --repo lets glab auto-detect.
        let runner = SequencedMockCommandRunner::from_results(&[
            (true, "Approved MR #26"),
            (true, r#"[{"author":{"username":"reviewer","id":42}}]"#),
        ]);
        let provider = GitLabReviewProvider::with_runner("iproost/proxy/edge", runner.clone());

        let review = provider
            .approve(26, Some("LGTM"))
            .await
            .expect("should approve");

        assert_eq!(review.state, ReviewState::Approved);
        assert_eq!(review.author.login, "reviewer");

        let calls = runner.recorded_calls();
        assert_eq!(
            calls[0].1,
            vec!["mr", "approve", "26", "--comment", "LGTM"]
                .into_iter()
                .map(String::from)
                .collect::<Vec<_>>()
        );
        assert_eq!(
            calls[1].1,
            vec!["mr", "list", "--output", "json", "--per-page", "1"]
                .into_iter()
                .map(String::from)
                .collect::<Vec<_>>()
        );
    }
}