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
use std::path::Path;

use anyhow::Error;
use heck::{ToPascalCase, ToSnakeCase};
use minijinja::Environment;
use once_cell::sync::Lazy;
use wai_bindgen_gen_core::Generator;
use wai_bindgen_gen_js::Js;
use wai_parser::Interface;

use crate::{
    types::BindingsOptions, types::Command, Files, Library, Metadata, Package, SourceFile,
};

/// The version of `@wasmer/wasi` pulled in when using a WASI library.
///
/// Note: we need at least `1.2.2` so we get the fix for
/// [wasmer-js#310](https://github.com/wasmerio/wasmer-js/pull/310).
const WASMER_WASI_VERSION: &str = "^1.2.2";

static TEMPLATES: Lazy<Environment> = Lazy::new(|| {
    let mut env = Environment::new();
    env.add_template("bindings.index.js", include_str!("bindings.index.js.j2"))
        .unwrap();
    env.add_template(
        "bindings.index.d.ts",
        include_str!("bindings.index.d.ts.j2"),
    )
    .unwrap();
    env.add_template("command.d.ts", include_str!("command.d.ts.j2"))
        .unwrap();
    env.add_template("command.js", include_str!("command.js.j2"))
        .unwrap();
    env.add_template("top-level.index.js", include_str!("top-level.index.js.j2"))
        .unwrap();
    env.add_template(
        "top-level.index.d.ts",
        include_str!("top-level.index.d.ts.j2"),
    )
    .unwrap();

    env
});

/// Generate JavaScript bindings for a package.
pub fn generate_javascript(package: &Package, options: &BindingsOptions) -> Result<Files, Error> {
    let mut files = Files::new();

    let ctx = Context::for_package(package);

    files.insert_child_directory(Path::new("src").join("bindings"), library_bindings(&ctx)?);

    for cmd in &ctx.commands {
        files.insert_child_directory(Path::new("src").join("commands"), command_bindings(cmd)?);
    }

    files.insert_child_directory("src", top_level(&ctx)?);
    let mut metadata = package.metadata().clone();
    if let Some(package_name) = &options.name {
        metadata.package_name.set_name(package_name);
    }
    let package_json = generate_package_json(package.requires_wasi(), &metadata);
    files.insert("package.json", package_json);

    // Note: We need to wrap the generated files in an extra folder because
    // that's how "npm pack" works
    let mut f = Files::new();
    f.insert_child_directory("package", files);

    Ok(f)
}

#[derive(Debug, serde::Serialize)]
struct Context {
    libraries: Vec<LibraryContext>,
    commands: Vec<CommandContext>,
    generator: String,
    wasi: bool,
    has_wasi_libraries: bool,
}

impl Context {
    fn for_package(pkg: &Package) -> Self {
        let libraries: Vec<_> = pkg
            .libraries()
            .iter()
            .map(LibraryContext::for_lib)
            .collect();
        let commands: Vec<_> = pkg.commands().iter().map(CommandContext::for_cmd).collect();

        let has_wasi_libraries = libraries.iter().any(|lib| lib.wasi);

        let wasi = !commands.is_empty() || has_wasi_libraries;

        Context {
            libraries,
            commands,
            generator: crate::GENERATOR.to_string(),
            wasi,
            has_wasi_libraries,
        }
    }
}

#[derive(Debug, serde::Serialize)]
struct CommandContext {
    name: String,
    ident: String,
    module_filename: String,
    #[serde(skip)]
    wasm: Vec<u8>,
}

impl CommandContext {
    fn for_cmd(cmd: &Command) -> CommandContext {
        let module_filename = Path::new(&cmd.name).with_extension("wasm");

        CommandContext {
            name: cmd.name.clone(),
            ident: cmd.name.to_snake_case(),
            module_filename: module_filename.display().to_string(),
            wasm: cmd.wasm.clone(),
        }
    }
}

#[derive(Debug, serde::Serialize)]
struct LibraryContext {
    /// The identifier that should be used when accessing this library.
    ident: String,
    /// The filename of the WebAssembly module (e.g. `wasmer-pack.wasm`).
    module_filename: String,
    /// Does this library require WASI?
    wasi: bool,
    exports: InterfaceContext,
    imports: Vec<InterfaceContext>,
    #[serde(skip)]
    wasm: Vec<u8>,
}

