webhooks.rs 26.5 KB
Newer Older
1 2 3 4 5 6
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

Ben Boeckel's avatar
Ben Boeckel committed
7 8 9 10 11 12 13
//! Web hook structures
//!
//! These hooks are received from Gitlab when registered as a web hook within a project.
//!
//! Gitlab does not have consistent structures for its hooks, so they often change from
//! version to version.

Brad King's avatar
Brad King committed
14
use crates::chrono::{DateTime, NaiveDate, TimeZone, Utc};
15
use crates::serde::de::{Error, Unexpected};
Ben Boeckel's avatar
Ben Boeckel committed
16
use crates::serde::{Deserialize, Deserializer, Serialize, Serializer};
17
use crates::serde_json::{self, Value};
18

Ben Boeckel's avatar
Ben Boeckel committed
19 20 21 22 23
use types::{
    IssueId, IssueInternalId, IssueState, JobId, MergeRequestId, MergeRequestInternalId,
    MergeRequestState, MergeStatus, MilestoneId, NoteId, NoteType, NoteableId, ObjectId, ProjectId,
    SnippetId, UserId,
};
24 25 26 27 28 29

#[derive(Debug, Clone, Copy)]
/// A wrapper struct for dates in web hooks.
///
/// Gitlab does not use a standard date format for dates in web hooks. This structure supports
/// deserializing the formats that have been observed.
Brad King's avatar
Brad King committed
30
pub struct HookDate(DateTime<Utc>);
31 32 33 34 35 36 37

impl Serialize for HookDate {
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        self.0.serialize(serializer)
    }
}

38 39
impl<'de> Deserialize<'de> for HookDate {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
Ben Boeckel's avatar
Ben Boeckel committed
40 41
    where
        D: Deserializer<'de>,
42
    {
43 44
        let val = String::deserialize(deserializer)?;

Brad King's avatar
Brad King committed
45
        Utc.datetime_from_str(&val, "%Y-%m-%d %H:%M:%S UTC")
46
            .or_else(|_| {
47 48 49 50 51 52 53 54 55 56
                DateTime::parse_from_rfc3339(&val).map(|dt| dt.with_timezone(&Utc))
            })
            .or_else(|_| {
                DateTime::parse_from_str(&val, "%Y-%m-%d %H:%M:%S %z").map(|dt| dt.with_timezone(&Utc))
            })
            .map_err(|err| {
                D::Error::invalid_value(
                    Unexpected::Other("hook date"),
                    &format!("Unsupported format: {} {:?}", val, err).as_str(),
                    )
57 58 59 60 61
            })
            .map(HookDate)
    }
}

Brad King's avatar
Brad King committed
62 63
impl AsRef<DateTime<Utc>> for HookDate {
    fn as_ref(&self) -> &DateTime<Utc> {
64 65 66 67
        &self.0
    }
}

Ben Boeckel's avatar
Ben Boeckel committed
68
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Project information exposed in hooks.
pub struct ProjectHookAttrs {
    /// The display name of the project.
    pub name: String,
    /// The description of the project.
    pub description: Option<String>,
    /// The URL for the project's homepage.
    pub web_url: String,
    /// The URL to the project avatar.
    pub avatar_url: Option<String>,
    /// The URL to clone the repository over SSH.
    pub git_ssh_url: String,
    /// The URL to clone the repository over HTTPS.
    pub git_http_url: String,
    /// The namespace the project lives in.
    pub namespace: String,
    /// Integral value for the project's visibility.
    pub visibility_level: u64,
    /// The path to the project's repository with its namespace.
    pub path_with_namespace: String,
    /// The default branch for the project.
91
    pub default_branch: Option<String>,
92 93 94 95
    homepage: String,
    http_url: String,
    ssh_url: String,
    url: String,
96 97
}

Ben Boeckel's avatar
Ben Boeckel committed
98
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Wiki project information exposed in hooks.
pub struct ProjectWikiHookAttrs {
    /// The URL for the project's homepage.
    pub web_url: String,
    /// The URL to clone the repository over SSH.
    pub git_ssh_url: String,
    /// The URL to clone the repository over HTTPS.
    pub git_http_url: String,
    /// The path to the project's repository with its namespace.
    pub path_with_namespace: String,
    /// The default branch for the project.
    pub default_branch: String,
}

