cheers 0.1.0-alpha.1

Fullstack hypermedia framework for Rust.
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
use std::collections::{HashMap, HashSet};

use anyhow::{Context, Error, anyhow, bail};
use swc_bundler::{Bundler, Hook, Load, ModuleData, ModuleRecord};
use swc_common::{FileName, GLOBALS, Globals, Mark, SourceMap, Span, sync::Lrc};
use swc_ecma_ast::*;
use swc_ecma_codegen::{
    Emitter,
    text_writer::{JsWriter, WriteJs, omit_trailing_semi},
};
use swc_ecma_loader::{resolve::Resolve, resolvers::lru::CachingResolver};
use swc_ecma_minifier::option::{CompressOptions, ExtraOptions, MangleOptions, MinifyOptions};
use swc_ecma_parser::{Syntax, parse_file_as_module};
use swc_ecma_transforms_base::fixer::fixer;
use swc_ecma_transforms_typescript::typescript;
use swc_ecma_visit::VisitMutWith;

/// Semantic bundling profile.
///
/// Keep this enum high-level: callers should choose the kind of JavaScript they are producing,
/// not tune SWC's individual compression and mangling booleans.
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum BundleProfile {
    /// Cheers-owned runtime module where all call sites are inside the bundle.
    ///
    /// Enables tree-shaking plus aggressive SWC compression and mangling, including top-level
    /// names.
    Runtime,

    /// Application-owned classic script loaded with a normal `<script>` tag.
    ///
    /// Performs syntax minification only. Top-level declarations and externally visible names are
    /// preserved because inline/event scripts or later classic scripts may reference them.
    ClassicScript,
}

/// Options for [`bundle`].
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub struct BundleOptions {
    pub profile: BundleProfile,
}

impl BundleOptions {
    pub const fn runtime() -> Self {
        Self {
            profile: BundleProfile::Runtime,
        }
    }

    pub const fn classic_script() -> Self {
        Self {
            profile: BundleProfile::ClassicScript,
        }
    }
}

impl Default for BundleOptions {
    fn default() -> Self {
        Self::runtime()
    }
}

impl BundleProfile {
    const fn disable_dce(self) -> bool {
        match self {
            Self::Runtime => false,
            Self::ClassicScript => true,
        }
    }

    const fn optimize_ast(self) -> bool {
        match self {
            Self::Runtime => true,
            Self::ClassicScript => false,
        }
    }

    const fn minify_syntax(self) -> bool {
        true
    }
}

#[derive(Debug, Clone)]
pub struct VirtualModule {
    pub specifier: String,
    pub content: String,
}

impl VirtualModule {
    pub fn new(specifier: impl Into<String>, content: impl Into<String>) -> Self {
        Self {
            specifier: specifier.into(),
            content: content.into(),
        }
    }
}

struct PseudoResolver {
    virtual_modules: HashSet<String>,
}

fn resolve_datastar_alias(module_specifier: &str) -> Option<swc_ecma_loader::resolve::Resolution> {
    if module_specifier == "@engine" {
        return Some(swc_ecma_loader::resolve::Resolution {
            filename: FileName::Real("engine/engine".into()),
            slug: None,
        });
    }

    let resolved = if let Some(rest) = module_specifier.strip_prefix("@engine/") {
        Some(format!("engine/{rest}"))
    } else if let Some(rest) = module_specifier.strip_prefix("@utils/") {
        Some(format!("utils/{rest}"))
    } else {
        module_specifier
            .strip_prefix("@plugins/")
            .map(|rest| format!("plugins/{rest}"))
    };

    resolved.map(|filename| swc_ecma_loader::resolve::Resolution {
        filename: FileName::Real(filename.into()),
        slug: None,
    })
}

fn resolve_relative_specifier(base: &str, module_specifier: &str) -> Result<String, Error> {
    let mut parts = base
        .split('/')
        .filter(|segment| !segment.is_empty())
        .collect::<Vec<_>>();

    let Some(_) = parts.pop() else {
        bail!(
            "resolve relative module specifier `{module_specifier}` from `{base}`: missing base module name"
        );
    };

    for segment in module_specifier.split('/') {
        match segment {
            "" | "." => {}
            ".." => {
                let Some(_) = parts.pop() else {
                    bail!(
                        "resolve relative module specifier `{module_specifier}` from `{base}`: walked past the virtual root"
                    );
                };
            }
            _ => parts.push(segment),
        }
    }

    if parts.is_empty() {
        bail!(
            "resolve relative module specifier `{module_specifier}` from `{base}`: resolved to an empty module name"
        );
    }

    Ok(parts.join("/"))
}

fn is_relative_specifier(module_specifier: &str) -> bool {
    module_specifier == "."
        || module_specifier == ".."
        || module_specifier.starts_with("./")
        || module_specifier.starts_with("../")
}

