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
//! Contains the [`EventHandler`] trait and its default implementation
//! ([`DefaultEventHandler`]).

use std::sync::Arc;

use async_trait::async_trait;

use github_rest::model::{
    apps::events::{AppAuthorizationEvent, InstallationEvent, InstallationRepositoriesEvent},
    commits::events::{CommitCommentEvent, StatusEvent},
    discussions::events::{DiscussionCommentEvent, DiscussionEvent},
    issues::events::{IssueCommentEvent, IssueEvent, LabelEvent},
    misc::events::{DeploymentEvent, DeploymentStatusEvent, MarketplacePurchaseEvent, MetaEvent, SponsorshipEvent},
    organizations::events::{MembershipEvent, OrgBlockEvent, OrganizationEvent, TeamEvent},
    pull_requests::events::{PullRequestEvent, PullRequestReviewCommentEvent, PullRequestReviewEvent},
    releases::events::{CreateEvent, DeleteEvent, ReleaseEvent},
    repositories::{
        events::{
            BranchProtectionRuleEvent, CodeScanningAlertEvent, DeployKeyEvent, ForkEvent, MemberEvent, MilestoneEvent,
            PackageEvent, PingEvent, ProjectCardEvent, ProjectColumnEvent, ProjectEvent, PublicEvent, PushEvent,
            RepositoryDispatchEvent, RepositoryEvent, RepositoryImportEvent, RepositoryVulnerabilityAlertEvent,
            SecretScanningAlertEvent, StarEvent, TeamAddEvent, WatchEvent,
        },
        security_advisory::events::SecurityAdvisoryEvent,
        wiki::events::GollumEvent,
        workflows::events::{
            CheckRunEvent, CheckSuiteEvent, PageBuildEvent, WorkflowDispatchEvent, WorkflowJobEvent, WorkflowRunEvent,
        },
    },
};

use crate::{client::GitHubClient, github::command::Command, Client};
#[cfg(feature = "secrets")]
use lazy_static::lazy_static;

#[cfg(feature = "secrets")]
lazy_static! {
    static ref WEBHOOK_SECRET: String = std::env::var("WEBHOOK_SECRET").unwrap();
}

/// An event handler that is used in all clients. For end users, an implementer
/// of this trait is passed to a [`ClientBuilder`] instance when creating the
/// client in your main function.
///
/// [`ClientBuilder`]: crate::github::ClientBuilder
#[async_trait]
#[allow(unused_variables)]
pub trait EventHandler {
    type Message: std::fmt::Debug + Send;
    type GitHubClient: GitHubClient + Send + Sync;

    /// Utility function for setting the port used by the webhook.
    #[cfg(feature = "native")]
    fn listener_port(&self) -> u16 {
        8080
    }

