使用 WebAssembly 进行扩展开发

2024年5月8日，Dirk Bäumer 撰写

Visual Studio Code 通过 WebAssembly 执行引擎 扩展支持 WASM 二进制文件的执行。主要用例是将用 C/C++ 或 Rust 编写的程序编译为 WebAssembly，然后直接在 VS Code 中运行这些程序。Visual Studio Code for Education 是一个值得注意的例子，它利用此支持在 VS Code for the Web 中运行 Python 解释器。这篇博客文章 提供了关于如何实现这一点的详细见解。

2024年1月，Bytecode Alliance 发布了 WASI 0.2 预览版。WASI 0.2 预览版中的一项关键技术是 组件模型。WebAssembly 组件模型通过标准化接口、数据类型和模块组成，简化了 WebAssembly 组件与其宿主环境之间的交互。这种标准化是通过使用 WIT (WASM 接口类型) 文件实现的。WIT 文件有助于描述 JavaScript/TypeScript 扩展（宿主）与执行用 Rust 或 C/C++ 等其他语言编码的计算的 WebAssembly 组件之间的交互。

这篇博客文章概述了开发人员如何利用组件模型将 WebAssembly 库集成到他们的扩展中。我们重点关注三个用例：(a) 使用 WebAssembly 实现库并从 JavaScript/TypeScript 的扩展代码中调用它，(b) 从 WebAssembly 代码调用 VS Code API，以及 (c) 演示如何使用资源来封装和管理 WebAssembly 或 TypeScript 代码中的有状态对象。

除了 VS Code 和 NodeJS，示例还需要您安装以下工具的最新版本：Rust 编译器工具链、wasm-tools 和 wit-bindgen。

我还要感谢 Fastly 的 L. Pereira 和 Luke Wagner 对本文提供的宝贵反馈。

用 Rust 编写的计算器

在第一个示例中，我们演示了开发人员如何将用 Rust 编写的库集成到 VS Code 扩展中。如前所述，组件使用 WIT 文件进行描述。在我们的示例中，该库执行简单的操作，例如加法、减法、乘法和除法。相应的 WIT 文件如下所示：

package vscode:example;

interface types {
	record operands {
		left: u32,
		right: u32
	}

	variant operation {
		add(operands),
		sub(operands),
		mul(operands),
		div(operands)
	}
}
world calculator {
	use types.{ operation };

	export calc: func(o: operation) -> u32;
}

Rust 工具 wit-bindgen 用于为计算器生成 Rust 绑定。使用此工具有两种方法：

• 作为过程宏，直接在实现文件中生成绑定。此方法是标准方法，但缺点是无法检查生成的绑定代码。

• 作为命令行工具，它会在磁盘上创建绑定文件。下面的资源示例中 VS Code 扩展示例仓库 中的代码就示例了这种方法。

相应的 Rust 文件，使用 wit-bindgen 工具作为过程宏，如下所示：

// Use a procedural macro to generate bindings for the world we specified in
// `calculator.wit`
wit_bindgen::generate!({
	// the name of the world in the `*.wit` input file
	world: "calculator",
});

然而，使用命令 cargo build --target wasm32-unknown-unknown 将 Rust 文件编译为 WebAssembly 会由于缺少导出 calc 函数的实现而导致编译错误。下面是 calc 函数的简单实现：

// Use a procedural macro to generate bindings for the world we specified in
// `calculator.wit`
wit_bindgen::generate!({
	// the name of the world in the `*.wit` input file
	world: "calculator",
});

struct Calculator;

impl Guest for Calculator {

    fn calc(op: Operation) -> u32 {
		match op {
			Operation::Add(operands) => operands.left + operands.right,
			Operation::Sub(operands) => operands.left - operands.right,
			Operation::Mul(operands) => operands.left * operands.right,
			Operation::Div(operands) => operands.left / operands.right,
		}
	}
}

// Export the Calculator to the extension code.
export!(Calculator);

文件末尾的 export!(Calculator); 语句将 Calculator 从 WebAssembly 代码导出，以便扩展能够调用 API。

wit2ts 工具用于生成必要的 TypeScript 绑定，以便在 VS Code 扩展中与 WebAssembly 代码进行交互。该工具由 VS Code 团队开发，旨在满足 VS Code 扩展架构的特定要求，主要原因如下：

