wasmer_cli/commands/run/
runtime.rs

1//! Provides CLI-specific Wasix components.
2
3use std::{sync::Arc, time::Duration};
4
5use anyhow::Error;
6use futures::future::BoxFuture;
7use indicatif::ProgressBar;
8use std::io::IsTerminal as _;
9use wasmer::{Engine, Module};
10use wasmer_config::package::PackageSource;
11use wasmer_types::ModuleHash;
12use wasmer_wasix::{
13    SpawnError,
14    bin_factory::{BinaryPackage, BinaryPackageCommand},
15    runtime::{
16        ModuleInput,
17        module_cache::{
18            HashedModuleData,
19            progress::{ModuleLoadProgress, ModuleLoadProgressReporter},
20        },
21        resolver::{PackageSummary, QueryError},
22    },
23};
24use webc::Container;
25
26/// Special wasix runtime implementation for the CLI.
27///
28/// Wraps an undelrying runtime and adds progress monitoring for package
29/// compilation.
30#[derive(Debug)]
31pub struct MonitoringRuntime<R> {
32    pub runtime: Arc<R>,
33    progress: ProgressBar,
34    quiet_mode: bool,
35}
36
37impl<R> MonitoringRuntime<R> {
38    pub fn new(runtime: R, progress: ProgressBar, quiet_mode: bool) -> Self {
39        MonitoringRuntime {
40            runtime: Arc::new(runtime),
41            progress,
42            quiet_mode,
43        }
44    }
45}
46
47impl<R: wasmer_wasix::Runtime + Send + Sync> wasmer_wasix::Runtime for MonitoringRuntime<R> {
48    fn networking(&self) -> &virtual_net::DynVirtualNetworking {
49        self.runtime.networking()
50    }
51
52    fn task_manager(&self) -> &Arc<dyn wasmer_wasix::VirtualTaskManager> {
53        self.runtime.task_manager()
54    }
55
56    fn package_loader(
57        &self,
58    ) -> Arc<dyn wasmer_wasix::runtime::package_loader::PackageLoader + Send + Sync> {
59        let inner = self.runtime.package_loader();
60        Arc::new(MonitoringPackageLoader {
61            inner,
62            progress: self.progress.clone(),
63        })
64    }
65
66    fn module_cache(
67        &self,
68    ) -> Arc<dyn wasmer_wasix::runtime::module_cache::ModuleCache + Send + Sync> {
69        self.runtime.module_cache()
70    }
71
72    fn source(&self) -> Arc<dyn wasmer_wasix::runtime::resolver::Source + Send + Sync> {
73        let inner = self.runtime.source();
74        Arc::new(MonitoringSource {
75            inner,
76            progress: self.progress.clone(),
77        })
78    }
79
80    fn engine(&self) -> Engine {
81        self.runtime.engine()
82    }
83
84    fn new_store(&self) -> wasmer::Store {
85        self.runtime.new_store()
86    }
87
88    fn http_client(&self) -> Option<&wasmer_wasix::http::DynHttpClient> {
89        self.runtime.http_client()
90    }
91
92    fn tty(&self) -> Option<&(dyn wasmer_wasix::os::TtyBridge + Send + Sync)> {
93        self.runtime.tty()
94    }
95
96    #[cfg(feature = "journal")]
97    fn read_only_journals<'a>(
98        &'a self,
99    ) -> Box<dyn Iterator<Item = Arc<wasmer_wasix::journal::DynReadableJournal>> + 'a> {
100        self.runtime.read_only_journals()
101    }
102
103    #[cfg(feature = "journal")]
104    fn writable_journals<'a>(
105        &'a self,
106    ) -> Box<dyn Iterator<Item = Arc<wasmer_wasix::journal::DynJournal>> + 'a> {
107        self.runtime.writable_journals()
108    }
109
110    #[cfg(feature = "journal")]
111    fn active_journal(&self) -> Option<&'_ wasmer_wasix::journal::DynJournal> {
112        self.runtime.active_journal()
113    }
114
115    fn resolve_module<'a>(
116        &'a self,
117        input: ModuleInput<'a>,
118        engine: Option<&Engine>,
119        on_progress: Option<ModuleLoadProgressReporter>,
120    ) -> BoxFuture<'a, Result<Module, SpawnError>> {
121        // If a progress reporter is already provided, or quiet mode is enabled,
122        // just delegate to the inner runtime.
123        if on_progress.is_some() || self.quiet_mode {
124            return self.runtime.resolve_module(input, engine, on_progress);
125        }
126
127        // Compile with progress monitoring through the progress bar.
128
129        use std::fmt::Write as _;
130
131        let short_hash = input.hash().short_hash();
132        let progress_msg = match &input {
133            ModuleInput::Bytes(_) | ModuleInput::Hashed(_) => {
134                format!("Compiling module ({short_hash})")
135            }
136            ModuleInput::Command(cmd) => format!("Compiling {}", cmd.name()),
137        };
138
139        let pb = self.progress.clone();
140
141        let on_progress = Some(ModuleLoadProgressReporter::new({
142            let base_msg = progress_msg.clone();
143            move |prog| {
144                let msg = match prog {
145                    ModuleLoadProgress::CompilingModule(c) => {
146                        let mut msg = base_msg.clone();
147                        if let (Some(step), Some(step_count)) =
148                            (c.phase_step(), c.phase_step_count())
149                        {
150                            pb.set_length(step_count);
151                            pb.set_position(step);
152                            // Note: writing to strings can not fail.
153                            if step_count != 0 {
154                                write!(
155                                    &mut msg,
156                                    " ({:.0}%)",
157                                    100.0 * step as f32 / step_count as f32
158                                )
159                                .unwrap();
160                            }
161                        };
162                        pb.tick();
163
164                        msg
165                    }
166                    _ => base_msg.clone(),
167                };
168
169                pb.set_message(msg);
170                Ok(())
171            }
172        }));
173
174        let engine = engine.cloned();
175
176        let style = indicatif::ProgressStyle::default_bar()
177            .template("{spinner} {wide_bar:.cyan/blue} {msg}")
178            .expect("invalid progress bar template");
179        self.progress.set_style(style);
180
181        self.progress.reset();
182        if self.progress.is_hidden() {
183            self.progress
184                .set_draw_target(indicatif::ProgressDrawTarget::stderr());
185        }
186        self.progress.set_message(progress_msg);
187
188        let f = async move {
189            let res = self
190                .runtime
191                .resolve_module(input, engine.as_ref(), on_progress)
192                .await;
193
194            // Hide the progress bar and reset it to the default spinner style.
195            // Needed because future module downloads should not show a bar.
196            self.progress
197                .set_style(indicatif::ProgressStyle::default_spinner());
198            self.progress.reset();
199            self.progress.finish_and_clear();
200
201            res
202        };
203
204        Box::pin(f)
205    }
206}
207
208#[derive(Debug)]
209struct MonitoringSource {
210    inner: Arc<dyn wasmer_wasix::runtime::resolver::Source + Send + Sync>,
211    progress: ProgressBar,
212}
213
214#[async_trait::async_trait]
215impl wasmer_wasix::runtime::resolver::Source for MonitoringSource {
216    async fn query(&self, package: &PackageSource) -> Result<Vec<PackageSummary>, QueryError> {
217        self.progress.set_message(format!("Looking up {package}"));
218        self.inner.query(package).await
219    }
220}
221
222#[derive(Debug)]
223struct MonitoringPackageLoader {
224    inner: Arc<dyn wasmer_wasix::runtime::package_loader::PackageLoader + Send + Sync>,
225    progress: ProgressBar,
226}
227
228#[async_trait::async_trait]
229impl wasmer_wasix::runtime::package_loader::PackageLoader for MonitoringPackageLoader {
230    async fn load(&self, summary: &PackageSummary) -> Result<Container, Error> {
231        let pkg_id = summary.package_id();
232        self.progress.set_message(format!("Downloading {pkg_id}"));
233
234        self.inner.load(summary).await
235    }
236
237    async fn load_package_tree(
238        &self,
239        root: &Container,
240        resolution: &wasmer_wasix::runtime::resolver::Resolution,
241        root_is_local_dir: bool,
242    ) -> Result<BinaryPackage, Error> {
243        self.inner
244            .load_package_tree(root, resolution, root_is_local_dir)
245            .await
246    }
247}
wasmer_cli/commands/run/runtime.rs

wasmer_cli/commands/run/
runtime.rs