    /// The route at which the listener should listen for payloads from GitHub.
    #[cfg(feature = "native")]
    fn route(&self) -> &'static str {
        "payload"
    }

    /// The webhook secret. Defaults to none.
    #[cfg(feature = "secrets")]
    fn listener_secret(&self) -> &'static [u8];

    async fn message(&self, message: Self::Message) {}

    /// Someone revokes their authorization of a GitHub App
    async fn app_authorization_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        app_authorization_event: AppAuthorizationEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to a GitHub App installation
    async fn installation_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        installation_event: InstallationEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to repositories being added to a GitHub App
    /// installation
    async fn installation_repositories_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        installation_repositories_event: InstallationRepositoriesEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Commit pushed to a repository
    async fn push_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        push_event: PushEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Comment added to a repository commit
    async fn commit_comment_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        commit_comment_event: CommitCommentEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Release created
    async fn release_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        release_event: ReleaseEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Repository-related activity
    async fn repository_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        repository_event: RepositoryEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Organization-related activity
    async fn organization_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        organization_event: OrganizationEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to an organization's team
    async fn team_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        team_event: TeamEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// A repository is added to a team
    async fn team_add_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        team_add_event: TeamAddEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to project boards
    async fn project_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        project_event: ProjectEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to project cards
    async fn project_card_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        project_card_event: ProjectCardEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to columns in a project board
    async fn project_column_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        project_column_event: ProjectColumnEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// The webhook this event is configured on was deleted. This event will
    /// only listen for changes to the particular hook the event is installed on
    async fn meta_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        meta_event: MetaEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to GitHub Packages
    async fn package_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        package_event: PackageEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// New webhook created
    async fn ping_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        ping_event: PingEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to a sponsorship listing
    async fn sponsorship_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        sponsorship_event: SponsorshipEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to a GitHub Marketplace purchase
    async fn marketplace_purchase_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        marketplace_purchase_event: MarketplacePurchaseEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// GitHub App sends a POST request to the "[create a repository dispatch event](https://docs.github.com/en/rest/reference/repos#create-a-repository-dispatch-event)" endpoint
    async fn repository_dispatch_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        repository_dispatch_event: RepositoryDispatchEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to a repository being imported to GitHub
    async fn repository_import_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        repository_import_event: RepositoryImportEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to security vulnerability alerts in a repository
    async fn repository_vulnerability_alert(
        &self,
        github_client: Arc<Self::GitHubClient>,
        repository_vulnerability_alert: RepositoryVulnerabilityAlertEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to secret scanning alerts in a repository
    async fn secret_scanning_alert(
        &self,
        github_client: Arc<Self::GitHubClient>,
        secret_scanning_alert: SecretScanningAlertEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Status of a Git commit changed
    async fn status_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        status_event: StatusEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to a label.
    async fn label_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        label_event: LabelEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to a discussion
    async fn discussion_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        discussion_event: DiscussionEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to a comment in a discussion
    async fn discussion_comment_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        discussion_comment_event: DiscussionCommentEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to a branch protection rule
    async fn branch_protection_rule_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        branch_protection_rule_event: BranchProtectionRuleEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Check suite activity has occurred
    async fn check_suite_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        check_suite_event: CheckSuiteEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to code scanning alerts in a repository
    async fn code_scanning_alert(
        &self,
        github_client: Arc<Self::GitHubClient>,
        code_scanning_alert: CodeScanningAlertEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// A deployment is created
    async fn deployment_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        deployment_event: DeploymentEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// A deployment is created
    async fn deployment_status_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        deployment_status_event: DeploymentStatusEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Represents an attempted build of a GitHub Pages site (successful or
    /// not)
    async fn page_build_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        page_build_event: PageBuildEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Someone triggers a workflow run on GitHub or sends a POST request to the
    /// "[create a workflow dispatch event](https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event)" endpoint
    async fn workflow_dispatch_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        workflow_dispatch_event: WorkflowDispatchEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Deploy key added or removed from a repository
    async fn deploy_key_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        deploy_key_event: DeployKeyEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// A wiki page is created or updated
    async fn gollum_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        gollum_event: GollumEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to team membership
    async fn membership_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        membership_event: MembershipEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to a user being blocked in an organization
    async fn org_block_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        org_block_event: OrgBlockEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Event related to repository collaborators
    async fn member_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        member_event: MemberEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Repository made public
    async fn public_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        public_event: PublicEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Event related to repository milestones
    async fn milestone_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        milestone_event: MilestoneEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Git branch or tag created
    async fn tag_created(
        &self,
        github_client: Arc<Self::GitHubClient>,
        create_event: CreateEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Git branch or tag deleted
    async fn tag_deleted(
        &self,
        github_client: Arc<Self::GitHubClient>,
        delete_event: DeleteEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Repository receives a star
    async fn star_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        star_event: StarEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    // Repository gets a new security advisory
    async fn security_advisory_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        security_advisory_event: SecurityAdvisoryEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Someone begins watching a repository
    async fn watch_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        watch_event: WatchEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Repository is forked
    async fn repository_forked(
        &self,
        github_client: Arc<Self::GitHubClient>,
        fork_event: ForkEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to pull requests
    async fn pull_request_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        pull_request_event: PullRequestEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to pull request reviews
    async fn pull_request_review_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        pull_request_review_event: PullRequestReviewEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to pull request review comments in the pull request's
    /// unified diff
    async fn pull_request_review_comment_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        pull_request_review_comment_event: PullRequestReviewCommentEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// A GitHub Actions workflow run is requested or completed
    async fn workflow_run(
        &self,
        github_client: Arc<Self::GitHubClient>,
        workflow_run: WorkflowRunEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// A GitHub Actions workflow job has been queued, is in progress, or has
    /// been completed on a repository
    async fn workflow_job(
        &self,
        github_client: Arc<Self::GitHubClient>,
        workflow_job: WorkflowJobEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Check run activity has occurred
    async fn check_run(
        &self,
        github_client: Arc<Self::GitHubClient>,
        check_run: CheckRunEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to an issue
    async fn issue_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        issue_event: IssueEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }

    /// Activity related to an issue or pull request comment
    async fn issue_comment_event(
        &self,
        github_client: Arc<Self::GitHubClient>,
        issue_comment_event: IssueCommentEvent,
    ) -> Command<Self::Message> {
        Command::none()
    }
}

#[derive(Debug)]
pub struct DefaultEventHandler;

#[async_trait]
impl EventHandler for DefaultEventHandler {
    type Message = ();
    type GitHubClient = Client<Self>;

    #[cfg(feature = "secrets")]
    fn listener_secret(&self) -> &'static [u8] {
        WEBHOOK_SECRET.as_bytes()
    }

    async fn message(&self, _message: Self::Message) {}
}

impl DefaultEventHandler {
    pub fn new() -> Self {
        Self
    }
}

impl Default for DefaultEventHandler {
    fn default() -> Self {
        Self::new()
    }
}