rustyscript 0.12.3

Effortless JS Integration for Rust
Documentation
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
#![allow(unused_imports)]
#![allow(deprecated)]
#![allow(dead_code)]

use std::{
    cell::RefCell,
    collections::{HashMap, HashSet},
    path::Path,
    path::PathBuf,
    rc::Rc,
    sync::{Arc, RwLock},
};

use deno_core::{
    error::{AnyError, ModuleLoaderError},
    futures::FutureExt,
    url::ParseError,
    FastString, ModuleLoadResponse, ModuleResolutionError, ModuleSource, ModuleSourceCode,
    ModuleSpecifier, ModuleType,
};
use deno_error::JsErrorBox;

use crate::{
    module_loader::{ClonableSource, ModuleCacheProvider},
    traits::ToModuleSpecifier,
    transpiler::{transpile, transpile_extension, ExtensionTranspilation},
    Error,
};

#[cfg(feature = "node_experimental")]
use crate::ext::node::resolvers::{RustyNpmPackageFolderResolver, RustyResolver};
#[cfg(feature = "node_experimental")]
use crate::ext::node::NodeCodeTranslator;
#[cfg(feature = "node_experimental")]
use deno_node::NodeResolver;
#[cfg(feature = "node_experimental")]
use node_resolver::InNpmPackageChecker;
#[cfg(feature = "node_experimental")]
use node_resolver::{NodeResolutionKind, ResolutionMode};

use super::ImportProvider;

/// Stores the source code and source ma#![allow(deprecated)]p for loaded modules
type SourceMapCache = HashMap<String, (String, Option<Vec<u8>>)>;

/// Options for the `RustyLoader` struct
/// Not for public use
#[derive(Default)]
pub struct LoaderOptions {
    /// An optional cache provider to manage module code caching
    pub cache_provider: Option<Box<dyn ModuleCacheProvider>>,

    /// A whitelist of module specifiers that are always allowed to be loaded from the filesystem
    pub fs_whitelist: HashSet<String>,

    /// A cache for source maps for loaded modules
    /// Used for error message generation
    pub source_map_cache: SourceMapCache,

    /// A resolver for node modules
    #[cfg(feature = "node_experimental")]
    pub node_resolver: Arc<RustyResolver>,

    /// An optional import provider to manage module resolution
    pub import_provider: Option<Box<dyn ImportProvider>>,

    /// A whitelist of custom schema prefixes that are allowed to be loaded
    pub schema_whlist: HashSet<String>,

    /// The current working directory for the loader
    pub cwd: PathBuf,
}

#[cfg(feature = "node_experimental")]
struct NodeProvider {
    rusty_resolver: Arc<RustyResolver>,
    node_resolver: Arc<
        NodeResolver<
            deno_resolver::npm::DenoInNpmPackageChecker,
            RustyNpmPackageFolderResolver,
            sys_traits::impls::RealSys,
        >,
    >,
    code_translator: Rc<NodeCodeTranslator>,
}
#[cfg(feature = "node_experimental")]
impl NodeProvider {
    pub fn new(resolver: Arc<RustyResolver>) -> Self {
        let node_resolver = resolver.node_resolver();
        let code_translator = Rc::new(resolver.code_translator(node_resolver.clone()));
        Self {
            rusty_resolver: resolver,
            node_resolver,
            code_translator,
        }
    }
}

/// Internal implementation of the module loader
/// Stores the cache provider, filesystem whitelist, and source map cache
/// Unlike the outer loader, this struture does not need to rely on inner mutability
///
/// Not for public use
pub struct InnerRustyLoader {
    cache_provider: Option<Box<dyn ModuleCacheProvider>>,
    fs_whlist: HashSet<String>,
    source_map_cache: SourceMapCache,
    import_provider: Option<Box<dyn ImportProvider>>,
    schema_whlist: HashSet<String>,
    cwd: PathBuf,

    #[cfg(feature = "node_experimental")]
    node: NodeProvider,
}

impl InnerRustyLoader {
    /// Creates a new instance of `InnerRustyLoader`
    /// An optional cache provider can be provided to manage module code caching, as well as an import provider to manage module resolution.
    pub fn new(options: LoaderOptions) -> Self {
        Self {
            cache_provider: options.cache_provider,
            fs_whlist: options.fs_whitelist,
            source_map_cache: options.source_map_cache,
            import_provider: options.import_provider,
            schema_whlist: options.schema_whlist,
            cwd: options.cwd,

            #[cfg(feature = "node_experimental")]
            node: NodeProvider::new(options.node_resolver),
        }
    }