• VS Code API 只能在扩展宿主工作程序中访问。从扩展宿主工作程序派生的任何其他工作程序都无法访问 VS Code API，这与 NodeJS 或浏览器等环境形成对比，在这些环境中，每个工作程序通常都可以访问几乎所有运行时 API。
• 多个扩展共享同一个扩展宿主工作程序。扩展应避免在该工作程序上执行任何长时间运行的同步计算。

当我们在 VS Code 的 WASI 预览版 1 中实现时，这些架构要求已经存在。然而，我们最初的实现是手动编写的。考虑到组件模型将得到更广泛的应用，我们开发了一个工具来促进组件与它们的 VS Code 特定宿主实现之间的集成。

命令 wit2ts --outDir ./src ./wit 会在 src 文件夹中生成一个 calculator.ts 文件，其中包含 WebAssembly 代码的 TypeScript 绑定。一个使用这些绑定的简单扩展将如下所示：

import * as vscode from 'vscode';
import { WasmContext, Memory } from '@vscode/wasm-component-model';

// Import the code generated by wit2ts
import { calculator, Types } from './calculator';

export async function activate(context: vscode.ExtensionContext): Promise<void> {
  // The channel for printing the result.
  const channel = vscode.window.createOutputChannel('Calculator');
  context.subscriptions.push(channel);

  // Load the Wasm module
  const filename = vscode.Uri.joinPath(
    context.extensionUri,
    'target',
    'wasm32-unknown-unknown',
    'debug',
    'calculator.wasm'
  );
  const bits = await vscode.workspace.fs.readFile(filename);
  const module = await WebAssembly.compile(bits);

  // The context for the WASM module
  const wasmContext: WasmContext.Default = new WasmContext.Default();

  // Instantiate the module
  const instance = await WebAssembly.instantiate(module, {});
  // Bind the WASM memory to the context
  wasmContext.initialize(new Memory.Default(instance.exports));

  // Bind the TypeScript Api
  const api = calculator._.exports.bind(
    instance.exports as calculator._.Exports,
    wasmContext
  );

  context.subscriptions.push(
    vscode.commands.registerCommand('vscode-samples.wasm-component-model.run', () => {
      channel.show();
      channel.appendLine('Running calculator example');
      const add = Types.Operation.Add({ left: 1, right: 2 });
      channel.appendLine(`Add ${api.calc(add)}`);
      const sub = Types.Operation.Sub({ left: 10, right: 8 });
      channel.appendLine(`Sub ${api.calc(sub)}`);
      const mul = Types.Operation.Mul({ left: 3, right: 7 });
      channel.appendLine(`Mul ${api.calc(mul)}`);
      const div = Types.Operation.Div({ left: 10, right: 2 });
      channel.appendLine(`Div ${api.calc(div)}`);
    })
  );
}

当您在 VS Code for the Web 中编译并运行上述代码时，它会在 Calculator 通道中产生以下输出：

您可以在 VS Code 扩展示例仓库 中找到此示例的完整源代码。

@vscode/wasm-component-model 内部解析

检查 wit2ts 工具生成的源代码会发现它依赖于 @vscode/wasm-component-model npm 模块。该模块作为 组件模型的规范 ABI 的 VS Code 实现，并借鉴了相应的 Python 代码。虽然理解组件模型的内部工作原理对于理解这篇博客文章并非必要，但我们将对其工作原理进行一些阐述，特别是关于数据如何在 JavaScript/TypeScript 和 WebAssembly 代码之间传递。

与 wit-bindgen 或 jco 等其他工具为 WIT 文件生成绑定不同，wit2ts 创建了一个元模型，然后可以在运行时用于各种用例生成绑定。这种灵活性使我们能够满足 VS Code 内部扩展开发的架构要求。通过使用这种方法，我们可以“Promise 化”绑定并实现在 worker 中运行 WebAssembly 代码。我们采用这种机制来实现 VS Code 的 WASI 0.2 预览版。

您可能已经注意到，在生成绑定时，函数使用 calculator._.imports.create（注意下划线）之类的名称引用。为了避免与 WIT 文件中的符号发生名称冲突（例如，可能有一个名为 imports 的类型定义），API 函数被放置在 _ 命名空间中。元模型本身位于 $ 命名空间中。因此，calculator.$.exports.calc 表示导出 calc 函数的元数据。

在上面的示例中，传入 calc 函数的 add 操作参数包含三个字段：操作码、左值和右值。根据组件模型的规范 ABI，参数通过值传递。它还概述了数据如何序列化、传递给 WebAssembly 函数以及在另一端反序列化。此过程会生成两个操作对象：一个在 JavaScript 堆上，另一个在线性 WebAssembly 内存中。下图说明了这一点：

