使用 WebAssembly 进行扩展开发 - 第二部分

2024 年 6 月 7 日，Dirk Bäumer

在上一篇关于使用 WebAssembly 进行扩展开发 的博客文章中，我们演示了如何使用组件模型将 WebAssembly 代码集成到您的 Visual Studio Code 扩展中。在这篇博客文章中，我们重点介绍两个额外的独立用例：(a) 在 worker 中运行 WebAssembly 代码，以避免阻塞扩展主机的主线程，以及 (b) 使用编译为 WebAssembly 的语言创建 语言服务器。

要运行此博客文章中的示例，您需要以下工具：VS Code、Node.js、Rust 编译器工具链、wasm-tools 和 wit-bindgen。

在 Worker 中执行 WebAssembly 代码

上一篇博客文章中的示例在 VS Code 扩展主机的主线程中运行 WebAssembly 代码。只要执行时间很短，这就可以了。但是，长时间运行的操作应该在 worker 中执行，以确保扩展主机的主线程保持可用于其他扩展。

VS Code 组件模型提供了一个元模型，通过使我们能够自动生成 worker 和扩展主侧的必要胶水代码，使得这个过程更容易。

以下代码片段显示了 worker 的必要代码。该示例假设代码存储在名为 worker.ts 的文件中

import { Connection, RAL } from '@vscode/wasm-component-model';
import { calculator } from './calculator';

async function main(): Promise<void> {
  const connection = await Connection.createWorker(calculator._);
  connection.listen();
}

main().catch(RAL().console.error);

该代码创建一个连接以与扩展主机主 worker 通信，并使用 wit2ts 工具生成的 calculator world 初始化连接。

在扩展侧，我们加载 WebAssembly 模块并将其绑定到 calculator world。执行计算的相应调用需要等待，因为执行在 worker 中异步发生（例如，await api.calc(...)）。

// The channel for printing the result.
const channel = vscode.window.createOutputChannel('Calculator');
context.subscriptions.push(channel);

// 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.Promisified = {
  log: async (msg: string): Promise<void> => {
    // Wait 100ms to slow things down :-)
    await new Promise(resolve => setTimeout(resolve, 100));
    log.info(msg);
  }
};

// Load the WASM model
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);

// Create the worker
const worker = new Worker(
  vscode.Uri.joinPath(context.extensionUri, './out/worker.js').fsPath
);
// Bind the world to the worker
const api = await calculator._.bind(service, module, worker);

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

有几点需要注意

• 此示例中使用的 WIT 文件与上一篇博客文章中 计算器示例 中使用的文件没有区别。
• 由于 WebAssembly 代码的执行发生在 worker 中，因此导入服务（例如，上面的 log 函数）的实现可以返回 Promise，但不是必须的。
• WebAssembly 目前仅支持同步执行模型。因此，从执行 WebAssembly 代码的 worker 到扩展主机主线程的每次调用都需要以下步骤：
  1. 向扩展主机主线程发布一条消息，描述要调用的服务（例如，调用 log 函数）。
  2. 使用 Atomics.wait 挂起 worker 执行。
  3. 在扩展主机主线程中处理消息。
  4. 恢复 worker 并使用 Atomics.notify 通知其结果。

这种同步增加了可测量的时间开销。尽管所有这些步骤都由组件模型透明地处理，但开发人员应了解它们，并在设计导入的 API 表面时考虑这一点。

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

基于 WebAssembly 的语言服务器

当我们开始研究 VS Code for the Web 的 WebAssembly 支持时，我们设想的用例之一是使用 WebAssembly 执行语言服务器。随着 VS Code 的 LSP 库的最新更改以及引入一个新的模块来桥接 WebAssembly 和 LSP，实现 WebAssembly 语言服务器现在与将其实现为操作系统进程一样简单。

此外，WebAssembly 语言服务器在 WebAssembly Core 扩展上运行，该扩展完全支持 WASI Preview 1。这意味着即使文件存储在远程位置（例如在 GitHub 存储库中），语言服务器也可以使用其编程语言的常规文件系统 API 访问工作区中的文件。

以下代码片段显示了一个基于 lsp_server crate 的 示例服务器的 Rust 语言服务器。此语言服务器不执行任何语言分析，但只是为 GotoDefinition 请求返回一个预定义的结果

match cast::<GotoDefinition>(req) {
    Ok((id, params)) => {
        let uri = params.text_document_position_params.text_document.uri;
        eprintln!("Received gotoDefinition request #{} {}", id, uri.to_string());
        let loc = Location::new(
            uri,
            lsp_types::Range::new(lsp_types::Position::new(0, 0), lsp_types::Position::new(0, 0))
        );
        let mut vec = Vec::new();
        vec.push(loc);
        let result = Some(GotoDefinitionResponse::Array(vec));
        let result = serde_json::to_value(&result).unwrap();
        let resp = Response { id, result: Some(result), error: None };
        connection.sender.send(Message::Response(resp))?;
        continue;
    }
    Err(err @ ExtractError::JsonError { .. }) => panic!("{err:?}"),
    Err(ExtractError::MethodMismatch(req)) => req,
};