Ben Boeckel's avatar
Ben Boeckel committed
114
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
115 116 117 118 119 120 121 122
#[derive(Serialize, Deserialize, Debug, Clone)]
/// User information exposed in hooks.
pub struct UserHookAttrs {
    /// The name of the user.
    pub name: String,
    /// The handle of the user.
    pub username: String,
    /// The URL to the avatar of the user.
123
    pub avatar_url: Option<String>,
124 125
}

Ben Boeckel's avatar
Ben Boeckel committed
126
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
127 128 129 130 131 132 133 134 135
#[derive(Serialize, Deserialize, Debug, Clone)]
/// The identity of a user exposed through a hook.
pub struct HookCommitIdentity {
    /// The name of the author or committer.
    pub name: String,
    /// The email address of the author or committer.
    pub email: String,
}

Ben Boeckel's avatar
Ben Boeckel committed
136
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
137 138 139 140 141 142 143
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Commit information exposed in hooks.
pub struct CommitHookAttrs {
    /// The commit's ID.
    pub id: ObjectId,
    /// The commit message.
    pub message: String,
Brad King's avatar
Brad King committed
144
    pub timestamp: DateTime<Utc>,
145 146 147 148 149 150 151 152 153
    /// The URL of the commit.
    pub url: String,
    /// The author of the commit.
    pub author: HookCommitIdentity,
    pub added: Option<Vec<String>>,
    pub modified: Option<Vec<String>>,
    pub removed: Option<Vec<String>>,
}

Ben Boeckel's avatar
Ben Boeckel committed
154
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
155 156 157 158 159
#[derive(Serialize, Deserialize, Debug, Clone)]
/// A push hook.
pub struct PushHook {
    /// The event which occurred.
    pub object_kind: String,
160 161
    /// XXX(gitlab): Bug in Gitlab; it should not send this.
    event_name: String,
162 163 164 165
    /// The old object ID of the ref before the push.
    pub before: ObjectId,
    /// The new object ID of the ref after the push.
    pub after: ObjectId,
Ben Boeckel's avatar
Ben Boeckel committed
166
    #[serde(rename = "ref")]
167 168 169 170 171 172 173 174 175 176
    /// The name of the reference which has been pushed.
    pub ref_: String,
    /// The new object ID of the ref after the push.
    pub checkout_sha: Option<ObjectId>,
    /// The message for the push (used for annotated tags).
    pub message: Option<String>,
    /// The ID of the user who pushed.
    pub user_id: UserId,
    /// The name of the user who pushed.
    pub user_name: String,
177 178
    /// The username of the user who pushed.
    pub user_username: String,
179 180 181
    /// The email address of the user who pushed.
    pub user_email: String,
    /// The URL of the user's avatar.
182
    pub user_avatar: Option<String>,
183 184 185 186 187 188 189 190 191 192
    /// The ID of the project pushed to.
    pub project_id: ProjectId,
    /// Attributes of the project.
    pub project: ProjectHookAttrs,
    /// The commits pushed to the repository.
    ///
    /// Limited to 20 commits.
    pub commits: Vec<CommitHookAttrs>, // limited to 20 commits
    /// The total number of commits pushed.
    pub total_commits_count: u64,
193
    repository: Value,
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// Actions which may occur on an issue.
pub enum IssueAction {
    /// The issue was updated.
    Update,
    /// The issue was opened.
    Open,
    /// The issue was closed.
    Close,
    /// The issue was reopened.
    Reopen,
}
enum_serialize!(IssueAction -> "issue action",
    Update => "update",
    Open => "open",
    Close => "close",
    Reopen => "reopen",
);

Ben Boeckel's avatar
Ben Boeckel committed
215
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Issue information exposed in hooks.
pub struct IssueHookAttrs {
    /// The ID of the issue.
    pub id: IssueId,
    /// The title of the issue.
    pub title: String,
    /// The ID of the assignee of the issue.
    pub assignee_id: Option<UserId>,
    /// The ID of the author of the issue.
    pub author_id: UserId,
    /// The ID of the project.
    pub project_id: ProjectId,
    /// When the issue was created.
    pub created_at: HookDate,
    /// When the issue was last updated.
    pub updated_at: HookDate,
    /// When the issue was deleted.
    pub deleted_at: Option<HookDate>,
235 236
    /// When the issue was closed.
    pub closed_at: Option<HookDate>,
237 238 239 240 241 242 243 244
    /// When the issue is due.
    pub due_date: Option<NaiveDate>,
    /// The ID of the user which last updated the issue.
    pub updated_by_id: Option<UserId>,
    pub moved_to_id: Option<Value>, // ???
    /// The branch name for the issue.
    pub branch_name: Option<String>,
    /// The description of the issue.
Brad King's avatar
Brad King committed
245
    pub description: Option<String>,
246 247 248 249 250
    /// The ID of the milestone of the issue.
    pub milestone_id: Option<MilestoneId>,
    /// The state of the issue.
    pub state: IssueState,
    /// The user-visible ID of the issue.
Brad King's avatar
Brad King committed
251
    pub iid: IssueInternalId,
252 253
    /// Whether the issue is confidential or not.
    pub confidential: bool,
254 255 256 257 258 259 260 261
    /// The time estimate, in seconds.
    pub time_estimate: u64,
    /// The total time spent, in seconds.
    pub total_time_spent: u64,
    /// The time estimate, as a human-readable string.
    pub human_time_estimate: Option<String>,
    /// The total time spent, as a human-readable string.
    pub human_total_time_spent: Option<String>,
262 263 264 265 266 267 268 269