fn normalize_virtual_specifier(
    virtual_modules: &HashSet<String>,
    module_specifier: &str,
) -> Option<String> {
    if virtual_modules.contains(module_specifier) {
        return Some(module_specifier.to_owned());
    }

    if let Some(module_specifier) = module_specifier.strip_suffix(".ts")
        && virtual_modules.contains(module_specifier)
    {
        return Some(module_specifier.to_owned());
    }

    let module_specifier_with_ts = format!("{module_specifier}.ts");
    if virtual_modules.contains(&module_specifier_with_ts) {
        return Some(module_specifier_with_ts);
    }

    None
}

impl Resolve for PseudoResolver {
    fn resolve(
        &self,
        base: &FileName,
        module_specifier: &str,
    ) -> Result<swc_ecma_loader::resolve::Resolution, Error> {
        if let Some(resolution) = resolve_datastar_alias(module_specifier) {
            return Ok(resolution);
        }

        if is_relative_specifier(module_specifier) {
            let base = match base {
                FileName::Custom(name) => name.clone(),
                FileName::Real(path) => path.to_string_lossy().into_owned(),
                _ => bail!("unsupported base filename type: {base}"),
            };

            let resolved = resolve_relative_specifier(&base, module_specifier)?;
            if let Some(virtual_module) =
                normalize_virtual_specifier(&self.virtual_modules, &resolved)
            {
                return Ok(swc_ecma_loader::resolve::Resolution {
                    filename: FileName::Custom(virtual_module),
                    slug: None,
                });
            }

            return Ok(swc_ecma_loader::resolve::Resolution {
                filename: FileName::Real(resolved.into()),
                slug: None,
            });
        }

        if let Some(virtual_module) =
            normalize_virtual_specifier(&self.virtual_modules, module_specifier)
        {
            return Ok(swc_ecma_loader::resolve::Resolution {
                filename: FileName::Custom(virtual_module),
                slug: None,
            });
        }

        if let FileName::Custom(_) = base {
            return Ok(swc_ecma_loader::resolve::Resolution {
                filename: FileName::Real(module_specifier.into()),
                slug: None,
            });
        }

        bail!(
            "unsupported module specifier `{}` for base filename `{}`",
            module_specifier,
            base
        );
    }
}

struct NoopHook;

impl Hook for NoopHook {
    fn get_import_meta_props(&self, _: Span, _: &ModuleRecord) -> Result<Vec<KeyValueProp>, Error> {
        Ok(Vec::new())
    }
}

struct Loader {
    cm: Lrc<SourceMap>,
    virtual_modules: HashMap<String, String>,
}

include!(concat!(env!("OUT_DIR"), "/datastar_loader.rs"));

impl Load for Loader {
    fn load(&self, filename: &FileName) -> Result<ModuleData, Error> {
        let source_file = match filename {
            FileName::Real(path) => self.load_datastar_file(path),
            FileName::Custom(name) => {
                let content = self
                    .virtual_modules
                    .get(name)
                    .with_context(|| format!("unknown virtual module: {name}"))?;
                self.cm
                    .new_source_file(filename.clone().into(), content.clone())
            }
            _ => return Err(anyhow!("unexpected filename: {filename}")),
        };

        let module = parse_file_as_module(
            &source_file,
            Syntax::Typescript(Default::default()),
            EsVersion::Es2020,
            None,
            &mut Vec::new(),
        )
        .map_err(|e| anyhow!("parse: {:?}", e))?;

        let mut program = Program::Module(module);
        let mut ts_pass = typescript(Default::default(), Mark::new(), Mark::new());
        ts_pass.process(&mut program);

        let module = match program {
            Program::Module(m) => m,
            _ => unreachable!(),
        };

        Ok(ModuleData {
            fm: source_file,
            module,
            helpers: Default::default(),
        })
    }
}

