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
use crate::cmd::{cfg_spinner, run_stage};
use crate::install::Tools;
use crate::parse::{ExportOpts, Opts};
use crate::thread::{spawn_thread, ThreadHandle};
use crate::{errors::*, get_user_crate_name};
use console::{style, Emoji};
use indicatif::{MultiProgress, ProgressBar};
use std::fs;
use std::path::{Path, PathBuf};
// Emojis for stages
static EXPORTING: Emoji<'_, '_> = Emoji("📦", "");
static BUILDING: Emoji<'_, '_> = Emoji("🏗️ ", ""); // Yes, there's a space here, for some reason it's needed...
/// Returns the exit code if it's non-zero.
macro_rules! handle_exit_code {
($code:expr) => {
let (_, _, code) = $code;
if code != 0 {
return ::std::result::Result::Ok(code);
}
};
}
/// An internal macro for symlinking/copying files into the export package. The
/// `from` and `to` that this accepts should be extensions of the `target`, and
/// they'll be `.join()`ed on.
///
/// This will attempt to symlink, and, if that fails, it will print a warning
/// and copy normally.
///
/// For symlinking to work on Windows, developer mode must be enabled.
macro_rules! copy_file {
($from:expr, $to:expr, $target:expr) => {
// Try symlinking first
#[cfg(unix)]
if std::os::unix::fs::symlink($target.join($from), $target.join($to)).is_err() {
// That failed, try a usual copy
if let Err(err) = fs::copy($target.join($from), $target.join($to)) {
return Err(ExportError::MoveAssetFailed {
to: $to.to_string(),
from: $from.to_string(),
source: err,
});
}
}
#[cfg(windows)]
if std::os::windows::fs::symlink_file($target.join($from), $target.join($to)).is_err() {
// That failed, try a usual copy
if let Err(err) = fs::copy($target.join($from), $target.join($to)) {
return Err(ExportError::MoveAssetFailed {
to: $to.to_string(),
from: $from.to_string(),
source: err,
});
}
}
};
}
/// An internal macro for symlinking/copying directories into the export
/// package. The `from` and `to` that this accepts should be extensions of the
/// `target`, and they'll be `.join()`ed on.
///
/// This will attempt to symlink, and, if that fails, it will print a warning
/// and copy normally.
///
/// For symlinking to work on Windows, developer mode must be enabled.
macro_rules! copy_directory {
($from:expr, $to:expr, $to_symlink:expr, $target:expr) => {
// Try symlinking first
#[cfg(unix)]
if std::os::unix::fs::symlink($target.join($from), $target.join($to_symlink)).is_err() {
// That failed, try a usual copy
if let Err(err) = fs_extra::dir::copy(
$target.join($from),
$target.join($to),
&fs_extra::dir::CopyOptions::new(),
) {
return Err(ExportError::MoveDirFailed {
to: $to.to_string(),
from: $from.to_string(),
source: err,
});
}
}
#[cfg(windows)]
if std::os::windows::fs::symlink_dir($target.join($from), $target.join($to_symlink))
.is_err()
{
// That failed, try a usual copy
if let Err(err) = fs_extra::dir::copy(
$target.join($from),
$target.join($to),
&fs_extra::dir::CopyOptions::new(),
) {
return Err(ExportError::MoveDirFailed {
to: $to.to_string(),
from: $from.to_string(),
source: err,
});
}
}
};
}
/// Finalizes the export by copying assets. This is very different from the
/// finalization process of normal building.
pub fn finalize_export(target: &Path) -> Result<(), ExportError> {
// Copy files over (the directory structure should already exist from exporting
// the pages)
copy_file!(
"dist/pkg/perseus_engine.js",
"dist/exported/.perseus/bundle.js",
target
);
copy_file!(
"dist/pkg/perseus_engine_bg.wasm",
"dist/exported/.perseus/bundle.wasm",
target
);
// Copy any JS snippets over (if the directory doesn't exist though, don't do
// anything)
if fs::metadata(target.join("dist/pkg/snippets")).is_ok() {
copy_directory!(
"dist/pkg/snippets",
"dist/exported/.perseus", // For a usual copy
"dist/exported/.perseus/snippets", // For a symlink
target
);
}
Ok(())
}
/// Actually exports the user's code, program arguments having been interpreted.
/// This needs to know how many steps there are in total because the serving
/// logic also uses it. This also takes a `MultiProgress` to interact with so it
/// can be used truly atomically. This returns handles for waiting on the
/// component threads so we can use it composably.
#[allow(clippy::type_complexity)]
pub fn export_internal(
dir: PathBuf,
spinners: &MultiProgress,
num_steps: u8,
is_release: bool,
tools: &Tools,
global_opts: &Opts,
) -> Result<
(
ThreadHandle<impl FnOnce() -> Result<i32, ExportError>, Result<i32, ExportError>>,
ThreadHandle<impl FnOnce() -> Result<i32, ExportError>, Result<i32, ExportError>>,
),
ExportError,
> {
let tools = tools.clone();
let Opts {
cargo_browser_args,
cargo_engine_args,
wasm_bindgen_args,
wasm_opt_args,
verbose,
mut wasm_release_rustflags,
..
} = global_opts.clone();
let crate_name = get_user_crate_name(&dir)?;
wasm_release_rustflags.push_str(" --cfg=client");
// Exporting pages message
let ep_msg = format!(
"{} {} Exporting your app's pages",
style(format!("[1/{}]", num_steps)).bold().dim(),
EXPORTING
);
// Wasm building message
let wb_msg = format!(
"{} {} Building your app to Wasm",
style(format!("[2/{}]", num_steps)).bold().dim(),
BUILDING
);
// We parallelize the first two spinners (static generation and Wasm building)
// We make sure to add them at the top (the server spinner may have already been
// instantiated)
let ep_spinner = spinners.insert(0, ProgressBar::new_spinner());
let ep_spinner = cfg_spinner(ep_spinner, &ep_msg);
let ep_target = dir.clone();
let wb_spinner = spinners.insert(1, ProgressBar::new_spinner());
let wb_spinner = cfg_spinner(wb_spinner, &wb_msg);
let wb_target = dir;
let cargo_engine_exec = tools.cargo_engine.clone();
let ep_thread = spawn_thread(
move || {
handle_exit_code!(run_stage(
vec![&format!(
"{} run {} {}",
cargo_engine_exec,
if is_release { "--release" } else { "" },
cargo_engine_args
)],
&ep_target,
&ep_spinner,
&ep_msg,
vec![
("PERSEUS_ENGINE_OPERATION", "export"),
("CARGO_TARGET_DIR", "dist/target_engine"),
("RUSTFLAGS", "--cfg=engine"),
("CARGO_TERM_COLOR", "always")
],
verbose,
)?);
Ok(0)
},
global_opts.sequential,
);
let wb_thread = spawn_thread(
move || {
let mut cmds = vec![
// Build the Wasm artifact first (and we know where it will end up, since we're setting the target directory)
format!(
"{} build --target wasm32-unknown-unknown {} {}",
tools.cargo_browser,
if is_release { "--release" } else { "" },
cargo_browser_args
),
// NOTE The `wasm-bindgen` version has to be *identical* to the dependency version
format!(
"{cmd} ./dist/target_wasm/wasm32-unknown-unknown/{profile}/{crate_name}.wasm --out-dir dist/pkg --out-name perseus_engine --target web {args}",
cmd=tools.wasm_bindgen,
profile={ if is_release { "release" } else { "debug" } },
args=wasm_bindgen_args,
crate_name=crate_name
)
];
// If we're building for release, then we should run `wasm-opt`
if is_release {
cmds.push(format!(
"{cmd} -Oz ./dist/pkg/perseus_engine_bg.wasm -o ./dist/pkg/perseus_engine_bg.wasm {args}",
cmd=tools.wasm_opt,
args=wasm_opt_args
));
}
let cmds = cmds.iter().map(|s| s.as_str()).collect::<Vec<&str>>();
handle_exit_code!(run_stage(
cmds,
&wb_target,
&wb_spinner,
&wb_msg,
if is_release {
vec![
("CARGO_TARGET_DIR", "dist/target_wasm"),
("RUSTFLAGS", &wasm_release_rustflags),
("CARGO_TERM_COLOR", "always"),
]
} else {
vec![
("CARGO_TARGET_DIR", "dist/target_wasm"),
("RUSTFLAGS", "--cfg=client"),
("CARGO_TERM_COLOR", "always"),
]
},
verbose,
)?);
Ok(0)
},
global_opts.sequential,
);
Ok((ep_thread, wb_thread))
}
/// Builds the subcrates to get a directory that we can serve. Returns an exit
/// code.
pub fn export(
dir: PathBuf,
opts: &ExportOpts,
tools: &Tools,
global_opts: &Opts,
) -> Result<i32, ExportError> {
let spinners = MultiProgress::new();
// We'll add another not-quite-spinner if we're serving
let num_spinners = if opts.serve { 3 } else { 2 };
let (ep_thread, wb_thread) = export_internal(
dir.clone(),
&spinners,
num_spinners,
opts.release,
tools,
global_opts,
)?;
let ep_res = ep_thread
.join()
.map_err(|_| ExecutionError::ThreadWaitFailed)??;
if ep_res != 0 {
return Ok(ep_res);
}
let wb_res = wb_thread
.join()
.map_err(|_| ExecutionError::ThreadWaitFailed)??;
if wb_res != 0 {
return Ok(wb_res);
}
// And now we can run the finalization stage
finalize_export(&dir)?;
// We've handled errors in the component threads, so the exit code is now zero
Ok(0)
}