impl LibraryContext {
    fn for_lib(lib: &Library) -> Self {
        let module_filename = Path::new(lib.module_filename()).with_extension("wasm");
        let interface_name = lib.interface_name();
        let ident = interface_name.to_snake_case();

        let exports = InterfaceContext {
            interface_name: lib.exports.name().to_string(),
            class_name: lib.exports.name().to_pascal_case(),
            interface: lib.exports.0.clone(),
        };
        let imports = lib
            .imports
            .iter()
            .map(|interface| InterfaceContext {
                interface_name: interface.name().to_string(),
                class_name: interface.name().to_pascal_case(),
                interface: interface.0.clone(),
            })
            .collect();

        LibraryContext {
            ident,
            module_filename: module_filename.display().to_string(),
            wasi: lib.requires_wasi(),
            exports,
            imports,
            wasm: lib.module.wasm.clone(),
        }
    }
}

#[derive(Debug, serde::Serialize)]
struct InterfaceContext {
    /// The name of the interface (i.e. the `wasmer-pack` in
    /// `wasmer-pack.exports.wit`).
    interface_name: String,
    /// The name of the class generated by `wai-bindgen` (i.e. `WasmerPack`).
    class_name: String,
    #[serde(skip)]
    interface: Interface,
}

fn command_bindings(cmd: &CommandContext) -> Result<Files, Error> {
    let mut files = Files::new();
    let module_filename = Path::new(&cmd.name).with_extension("wasm");

    files.insert(
        Path::new(&cmd.name).with_extension("js"),
        TEMPLATES
            .get_template("command.js")
            .unwrap()
            .render(cmd)?
            .into(),
    );

    files.insert(
        Path::new(&cmd.name).with_extension("d.ts"),
        TEMPLATES
            .get_template("command.d.ts")
            .unwrap()
            .render(cmd)?
            .into(),
    );
    files.insert(module_filename, SourceFile::from(&cmd.wasm));

    Ok(files)
}

fn top_level(ctx: &Context) -> Result<Files, Error> {
    let mut files = Files::new();

    files.insert(
        "index.js",
        TEMPLATES
            .get_template("top-level.index.js")
            .unwrap()
            .render(ctx)?
            .into(),
    );

    files.insert(
        "index.d.ts",
        TEMPLATES
            .get_template("top-level.index.d.ts")
            .unwrap()
            .render(ctx)?
            .into(),
    );

    Ok(files)
}

fn library_bindings(ctx: &Context) -> Result<Files, Error> {
    let mut files = Files::new();

    for LibraryContext {
        module_filename,
        exports,
        imports,
        wasm,
        ..
    } in &ctx.libraries
    {
        let mut bindings = generate_bindings(exports, imports);
        bindings.insert(module_filename, wasm.into());
        files.insert_child_directory(&exports.interface_name, bindings);
    }

    let index_js = TEMPLATES
        .get_template("bindings.index.js")
        .unwrap()
        .render(ctx)?;
    files.insert("index.js", index_js.into());

    let typings_file = TEMPLATES
        .get_template("bindings.index.d.ts")
        .unwrap()
        .render(ctx)?;
    files.insert("index.d.ts", typings_file.into());

    Ok(files)
}

fn generate_package_json(needs_wasi: bool, metadata: &Metadata) -> SourceFile {
    let dependencies = if needs_wasi {
        serde_json::json!({
            "@wasmer/wasi": WASMER_WASI_VERSION,
        })
    } else {
        serde_json::json!({})
    };

    let package_json = serde_json::json!({
        "name": metadata.package_name.javascript_package(),
        "version": &metadata.version,
        "main": format!("src/index.js"),
        "types": format!("src/index.d.ts"),
        "type": "commonjs",
        "dependencies": dependencies,
    });

    format!("{package_json:#}").into()
}