下表列出了可用的 WIT 类型、它们在 VS Code 组件模型实现中映射到的 JavaScript 对象，以及使用的相应 TypeScript 类型。

需要注意的是，组件模型不支持低级（C 风格）指针。因此，您不能传递对象图或递归数据结构。在这方面，它与 JSON 具有相同的限制。为了最大限度地减少数据复制，组件模型引入了资源的概念，我们将在本博客文章的后续部分更详细地探讨这一概念。

jco 项目 也支持使用 type 命令为 WebAssembly 组件生成 JavaScript/TypeScript 绑定。如前所述，我们开发了自己的工具来满足 VS Code 的特定需求。然而，我们每两周与 jco 团队举行一次会议，以确保在可能的情况下工具之间保持一致。一个基本要求是两种工具应使用相同的 JavaScript 和 TypeScript 表示法来表示 WIT 数据类型。我们还在探索两种工具之间共享代码的可能性。

从 WebAssembly 代码调用 TypeScript

WIT 文件描述了宿主（VS Code 扩展）和 WebAssembly 代码之间的交互，促进了双向通信。在我们的示例中，此功能允许 WebAssembly 代码记录其活动踪迹。为了启用此功能，我们修改 WIT 文件如下：

world calculator {

	/// ....

	/// A log function implemented on the host side.
	import log: func(msg: string);

	/// ...
}

在 Rust 端，我们现在可以调用 log 函数了：

fn calc(op: Operation) -> u32 {
	log(&format!("Starting calculation: {:?}", op));
	let result = match op {
		// ...
	};
	log(&format!("Finished calculation: {:?}", op));
	result
}

在 TypeScript 端，扩展开发人员唯一需要做的就是提供 log 函数的实现。然后，VS Code 组件模型会促进生成必要的绑定，这些绑定将作为导入传递给 WebAssembly 实例。

export async function activate(context: vscode.ExtensionContext): Promise<void> {
  // ...

  // The channel for printing the log.
  const log = vscode.window.createOutputChannel('Calculator - Log', { log: true });
  context.subscriptions.push(log);

  // The implementation of the log function that is called from WASM
  const service: calculator.Imports = {
    log: (msg: string) => {
      log.info(msg);
    }
  };

  // Create the bindings to import the log function into the WASM module
  const imports = calculator._.imports.create(service, wasmContext);
  // Instantiate the module
  const instance = await WebAssembly.instantiate(module, imports);

  // ...
}

与第一个示例相比，WebAssembly.instantiate 调用现在包含 calculator._.imports.create(service, wasmContext) 的结果作为第二个参数。此 imports.create 调用从服务实现生成低级 WASM 绑定。在初始示例中，我们传递了一个空对象字面量，因为不需要导入。这次，我们在 VS Code 桌面环境中，在调试器下执行扩展。多亏了 Connor Peet 出色的工作，现在可以在 Rust 代码中设置断点，并使用 VS Code 调试器单步执行它。

使用组件模型资源

WebAssembly 组件模型引入了资源的概念，它提供了一种封装和管理状态的标准化机制。这种状态在调用边界的一侧（例如，在 TypeScript 代码中）进行管理，并在另一侧（例如，在 WebAssembly 代码中）进行访问和操作。资源在 WASI 预览版 0.2 API 中被广泛使用，文件描述符就是一个典型的例子。在此设置中，状态由扩展宿主管理，并由 WebAssembly 代码访问和操作。

资源也可以反向运行，即其状态由 WebAssembly 代码管理，并由扩展代码访问和操作。这种方法对于 VS Code 来说特别有益，可以在 WebAssembly 中实现有状态服务，然后从 TypeScript 端访问。在下面的示例中，我们定义了一个实现 逆波兰表示法 的计算器资源，类似于 惠普 手持计算器中使用的那种。

// wit/calculator.wit
package vscode:example;

interface types {

	enum operation {
		add,
		sub,
		mul,
		div
	}

	resource engine {
		constructor();
		push-operand: func(operand: u32);
		push-operation: func(operation: operation);
		execute: func() -> u32;
	}
}
world calculator {
	export types;
}

下面是 Rust 中计算器资源的简单实现：

impl EngineImpl {
	fn new() -> Self {
		EngineImpl {
			left: None,
			right: None,
		}
	}

	fn push_operand(&mut self, operand: u32) {
		if self.left == None {
			self.left = Some(operand);
		} else {
			self.right = Some(operand);
		}
	}