    /// Sets the current working directory for the loader
    pub fn set_current_dir(&mut self, cwd: PathBuf) {
        self.cwd = cwd;
    }

    /// Adds a module specifier to the whitelist
    /// This allows the module to be loaded from the filesystem
    /// If they are included from rust first
    pub fn whitelist_add(&mut self, specifier: &str) {
        self.fs_whlist.insert(specifier.to_string());
    }

    /// Checks if a module specifier is in the whitelist
    /// Used to determine if a module can be loaded from the filesystem
    /// or not if `fs_import` is disabled
    pub fn whitelist_has(&self, specifier: &str) -> bool {
        self.fs_whlist.contains(specifier)
    }

    #[allow(clippy::unused_self)]
    pub fn transpile_extension(
        &self,
        specifier: &FastString,
        code: &FastString,
    ) -> Result<ExtensionTranspilation, JsErrorBox> {
        let specifier = specifier
            .as_str()
            .to_module_specifier(&self.cwd)
            .map_err(|e| JsErrorBox::from_err(std::io::Error::other(e)))?;
        let code = code.as_str();
        transpile_extension(&specifier, code)
    }

    pub fn resolve(
        &mut self,
        specifier: &str,
        referrer: &str,
        kind: deno_core::ResolutionKind,
    ) -> Result<ModuleSpecifier, ModuleLoaderError> {
        #[cfg(feature = "node_experimental")]
        let referrer_specifier = if deno_core::specifier_has_uri_scheme(referrer) {
            deno_core::resolve_url(referrer).map_err(JsErrorBox::from_err)?
        } else {
            referrer
                .to_module_specifier(&self.cwd)
                .map_err(JsErrorBox::from_err)?
        };

        //
        // Handle import aliasing for node imports
        #[cfg(feature = "node_experimental")]
        if let Some(alias) = self.handle_alias(specifier, referrer)? {
            return Ok(alias);
        }

        //
        // Handle built-in node modules
        #[cfg(feature = "node_experimental")]
        if is_builtin_node_module(specifier) {
            return self.load_npm(specifier, referrer);
        }

        //
        // Use node resolution if we're in an npm package
        #[cfg(feature = "node_experimental")]
        if referrer_specifier.scheme() == "file"
            && self.node.rusty_resolver.in_npm_package(&referrer_specifier)
        {
            return self.load_npm(specifier, referrer);
        }

        // Resolve the module specifier to an absolute URL
        let url =
            deno_core::resolve_import(specifier, referrer).map_err(ModuleLoaderError::from_err)?;

        // Check if the module is in the cache
        if self
            .cache_provider
            .as_ref()
            .is_some_and(|c| c.get(&url).is_some())
        {
            return Ok(url);
        }

        // Check if the import provider allows the import
        if let Some(import_provider) = &mut self.import_provider {
            let resolve_result = import_provider.resolve(&url, referrer, kind);
            if let Some(result) = resolve_result {
                return result;
            }
        }

        if referrer == "." {
            // Added from rust, add to the whitelist
            // so we can load it from the filesystem
            self.whitelist_add(url.as_str());
        }

        // We check permissions first
        match url.scheme() {
            // Remote fetch imports
            "https" | "http" => {
                #[cfg(not(feature = "url_import"))]
                return Err(JsErrorBox::from_err(Error::Runtime(format!(
                    "{specifier} imports are not allowed here"
                ))));
            }

            // Dynamic FS imports
            "file" =>
            {
                #[cfg(not(feature = "fs_import"))]
                if !self.whitelist_has(url.as_str()) {
                    return Err(JsErrorBox::from_err(Error::Runtime(format!(
                        "module {url} is not loaded"
                    ))));
                }
            }

            _ if specifier.starts_with("ext:") => {
                // Extension import - allow
            }

            #[cfg(feature = "node_experimental")]
            _ if specifier.starts_with("npm:") || specifier.starts_with("node:") => {
                return self.load_npm(specifier, referrer);
            }

            _ if self.schema_whlist.iter().any(|s| specifier.starts_with(s)) => {
                // Custom schema whitelist import - allow
            }

            _ => {
                let error = Error::Runtime(format!("unsupported scheme: {}", url.scheme()));
                return Err(JsErrorBox::from_err(error));
            }
        }

        Ok(url)
    }

