forked from rust-lang/docs.rs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreleases.rs
2234 lines (1994 loc) · 74.9 KB
/
releases.rs
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
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
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
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! Releases web handlers
use crate::{
AsyncBuildQueue, Config, InstanceMetrics, RegistryApi,
build_queue::{QueuedCrate, REBUILD_PRIORITY},
cdn, impl_axum_webpage,
utils::report_error,
web::{
ReqVersion, axum_parse_uri_with_params, axum_redirect, encode_url_path,
error::{AxumNope, AxumResult},
extractors::{DbConnection, Path},
match_version,
page::templates::{RenderRegular, RenderSolid, filters},
},
};
use anyhow::{Context as _, Result, anyhow};
use askama::Template;
use axum::{
extract::{Extension, Query},
response::{IntoResponse, Response as AxumResponse},
};
use base64::{Engine, engine::general_purpose::STANDARD as b64};
use chrono::{DateTime, Utc};
use futures_util::stream::TryStreamExt;
use itertools::Itertools;
use serde::{Deserialize, Serialize};
use sqlx::Row;
use std::collections::{BTreeMap, HashMap, HashSet};
use std::str;
use std::sync::Arc;
use tracing::warn;
use url::form_urlencoded;
use super::cache::CachePolicy;
/// Number of release in home page
const RELEASES_IN_HOME: i64 = 15;
/// Releases in /releases page
const RELEASES_IN_RELEASES: i64 = 30;
/// Releases in recent releases feed
const RELEASES_IN_FEED: i64 = 150;
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct Release {
pub(crate) name: String,
pub(crate) version: String,
pub(crate) description: Option<String>,
pub(crate) target_name: Option<String>,
pub(crate) rustdoc_status: bool,
pub(crate) build_time: Option<DateTime<Utc>>,
pub(crate) stars: i32,
pub(crate) has_unyanked_releases: Option<bool>,
}
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub(crate) enum Order {
ReleaseTime, // this is default order
GithubStars,
RecentFailures,
FailuresByGithubStars,
}
impl Default for Order {
fn default() -> Self {
Self::ReleaseTime
}
}
pub(crate) async fn get_releases(
conn: &mut sqlx::PgConnection,
page: i64,
limit: i64,
order: Order,
latest_only: bool,
) -> Result<Vec<Release>> {
let offset = (page - 1) * limit;
// WARNING: it is _crucial_ that this always be hard-coded and NEVER be user input
let (ordering, filter_failed): (&'static str, _) = match order {
Order::ReleaseTime => ("release_build_status.last_build_time", false),
Order::GithubStars => ("repositories.stars", false),
Order::RecentFailures => ("release_build_status.last_build_time", true),
Order::FailuresByGithubStars => ("repositories.stars", true),
};
let query = format!(
"SELECT crates.name,
releases.version,
releases.description,
releases.target_name,
releases.rustdoc_status,
release_build_status.last_build_time,
repositories.stars
FROM crates
{1}
INNER JOIN release_build_status ON releases.id = release_build_status.rid
LEFT JOIN repositories ON releases.repository_id = repositories.id
WHERE
((NOT $3) OR (release_build_status.build_status = 'failure' AND releases.is_library = TRUE))
AND {0} IS NOT NULL AND
release_build_status.build_status != 'in_progress'
ORDER BY {0} DESC
LIMIT $1 OFFSET $2",
ordering,
if latest_only {
"INNER JOIN releases ON crates.latest_version_id = releases.id"
} else {
"INNER JOIN releases ON crates.id = releases.crate_id"
}
);
Ok(sqlx::query(query.as_str())
.bind(limit)
.bind(offset)
.bind(filter_failed)
.fetch(conn)
.map_ok(|row| Release {
name: row.get(0),
version: row.get(1),
description: row.get(2),
target_name: row.get(3),
rustdoc_status: row.get::<Option<bool>, _>(4).unwrap_or(false),
build_time: row.get(5),
stars: row.get::<Option<i32>, _>(6).unwrap_or(0),
has_unyanked_releases: None,
})
.try_collect()
.await?)
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub(crate) enum ReleaseStatus {
Available(Release),
/// Only contains the crate name.
NotAvailable(String),
}
struct SearchResult {
pub results: Vec<ReleaseStatus>,
pub prev_page: Option<String>,
pub next_page: Option<String>,
}
/// Get the search results for a crate search query
///
/// This delegates to the crates.io search API.
async fn get_search_results(
conn: &mut sqlx::PgConnection,
registry: &RegistryApi,
query_params: &str,
) -> Result<SearchResult, anyhow::Error> {
let crate::registry_api::Search { crates, meta } = registry.search(query_params).await?;
let names = Arc::new(
crates
.into_iter()
.map(|krate| krate.name)
.collect::<Vec<_>>(),
);
// now we're trying to get the docs.rs data for the crates
// returned by the search.
// Docs.rs might not know about crates or `max_version` shortly after
// they were published on crates.io, or while the build is running.
// So for now we are using the version with the youngest release_time.
// This is different from all other release-list views where we show
// our latest build.
let mut crates: HashMap<String, Release> = sqlx::query!(
r#"SELECT
crates.name,
releases.version,
releases.description,
release_build_status.last_build_time,
releases.target_name,
releases.rustdoc_status,
repositories.stars as "stars?",
EXISTS (
SELECT 1
FROM releases AS all_releases
WHERE
all_releases.crate_id = crates.id AND
all_releases.yanked = false
) AS has_unyanked_releases
FROM crates
INNER JOIN releases ON crates.latest_version_id = releases.id
INNER JOIN release_build_status ON releases.id = release_build_status.rid
LEFT JOIN repositories ON releases.repository_id = repositories.id
WHERE
crates.name = ANY($1) AND
release_build_status.build_status <> 'in_progress'"#,
&names[..],
)
.fetch(&mut *conn)
.map_ok(|row| {
(
row.name.clone(),
Release {
name: row.name,
version: row.version,
description: row.description,
build_time: row.last_build_time,
target_name: row.target_name,
rustdoc_status: row.rustdoc_status.unwrap_or(false),
stars: row.stars.unwrap_or(0),
has_unyanked_releases: row.has_unyanked_releases,
},
)
})
.try_collect()
.await?;
let names: Vec<String> =
Arc::into_inner(names).expect("Arc still borrowed in `get_search_results`");
Ok(SearchResult {
// start with the original names from crates.io to keep the original ranking,
// extend with the release/build information from docs.rs
// Crates that are not on docs.rs yet will not be returned.
results: names
.into_iter()
.map(|name| {
if let Some(release) = crates.remove(&name) {
ReleaseStatus::Available(release)
} else {
ReleaseStatus::NotAvailable(name)
}
})
.collect(),
prev_page: meta.prev_page,
next_page: meta.next_page,
})
}
#[derive(Template)]
#[template(path = "core/home.html")]
#[derive(Debug, Clone, PartialEq, Eq)]
struct HomePage {
recent_releases: Vec<Release>,
}
impl_axum_webpage! {
HomePage,
cache_policy = |_| CachePolicy::ShortInCdnAndBrowser,
}
pub(crate) async fn home_page(mut conn: DbConnection) -> AxumResult<impl IntoResponse> {
let recent_releases =
get_releases(&mut conn, 1, RELEASES_IN_HOME, Order::ReleaseTime, true).await?;
Ok(HomePage { recent_releases })
}
#[derive(Template)]
#[template(path = "releases/feed.xml")]
#[derive(Debug, Clone, PartialEq, Eq)]
struct ReleaseFeed {
recent_releases: Vec<Release>,
}
impl_axum_webpage! {
ReleaseFeed,
content_type = "application/xml",
}
pub(crate) async fn releases_feed_handler(mut conn: DbConnection) -> AxumResult<impl IntoResponse> {
let recent_releases =
get_releases(&mut conn, 1, RELEASES_IN_FEED, Order::ReleaseTime, true).await?;
Ok(ReleaseFeed { recent_releases })
}
#[derive(Template)]
#[template(path = "releases/releases.html")]
#[derive(Debug, Clone, PartialEq, Eq)]
struct ViewReleases {
releases: Vec<ReleaseStatus>,
description: String,
release_type: ReleaseType,
show_next_page: bool,
show_previous_page: bool,
page_number: i64,
owner: Option<String>,
}
impl_axum_webpage! { ViewReleases }
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub(crate) enum ReleaseType {
Recent,
Stars,
RecentFailures,
Failures,
Search,
}
impl PartialEq<&str> for ReleaseType {
fn eq(&self, other: &&str) -> bool {
self.as_str() == *other
}
}
impl PartialEq<str> for ReleaseType {
fn eq(&self, other: &str) -> bool {
self.as_str() == other
}
}
impl ReleaseType {
fn as_str(&self) -> &str {
match self {
Self::Recent => "recent",
Self::Stars => "stars",
Self::RecentFailures => "recent-failures",
Self::Failures => "failures",
Self::Search => "search",
}
}
}
pub(crate) async fn releases_handler(
conn: &mut sqlx::PgConnection,
page: Option<i64>,
release_type: ReleaseType,
) -> AxumResult<impl IntoResponse + use<>> {
let page_number = page.unwrap_or(1);
let (description, release_order, latest_only) = match release_type {
ReleaseType::Recent => ("Recently uploaded crates", Order::ReleaseTime, false),
ReleaseType::Stars => ("Crates with most stars", Order::GithubStars, true),
ReleaseType::RecentFailures => (
"Recent crates failed to build",
Order::RecentFailures,
false,
),
ReleaseType::Failures => (
"Crates with most stars failed to build",
Order::FailuresByGithubStars,
true,
),
ReleaseType::Search => {
panic!("The search page has special requirements and cannot use this handler",)
}
};
let releases = get_releases(
&mut *conn,
page_number,
RELEASES_IN_RELEASES,
release_order,
latest_only,
)
.await?;
// Show next and previous page buttons
let (show_next_page, show_previous_page) = (
releases.len() == RELEASES_IN_RELEASES as usize,
page_number != 1,
);
Ok(ViewReleases {
releases: releases
.into_iter()
.map(ReleaseStatus::Available)
.collect::<Vec<_>>(),
description: description.into(),
release_type,
show_next_page,
show_previous_page,
page_number,
owner: None,
})
}
pub(crate) async fn recent_releases_handler(
page: Option<Path<i64>>,
mut conn: DbConnection,
) -> AxumResult<impl IntoResponse> {
releases_handler(&mut conn, page.map(|p| p.0), ReleaseType::Recent).await
}
pub(crate) async fn releases_by_stars_handler(
page: Option<Path<i64>>,
mut conn: DbConnection,
) -> AxumResult<impl IntoResponse> {
releases_handler(&mut conn, page.map(|p| p.0), ReleaseType::Stars).await
}
pub(crate) async fn releases_recent_failures_handler(
page: Option<Path<i64>>,
mut conn: DbConnection,
) -> AxumResult<impl IntoResponse> {
releases_handler(&mut conn, page.map(|p| p.0), ReleaseType::RecentFailures).await
}
pub(crate) async fn releases_failures_by_stars_handler(
page: Option<Path<i64>>,
mut conn: DbConnection,
) -> AxumResult<impl IntoResponse> {
releases_handler(&mut conn, page.map(|p| p.0), ReleaseType::Failures).await
}
pub(crate) async fn owner_handler(Path(owner): Path<String>) -> AxumResult<impl IntoResponse> {
axum_redirect(format!(
"https://crates.io/users/{}",
encode_url_path(owner.strip_prefix('@').unwrap_or(&owner))
))
.map_err(|_| AxumNope::OwnerNotFound)
}
#[derive(Template)]
#[template(path = "releases/search_results.html")]
#[derive(Debug, Clone, PartialEq)]
pub(super) struct Search {
pub(super) title: String,
pub(super) releases: Vec<ReleaseStatus>,
pub(super) search_query: Option<String>,
pub(super) search_sort_by: Option<String>,
pub(super) previous_page_link: Option<String>,
pub(super) next_page_link: Option<String>,
/// This should always be `ReleaseType::Search`
pub(super) release_type: ReleaseType,
pub(super) status: http::StatusCode,
}
impl Default for Search {
fn default() -> Self {
Self {
title: String::default(),
releases: Vec::default(),
search_query: None,
previous_page_link: None,
next_page_link: None,
search_sort_by: None,
release_type: ReleaseType::Search,
status: http::StatusCode::OK,
}
}
}
async fn redirect_to_random_crate(
config: Arc<Config>,
metrics: Arc<InstanceMetrics>,
conn: &mut sqlx::PgConnection,
) -> AxumResult<impl IntoResponse + use<>> {
// We try to find a random crate and redirect to it.
//
// The query is efficient, but relies on a static factor which depends
// on the amount of crates with > 100 GH stars over the amount of all crates.
//
// If random-crate-searches end up being empty, increase that value.
let row = sqlx::query!(
"WITH params AS (
-- get maximum possible id-value in crates-table
SELECT last_value AS max_id FROM crates_id_seq
)
SELECT
crates.name,
releases.version,
releases.target_name
FROM (
-- generate random numbers in the ID-range.
SELECT DISTINCT 1 + trunc(random() * params.max_id)::INTEGER AS id
FROM params, generate_series(1, $1)
) AS r
INNER JOIN crates ON r.id = crates.id
INNER JOIN releases ON crates.latest_version_id = releases.id
INNER JOIN repositories ON releases.repository_id = repositories.id
WHERE
releases.rustdoc_status = TRUE AND
repositories.stars >= 100
LIMIT 1",
config.random_crate_search_view_size as i32,
)
.fetch_optional(&mut *conn)
.await
.context("error fetching random crate")?;
if let Some(row) = row {
metrics.im_feeling_lucky_searches.inc();
Ok(axum_redirect(format!(
"/{}/{}/{}/",
row.name,
row.version,
row.target_name
.expect("we only look at releases with docs, so target_name will exist")
))?)
} else {
report_error(&anyhow!("found no result in random crate search"));
Err(AxumNope::NoResults)
}
}
impl_axum_webpage! {
Search,
status = |search| search.status,
}
pub(crate) async fn search_handler(
mut conn: DbConnection,
Extension(config): Extension<Arc<Config>>,
Extension(registry): Extension<Arc<RegistryApi>>,
Extension(metrics): Extension<Arc<InstanceMetrics>>,
Query(mut params): Query<HashMap<String, String>>,
) -> AxumResult<AxumResponse> {
let mut query = params
.get("query")
.map(|q| q.to_string())
.unwrap_or_else(|| "".to_string());
let mut sort_by = params
.get("sort")
.map(|q| q.to_string())
.unwrap_or_else(|| "relevance".to_string());
// check if I am feeling lucky button pressed and redirect user to crate page
// if there is a match. Also check for paths to items within crates.
if params.remove("i-am-feeling-lucky").is_some() || query.contains("::") {
// redirect to a random crate if query is empty
if query.is_empty() {
return Ok(redirect_to_random_crate(config, metrics, &mut conn)
.await?
.into_response());
}
let mut queries = BTreeMap::new();
let krate = match query.split_once("::") {
Some((krate, query)) => {
queries.insert("search".into(), query.into());
krate
}
None => &query,
};
// since we never pass a version into `match_version` here, we'll never get
// `MatchVersion::Exact`, so the distinction between `Exact` and `Semver` doesn't
// matter
if let Ok(matchver) = match_version(&mut conn, krate, &ReqVersion::Latest)
.await
.map(|matched_release| matched_release.into_exactly_named())
{
params.remove("query");
queries.extend(params);
let uri = if matchver.rustdoc_status() {
axum_parse_uri_with_params(
&format!(
"/{}/{}/{}/",
matchver.name,
matchver.version(),
matchver
.target_name()
.expect("target name will exist when rustdoc_status is true"),
),
queries,
)?
} else {
format!("/crate/{}/{}", matchver.name, matchver.version())
.parse::<http::Uri>()
.context("could not parse redirect URI")?
};
return Ok(super::axum_redirect(uri)?.into_response());
}
}
let search_result = if let Some(paginate) = params.get("paginate") {
let decoded = b64.decode(paginate.as_bytes()).map_err(|e| {
warn!("error when decoding pagination base64 string \"{paginate}\": {e:?}");
AxumNope::NoResults
})?;
let query_params = String::from_utf8_lossy(&decoded);
let query_params = query_params.strip_prefix('?').ok_or_else(|| {
// sometimes we see plain bytes being passed to `paginate`.
// In these cases we just return `NoResults` and don't call
// the crates.io API.
// The whole point of the `paginate` design is that we don't
// know anything about the pagination args and crates.io can
// change them as they wish, so we cannot do any more checks here.
warn!("didn't get query args in `paginate` arguments for search: \"{query_params}\"");
AxumNope::NoResults
})?;
for (k, v) in form_urlencoded::parse(query_params.as_bytes()) {
match &*k {
"q" => query = v.to_string(),
"sort" => sort_by = v.to_string(),
_ => {}
}
}
get_search_results(&mut conn, ®istry, query_params).await?
} else if !query.is_empty() {
let query_params: String = form_urlencoded::Serializer::new(String::new())
.append_pair("q", &query)
.append_pair("sort", &sort_by)
.append_pair("per_page", &RELEASES_IN_RELEASES.to_string())
.finish();
get_search_results(&mut conn, ®istry, &query_params).await?
} else {
return Err(AxumNope::NoResults);
};
let title = if search_result.results.is_empty() {
format!("No results found for '{query}'")
} else {
format!("Search results for '{query}'")
};
Ok(Search {
title,
releases: search_result.results,
search_query: Some(query),
search_sort_by: Some(sort_by),
next_page_link: search_result
.next_page
.map(|params| format!("/releases/search?paginate={}", b64.encode(params))),
previous_page_link: search_result
.prev_page
.map(|params| format!("/releases/search?paginate={}", b64.encode(params))),
..Default::default()
}
.into_response())
}
#[derive(Template)]
#[template(path = "releases/activity.html")]
#[derive(Debug, Clone, PartialEq)]
struct ReleaseActivity {
description: &'static str,
dates: Vec<String>,
counts: Vec<i64>,
failures: Vec<i64>,
}
impl_axum_webpage! { ReleaseActivity }
pub(crate) async fn activity_handler(mut conn: DbConnection) -> AxumResult<impl IntoResponse> {
let rows: Vec<_> = sqlx::query!(
r#"WITH dates AS (
-- we need this series so that days in the statistic that don't have any releases are included
SELECT generate_series(
CURRENT_DATE - INTERVAL '30 days',
CURRENT_DATE - INTERVAL '1 day',
'1 day'::interval
)::date AS date_
),
release_stats AS (
SELECT
release_time::date AS date_,
SUM(CAST(
release_build_status.build_status != 'in_progress' AS INT
)) AS counts,
SUM(CAST((
is_library = TRUE AND
release_build_status.build_status = 'failure'
) AS INT)) AS failures
FROM releases
INNER JOIN release_build_status ON releases.id = release_build_status.rid
WHERE
release_time >= CURRENT_DATE - INTERVAL '30 days' AND
release_time < CURRENT_DATE
GROUP BY
release_time::date
)
SELECT
dates.date_ AS "date!",
COALESCE(rs.counts, 0) AS "counts!",
COALESCE(rs.failures, 0) AS "failures!"
FROM
dates
LEFT OUTER JOIN Release_stats AS rs ON dates.date_ = rs.date_
ORDER BY
dates.date_
"#)
.fetch(&mut *conn)
.try_collect().await.context("error fetching data")?;
Ok(ReleaseActivity {
description: "Monthly release activity",
dates: rows
.iter()
.map(|row| row.date.format("%d %b").to_string())
.collect(),
counts: rows.iter().map(|rows| rows.counts).collect(),
failures: rows.iter().map(|rows| rows.failures).collect(),
})
}
#[derive(Template)]
#[template(path = "releases/build_queue.html")]
#[derive(Debug, Clone, PartialEq, Serialize)]
struct BuildQueuePage {
description: &'static str,
queue: Vec<QueuedCrate>,
rebuild_queue: Vec<QueuedCrate>,
active_cdn_deployments: Vec<String>,
in_progress_builds: Vec<(String, String)>,
expand_rebuild_queue: bool,
}
impl_axum_webpage! { BuildQueuePage }
#[derive(Deserialize)]
pub(crate) struct BuildQueueParams {
expand: Option<String>,
}
pub(crate) async fn build_queue_handler(
Extension(build_queue): Extension<Arc<AsyncBuildQueue>>,
mut conn: DbConnection,
Query(params): Query<BuildQueueParams>,
) -> AxumResult<impl IntoResponse> {
let mut active_cdn_deployments: Vec<_> = cdn::queued_or_active_crate_invalidations(&mut conn)
.await?
.into_iter()
.map(|i| i.krate)
.collect();
// deduplicate the list of crates while keeping their order
let mut set = HashSet::new();
active_cdn_deployments.retain(|k| set.insert(k.clone()));
// reverse the list, so the oldest comes first
active_cdn_deployments.reverse();
let in_progress_builds: Vec<(String, String)> = sqlx::query!(
r#"SELECT
crates.name,
releases.version
FROM builds
INNER JOIN releases ON releases.id = builds.rid
INNER JOIN crates ON releases.crate_id = crates.id
WHERE
builds.build_status = 'in_progress'
ORDER BY builds.id ASC"#
)
.fetch_all(&mut *conn)
.await?
.into_iter()
.map(|rec| (rec.name, rec.version))
.collect();
let mut rebuild_queue = Vec::new();
let mut queue = build_queue
.queued_crates()
.await?
.into_iter()
.filter(|krate| {
!in_progress_builds.iter().any(|(name, version)| {
// use `.any` instead of `.contains` to avoid cloning name& version for the match
*name == krate.name && *version == krate.version
})
})
.collect_vec();
queue.retain_mut(|krate| {
if krate.priority >= REBUILD_PRIORITY {
rebuild_queue.push(krate.clone());
false
} else {
// The priority here is inverted: in the database if a crate has a higher priority it
// will be built after everything else, which is counter-intuitive for people not
// familiar with docs.rs's inner workings.
krate.priority = -krate.priority;
true
}
});
Ok(BuildQueuePage {
description: "crate documentation scheduled to build & deploy",
queue,
rebuild_queue,
active_cdn_deployments,
in_progress_builds,
expand_rebuild_queue: params.expand.is_some(),
})
}
#[cfg(test)]
mod tests {
use super::*;
use crate::db::types::BuildStatus;
use crate::db::{finish_build, initialize_build, initialize_crate, initialize_release};
use crate::registry_api::{CrateOwner, OwnerKind};
use crate::test::{
AxumResponseTestExt, AxumRouterTestExt, FakeBuild, async_wrapper,
fake_release_that_failed_before_build,
};
use anyhow::Error;
use chrono::{Duration, TimeZone};
use kuchikiki::traits::TendrilSink;
use mockito::Matcher;
use reqwest::StatusCode;
use serde_json::json;
use test_case::test_case;
#[test]
fn test_release_list_with_incomplete_release_and_successful_build() {
async_wrapper(|env| async move {
let db = env.async_db().await;
let mut conn = db.async_conn().await;
let crate_id = initialize_crate(&mut conn, "foo").await?;
let release_id = initialize_release(&mut conn, crate_id, "0.1.0").await?;
let build_id = initialize_build(&mut conn, release_id).await?;
finish_build(
&mut conn,
build_id,
"rustc-version",
"docs.rs 4.0.0",
BuildStatus::Success,
None,
None,
)
.await?;
let releases = get_releases(&mut conn, 1, 10, Order::ReleaseTime, false).await?;
assert_eq!(
vec!["foo"],
releases
.iter()
.map(|release| release.name.as_str())
.collect::<Vec<_>>(),
);
Ok(())
})
}
#[test]
fn get_releases_by_stars() {
async_wrapper(|env| async move {
let db = env.async_db().await;
env.fake_release()
.await
.name("foo")
.version("1.0.0")
.github_stats("ghost/foo", 10, 10, 10)
.create()
.await?;
env.fake_release()
.await
.name("bar")
.version("1.0.0")
.github_stats("ghost/bar", 20, 20, 20)
.create()
.await?;
env.fake_release()
.await
.name("bar")
.version("1.0.0")
.github_stats("ghost/bar", 20, 20, 20)
.create()
.await?;
// release without stars will not be shown
env.fake_release()
.await
.name("baz")
.version("1.0.0")
.create()
.await?;
// release with only in-progress build (= in progress release) will not be shown
env.fake_release()
.await
.name("in_progress")
.version("0.1.0")
.builds(vec![
FakeBuild::default()
.build_status(BuildStatus::InProgress)
.rustc_version("rustc (blabla 2022-01-01)")
.docsrs_version("docs.rs 4.0.0"),
])
.create()
.await?;
let releases =
get_releases(&mut *db.async_conn().await, 1, 10, Order::GithubStars, true)
.await
.unwrap();
assert_eq!(
vec![
"bar", // 20 stars
"foo", // 10 stars
],
releases
.iter()
.map(|release| release.name.as_str())
.collect::<Vec<_>>(),
);
Ok(())
})
}
#[test]
fn search_im_feeling_lucky_with_query_redirect_to_crate_page() {
async_wrapper(|env| async move {
let web = env.web_app().await;
env.fake_release()
.await
.name("some_random_crate")
.build_result_failed()
.create()
.await?;
env.fake_release()
.await
.name("some_other_crate")
.create()
.await?;
web.assert_redirect(
"/releases/search?query=some_random_crate&i-am-feeling-lucky=1",
"/crate/some_random_crate/1.0.0",
)
.await?;
Ok(())
})
}
#[test]
fn search_im_feeling_lucky_with_query_redirect_to_docs() {
async_wrapper(|env| async move {
let web = env.web_app().await;
env.fake_release()
.await
.name("some_random_crate")
.create()
.await?;
env.fake_release()
.await
.name("some_other_crate")
.create()
.await?;
web.assert_redirect(
"/releases/search?query=some_random_crate&i-am-feeling-lucky=1",
"/some_random_crate/1.0.0/some_random_crate/",
)
.await?;
Ok(())
})
}
#[test]
fn im_feeling_lucky_with_stars() {
async_wrapper(|env| async move {
// The normal test-setup will offset all primary sequences by 10k
// to prevent errors with foreign key relations.
// Random-crate-search relies on the sequence for the crates-table
// to find a maximum possible ID. This combined with only one actual
// crate in the db breaks this test.
// That's why we reset the id-sequence to zero for this test.
let mut conn = env.async_db().await.async_conn().await;
sqlx::query!(r#"ALTER SEQUENCE crates_id_seq RESTART WITH 1"#)
.execute(&mut *conn)
.await?;
let web = env.web_app().await;
env.fake_release()
.await
.github_stats("some/repo", 333, 22, 11)
.name("some_random_crate")
.create()
.await?;
web.assert_redirect(
"/releases/search?query=&i-am-feeling-lucky=1",
"/some_random_crate/1.0.0/some_random_crate/",
)
.await?;
Ok(())
})
}
#[test]
fn search_coloncolon_path_redirects_to_crate_docs() {
async_wrapper(|env| async move {
let web = env.web_app().await;
env.fake_release()
.await
.name("some_random_crate")
.create()
.await?;
env.fake_release()
.await
.name("some_other_crate")
.create()
.await?;
web.assert_redirect(
"/releases/search?query=some_random_crate::somepath",
"/some_random_crate/1.0.0/some_random_crate/?search=somepath",