OXYGENHUB
# 8597fb5ca16c oxygenhub / crates / hub / src / db / repos.rs
18.5 KiB · Rust · last changed Push without starting a run: [skip flow] (closes #284) 16 days ago source blame history raw
1
//! The `repositories` and `pushes` tables.
2
3
use super::{now_ms, Pool};
4
use hub_api::Visibility;
5
use sqlx::FromRow;
6
7
#[derive(Clone, Debug, Default, FromRow)]
8
pub struct RepoRow {
9
    pub id: i64,
10
    pub owner: String,
11
    pub name: String,
12
    pub description: String,
13
    pub default_bookmark: String,
14
    pub visibility: String,
15
    pub created_ms: i64,
16
    pub updated_ms: i64,
17
    #[sqlx(default)]
18
    pub git_mirror: bool,
19
    #[sqlx(default)]
20
    pub git_mirror_state: String,
21
    /// The repository this one was forked from (migration 0009).
22
    #[sqlx(default)]
23
    pub forked_from: Option<i64>,
24
    /// Space-separated topics (migration 0010).
25
    #[sqlx(default)]
26
    pub topics: String,
27
    /// OxygenFlow: `on`, `off`, or empty to follow hub.toml (migration 0018).
28
    #[sqlx(default)]
29
    pub flow: String,
30
    /// Its jobs' priority: `low`, `normal`, `high`, or empty to follow its
31
    /// organisation's and the site's (oxygenhub#244, migration 0073).
32
    #[sqlx(default)]
33
    pub flow_priority: String,
34
    /// Diffusion: `off`, `green`, `any`, or empty to follow hub.toml
35
    /// (migration 0058, #148).
36
    #[sqlx(default)]
37
    pub diffusion: String,
38
    /// Diffusion auto-land: `auto`, `propose`, or empty for propose
39
    /// (migration 0061).
40
    #[sqlx(default)]
41
    pub diffusion_land: String,
42
    /// Backups (migration 0062): empty with its owner's, `off`, or its own
43
    /// `hourly` or `daily`.
44
    #[sqlx(default)]
45
    pub backup: String,
46
    /// Read-only, with why (migration 0040, #108).
47
    #[sqlx(default)]
48
    pub archived: bool,
49
    #[sqlx(default)]
50
    pub archived_reason: String,
51
    /// Agents' tokens may approve or reject its approval gates (#258).
52
    #[sqlx(default)]
53
    pub agents_decide_gates: bool,
54
    /// Newest run wins (#267): a superseded run already running finishes;
55
    /// only queued ones are cancelled. Off by default.
56
    #[sqlx(default)]
57
    pub flow_keep_running: bool,
58
    /// Where a push may skip its run with `[skip flow]` (#284, migration
59
    /// 0088): `any` bookmark, `others` than the default one, or `never`.
60
    #[sqlx(default)]
61
    pub flow_skip: String,
62
    /// Pushes that add possible secrets are refused (#268, migration
63
    /// 0085). On by default.
64
    #[sqlx(default)]
65
    pub push_protection: bool,
66
    /// `repo`, or `drop` for a drop (#279, migration 0087): a small
67
    /// repository named `drops/ID` that no repository list shows.
68
    #[sqlx(default)]
69
    pub kind: String,
70
    /// A drop's title.
71
    #[sqlx(default)]
72
    pub title: String,
73
    /// Counts for the tabs; filled by `get` only.
74
    #[sqlx(default)]
75
    pub open_issues: i64,
76
    #[sqlx(default)]
77
    pub open_proposals: i64,
78
}
79
80
impl RepoRow {
81
    pub fn visibility(&self) -> Visibility {
82
        Visibility::parse(&self.visibility).unwrap_or(Visibility::Private)
83
    }
84
85
    pub fn topic_list(&self) -> Vec<&str> {
86
        self.topics.split_whitespace().collect()
87
    }
88
89
    pub fn slug(&self) -> String {
90
        format!("{}/{}", self.owner, self.name)
91
    }
92
93
    /// A drop (#279), not a repository.
94
    pub fn is_drop(&self) -> bool {
95
        self.kind == DROP
96
    }
97
}
98
99
/// `repositories.kind` of a drop (#279).
100
pub const DROP: &str = "drop";
101
102
#[derive(Clone, Debug, FromRow)]
103
pub struct PushRow {
104
    pub id: i64,
105
    pub at_ms: i64,
106
    pub reference: String,
107
    pub ok: bool,
108
    pub reason: String,
109
    pub old_state: String,
110
    pub new_state: String,
111
    pub heads: i64,
112
    pub changes: i64,
113
    pub pusher: String,
114
}
115
116
/// One reference's outcome in a push, as the protocol backend reports it.
117
#[derive(Clone, Debug)]
118
pub struct PushOutcome {
119
    pub reference: String,
120
    pub ok: bool,
121
    pub reason: String,
122
    pub old_state: String,
123
    pub new_state: String,
124
    pub heads: i64,
125
    pub changes: i64,
126
}
127
128
/// Every repository, drops left out: what every list, search and count
129
/// of repositories starts from (#279).
130
pub async fn list(pool: &Pool) -> sqlx::Result<Vec<RepoRow>> {
131
    sqlx::query_as("SELECT * FROM repositories WHERE kind = 'repo' ORDER BY updated_ms DESC, owner, name").fetch_all(pool).await
132
}
133
134
/// Every repository and every drop: for upkeep that covers all stored
135
/// repositories (gc, the history scan, `oxygenhub check`), never a list
136
/// people see unless it labels the drops.
137
pub async fn list_with_drops(pool: &Pool) -> sqlx::Result<Vec<RepoRow>> {
138
    sqlx::query_as("SELECT * FROM repositories ORDER BY updated_ms DESC, owner, name").fetch_all(pool).await
139
}
140
141
pub async fn get_by_id(pool: &Pool, id: i64) -> sqlx::Result<Option<RepoRow>> {
142
    sqlx::query_as("SELECT * FROM repositories WHERE id = $1").bind(id).fetch_optional(pool).await
143
}
144
145
pub async fn list_by_owner(pool: &Pool, owner: &str) -> sqlx::Result<Vec<RepoRow>> {
146
    sqlx::query_as("SELECT * FROM repositories WHERE owner = $1 AND kind = 'repo' ORDER BY updated_ms DESC, name")
147
        .bind(owner)
148
        .fetch_all(pool)
149
        .await
150
}
151
152
// ------------------------------------------------------------------ drops
153
154
/// A drop's row (#279): a repository named `drops/ID`, its kind `drop`,
155
/// push protection on and Flow off. `visibility` is `public`, or
156
/// `private` for a secret drop.
157
pub async fn create_drop(
158
    pool: &Pool,
159
    owner: &str,
160
    id: &str,
161
    title: &str,
162
    description: &str,
163
    visibility: Visibility,
164
) -> sqlx::Result<RepoRow> {
165
    let now = now_ms();
166
    sqlx::query_as(
167
        "INSERT INTO repositories (owner, name, description, visibility, created_ms, updated_ms, kind, title, flow) \
168
         VALUES ($1, $2, $3, $4, $5, $6, $7, $8, 'off') RETURNING *",
169
    )
170
    .bind(owner)
171
    .bind(format!("{}/{id}", crate::repos::names::DROPS))
172
    .bind(description)
173
    .bind(visibility.as_str())
174
    .bind(now)
175
    .bind(now)
176
    .bind(DROP)
177
    .bind(title)
178
    .fetch_one(pool)
179
    .await
180
}
181
182
/// An owner's drops, newest activity first.
183
pub async fn drops_of(pool: &Pool, owner: &str) -> sqlx::Result<Vec<RepoRow>> {
184
    sqlx::query_as("SELECT * FROM repositories WHERE kind = 'drop' AND owner = $1 ORDER BY updated_ms DESC, id DESC")
185
        .bind(owner)
186
        .fetch_all(pool)
187
        .await
188
}
189
190
/// The drop with this id, whoever owns it: ids are random and made
191
/// unique across the hub.
192
pub async fn drop_by_id(pool: &Pool, id: &str) -> sqlx::Result<Option<RepoRow>> {
193
    sqlx::query_as("SELECT * FROM repositories WHERE kind = 'drop' AND name = $1")
194
        .bind(format!("{}/{id}", crate::repos::names::DROPS))
195
        .fetch_optional(pool)
196
        .await
197
}
198
199
/// A drop's title, description and visibility, and that it changed.
200
pub async fn set_drop(pool: &Pool, row_id: i64, title: &str, description: &str, visibility: Visibility) -> sqlx::Result<()> {
201
    sqlx::query("UPDATE repositories SET title = $1, description = $2, visibility = $3, updated_ms = $4 WHERE id = $5 AND kind = 'drop'")
202
        .bind(title)
203
        .bind(description)
204
        .bind(visibility.as_str())
205
        .bind(now_ms())
206
        .bind(row_id)
207
        .execute(pool)
208
        .await?;
209
    Ok(())
210
}
211
212
/// One repository, with its open issue and proposal counts for the tabs.
213
pub async fn get(pool: &Pool, owner: &str, name: &str) -> sqlx::Result<Option<RepoRow>> {
214
    sqlx::query_as(
215
        "SELECT r.*, \
216
           (SELECT COUNT(*) FROM issues i WHERE i.repo_id = r.id AND i.state = 'open') AS open_issues, \
217
           (SELECT COUNT(*) FROM proposals p WHERE p.repo_id = r.id AND p.state IN ('open', 'draft')) AS open_proposals \
218
         FROM repositories r WHERE r.owner = $1 AND r.name = $2",
219
    )
220
    .bind(owner)
221
    .bind(name)
222
    .fetch_optional(pool)
223
    .await
224
}
225
226
/// Create a repository row. One under an organisation of two or more
227
/// members requires one sealed approval to land a proposal (oxygenhub#64),
228
/// since someone other than the author can then give it; others require none.
229
pub async fn create(pool: &Pool, owner: &str, name: &str, description: &str, visibility: Visibility) -> sqlx::Result<RepoRow> {
230
    let now = now_ms();
231
    sqlx::query_as(
232
        "INSERT INTO repositories (owner, name, description, visibility, created_ms, updated_ms, required_approvals) \
233
         VALUES ($1, $2, $3, $4, $5, $6, (SELECT CASE WHEN COUNT(*) >= 2 THEN 1 ELSE 0 END FROM org_members m JOIN organisations o ON o.id = m.org_id WHERE o.name = $7)) RETURNING *",
234
    )
235
    .bind(owner)
236
    .bind(name)
237
    .bind(description)
238
    .bind(visibility.as_str())
239
    .bind(now)
240
    .bind(now)
241
    .bind(owner)
242
    .fetch_one(pool)
243
    .await
244
}
245
246
/// The repository an old name now points at, after a transfer.
247
pub async fn moved_to(pool: &Pool, owner: &str, name: &str) -> sqlx::Result<Option<RepoRow>> {
248
    let id: Option<i64> = sqlx::query_scalar("SELECT repo_id FROM repo_redirects WHERE old_owner = $1 AND old_name = $2")
249
        .bind(owner)
250
        .bind(name)
251
        .fetch_optional(pool)
252
        .await?;
253
    match id {
254
        Some(id) => get_by_id(pool, id).await,
255
        None => Ok(None),
256
    }
257
}
258
259
/// Move a repository to another owner, keeping its name: the row, and a
260
/// redirect from the old name. A redirect that pointed at the new name
261
/// goes, so names never loop.
262
pub async fn transfer(pool: &Pool, id: i64, old_owner: &str, name: &str, new_owner: &str) -> sqlx::Result<()> {
263
    sqlx::query("UPDATE repositories SET owner = $1, updated_ms = $2 WHERE id = $3")
264
        .bind(new_owner)
265
        .bind(now_ms())
266
        .bind(id)
267
        .execute(pool)
268
        .await?;
269
    sqlx::query("DELETE FROM repo_redirects WHERE old_owner = $1 AND old_name = $2").bind(new_owner).bind(name).execute(pool).await?;
270
    sqlx::query("INSERT OR REPLACE INTO repo_redirects (old_owner, old_name, repo_id, moved_ms) VALUES ($1, $2, $3, $4)")
271
        .bind(old_owner)
272
        .bind(name)
273
        .bind(id)
274
        .bind(now_ms())
275
        .execute(pool)
276
        .await?;
277
    Ok(())
278
}
279
280
/// Archive (read-only) or bring back a repository.
281
pub async fn set_archived(pool: &Pool, id: i64, archived: bool, reason: &str) -> sqlx::Result<()> {
282
    sqlx::query("UPDATE repositories SET archived = $1, archived_reason = $2, updated_ms = $3 WHERE id = $4")
283
        .bind(archived)
284
        .bind(if archived { reason } else { "" })
285
        .bind(now_ms())
286
        .bind(id)
287
        .execute(pool)
288
        .await?;
289
    Ok(())
290
}
291
292
pub async fn delete(pool: &Pool, id: i64) -> sqlx::Result<()> {
293
    sqlx::query("DELETE FROM repositories WHERE id = $1").bind(id).execute(pool).await?;
294
    Ok(())
295
}
296
297
pub async fn set_description(pool: &Pool, id: i64, description: &str) -> sqlx::Result<()> {
298
    sqlx::query("UPDATE repositories SET description = $1 WHERE id = $2").bind(description).bind(id).execute(pool).await?;
299
    Ok(())
300
}
301
302
pub async fn set_default_bookmark(pool: &Pool, id: i64, bookmark: &str) -> sqlx::Result<()> {
303
    sqlx::query("UPDATE repositories SET default_bookmark = $1 WHERE id = $2").bind(bookmark).bind(id).execute(pool).await?;
304
    Ok(())
305
}
306
307
pub async fn set_visibility(pool: &Pool, id: i64, visibility: Visibility) -> sqlx::Result<()> {
308
    sqlx::query("UPDATE repositories SET visibility = $1 WHERE id = $2").bind(visibility.as_str()).bind(id).execute(pool).await?;
309
    Ok(())
310
}
311
312
/// Record a push's per-reference results and bump the repository's activity.
313
pub async fn record_push(pool: &Pool, id: i64, pusher: Option<(i64, &str)>, results: &[PushOutcome]) -> sqlx::Result<()> {
314
    record_push_via(pool, id, pusher, "", results).await
315
}
316
317
/// [`record_push`], naming the agent token the push came through (#217).
318
pub async fn record_push_via(pool: &Pool, id: i64, pusher: Option<(i64, &str)>, via: &str, results: &[PushOutcome]) -> sqlx::Result<()> {
319
    let now = now_ms();
320
    let mut tx = super::begin_write(pool).await?;
321
    for r in results {
322
        sqlx::query("INSERT INTO pushes (repo_id, at_ms, reference, ok, reason, old_state, new_state, heads, changes, account_id, pusher, via) VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12)")
323
            .bind(id)
324
            .bind(now)
325
            .bind(&r.reference)
326
            .bind(r.ok)
327
            .bind(&r.reason)
328
            .bind(&r.old_state)
329
            .bind(&r.new_state)
330
            .bind(r.heads)
331
            .bind(r.changes)
332
            .bind(pusher.map(|p| p.0).filter(|id| *id > 0))
333
            .bind(pusher.map(|p| p.1).unwrap_or(""))
334
            .bind(via)
335
            .execute(&mut *tx)
336
            .await?;
337
    }
338
    if results.iter().any(|r| r.ok) {
339
        sqlx::query("UPDATE repositories SET updated_ms = $1 WHERE id = $2").bind(now).bind(id).execute(&mut *tx).await?;
340
    }
341
    tx.commit().await
342
}
343
344
pub async fn pushes(pool: &Pool, id: i64, limit: i64) -> sqlx::Result<Vec<PushRow>> {
345
    sqlx::query_as("SELECT id, at_ms, reference, ok, reason, old_state, new_state, heads, changes, pusher FROM pushes WHERE repo_id = $1 ORDER BY at_ms DESC, id DESC LIMIT $2")
346
        .bind(id)
347
        .bind(limit)
348
        .fetch_all(pool)
349
        .await
350
}
351
352
/// Topics from user input: comma or space separated, lower-cased,
353
/// letters, digits and dashes, at most 35 characters each and 20 in all.
354
/// Returns the stored form or what is wrong.
355
pub fn parse_topics(input: &str) -> Result<String, String> {
356
    let mut out: Vec<String> = Vec::new();
357
    for t in input.split([',', ' ', '\n', '\t']).map(|t| t.trim().to_ascii_lowercase()).filter(|t| !t.is_empty()) {
358
        if t.len() > 35 || !t.chars().all(|c| c.is_ascii_alphanumeric() || c == '-') || t.starts_with('-') {
359
            return Err(format!("\"{t}\" is not a topic: use letters, digits and dashes, up to 35 characters"));
360
        }
361
        if !out.contains(&t) {
362
            out.push(t);
363
        }
364
    }
365
    if out.len() > 20 {
366
        return Err("At most 20 topics.".into());
367
    }
368
    Ok(out.join(" "))
369
}
370
371
pub async fn set_topics(pool: &Pool, id: i64, topics: &str) -> sqlx::Result<()> {
372
    sqlx::query("UPDATE repositories SET topics = $1 WHERE id = $2").bind(topics).bind(id).execute(pool).await?;
373
    Ok(())
374
}
375
376
/// Star or unstar; returns whether it is now starred.
377
pub async fn toggle_star(pool: &Pool, account_id: i64, repo_id: i64) -> sqlx::Result<bool> {
378
    let gone = sqlx::query("DELETE FROM stars WHERE account_id = $1 AND repo_id = $2").bind(account_id).bind(repo_id).execute(pool).await?;
379
    if gone.rows_affected() > 0 {
380
        return Ok(false);
381
    }
382
    sqlx::query("INSERT INTO stars (account_id, repo_id, at_ms) VALUES ($1, $2, $3)")
383
        .bind(account_id)
384
        .bind(repo_id)
385
        .bind(now_ms())
386
        .execute(pool)
387
        .await?;
388
    Ok(true)
389
}
390
391
pub async fn starred(pool: &Pool, account_id: i64, repo_id: i64) -> sqlx::Result<bool> {
392
    let n: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM stars WHERE account_id = $1 AND repo_id = $2")
393
        .bind(account_id)
394
        .bind(repo_id)
395
        .fetch_one(pool)
396
        .await?;
397
    Ok(n > 0)
398
}
399
400
/// Stars and watchers of one repository.
401
pub async fn counts(pool: &Pool, repo_id: i64) -> sqlx::Result<(i64, i64)> {
402
    let stars: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM stars WHERE repo_id = $1").bind(repo_id).fetch_one(pool).await?;
403
    let watchers = super::notify::watchers(pool, repo_id).await?.len() as i64;
404
    Ok((stars, watchers))
405
}
406
407
/// Star counts of every starred repository.
408
pub async fn star_counts(pool: &Pool) -> sqlx::Result<std::collections::HashMap<i64, i64>> {
409
    let rows: Vec<(i64, i64)> = sqlx::query_as("SELECT repo_id, COUNT(*) FROM stars GROUP BY repo_id").fetch_all(pool).await?;
410
    Ok(rows.into_iter().collect())
411
}
412
413
/// Record that `id` is a fork of `from`.
414
pub async fn set_forked_from(pool: &Pool, id: i64, from: i64) -> sqlx::Result<()> {
415
    sqlx::query("UPDATE repositories SET forked_from = $1 WHERE id = $2").bind(from).bind(id).execute(pool).await?;
416
    Ok(())
417
}
418
419
/// The forks of `id`, newest activity first.
420
pub async fn forks_of(pool: &Pool, id: i64) -> sqlx::Result<Vec<RepoRow>> {
421
    sqlx::query_as("SELECT * FROM repositories WHERE forked_from = $1 AND kind = 'repo' ORDER BY updated_ms DESC")
422
        .bind(id)
423
        .fetch_all(pool)
424
        .await
425
}
426
427
/// `on`, `off`, or `` (follow hub.toml's `[flow] repos`).
428
pub async fn set_flow(pool: &Pool, id: i64, setting: &str) -> sqlx::Result<()> {
429
    sqlx::query("UPDATE repositories SET flow = $1 WHERE id = $2").bind(setting).bind(id).execute(pool).await?;
430
    Ok(())
431
}
432
433
pub async fn set_flow_priority(pool: &Pool, id: i64, priority: &str) -> sqlx::Result<()> {
434
    sqlx::query("UPDATE repositories SET flow_priority = $1 WHERE id = $2").bind(priority).bind(id).execute(pool).await?;
435
    Ok(())
436
}
437
438
/// Whether agents' tokens may decide the repository's approval gates (#258).
439
pub async fn set_agents_decide_gates(pool: &Pool, id: i64, on: bool) -> sqlx::Result<()> {
440
    sqlx::query("UPDATE repositories SET agents_decide_gates = $1 WHERE id = $2").bind(on).bind(id).execute(pool).await?;
441
    Ok(())
442
}
443
444
/// Whether a new run leaves the older runs it supersedes that are already
445
/// running to finish (#267), cancelling only the queued ones.
446
pub async fn set_flow_skip(pool: &Pool, id: i64, skip: &str) -> sqlx::Result<()> {
447
    sqlx::query("UPDATE repositories SET flow_skip = $1 WHERE id = $2").bind(skip).bind(id).execute(pool).await?;
448
    Ok(())
449
}
450
451
pub async fn set_flow_keep_running(pool: &Pool, id: i64, on: bool) -> sqlx::Result<()> {
452
    sqlx::query("UPDATE repositories SET flow_keep_running = $1 WHERE id = $2").bind(on).bind(id).execute(pool).await?;
453
    Ok(())
454
}
455
456
pub async fn set_backup(pool: &Pool, id: i64, setting: &str) -> sqlx::Result<()> {
457
    sqlx::query("UPDATE repositories SET backup = $1 WHERE id = $2").bind(setting).bind(id).execute(pool).await?;
458
    Ok(())
459
}
460
461
pub async fn set_diffusion_land(pool: &Pool, id: i64, setting: &str) -> sqlx::Result<()> {
462
    sqlx::query("UPDATE repositories SET diffusion_land = $1 WHERE id = $2").bind(setting).bind(id).execute(pool).await?;
463
    Ok(())
464
}
465
466
pub async fn set_diffusion(pool: &Pool, id: i64, setting: &str) -> sqlx::Result<()> {
467
    sqlx::query("UPDATE repositories SET diffusion = $1 WHERE id = $2").bind(setting).bind(id).execute(pool).await?;
468
    Ok(())
469
}
470
471
pub async fn set_git_mirror(pool: &Pool, id: i64, on: bool) -> sqlx::Result<()> {
472
    sqlx::query("UPDATE repositories SET git_mirror = $1 WHERE id = $2").bind(on).bind(id).execute(pool).await?;
473
    Ok(())
474
}
475
476
pub async fn set_git_mirror_state(pool: &Pool, id: i64, state: &str) -> sqlx::Result<()> {
477
    sqlx::query("UPDATE repositories SET git_mirror_state = $1 WHERE id = $2").bind(state).bind(id).execute(pool).await?;
478
    Ok(())
479
}
480
481
#[cfg(test)]
482
mod topic_tests {
483
    use super::parse_topics;
484
485
    #[test]
486
    fn topics_are_normalised_and_checked() {
487
        assert_eq!(parse_topics("Rust, vcs  retro-computing,rust").unwrap(), "rust vcs retro-computing");
488
        assert_eq!(parse_topics("").unwrap(), "");
489
        assert!(parse_topics("c++").is_err());
490
        assert!(parse_topics("-lead").is_err());
491
        assert!(parse_topics(&"x".repeat(36)).is_err());
492
        assert!(parse_topics(&(0..21).map(|i| format!("t{i}")).collect::<Vec<_>>().join(" ")).is_err());
493
    }
494
}