    pub fn load(
        inner: Rc<RefCell<Self>>,
        module_specifier: &ModuleSpecifier,
        maybe_referrer: Option<&ModuleSpecifier>,
        is_dyn_import: bool,
        requested_module_type: deno_core::RequestedModuleType,
    ) -> deno_core::ModuleLoadResponse {
        let module_specifier = module_specifier.clone();
        let maybe_referrer = maybe_referrer.cloned();

        // Check if the module is in the cache first
        if let Some(cache) = &inner.borrow().cache_provider {
            if let Some(source) = cache.get(&module_specifier) {
                return deno_core::ModuleLoadResponse::Sync(Ok(source));
            }
        }

        // Next check the import provider
        let provider_result = inner.borrow_mut().import_provider.as_mut().and_then(|p| {
            p.import(
                &module_specifier,
                maybe_referrer.as_ref(),
                is_dyn_import,
                requested_module_type,
            )
        });
        if let Some(result) = provider_result {
            return ModuleLoadResponse::Async(
                async move {
                    Self::handle_load(inner, module_specifier, |_, _| async move { result }).await
                }
                .boxed_local(),
            );
        }

        // We check permissions next
        match module_specifier.scheme() {
            // Remote fetch imports
            #[cfg(feature = "url_import")]
            "https" | "http" => ModuleLoadResponse::Async(
                async move { Self::handle_load(inner, module_specifier, Self::load_remote).await }
                    .boxed_local(),
            ),

            // FS imports
            "file" => ModuleLoadResponse::Async(
                async move { Self::handle_load(inner, module_specifier, Self::load_file).await }
                    .boxed_local(),
            ),

            // Default deny-all
            x => {
                let error =
                    Error::Runtime(format!("unsupported scheme: {x} for {module_specifier}"));
                ModuleLoadResponse::Sync(Err(JsErrorBox::from_err(error)))
            }
        }
    }

    #[allow(unused_variables)]
    #[allow(clippy::unused_async)]
    pub async fn translate_cjs(
        inner: Rc<RefCell<Self>>,
        module_specifier: ModuleSpecifier,
        content: String,
    ) -> Result<String, Error> {
        #[cfg(not(feature = "node_experimental"))]
        {
            Ok(content)
        }

        #[cfg(feature = "node_experimental")]
        {
            let is_npm = inner
                .borrow()
                .node
                .rusty_resolver
                .in_npm_package(&module_specifier);
            if is_npm {
                let translator = inner.borrow().node.code_translator.clone();

                let source = translator
                    .translate_cjs_to_esm(
                        &module_specifier,
                        Some(std::borrow::Cow::Borrowed(&content)),
                    )
                    .await?
                    .into_owned();
                Ok(source)
            } else {
                Ok(content)
            }
        }
    }

    #[cfg(feature = "node_experimental")]
    fn handle_alias(
        &self,
        specifier: &str,
        referrer: &str,
    ) -> Result<Option<ModuleSpecifier>, ModuleLoaderError> {
        if specifier.starts_with('#') {
            let referrer = if deno_core::specifier_has_uri_scheme(referrer) {
                deno_core::resolve_url(referrer).map_err(JsErrorBox::from_err)?
            } else {
                referrer
                    .to_module_specifier(&self.cwd)
                    .map_err(JsErrorBox::from_err)?
            };

            let Ok(referrer_path) = referrer.to_file_path() else {
                return Ok(None);
            };

            let package = self
                .node
                .rusty_resolver
                .package_json_resolver()
                .get_closest_package_json(&referrer_path)
                .map_err(JsErrorBox::from_err)?;
            if let Some(package) = package {
                let referrer = node_resolver::UrlOrPathRef::from_url(&referrer);
                let url = self
                    .node
                    .node_resolver
                    .resolve_package_import(
                        specifier,
                        Some(&referrer),
                        Some(&package),
                        ResolutionMode::Import,
                        NodeResolutionKind::Execution,
                    )
                    .map_err(JsErrorBox::from_err)?;

                let url = match url {
                    node_resolver::UrlOrPath::Url(url) => url,
                    node_resolver::UrlOrPath::Path(path) => {
                        let url = format!("file://{}", path.to_string_lossy());
                        deno_core::resolve_url(&url).map_err(JsErrorBox::from_err)?
                    }
                };

                return Ok(Some(url));
            }
        }

        Ok(None)
    }