pub fn bundle(
    entry_specifier: &str,
    virtual_modules: impl IntoIterator<Item = VirtualModule>,
    options: BundleOptions,
) -> Result<String, Error> {
    let mut modules_by_specifier = HashMap::new();
    for module in virtual_modules {
        if modules_by_specifier
            .insert(module.specifier.clone(), module.content)
            .is_some()
        {
            bail!("duplicate virtual module specifier `{}`", module.specifier);
        }
    }

    if !modules_by_specifier.contains_key(entry_specifier) {
        bail!("entry virtual module `{entry_specifier}` not found");
    }

    let cm = Lrc::new(SourceMap::new(swc_common::FilePathMapping::empty()));

    let resolver = PseudoResolver {
        virtual_modules: modules_by_specifier.keys().cloned().collect(),
    };
    let loader = Loader {
        cm: cm.clone(),
        virtual_modules: modules_by_specifier,
    };

    let globals = Globals::new();

    let mut bundler = Bundler::new(
        &globals,
        cm.clone(),
        &loader,
        CachingResolver::new(4096, resolver),
        swc_bundler::Config {
            require: false,
            disable_inliner: false,
            external_modules: Default::default(),
            disable_fixer: true,
            disable_hygiene: true,
            disable_dce: options.profile.disable_dce(),
            module: Default::default(),
        },
        Box::new(NoopHook),
    );

    let entries = HashMap::from([(
        "datastar".to_owned(),
        FileName::Custom(entry_specifier.to_owned()),
    )]);

    let mut bundles = bundler.bundle(entries)?.into_iter();
    let mut bundle = bundles.next().with_context(|| "create a single bundle")?;
    if bundles.next().is_some() {
        bail!("expected one bundle but got more");
    }

    bundle = GLOBALS.set(&globals, || {
        if options.profile.optimize_ast() {
            bundle.module = swc_ecma_minifier::optimize(
                bundle.module.into(),
                cm.clone(),
                None,
                None,
                &MinifyOptions {
                    compress: Some(CompressOptions::default()),
                    mangle: Some(MangleOptions {
                        top_level: Some(true),
                        ..Default::default()
                    }),
                    ..Default::default()
                },
                &ExtraOptions {
                    unresolved_mark: Mark::new(),
                    top_level_mark: Mark::new(),
                    mangle_name_cache: None,
                },
            )
            .module()
            .expect("expected a module to come out of optimizing module");
        }

        bundle.module.visit_mut_with(&mut fixer(None));
        bundle
    });

    let mut buf = Vec::new();
    {
        let wr = JsWriter::new(cm.clone(), "\n", &mut buf, None);
        let mut emitter = Emitter {
            cfg: swc_ecma_codegen::Config::default().with_minify(options.profile.minify_syntax()),
            cm: cm.clone(),
            comments: None,
            wr: Box::new(omit_trailing_semi(wr)) as Box<dyn WriteJs>,
        };
        emitter.emit_module(&bundle.module)?;
    }

    Ok(String::from_utf8_lossy(&buf).to_string())
}

#[cfg(test)]
mod tests {
    use super::{BundleOptions, VirtualModule, bundle};

    #[test]
    fn bundles_virtual_modules_with_relative_imports() {
        let bundle = bundle(
            "cheers/entry",
            [
                VirtualModule::new("cheers/entry", "import './dep'"),
                VirtualModule::new("cheers/dep", "globalThis.__cheers_bundle_test = 1"),
            ],
            BundleOptions::runtime(),
        )
        .expect("bundle should succeed");

        assert!(bundle.contains("__cheers_bundle_test"), "{bundle}");
    }

    #[test]
    fn resolves_virtual_modules_with_ts_extensions() {
        let bundle = bundle(
            "cheers/entry",
            [
                VirtualModule::new("cheers/entry", "import './dep.ts'"),
                VirtualModule::new("cheers/dep", "globalThis.__cheers_bundle_test_ts = 1"),
            ],
            BundleOptions::runtime(),
        )
        .expect("bundle should succeed");

        assert!(bundle.contains("__cheers_bundle_test_ts"), "{bundle}");
    }

    #[test]
    fn preserves_http_and_json_property_names() {
        let bundle = bundle(
            "cheers/entry",
            [VirtualModule::new(
                "cheers/entry",
                r#"
                const body = JSON.stringify({
                    sent_at_ms: 1,
                    items: [{ timestamp_ms: 2, props: { button_id: "main" } }],
                });

                fetch("/_track", {
                    method: "POST",
                    headers: {
                        "content-type": "application/json",
                    },
                    body,
                });
                "#,
            )],
            BundleOptions::runtime(),
        )
        .expect("bundle should succeed");

        assert!(bundle.contains("content-type"), "{bundle}");
        assert!(bundle.contains("sent_at_ms"), "{bundle}");
        assert!(bundle.contains("timestamp_ms"), "{bundle}");
        assert!(bundle.contains("props"), "{bundle}");
    }

    #[test]
    fn classic_script_minification_preserves_top_level_api_names() {
        let bundle = bundle(
            "cheers/entry",
            [VirtualModule::new(
                "cheers/entry",
                r#"
                function CheersTopLevelApiForInlineHandlers() {
                    return true;
                }

                var CheersTopLevelValueForInlineHandlers = 1;
                window.CheersExplicitApi = {
                    call: CheersTopLevelApiForInlineHandlers,
                    value: CheersTopLevelValueForInlineHandlers,
                };
                "#,
            )],
            BundleOptions::classic_script(),
        )
        .expect("bundle should succeed");

        assert!(
            bundle.contains("CheersTopLevelApiForInlineHandlers"),
            "{bundle}"
        );
        assert!(
            bundle.contains("CheersTopLevelValueForInlineHandlers"),
            "{bundle}"
        );
        assert!(bundle.contains("CheersExplicitApi"), "{bundle}");
    }

    #[test]
    fn classic_script_minification_preserves_externally_referenced_top_level_names() {
        let bundle = bundle(
            "cheers/entry",
            [VirtualModule::new(
                "cheers/entry",
                r#"
                function CalledFromInlineOnClick() {
                    return true;
                }

                var ReadFromLaterScript = 1;
                "#,
            )],
            BundleOptions::classic_script(),
        )
        .expect("bundle should succeed");

        assert!(bundle.contains("CalledFromInlineOnClick"), "{bundle}");
        assert!(bundle.contains("ReadFromLaterScript"), "{bundle}");
    }
}