Skip to content

Crate details page: when a build has failed, display a message that links to last successful build #543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/test/fakes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ impl<'db> FakeRelease<'db> {
self
}

pub(crate) fn build_result_successful(mut self, new: bool) -> Self {
self.build_result.successful = new;
self
}

pub(crate) fn create(self) -> Result<i32, Error> {
let tempdir = tempdir::TempDir::new("docs.rs-fake")?;

Expand Down
92 changes: 92 additions & 0 deletions src/web/crate_details.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ pub struct CrateDetails {
rustdoc: Option<String>, // this is description_long in database
release_time: time::Timespec,
build_status: bool,
last_successful_build: Option<String>,
rustdoc_status: bool,
repository_url: Option<String>,
homepage_url: Option<String>,
Expand Down Expand Up @@ -69,6 +70,7 @@ impl ToJson for CrateDetails {
m.insert("release_time".to_string(),
duration_to_str(self.release_time).to_json());
m.insert("build_status".to_string(), self.build_status.to_json());
m.insert("last_successful_build".to_string(), self.last_successful_build.to_json());
m.insert("rustdoc_status".to_string(), self.rustdoc_status.to_json());
m.insert("repository_url".to_string(), self.repository_url.to_json());
m.insert("homepage_url".to_string(), self.homepage_url.to_json());
Expand Down Expand Up @@ -172,6 +174,7 @@ impl CrateDetails {
rustdoc: rows.get(0).get(8),
release_time: rows.get(0).get(9),
build_status: rows.get(0).get(10),
last_successful_build: None,
rustdoc_status: rows.get(0).get(11),
repository_url: rows.get(0).get(12),
homepage_url: rows.get(0).get(13),
Expand Down Expand Up @@ -215,6 +218,23 @@ impl CrateDetails {
crate_details.owners.push((row.get(0), row.get(1)));
}

// retrieve last successful build if build failed
if !crate_details.build_status {
let rows = conn.query(
"SELECT version
FROM releases
INNER JOIN crates ON releases.crate_id = crates.id
WHERE build_status = true AND yanked = false AND crates.name = $1
ORDER BY release_time desc
LIMIT 1;",
&[&name],
).unwrap();

if rows.len() >= 1 {
crate_details.last_successful_build = Some(rows.get(0).get(0));
}
}

Some(crate_details)
}
}
Expand Down Expand Up @@ -252,3 +272,75 @@ pub fn crate_details_handler(req: &mut Request) -> IronResult<Response> {
}
}
}

#[cfg(test)]
mod tests {
use super::*;
use crate::test::TestDatabase;
use failure::Error;

fn create_release(db: &TestDatabase, package: &str, version: &str, successful: bool) -> Result<i32, Error> {
db.fake_release()
.name(package)
.version(version)
.build_result_successful(successful)
.create()
}

fn assert_last_successful_build_equals(
db: &TestDatabase,
package: &str,
version: &str,
expected_last_successful_build: Option<&str>,
) -> Result<(), Error> {

let details = CrateDetails::new(&db.conn(), package, version)
.ok_or(failure::err_msg("could not fetch crate details"))?;

assert_eq!(
details.last_successful_build,
expected_last_successful_build.map(|s| s.to_string()),
);
Ok(())
}

#[test]
fn test_last_successful_build_when_last_release_failed() {
crate::test::with_database(|db| {
create_release(&db, "foo", "0.0.1", true)?;
create_release(&db, "foo", "0.0.2", true)?;
create_release(&db, "foo", "0.0.3", false)?;

assert_last_successful_build_equals(&db, "foo", "0.0.1", None)?;
assert_last_successful_build_equals(&db, "foo", "0.0.2", None)?;
assert_last_successful_build_equals(&db, "foo", "0.0.3", Some("0.0.2"))?;
Ok(())
});
}

#[test]
fn test_last_successful_build_when_all_releases_failed() {
crate::test::with_database(|db| {
create_release(&db, "foo", "0.0.1", false)?;
create_release(&db, "foo", "0.0.2", false)?;

assert_last_successful_build_equals(&db, "foo", "0.0.1", None)?;
assert_last_successful_build_equals(&db, "foo", "0.0.2", None)?;
Ok(())
});
}

#[test]
fn test_last_successful_build_when_an_intermittent_release_failed() {
crate::test::with_database(|db| {
create_release(&db, "foo", "0.0.1", true)?;
create_release(&db, "foo", "0.0.2", false)?;
create_release(&db, "foo", "0.0.3", true)?;

assert_last_successful_build_equals(&db, "foo", "0.0.1", None)?;
assert_last_successful_build_equals(&db, "foo", "0.0.2", Some("0.0.3"))?;
assert_last_successful_build_equals(&db, "foo", "0.0.3", None)?;
Ok(())
});
}
}
3 changes: 3 additions & 0 deletions templates/crate_details.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@
{{else}}
{{#unless build_status}}
<div class="warning">docs.rs failed to build {{name}}-{{version}}<br>Please check the <a href="/crate/{{name}}/{{version}}/builds">build logs</a> and, if you believe this is docs.rs' fault, <a href="https://github.com/rust-lang/docs.rs/issues/new/choose">open an issue</a>.</div>
{{#if last_successful_build}}
<div class="info">Visit the last successful build: <a href="/crate/{{name}}/{{last_successful_build}}">{{name}}-{{last_successful_build}}</a></div>
{{/if}}
{{else}}
{{#unless rustdoc_status}}
<div class="warning">{{name}}-{{version}} doesn't have any documentation.</div>
Expand Down
9 changes: 7 additions & 2 deletions templates/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -706,10 +706,10 @@ div.cratesfyi-package-container-rustdoc {
margin-bottom: 10px;
}

div.warning {
div.info {
font-family: $font-family-sans;
border-radius: 4px;
background-color: lighten($color-type, 45%);
background-color: $color-background-code;
padding: .4em 1em;
text-align: center;
margin-bottom: 10px;
Expand All @@ -720,6 +720,11 @@ div.warning {
}
}

div.warning {
@extend div.info;
background-color: lighten($color-type, 45%);
}

div.search-page-search-form {
padding: .4em 1em;
text-align: center;
Expand Down