Sign in

pulls/pr_01m47d24b0e6n91zwymwxg0vpx

public

pr_01m47d24b0e6n91zwymwxg0vpx/crates/contracts/src/events.rs

182 lines5,518 bytesCodeBlame
1//! Events published on the bus, and the events service that carries them.
2//! Mirrors `packages/contracts/src/events.ts`.
3
4use serde::Serialize;
5
6/// What a publisher supplies; the bus fills in the id and time.
7#[derive(Debug, Serialize)]
8#[serde(rename_all = "camelCase")]
9pub struct NewEvent<T: Serialize> {
10 #[serde(rename = "type")]
11 pub kind: &'static str,
12 /// The service that published it.
13 pub source: &'static str,
14 /// The repo the event concerns.
15 pub repo_id: Option<String>,
16 /// The user or agent that caused it, if any.
17 pub actor: Option<String>,
18 pub data: T,
19}
20
21#[derive(Debug, Serialize)]
22#[serde(rename_all = "camelCase")]
23pub struct RepoCreated {
24 pub repo_id: String,
25 pub namespace: String,
26 pub name: String,
27 pub is_private: bool,
28}
29
30#[derive(Debug, Serialize)]
31#[serde(rename_all = "camelCase")]
32pub struct RepoForked {
33 pub repo_id: String,
34 pub source_repo_id: String,
35 pub pull_id: String,
36}
37
38/// One branch moved by a push. `after` is the commit it points to now.
39#[derive(Debug, Serialize)]
40#[serde(rename_all = "camelCase")]
41pub struct GitPush {
42 pub repo_id: String,
43 /// The full ref, such as `refs/heads/main`.
44 #[serde(rename = "ref")]
45 pub git_ref: String,
46 pub after: String,
47 /// Whether the ref is the repository's default branch.
48 pub default_branch: bool,
49}
50
51/// The payload of `issue.opened`, `issue.updated`, `issue.closed` and
52/// `issue.reopened`; each uses the fields that apply to it.
53#[derive(Debug, Default, Serialize)]
54#[serde(rename_all = "camelCase")]
55pub struct IssueEvent {
56 pub issue_id: String,
57 pub repo_id: String,
58 pub number: u32,
59 #[serde(skip_serializing_if = "Option::is_none")]
60 pub title: Option<String>,
61 /// On close: `completed` or `not_planned`.
62 #[serde(skip_serializing_if = "Option::is_none")]
63 pub reason: Option<&'static str>,
64 /// On close: the number of the pull request whose merge closed it.
65 #[serde(skip_serializing_if = "Option::is_none")]
66 pub resolved_by: Option<u32>,
67}
68
69/// The payload of `pull.opened`, `pull.ready`, `pull.updated` (its head
70/// moved), `pull.closed` and `pull.merged`; each uses the fields that apply to it.
71#[derive(Debug, Default, Serialize)]
72#[serde(rename_all = "camelCase")]
73pub struct PullEvent {
74 pub pull_id: String,
75 pub repo_id: String,
76 pub number: u32,
77 /// The number of the issue it is for.
78 #[serde(skip_serializing_if = "Option::is_none")]
79 pub issue: Option<u32>,
80 #[serde(skip_serializing_if = "Option::is_none")]
81 pub agent: Option<String>,
82 /// On merge: the commit the branch now points to.
83 #[serde(skip_serializing_if = "Option::is_none")]
84 pub commit: Option<String>,
85 /// On close: the pull request that was merged instead.
86 #[serde(skip_serializing_if = "Option::is_none")]
87 pub superseded_by: Option<u32>,
88}
89
90/// `checks.completed`: a run of an issue's acceptance checks against a pull
91/// request finished.
92#[derive(Debug, Serialize)]
93#[serde(rename_all = "camelCase")]
94pub struct ChecksEvent {
95 pub pull_id: String,
96 pub repo_id: String,
97 pub number: u32,
98 /// `passed`, `failed` or `errored`.
99 pub status: &'static str,
100 /// The commit that was checked.
101 pub commit: String,
102}
103
104/// `comment.created`. `number` is the issue or pull request commented on.
105#[derive(Debug, Serialize)]
106#[serde(rename_all = "camelCase")]
107pub struct CommentCreated {
108 pub comment_id: String,
109 pub repo_id: String,
110 pub number: u32,
111}
112
113#[derive(Debug, Serialize)]
114#[serde(rename_all = "camelCase")]
115pub struct SessionAppended {
116 pub pull_id: String,
117 pub repo_id: String,
118 pub number: u32,
119 pub count: u32,
120}
121
122/// An event as stored in the log and delivered to subscribers. `data` is
123/// left as JSON; each reader decodes the types it cares about.
124#[derive(Clone, Debug, Serialize, serde::Deserialize)]
125#[serde(rename_all = "camelCase")]
126pub struct Event {
127 /// Sorts by the time the event was published.
128 pub id: String,
129 #[serde(rename = "type")]
130 pub kind: String,
131 /// The service that published it.
132 pub source: String,
133 /// RFC 3339.
134 pub time: String,
135 /// The repo the event concerns.
136 pub repo_id: Option<String>,
137 /// The user or agent that caused it, if any.
138 pub actor: Option<String>,
139 pub data: serde_json::Value,
140}
141
142/// `publish`, as a publisher sends it. Returns nothing.
143#[derive(Debug, Serialize)]
144pub struct Publish<T: Serialize> {
145 pub events: Vec<NewEvent<T>>,
146}
147
148/// `publish`, as the events service reads it.
149#[derive(Debug, serde::Deserialize)]
150pub struct PublishArgs {
151 pub events: Vec<Published>,
152}
153
154/// A [`NewEvent`] of any type, as received.
155#[derive(Debug, serde::Deserialize)]
156#[serde(rename_all = "camelCase")]
157pub struct Published {
158 #[serde(rename = "type")]
159 pub kind: String,
160 pub source: String,
161 #[serde(default)]
162 pub repo_id: Option<String>,
163 #[serde(default)]
164 pub actor: Option<String>,
165 pub data: serde_json::Value,
166}
167
168/// `list`: events from the log, newest first. Returns `Vec<Event>`.
169#[derive(Debug, Default, Serialize, serde::Deserialize)]
170#[serde(rename_all = "camelCase")]
171pub struct ListArgs {
172 #[serde(default)]
173 pub repo_id: Option<String>,
174 /// Only these types; all types when empty.
175 #[serde(default)]
176 pub types: Vec<String>,
177 /// Only events older than this event id.
178 #[serde(default)]
179 pub before: Option<String>,
180 #[serde(default)]
181 pub limit: Option<u32>,
182}