Skip to content

Add size information on crate details page #2659

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 4 commits into from
Nov 2, 2024
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

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

82 changes: 59 additions & 23 deletions src/web/crate_details.rs
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ pub(crate) struct CrateDetails {
pub(crate) crate_id: i32,
/// Database id for this release
pub(crate) release_id: i32,
source_size: Option<i64>,
documentation_size: Option<i64>,
}

#[derive(Debug, Clone, PartialEq)]
Expand Down Expand Up @@ -134,17 +136,9 @@ impl CrateDetails {
releases.description_long,
releases.release_time,
release_build_status.build_status as "build_status!: BuildStatus",
(
-- this is the latest build ID that generated content
-- it's used to invalidate some blob storage related caches.
SELECT id
FROM builds
WHERE
builds.rid = releases.id AND
builds.build_status = 'success'
ORDER BY build_finished DESC
LIMIT 1
) AS latest_build_id,
-- this is the latest build ID that generated content
-- it's used to invalidate some blob storage related caches.
builds.id as "latest_build_id?",
releases.rustdoc_status,
releases.archive_storage,
releases.repository_url,
Expand All @@ -163,18 +157,12 @@ impl CrateDetails {
releases.license,
releases.documentation_url,
releases.default_target,
(
-- we're using the rustc version here to set the correct CSS file
-- in the metadata.
-- So we're only interested in successful builds here.
SELECT rustc_version
FROM builds
WHERE
builds.rid = releases.id AND
builds.build_status = 'success'
ORDER BY builds.build_finished
DESC LIMIT 1
) as "rustc_version?",
releases.source_size as "source_size?",
builds.documentation_size as "documentation_size?",
-- we're using the rustc version here to set the correct CSS file
-- in the metadata.
-- So we're only interested in successful builds here.
builds.rustc_version as "rustc_version?",
doc_coverage.total_items,
doc_coverage.documented_items,
doc_coverage.total_items_needing_examples,
Expand All @@ -184,6 +172,15 @@ impl CrateDetails {
INNER JOIN crates ON releases.crate_id = crates.id
LEFT JOIN doc_coverage ON doc_coverage.release_id = releases.id
LEFT JOIN repositories ON releases.repository_id = repositories.id
LEFT JOIN LATERAL (
SELECT rustc_version, documentation_size, id
FROM builds
WHERE
builds.rid = releases.id AND
builds.build_status = 'success'
ORDER BY builds.build_finished
DESC LIMIT 1
) AS builds ON true
WHERE crates.name = $1 AND releases.version = $2;"#,
name,
version.to_string(),
Expand Down Expand Up @@ -258,6 +255,8 @@ impl CrateDetails {
items_with_examples: krate.items_with_examples,
crate_id: krate.crate_id,
release_id: krate.release_id,
documentation_size: krate.documentation_size,
source_size: krate.source_size,
};

// get owners
Expand Down Expand Up @@ -442,6 +441,8 @@ struct CrateDetailsPage {
last_successful_build: Option<String>,
rustdoc: Option<String>, // this is description_long in database
csp_nonce: String,
source_size: Option<i64>,
documentation_size: Option<i64>,
}

impl CrateDetailsPage {
Expand Down Expand Up @@ -513,6 +514,8 @@ pub(crate) async fn crate_details_handler(
is_library,
last_successful_build,
rustdoc,
source_size,
documentation_size,
..
} = details;

Expand All @@ -538,6 +541,8 @@ pub(crate) async fn crate_details_handler(
last_successful_build,
rustdoc,
csp_nonce: String::new(),
source_size,
documentation_size,
}
.into_response();
res.extensions_mut()
Expand Down Expand Up @@ -2160,4 +2165,35 @@ mod tests {
Ok(())
})
}

#[test]
fn test_sizes_display() {
wrapper(|env| {
env.fake_release()
.name("dummy")
.version("0.4.0")
.rustdoc_file("dummy/index.html")
.create()?;

let response = env.frontend().get("/crate/dummy/0.4.0").send()?;
assert!(response.status().is_success());

let mut has_source_code_size = false;
let mut has_doc_size = false;
for span in kuchikiki::parse_html()
.one(response.text()?)
.select(r#".pure-menu-item span.documented-info"#)
.expect("invalid selector")
{
if span.text_contents().starts_with("Source code size:") {
has_source_code_size = true;
} else if span.text_contents().starts_with("Documentation size:") {
has_doc_size = true;
}
}
assert!(has_source_code_size);
assert!(has_doc_size);
Ok(())
});
}
}
13 changes: 12 additions & 1 deletion templates/crate/details.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,19 @@
{%- endif -%}
</li>
{%- endif -%}
<li class="pure-menu-heading">Links</li>
{%- if let Some(source_size) = source_size -%}
<li class="pure-menu-heading">Size</li>
<li class="pure-menu-item">
<span class="documented-info">Source code size: {{(*source_size)|filesizeformat}}</span>
</li>
{%- if let Some(doc_size) = documentation_size -%}
<li class="pure-menu-item">
<span class="documented-info">Documentation size: {{(*doc_size)|filesizeformat}}</span>
</li>
{%- endif -%}
{%- endif -%}

<li class="pure-menu-heading">Links</li>
{# If the crate has a homepage, show it #}
{%- if let Some(homepage_url) = homepage_url -%}
<li class="pure-menu-item">
Expand Down
Loading