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

wasmer_cli/commands/run/
runtime.rs