    #[cfg(feature = "node_experimental")]
    fn load_npm(
        &self,
        specifier: &str,
        referrer: &str,
    ) -> Result<ModuleSpecifier, ModuleLoaderError> {
        let referrer = if deno_core::specifier_has_uri_scheme(referrer) {
            deno_core::resolve_url(referrer).map_err(JsErrorBox::from_err)?
        } else {
            referrer
                .to_module_specifier(&self.cwd)
                .map_err(JsErrorBox::from_err)?
        };

        // Strip the scheme from the specifier
        let (_, specifier) = specifier.split_once(':').unwrap_or(("", specifier));

        let resolution = self
            .node
            .node_resolver
            .resolve(
                specifier,
                &referrer,
                ResolutionMode::Import,
                NodeResolutionKind::Execution,
            )
            .map_err(JsErrorBox::from_err)?;
        let url = resolution.into_url().map_err(JsErrorBox::from_err)?;

        Ok(url)
    }

    #[allow(unused_variables)]
    async fn load_file(
        inner: Rc<RefCell<Self>>,
        module_specifier: ModuleSpecifier,
    ) -> Result<String, ModuleLoaderError> {
        let path = module_specifier.to_file_path().map_err(|()| {
            JsErrorBox::from_err(Error::Runtime(format!(
                "{module_specifier} is not a file path"
            )))
        })?;
        let content = tokio::fs::read_to_string(path)
            .await
            .map_err(ModuleLoaderError::from_err)?;
        let content = Self::translate_cjs(inner, module_specifier, content)
            .await
            .map_err(ModuleLoaderError::from_err)?;

        Ok(content)
    }

    #[cfg(feature = "url_import")]
    async fn load_remote(
        _: Rc<RefCell<Self>>,
        module_specifier: ModuleSpecifier,
    ) -> Result<String, ModuleLoaderError> {
        let response = reqwest::get(module_specifier)
            .await
            .map_err(|e| ModuleLoaderError::generic(e.to_string()))?;
        let response = response
            .text()
            .await
            .map_err(|e| ModuleLoaderError::generic(e.to_string()))?;
        Ok(response)
    }

    /// Loads a module's source code from the cache or from the provided handler
    async fn handle_load<F, Fut>(
        inner: Rc<RefCell<Self>>,
        module_specifier: ModuleSpecifier,
        handler: F,
    ) -> Result<ModuleSource, ModuleLoaderError>
    where
        F: FnOnce(Rc<RefCell<Self>>, ModuleSpecifier) -> Fut,
        Fut: std::future::Future<Output = Result<String, ModuleLoaderError>>,
    {
        // Check if the module is in the cache first
        if let Some(Some(source)) = inner
            .borrow()
            .cache_provider
            .as_ref()
            .map(|p| p.get(&module_specifier))
        {
            return Ok(source);
        }

        //
        // Not in the cache, load the module from the handler
        //

        // Get the module type first
        let extension = Path::new(module_specifier.path())
            .extension()
            .unwrap_or_default();
        let module_type = if extension.eq_ignore_ascii_case("json") {
            ModuleType::Json
        } else {
            ModuleType::JavaScript
        };

        // Load the module code, and transpile it if necessary
        let code = handler(inner.clone(), module_specifier.clone()).await?;
        let (tcode, source_map) =
            transpile(&module_specifier, &code).map_err(ModuleLoaderError::from_err)?;

        // Create the module source
        let mut source = ModuleSource::new(
            module_type,
            ModuleSourceCode::String(tcode.into()),
            &module_specifier,
            None,
        );

        // Add the source to our source cache
        inner.borrow_mut().add_source_map(
            module_specifier.as_str(),
            code,
            source_map.map(|s| s.to_vec()),
        );

        // Cache the source if a cache provider is available
        // Could speed up loads on some future runtime
        if let Some(p) = &mut inner.borrow_mut().cache_provider {
            p.set(&module_specifier, source.clone(&module_specifier));
        }

        // Run import provider post-processing
        if let Some(import_provider) = &mut inner.borrow_mut().import_provider {
            source = import_provider.post_process(&module_specifier, source)?;
        }

        Ok(source)
    }

    /// Returns a reference to a file in the source map cache
    pub fn get_source_map(&self, filename: &str) -> Option<&(String, Option<Vec<u8>>)> {
        self.source_map_cache.get(filename)
    }

    /// Adds a source map to the cache
    pub fn add_source_map(&mut self, filename: &str, source: String, source_map: Option<Vec<u8>>) {
        self.source_map_cache
            .insert(filename.to_string(), (source, source_map));
    }
}

#[cfg(feature = "node_experimental")]
fn is_builtin_node_module(specifier: &str) -> bool {
    use node_resolver::IsBuiltInNodeModuleChecker;
    node_resolver::DenoIsBuiltInNodeModuleChecker.is_builtin_node_module(specifier)
}