    // It seems that notes miss these properties?
    /// The URL of the issue.
    pub url: Option<String>,
    /// The type of action which caused the hook.
    pub action: Option<IssueAction>,
}

Ben Boeckel's avatar
Ben Boeckel committed
270
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
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
#[derive(Serialize, Deserialize, Debug, Clone)]
/// An issue hook.
pub struct IssueHook {
    /// The event which occurred.
    pub object_kind: String,
    /// The user which triggered the hook.
    pub user: UserHookAttrs,
    /// The project the hook was created for.
    pub project: ProjectHookAttrs,
    /// Attributes of the issue.
    pub object_attributes: IssueHookAttrs,
    /// The assignee of the issue.
    pub assignee: Option<UserHookAttrs>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// Actions which may occur on a merge request.
pub enum MergeRequestAction {
    /// The merge request was updated.
    Update,
    /// The merge request was opened.
    Open,
    /// The merge request was closed.
    Close,
    /// The merge request was reopened.
    Reopen,
    /// The merge request was merged.
    Merge,
}
enum_serialize!(MergeRequestAction -> "merge request action",
    Update => "update",
    Open => "open",
    Close => "close",
    Reopen => "reopen",
    Merge => "merge",
);

Ben Boeckel's avatar
Ben Boeckel committed
308
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
309 310 311 312 313 314 315 316 317 318 319 320 321
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Merge parameters for a merge request.
pub struct MergeRequestParams {
    force_remove_source_branch: Option<Value>, // sigh
}

impl MergeRequestParams {
    /// Whether the author of the merge request indicated that the source branch should be deleted
    /// upon merge or not.
    // https://gitlab.com/gitlab-org/gitlab-ce/issues/20880
    pub fn force_remove_source_branch(&self) -> bool {
        self.force_remove_source_branch
            .as_ref()
Ben Boeckel's avatar
Ben Boeckel committed
322
            .map_or(false, |val| {
323 324 325 326 327 328 329 330 331 332 333 334 335
                if let Some(as_str) = val.as_str() {
                    as_str == "1"
                } else if let Some(as_bool) = val.as_bool() {
                    as_bool
                } else {
                    error!(target: "gitlab",
                           "unknown value for force_remove_source_branch: {}", val);
                    false
                }
            })
    }
}

Ben Boeckel's avatar
Ben Boeckel committed
336
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Merge request information exposed in hooks.
pub struct MergeRequestHookAttrs {
    /// The source project of the merge request.
    ///
    /// If this is `None`, the source repository has been deleted.
    pub source: Option<ProjectHookAttrs>,
    /// The target project of the merge request.
    pub target: ProjectHookAttrs,
    pub last_commit: Option<CommitHookAttrs>,
    /// Whether the merge request is a work-in-progress or not.
    pub work_in_progress: bool,
    /// The object ID of the merge commit which is currently being handled.
    pub in_progress_merge_commit_sha: Option<ObjectId>,