您可以在 VS Code 示例存储库中找到语言服务器的完整源代码。

您可以使用新的 @vscode/wasm-wasi-lsp npm 模块在扩展的 TypeScript 代码中创建 WebAssembly 语言服务器。通过使用 WebAssembly Core 扩展，将 WebAssembly 代码实例化为支持 WASI 的 worker，该扩展在我们 在 VS Code for the Web 中运行 WebAssembly 博客文章中有详细描述。

该扩展的 TypeScript 代码也很简单。它为纯文本文件注册服务器。

import {
  createStdioOptions,
  createUriConverters,
  startServer
} from '@vscode/wasm-wasi-lsp';

export async function activate(context: ExtensionContext) {
  const wasm: Wasm = await Wasm.load();

  const channel = window.createOutputChannel('LSP WASM Server');
  // The server options to run the WebAssembly language server.
  const serverOptions: ServerOptions = async () => {
    const options: ProcessOptions = {
      stdio: createStdioOptions(),
      mountPoints: [{ kind: 'workspaceFolder' }]
    };

    // Load the WebAssembly code
    const filename = Uri.joinPath(
      context.extensionUri,
      'server',
      'target',
      'wasm32-wasip1-threads',
      'release',
      'server.wasm'
    );
    const bits = await workspace.fs.readFile(filename);
    const module = await WebAssembly.compile(bits);

    // Create the wasm worker that runs the LSP server
    const process = await wasm.createProcess(
      'lsp-server',
      module,
      { initial: 160, maximum: 160, shared: true },
      options
    );

    // Hook stderr to the output channel
    const decoder = new TextDecoder('utf-8');
    process.stderr!.onData(data => {
      channel.append(decoder.decode(data));
    });

    return startServer(process);
  };

  const clientOptions: LanguageClientOptions = {
    documentSelector: [{ language: 'plaintext' }],
    outputChannel: channel,
    uriConverters: createUriConverters()
  };

  let client = new LanguageClient('lspClient', 'LSP Client', serverOptions, clientOptions);
  await client.start();
}

运行代码会在纯文本文件的上下文菜单中添加一个“跳转到定义”条目。执行此操作会将相应的请求发送到 LSP 服务器。

重要的是要注意，@vscode/wasm-wasi-lsp npm 模块会自动将其工作区值中的文档 URI 转换为 WASI Preview 1 主机中识别的值。在上面的示例中，VS Code 中的文本文档的 URI 通常类似于 vscode-vfs://github/dbaeumer/plaintext-sample/lorem.txt，并且此值会转换为 file:///workspace/lorem.txt，WASI 主机中会识别该值。当语言服务器将 URI 发送回 VS Code 时，也会自动进行此转换。

大多数语言服务器库都支持自定义消息，从而可以轻松地向语言服务器添加 语言服务器协议规范中尚未提供的功能。以下代码片段演示了如何为计算给定工作区文件夹中的文件数，向我们之前使用的 Rust 语言服务器添加自定义消息处理程序

#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CountFilesParams {
    pub folder: Url,
}

pub enum CountFilesRequest {}
impl Request for CountFilesRequest {
    type Params = CountFilesParams;
    type Result = u32;
    const METHOD: &'static str = "wasm-language-server/countFilesInDirectory";
}

//...

for msg in &connection.receiver {
    match msg {
		//....
		match cast::<CountFilesRequest>(req) {
    		Ok((id, params)) => {
				eprintln!("Received countFiles request #{} {}", id, params.folder);
        		let result = count_files_in_directory(&params.folder.path());
        		let json = serde_json::to_value(&result).unwrap();
        		let resp = Response { id, result: Some(json), error: None };
        		connection.sender.send(Message::Response(resp))?;
        		continue;
    		}
    		Err(err @ ExtractError::JsonError { .. }) => panic!("{err:?}"),
    		Err(ExtractError::MethodMismatch(req)) => req,
		}
	}
	//...
}

fn count_files_in_directory(path: &str) -> usize {
    WalkDir::new(path)
        .into_iter()
        .filter_map(Result::ok)
        .filter(|entry| entry.file_type().is_file())
        .count()
}

向 LSP 服务器发送此自定义请求的 TypeScript 代码如下所示

const folder = workspace.workspaceFolders![0].uri;
const result = await client.sendRequest(CountFilesRequest, {
  folder: client.code2ProtocolConverter.asUri(folder)
});
window.showInformationMessage(`The workspace contains ${result} files.`);

在 vscode-languageserver 存储库上运行此操作会显示以下通知

请注意，语言服务器不一定需要实现 语言服务器协议规范中指定的任何功能。如果扩展想要集成只能编译为 WASI Preview 1 目标的库代码，那么在 VS Code 在其组件模型实现中支持 WASI 0.2 Preview 之前，使用自定义消息实现语言服务器可能是一个不错的选择。

接下来会发生什么

如上一篇博客文章所述，我们将继续努力为 VS Code 实现 WASI 0.2 Preview。我们还计划扩展代码示例，以包括除编译为 WASM 的 Rust 之外的其他语言。

谢谢，

Dirk 和 VS Code 团队

快乐编码！