	fn push_operation(&mut self, operation: Operation) {
        let left = self.left.unwrap();
        let right = self.right.unwrap();
        self.left = Some(match operation {
			Operation::Add => left + right,
			Operation::Sub => left - right,
			Operation::Mul => left * right,
			Operation::Div => left / right,
		});
	}

	fn execute(&mut self) -> u32 {
		self.left.unwrap()
	}
}

在 TypeScript 代码中，我们像以前一样绑定导出。唯一的区别是，绑定过程现在为我们提供了一个代理类，用于在 WebAssembly 代码中实例化和管理 calculator 资源。

// Bind the JavaScript Api
const api = calculator._.exports.bind(
  instance.exports as calculator._.Exports,
  wasmContext
);

context.subscriptions.push(
  vscode.commands.registerCommand('vscode-samples.wasm-component-model.run', () => {
    channel.show();
    channel.appendLine('Running calculator example');

    // Create a new calculator engine
    const calculator = new api.types.Engine();

    // Push some operands and operations
    calculator.pushOperand(10);
    calculator.pushOperand(20);
    calculator.pushOperation(Types.Operation.add);
    calculator.pushOperand(2);
    calculator.pushOperation(Types.Operation.mul);

    // Calculate the result
    const result = calculator.execute();
    channel.appendLine(`Result: ${result}`);
  })
);

当您运行相应的命令时，它会在输出通道中打印 Result: 60。如前所述，资源的状态位于调用边界的一侧，并使用句柄从另一侧访问。除了传递给与资源交互的方法的参数外，没有发生数据复制。

此示例的完整源代码可在 VS Code 扩展示例仓库 中找到。

直接从 Rust 调用 VS Code API

组件模型资源可用于封装和管理 WebAssembly 组件和宿主之间的状态。此功能允许我们利用资源将 VS Code API 规范地暴露给 WebAssembly 代码。这种方法的优点在于，整个扩展可以用编译为 WebAssembly 的语言编写。我们已经开始探索这种方法，下面是用 Rust 编写的扩展的源代码：

use std::rc::Rc;

#[export_name = "activate"]
pub fn activate() -> vscode::Disposables {
	let mut disposables: vscode::Disposables = vscode::Disposables::new();

	// Create an output channel.
	let channel: Rc<vscode::OutputChannel> = Rc::new(vscode::window::create_output_channel("Rust Extension", Some("plaintext")));

	// Register a command handler
	let channel_clone = channel.clone();
	disposables.push(vscode::commands::register_command("testbed-component-model-vscode.run", move || {
		channel_clone.append_line("Open documents");

		// Print the URI of all open documents
		for document in vscode::workspace::text_documents() {
			channel.append_line(&format!("Document: {}", document.uri()));
		}
	}));
	return disposables;
}

#[export_name = "deactivate"]
pub fn deactivate() {
}

请注意，此代码类似于用 TypeScript 编写的扩展。

尽管这次探索看起来很有前景，但我们目前决定不继续进行。主要原因是 WASM 缺乏异步支持。许多 VS Code API 都是异步的，这使得它们很难直接代理到 WebAssembly 代码中。我们可以在单独的 worker 中运行 WebAssembly 代码，并采用 WASI 预览版 1 支持 中 WebAssembly worker 和扩展宿主 worker 之间使用的相同同步机制。但是，这种方法可能导致同步 API 调用期间出现意外行为，因为这些调用实际上将异步执行。结果是，在两次同步调用之间，可观察状态可能会发生变化（例如，setX(5); getX(); 可能不会返回 5）。

此外，目前正在努力在 WASI 0.3 预览版中引入完整的异步支持。Luke Wagner 在 WASM I/O 2024 上提供了有关异步支持当前状态的最新信息。我们决定等待这种支持，因为它将实现更完整和更干净的实现。

如果您对相应的 WIT 文件、Rust 代码和 TypeScript 代码感兴趣，可以在 vscode-wasm 仓库的 rust-api 文件夹中找到它们。

下一步

我们目前正在准备一篇后续博客文章，其中将涵盖 WebAssembly 代码可用于扩展开发的更多领域。主要主题将包括：

• 用 WebAssembly 编写语言服务器。
• 使用生成的元模型将长时间运行的 WebAssembly 代码透明地卸载到单独的 worker 中。

随着组件模型在 VS Code 中的惯用实现到位，我们将继续努力为 VS Code 实现 WASI 0.2 预览版。

谢谢，

Dirk 和 VS Code 团队

编码愉快！