fn generate_bindings(
    guest_exports: &InterfaceContext,
    guest_imports: &[InterfaceContext],
) -> Files {
    // Note: imports and exports were reported from the perspective of the
    // guest, but we're generating bindings from the perspective of the host.
    // Hence the "host_imports = guest_exports" thing.
    let host_imports: &[wai_parser::Interface] = &[guest_exports.interface.clone()];
    let host_exports: Vec<_> = guest_imports.iter().map(|i| i.interface.clone()).collect();

    let mut generated = wai_bindgen_gen_core::Files::default();

    Js::new().generate_all(host_imports, &host_exports, &mut generated);

    generated.into()
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeSet;

    use insta::Settings;

    use crate::{Metadata, Module};

    use super::*;

    #[test]
    fn package_json() {
        let metadata = Metadata::new("wasmerio/wasmer-pack".parse().unwrap(), "0.0.0");

        let got = generate_package_json(false, &metadata);

        insta::assert_display_snapshot!(got.utf8_contents().unwrap());
    }

    #[test]
    fn package_json_wasi() {
        let metadata = Metadata::new("wasmerio/wabt".parse().unwrap(), "0.0.0");

        let got = generate_package_json(true, &metadata);

        insta::assert_display_snapshot!(got.utf8_contents().unwrap());
    }

    const WASMER_PACK_EXPORTS: &str = include_str!(concat!(
        env!("CARGO_MANIFEST_DIR"),
        "/../wasm/wasmer-pack.exports.wai"
    ));

    #[test]
    fn generated_files() {
        let expected: BTreeSet<&Path> = [
            "package/package.json",
            "package/src/bindings/index.d.ts",
            "package/src/bindings/index.js",
            "package/src/bindings/wasmer-pack/browser.d.ts",
            "package/src/bindings/wasmer-pack/browser.js",
            "package/src/bindings/wasmer-pack/intrinsics.js",
            "package/src/bindings/wasmer-pack/wasmer_pack_wasm.wasm",
            "package/src/bindings/wasmer-pack/wasmer-pack.d.ts",
            "package/src/bindings/wasmer-pack/wasmer-pack.js",
            "package/src/commands/first.d.ts",
            "package/src/commands/first.js",
            "package/src/commands/first.wasm",
            "package/src/commands/second-with-dashes.d.ts",
            "package/src/commands/second-with-dashes.js",
            "package/src/commands/second-with-dashes.wasm",
            "package/src/index.d.ts",
            "package/src/index.js",
        ]
        .iter()
        .map(Path::new)
        .collect();
        let metadata = Metadata::new("wasmer/wasmer-pack".parse().unwrap(), "1.2.3");
        let module = Module {
            name: "wasmer_pack_wasm.wasm".to_string(),
            abi: crate::Abi::None,
            wasm: Vec::new(),
        };
        let exports =
            crate::Interface::from_wit("wasmer-pack.exports.wit", WASMER_PACK_EXPORTS).unwrap();
        let commands = vec![
            Command::new("first", []),
            Command::new("second-with-dashes", []),
        ];
        let browser =
            crate::Interface::from_wit("browser.wit", "greet: func(who: string) -> string")
                .unwrap();
        let libraries = vec![Library {
            module,
            exports,
            imports: vec![browser],
        }];
        let pkg = Package::new(metadata, libraries, commands);
        let options = BindingsOptions::default();

        let files = generate_javascript(&pkg, &options).unwrap();

        let actual_files: BTreeSet<_> = files.iter().map(|(p, _)| p).collect();
        assert_eq!(actual_files, expected);

        let mut settings = Settings::clone_current();
        settings.add_filter(
            r"Generated by wasmer-pack v\d+\.\d+\.\d+(-\w+(\.\d+)?)?",
            "Generated by XXX",
        );
        settings.bind(|| {
            insta::assert_display_snapshot!(files["package/package.json"].utf8_contents().unwrap());
            insta::assert_display_snapshot!(files["package/src/commands/first.d.ts"]
                .utf8_contents()
                .unwrap());
            insta::assert_display_snapshot!(files["package/src/commands/first.js"]
                .utf8_contents()
                .unwrap());
            insta::assert_display_snapshot!(files["package/src/commands/second-with-dashes.d.ts"]
                .utf8_contents()
                .unwrap());
            insta::assert_display_snapshot!(files["package/src/commands/second-with-dashes.js"]
                .utf8_contents()
                .unwrap());
            insta::assert_display_snapshot!(files["package/src/index.d.ts"]
                .utf8_contents()
                .unwrap());
            insta::assert_display_snapshot!(files["package/src/index.js"].utf8_contents().unwrap());
            insta::assert_display_snapshot!(files["package/src/bindings/index.d.ts"]
                .utf8_contents()
                .unwrap());
            insta::assert_display_snapshot!(files["package/src/bindings/index.js"]
                .utf8_contents()
                .unwrap());
            insta::assert_display_snapshot!(files["package/src/bindings/wasmer-pack/browser.d.ts"]
                .utf8_contents()
                .unwrap());
            insta::assert_display_snapshot!(files["package/src/bindings/wasmer-pack/browser.js"]
                .utf8_contents()
                .unwrap());
        });
    }
}