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    fn additional_imports(
97        &self,
98        module: &Module,
99        store: &mut wasmer::StoreMut,
100    ) -> anyhow::Result<wasmer::Imports> {
101        self.runtime.additional_imports(module, store)
102    }
103
104    fn configure_new_instance(
105        &self,
106        module: &Module,
107        store: &mut wasmer::StoreMut,
108        instance: &wasmer::Instance,
109        imported_memory: Option<&wasmer::Memory>,
110    ) -> anyhow::Result<()> {
111        self.runtime
112            .configure_new_instance(module, store, instance, imported_memory)
113    }
114
115    #[cfg(feature = "journal")]
116    fn read_only_journals<'a>(
117        &'a self,
118    ) -> Box<dyn Iterator<Item = Arc<wasmer_wasix::journal::DynReadableJournal>> + 'a> {
119        self.runtime.read_only_journals()
120    }
121
122    #[cfg(feature = "journal")]
123    fn writable_journals<'a>(
124        &'a self,
125    ) -> Box<dyn Iterator<Item = Arc<wasmer_wasix::journal::DynJournal>> + 'a> {
126        self.runtime.writable_journals()
127    }
128
129    #[cfg(feature = "journal")]
130    fn active_journal(&self) -> Option<&'_ wasmer_wasix::journal::DynJournal> {
131        self.runtime.active_journal()
132    }
133
134    fn resolve_module<'a>(
135        &'a self,
136        input: ModuleInput<'a>,
137        engine: Option<&Engine>,
138        on_progress: Option<ModuleLoadProgressReporter>,
139    ) -> BoxFuture<'a, Result<Module, SpawnError>> {
140        // If a progress reporter is already provided, or quiet mode is enabled,
141        // just delegate to the inner runtime.
142        if on_progress.is_some() || self.quiet_mode {
143            return self.runtime.resolve_module(input, engine, on_progress);
144        }
145
146        // Compile with progress monitoring through the progress bar.
147
148        use std::fmt::Write as _;
149
150        let short_hash = input.hash().short_hash();
151        let progress_msg = match &input {
152            ModuleInput::Bytes(_) | ModuleInput::Hashed(_) => {
153                format!("Compiling module ({short_hash})")
154            }
155            ModuleInput::Command(cmd) => format!("Compiling {}", cmd.name()),
156        };
157
158        let pb = self.progress.clone();
159
160        let on_progress = Some(ModuleLoadProgressReporter::new({
161            let base_msg = progress_msg.clone();
162            move |prog| {
163                let msg = match prog {
164                    ModuleLoadProgress::CompilingModule(c) => {
165                        let mut msg = base_msg.clone();
166                        if let (Some(step), Some(step_count)) =
167                            (c.phase_step(), c.phase_step_count())
168                        {
169                            pb.set_length(step_count);
170                            pb.set_position(step);
171                            // Note: writing to strings can not fail.
172                            if step_count != 0 {
173                                write!(
174                                    &mut msg,
175                                    " ({:.0}%)",
176                                    100.0 * step as f32 / step_count as f32
177                                )
178                                .unwrap();
179                            }
180                        };
181                        pb.tick();
182
183                        msg
184                    }
185                    _ => base_msg.clone(),
186                };
187
188                pb.set_message(msg);
189                Ok(())
190            }
191        }));
192
193        let engine = engine.cloned();
194
195        let style = indicatif::ProgressStyle::default_bar()
196            .template("{spinner} {wide_bar:.cyan/blue} {msg}")
197            .expect("invalid progress bar template");
198        self.progress.set_style(style);
199
200        self.progress.reset();
201        if self.progress.is_hidden() {
202            self.progress
203                .set_draw_target(indicatif::ProgressDrawTarget::stderr());
204        }
205        self.progress.set_message(progress_msg);
206
207        let f = async move {
208            let res = self
209                .runtime
210                .resolve_module(input, engine.as_ref(), on_progress)
211                .await;
212
213            // Hide the progress bar and reset it to the default spinner style.
214            // Needed because future module downloads should not show a bar.
215            self.progress
216                .set_style(indicatif::ProgressStyle::default_spinner());
217            self.progress.reset();
218            self.progress.finish_and_clear();
219
220            res
221        };
222
223        Box::pin(f)
224    }
225}
226
227#[derive(Debug)]
228struct MonitoringSource {
229    inner: Arc<dyn wasmer_wasix::runtime::resolver::Source + Send + Sync>,
230    progress: ProgressBar,
231}
232
233#[async_trait::async_trait]
234impl wasmer_wasix::runtime::resolver::Source for MonitoringSource {
235    async fn query(&self, package: &PackageSource) -> Result<Vec<PackageSummary>, QueryError> {
236        self.progress.set_message(format!("Looking up {package}"));
237        self.inner.query(package).await
238    }
239}
240
241#[derive(Debug)]
242struct MonitoringPackageLoader {
243    inner: Arc<dyn wasmer_wasix::runtime::package_loader::PackageLoader + Send + Sync>,
244    progress: ProgressBar,
245}
246
247#[async_trait::async_trait]
248impl wasmer_wasix::runtime::package_loader::PackageLoader for MonitoringPackageLoader {
249    async fn load(&self, summary: &PackageSummary) -> Result<Container, Error> {
250        let pkg_id = summary.package_id();
251        self.progress.set_message(format!("Downloading {pkg_id}"));
252
253        self.inner.load(summary).await
254    }
255
256    async fn load_package_tree(
257        &self,
258        root: &Container,
259        resolution: &wasmer_wasix::runtime::resolver::Resolution,
260        root_is_local_dir: bool,
261    ) -> Result<BinaryPackage, Error> {
262        self.inner
263            .load_package_tree(root, resolution, root_is_local_dir)
264            .await
265    }
266}
wasmer_cli/commands/run/runtime.rs

wasmer_cli/commands/run/
runtime.rs
