Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Revert "Don't hard-code essential files in copy_doc_dir" #1329

Merged
merged 1 commit into from
Mar 23, 2021
Merged

Revert "Don't hard-code essential files in copy_doc_dir" #1329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
93 changes: 40 additions & 53 deletions src/docbuilder/rustwide_builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,20 @@ impl RustwideBuilder {
let krate = Crate::crates_io(DUMMY_CRATE_NAME, DUMMY_CRATE_VERSION);
krate.fetch(&self.workspace)?;

// TODO: remove this when https://github.com/rust-lang/rustwide/pull/53 lands.
struct Rustdoc<'a> {
toolchain_version: &'a str,
}
impl rustwide::cmd::Runnable for Rustdoc<'_> {
fn name(&self) -> Binary {
Binary::ManagedByRustwide(PathBuf::from("rustdoc"))
}

fn prepare_command<'w, 'pl>(&self, cmd: Command<'w, 'pl>) -> Command<'w, 'pl> {
cmd.args(&[format!("+{}", self.toolchain_version)])
}
}

build_dir
.build(&self.toolchain, &krate, self.prepare_sandbox(&limits))
.run(|build| {
Expand All @@ -198,14 +212,29 @@ impl RustwideBuilder {
.prefix("essential-files")
.tempdir()?;

for file_name in self.essential_files(build, &source)? {
let toolchain_version = self.toolchain.as_dist().unwrap().name();
let output = build.cmd(Rustdoc { toolchain_version })
.args(&["-Zunstable-options", "--print=unversioned-files"])
.run_capture()
.context("failed to learn about unversioned files - make sure you have nightly-2021-03-07 or later")?;
let essential_files_unversioned = output
.stdout_lines()
.iter()
.map(PathBuf::from);
let resource_suffix = format!("-{}", parse_rustc_version(&self.rustc_version)?);
let essential_files_versioned: Vec<_> = source.read_dir()?
.collect::<std::result::Result<Vec<_>, _>>()?
.into_iter()
.filter_map(|entry| {
entry.file_name().to_str().and_then(|name| if name.contains(&resource_suffix) {
Some(entry.file_name().into())
} else { None })
})
.collect();
for file_name in essential_files_unversioned.chain(essential_files_versioned) {
let source_path = source.join(&file_name);
let dest_path = dest.path().join(&file_name);
debug!(
"copying {} to {}",
source_path.display(),
dest_path.display()
);
debug!("copying {} to {}", source_path.display(), dest_path.display());
::std::fs::copy(&source_path, &dest_path).with_context(|_| {
format!(
"couldn't copy '{}' to '{}'",
Expand Down Expand Up @@ -334,7 +363,7 @@ impl RustwideBuilder {
let mut algs = HashSet::new();
if has_docs {
debug!("adding documentation for the default target to the database");
self.copy_docs(build, local_storage.path(), "", true)?;
self.copy_docs(&build.host_target_dir(), local_storage.path(), "", true)?;

successful_targets.push(res.target.clone());

Expand Down Expand Up @@ -436,7 +465,7 @@ impl RustwideBuilder {
// adding target to successfully_targets.
if build.host_target_dir().join(target).join("doc").is_dir() {
debug!("adding documentation for target {} to the database", target,);
self.copy_docs(build, local_storage, target, false)?;
self.copy_docs(&build.host_target_dir(), local_storage, target, false)?;
successful_targets.push(target.to_string());
}
}
Expand Down Expand Up @@ -609,12 +638,12 @@ impl RustwideBuilder {

fn copy_docs(
&self,
build: &Build,
target_dir: &Path,
local_storage: &Path,
target: &str,
is_default_target: bool,
) -> Result<()> {
let source = build.host_target_dir().join(target).join("doc");
let source = target_dir.join(target).join("doc");

let mut dest = local_storage.to_path_buf();
// only add target name to destination directory when we are copying a non-default target.
Expand All @@ -627,49 +656,7 @@ impl RustwideBuilder {
}

info!("{} {}", source.display(), dest.display());
let essential_files = self.essential_files(build, &source)?;
copy_doc_dir(source, dest, &essential_files)
}

fn essential_files(&self, build: &Build, doc_dir: &Path) -> Result<Vec<PathBuf>> {
// TODO: remove this when https://github.com/rust-lang/rustwide/pull/53 lands.
struct Rustdoc<'a> {
toolchain_version: &'a str,
}
impl rustwide::cmd::Runnable for Rustdoc<'_> {
fn name(&self) -> Binary {
Binary::ManagedByRustwide(PathBuf::from("rustdoc"))
}

fn prepare_command<'w, 'pl>(&self, cmd: Command<'w, 'pl>) -> Command<'w, 'pl> {
cmd.args(&[format!("+{}", self.toolchain_version)])
}
}

let toolchain_version = self.toolchain.as_dist().unwrap().name();
let output = build.cmd(Rustdoc { toolchain_version })
.args(&["-Zunstable-options", "--print=unversioned-files"])
.run_capture()
.context("failed to learn about unversioned files - make sure you have nightly-2021-03-07 or later")?;
let mut essential_files: Vec<_> = output.stdout_lines().iter().map(PathBuf::from).collect();
let resource_suffix = format!("-{}", parse_rustc_version(&self.rustc_version)?);

let essential_files_versioned = doc_dir
.read_dir()?
.collect::<std::result::Result<Vec<_>, _>>()?
.into_iter()
.filter_map(|entry| {
entry.file_name().to_str().and_then(|name| {
if name.contains(&resource_suffix) {
Some(entry.file_name().into())
} else {
None
}
})
});

essential_files.extend(essential_files_versioned);
Ok(essential_files)
copy_doc_dir(source, dest)
}

fn upload_docs(
Expand Down
35 changes: 14 additions & 21 deletions src/utils/copy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,36 @@
use crate::error::Result;
use std::fs;
use std::path::{Path, PathBuf};
use std::path::Path;

use regex::Regex;

/// Copies documentation from a crate's target directory to destination.
///
/// Target directory must have doc directory.
///
/// This does not copy any files with the same name as `shared_files`.
pub fn copy_doc_dir<P: AsRef<Path>, Q: AsRef<Path>>(
source: P,
destination: Q,
shared_files: &[PathBuf],
) -> Result<()> {
/// This function is designed to avoid file duplications.
pub fn copy_doc_dir<P: AsRef<Path>, Q: AsRef<Path>>(source: P, destination: Q) -> Result<()> {
let destination = destination.as_ref();

// Make sure destination directory exists
if !destination.exists() {
fs::create_dir_all(destination)?;
}

// Avoid copying common files
let dup_regex = Regex::new(
r"(\.lock|\.txt|\.woff|\.svg|\.css|main-.*\.css|main-.*\.js|normalize-.*\.js|rustdoc-.*\.css|storage-.*\.js|theme-.*\.js)$")
.unwrap();

for file in source.as_ref().read_dir()? {
let file = file?;
let filename = file.file_name();
let destination_full_path = destination.join(&filename);
let destination_full_path = destination.join(file.file_name());

let metadata = file.metadata()?;

if metadata.is_dir() {
copy_doc_dir(file.path(), destination_full_path, shared_files)?;
continue;
}

if shared_files.contains(&PathBuf::from(filename)) {
copy_doc_dir(file.path(), destination_full_path)?
} else if dup_regex.is_match(&file.file_name().into_string().unwrap()[..]) {
continue;
} else {
fs::copy(&file.path(), &destination_full_path)?;
Expand Down Expand Up @@ -66,13 +65,7 @@ mod test {
fs::write(doc.join("inner").join("important.svg"), "<svg></svg>").unwrap();

// lets try to copy a src directory to tempdir
let ignored_files = ["index.txt".into(), "important.svg".into()];
copy_doc_dir(
source.path().join("doc"),
destination.path(),
&ignored_files,
)
.unwrap();
copy_doc_dir(source.path().join("doc"), destination.path()).unwrap();
assert!(destination.path().join("index.html").exists());
assert!(!destination.path().join("index.txt").exists());
assert!(destination.path().join("inner").join("index.html").exists());
Expand Down