    /// The ID of the merge request.
    pub id: MergeRequestId,
    /// The target branch of the merge request.
    pub target_branch: String,
    /// The ID of the target project.
    pub target_project_id: ProjectId,
    /// The source branch of the merge request.
    pub source_branch: String,
    /// The ID of the source project.
361
    pub source_project_id: Option<ProjectId>,
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
    /// The ID of the author of the merge request.
    pub author_id: UserId,
    /// The ID of the assignee of the merge request.
    pub assignee_id: Option<UserId>,
    /// The title of the merge request.
    pub title: String,
    /// When the merge request was created.
    pub created_at: HookDate,
    /// When the merge request was last updated.
    pub updated_at: HookDate,
    /// When the merge request was deleted.
    pub deleted_at: Option<HookDate>,
    /// When the merge request was locked.
    pub locked_at: Option<HookDate>,
    /// The ID of the user which last updated the merge request.
    pub updated_by_id: Option<UserId>,
    /// The object ID of the commit which merged the merge request.
    pub merge_commit_sha: Option<ObjectId>,
    pub merge_error: Option<Value>, // String?
    /// The parameters for merging the merge request.
    pub merge_params: MergeRequestParams,
    /// The user which merged the merge request.
    pub merge_user_id: Option<UserId>,
    /// Whether the merge request will be merged once all builds succeed or not.
Ben Boeckel's avatar
Ben Boeckel committed
386
    pub merge_when_pipeline_succeeds: bool,
387 388 389 390 391 392 393 394 395 396
    // st_commits
    // st_diffs
    /// The milestone of the merge request.
    pub milestone_id: Option<MilestoneId>,
    pub oldrev: Option<ObjectId>,
    /// The state of the merge request.
    pub state: MergeRequestState,
    /// The merge status of the merge request.
    pub merge_status: MergeStatus,
    /// The user-visible ID of the merge request.
Brad King's avatar
Brad King committed
397
    pub iid: MergeRequestInternalId,
398 399 400 401 402 403 404 405
    /// The description of the merge request.
    pub description: Option<String>,

    // It seems that notes miss these properties?
    /// The URL of the merge request.
    pub url: Option<String>,
    /// The type of action which caused the hook.
    pub action: Option<MergeRequestAction>,
406 407
    pub time_estimate: u64,
    lock_version: Option<u64>,
408 409
}

Ben Boeckel's avatar
Ben Boeckel committed
410
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
411 412 413 414 415 416 417 418 419 420 421 422 423
#[derive(Serialize, Deserialize, Debug, Clone)]
/// A merge request hook.
pub struct MergeRequestHook {
    /// The event which occurred.
    pub object_kind: String,
    /// The user which triggered the hook.
    pub user: UserHookAttrs,
    /// The project the hook was created for.
    pub project: ProjectHookAttrs,
    /// Attributes of the merge request.
    pub object_attributes: MergeRequestHookAttrs,
    /// The assignee of the merge request.
    pub assignee: Option<UserHookAttrs>,
424
    repository: Value,
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// The type of a snippet.
pub enum SnippetType {
    /// A project-owned snippet.
    Project,
    /// A user-owned snippet.
    Personal,
}
enum_serialize!(SnippetType -> "snippet type",
    Project => "ProjectSnippet",
    Personal => "PersonalSnippet",
);

Ben Boeckel's avatar
Ben Boeckel committed
440
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Snippet information exposed in hooks.
pub struct SnippetHookAttrs {
    /// The title of the snippet.
    pub title: String,
    /// The content of the snippet.
    pub content: String,
    /// The author of the snippet.
    pub author_id: UserId,
    /// The project the snippet belongs to.
    pub project_id: Option<ProjectId>,
    /// When the snippet was created.
    pub created_at: HookDate,
    /// When the snippet was last updated.
    pub updated_at: HookDate,
    /// The name of the snippet.
    pub file_name: String,
Ben Boeckel's avatar
Ben Boeckel committed
458
    #[serde(rename = "type")]
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
    /// The type of the snippet.
    pub type_: SnippetType,
    /// The visibility of the snippet.
    pub visibility_level: u64,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// Actions which may occur on a wiki page.
pub enum WikiPageAction {
    /// A wiki page was created.
    Create,
    /// A wiki page was updated.
    Update,
}
enum_serialize!(WikiPageAction -> "wiki page action",
    Create => "create",
    Update => "update",
);

Ben Boeckel's avatar
Ben Boeckel committed
478
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Wiki information exposed in hooks.
pub struct WikiPageHookAttrs {
    /// The title of the wiki page.
    pub title: String,
    /// The content of the wiki page.
    pub content: String,
    pub format: String,
    pub message: String,
    /// The slug of the wiki page.
    pub slug: String,

    /// The URL of the wiki page.
    pub url: String,
    /// The type of action which caused the hook.
    pub action: WikiPageAction,
}

Ben Boeckel's avatar
Ben Boeckel committed
497
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Diff information exposed in hooks.
pub struct DiffHookAttrs {
    pub diff: String,
    /// The path on the new side of the diff.
    pub new_path: String,
    /// The path on the old side of the diff.
    pub old_path: String,
    /// The mode on the old side of the diff.
    // TODO: Create a mode type.
    pub a_mode: String,
    /// The mode on the new side of the diff.
    pub b_mode: String,
    /// Whether the diff indicates the addition of a file.
    pub new_file: bool,
    /// Whether the diff indicates the rename of a file.
    pub renamed_file: bool,
    /// Whether the diff indicates the deletion of a file.
    pub deleted_file: bool,
    pub too_large: bool,
}

Ben Boeckel's avatar
Ben Boeckel committed
520
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
521
#[derive(Serialize, Deserialize, Debug, Clone)]
522
// FIXME(gitlab#21467): This can apparently be a string sometimes.
523 524 525 526 527 528 529 530 531 532 533 534 535
// https://gitlab.com/gitlab-org/gitlab-ce/issues/21467
pub struct PositionHookAttrs {
    pub base_sha: ObjectId,
    pub head_sha: ObjectId,
    pub start_sha: ObjectId,
    pub old_line: Option<u64>,
    /// The path on the old side of the diff.
    pub old_path: String,
    pub new_line: Option<u64>,
    /// The path on the new side of the diff.
    pub new_path: String,
}

Ben Boeckel's avatar
Ben Boeckel committed
536
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
537 538 539 540 541 542 543 544 545 546
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Note (comment) information exposed in hooks.
pub struct NoteHookAttrs {
    /// The ID of the note.
    pub id: NoteId,
    /// THe content of the note.
    pub note: String,
    /// The type of entity the note is attached to.
    pub noteable_type: NoteType,
    // pub original_position: Option<PositionHookAttrs>,
547
    original_position: Value,
548
    // pub position: Option<PositionHookAttrs>,
549
    position: Value,
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
    /// The author of the note.
    pub author_id: UserId,
    /// When the note was created.
    pub created_at: HookDate,
    /// When the note was last updated.
    pub updated_at: HookDate,
    /// The ID of the user who last updated the note.
    pub updated_by_id: Option<UserId>,
    /// When the note was marked as resolved.
    pub resolved_at: Option<HookDate>,
    /// The ID of the user who marked the note as resolved.
    pub resolved_by_id: Option<UserId>,
    /// The ID of the project.
    pub project_id: ProjectId,
    /// The URL of an attachment to the note.
    pub attachment: Option<String>,
566
    pub line_code: Option<String>, // XXX: This is some internal format.
567 568 569 570 571 572 573 574 575 576
    pub commit_id: Option<ObjectId>, // XXX(8.11): apparently can be an empty string?
    pub discussion_id: ObjectId,
    pub original_discussion_id: Option<ObjectId>,
    noteable_id: Value, // Keep as JSON because its type depends on what `noteable_type` is.
    /// Whether the note was created by a user or in response to an external action.
    pub system: bool,
    pub st_diff: Option<DiffHookAttrs>,
    /// The URL of the note.
    pub url: String,

577
    // XXX: What is this field?
Ben Boeckel's avatar
Ben Boeckel committed
578
    #[serde(rename = "type")]
579 580 581
    pub type_: Option<String>,
    // XXX: Seems to have been removed?
    // pub is_award: bool,
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
}

impl NoteHookAttrs {
    /// The ID of the object the note is for.
    pub fn noteable_id(&self) -> Option<NoteableId> {
        match self.noteable_type {
            NoteType::Commit => {
                self.noteable_id
                    .as_str()
                    .map(|id| NoteableId::Commit(ObjectId::new(id)))
            },
            NoteType::Issue => {
                self.noteable_id
                    .as_u64()
                    .map(|id| NoteableId::Issue(IssueId::new(id)))
            },
            NoteType::MergeRequest => {
                self.noteable_id
                    .as_u64()
                    .map(|id| NoteableId::MergeRequest(MergeRequestId::new(id)))
            },
            NoteType::Snippet => {
                self.noteable_id
                    .as_u64()
                    .map(|id| NoteableId::Snippet(SnippetId::new(id)))
            },
        }
    }
}

Ben Boeckel's avatar
Ben Boeckel committed
612
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
#[derive(Serialize, Deserialize, Debug, Clone)]
/// A note hook.
pub struct NoteHook {
    /// The event which occurred.
    pub object_kind: String,
    /// The user who triggered the hook.
    pub user: UserHookAttrs,
    /// The ID of the project the note belongs to.
    pub project_id: ProjectId,
    /// The project the note belongs to.
    pub project: ProjectHookAttrs,
    /// The attributes on the note itself.
    pub object_attributes: NoteHookAttrs,
    /// The commit the note is associated with (for commit notes).
    pub commit: Option<CommitHookAttrs>,
    /// The issue the note is associated with (for issue notes).
    pub issue: Option<IssueHookAttrs>,
    /// The merge request the note is associated with (for merge request notes).
    pub merge_request: Option<MergeRequestHookAttrs>,
    /// The snippet the note is associated with (for snippet notes).
    pub snippet: Option<SnippetHookAttrs>,
634
    repository: Value,
635 636
}

Ben Boeckel's avatar
Ben Boeckel committed
637
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
638 639 640 641 642 643 644 645 646 647 648
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Build user information exposed in hooks.
pub struct BuildUserHookAttrs {
    /// The ID of the user.
    pub id: Option<UserId>,
    /// The user's name.
    pub name: Option<String>,
    /// The user's email address.
    pub email: Option<String>,
}

Ben Boeckel's avatar
Ben Boeckel committed
649
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Build commit information exposed in hooks.
pub struct BuildCommitHookAttrs {
    pub id: String,
    /// The object ID of the commit.
    pub sha: ObjectId,
    /// The full commit message.
    pub message: String,
    /// The commit's author's name.
    pub author_name: String,
    /// The commit's author's email address.
    pub author_email: String,
    pub status: String,
    pub duration: u64,
    /// When the build started.
    pub started_at: Option<HookDate>,
    /// When the build completed.
    pub finished_at: Option<HookDate>,
}

Ben Boeckel's avatar
Ben Boeckel committed
670
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
#[derive(Serialize, Deserialize, Debug, Clone)]
/// Project information exposed in build hooks.
pub struct BuildProjectHookAttrs {
    /// The display name of the project.
    pub name: String,
    /// The description of the project.
    pub description: Option<String>,
    /// The URL for the project's homepage.
    pub homepage: String,
    /// The URL to clone the repository over HTTPS.
    pub git_http_url: String,
    /// The URL to clone the repository over SSH.
    pub git_ssh_url: String,
    /// Integral value for the project's visibility.
    pub visibility_level: u64,
}

Ben Boeckel's avatar
Ben Boeckel committed
688
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
689 690 691 692 693
#[derive(Serialize, Deserialize, Debug, Clone)]
/// A build hook.
pub struct BuildHook {
    /// The event which occurred.
    pub object_kind: String,
Ben Boeckel's avatar
Ben Boeckel committed
694
    #[serde(rename = "ref")]
695 696 697 698 699 700 701
    /// The name of the reference that was tested.
    pub ref_: String,
    pub tag: String,
    pub before_sha: String,
    /// The object ID that was built.
    pub sha: String,
    /// The ID of the build.
Brad King's avatar
Brad King committed
702
    pub build_id: JobId,
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
    /// The name of the build.
    pub build_name: String,
    pub build_stage: String,
    /// When the build started.
    pub build_started_at: Option<HookDate>,
    /// When the build completed.
    pub build_finished_at: Option<HookDate>,
    pub build_duration: Option<u64>,
    /// Whether the build is allowed to fail.
    pub build_allow_failure: bool,
    /// The ID of the project.
    pub project_id: ProjectId,
    /// The user which owns the build.
    pub user: BuildUserHookAttrs,
    /// The commit which was built.
    pub commit: BuildCommitHookAttrs,
    /// The repository the build is for.
    pub repository: BuildProjectHookAttrs,
}

Ben Boeckel's avatar
Ben Boeckel committed
723
#[cfg_attr(feature = "strict", serde(deny_unknown_fields))]
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
#[derive(Serialize, Deserialize, Debug, Clone)]
/// A wiki page hook.
pub struct WikiPageHook {
    /// The event which occurred.
    pub object_kind: String,
    /// The user who caused the hook.
    pub user: UserHookAttrs,
    /// The project the wiki belongs to.
    pub project: ProjectHookAttrs,
    /// The wiki the page belongs to.
    pub wiki: ProjectWikiHookAttrs,
    /// The wiki page.
    pub object_attributes: WikiPageHookAttrs,
}

#[derive(Debug, Clone)]
/// A deserializable structure for all Gitlab web hooks.
pub enum WebHook {
    /// A push hook.
    Push(PushHook),
    /// An issue hook.
    Issue(IssueHook),
    /// A merge request hook.
    MergeRequest(MergeRequestHook),
    /// A note hook.
    Note(NoteHook),
    /// A build hook.
    Build(BuildHook),
    /// A wiki page hook.
    WikiPage(WikiPageHook),
}

756 757
impl<'de> Deserialize<'de> for WebHook {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
Ben Boeckel's avatar
Ben Boeckel committed
758 759
    where
        D: Deserializer<'de>,
760
    {
761 762 763 764 765
        let val = <Value as Deserialize>::deserialize(deserializer)?;

        let object_kind = match val.pointer("/object_kind") {
            Some(&Value::String(ref kind)) => kind.to_string(),
            Some(_) => {
Ben Boeckel's avatar
Ben Boeckel committed
766 767 768 769
                return Err(D::Error::invalid_type(
                    Unexpected::Other("JSON value"),
                    &"a string",
                ));
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
            },
            None => {
                return Err(D::Error::missing_field("object_kind"));
            },
        };

        let hook_res = match object_kind.as_str() {
            "push" | "tag_push" => serde_json::from_value(val).map(WebHook::Push),

            "issue" => serde_json::from_value(val).map(WebHook::Issue),

            "merge_request" => serde_json::from_value(val).map(WebHook::MergeRequest),

            "note" => serde_json::from_value(val).map(WebHook::Note),

            "build" => serde_json::from_value(val).map(WebHook::Build),

            _ => {
Ben Boeckel's avatar
Ben Boeckel committed
788 789 790 791
                return Err(D::Error::invalid_value(
                    Unexpected::Other("object kind"),
                    &format!("unrecognized webhook object kind: {}", object_kind).as_str(),
                ));
792 793 794 795
            },
        };

        hook_res.map_err(|err| {
Ben Boeckel's avatar
Ben Boeckel committed
796 797 798 799
            D::Error::invalid_value(
                Unexpected::Other("web hook"),
                &format!("{:?}", err).as_str(),
            )
800 801 802
        })
    }
}