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

2024 年 6 月 7 日，作者：Dirk Bäumer

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

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

在工作线程中执行 WebAssembly 代码

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

VS Code 组件模型提供了一个元模型，它使这变得更容易，因为它使我们能够自动生成工作线程和扩展主端所需的粘合代码。

以下代码片段显示了工作线程所需的代码。示例假设代码存储在名为 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);

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

在扩展端，我们加载 WebAssembly 模块并将其绑定到 calculator 世界。执行计算的相应调用需要等待，因为执行是在工作线程中异步发生的（例如，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 代码的执行发生在工作线程中，因此导入服务的实现（例如，上面的 log 函数）可以返回一个 Promise，但并非必须。
• WebAssembly 目前仅支持同步执行模型。因此，来自工作线程的每个调用 WebAssembly 代码以调用扩展主机主线程以调用导入服务的调用都需要以下步骤：
  1. 向扩展主机主线程发布一条消息，描述要调用的服务（例如，调用 log 函数）。
  2. 使用 Atomics.wait 暂停工作线程执行。
  3. 在扩展主机主线程中处理消息。
  4. 恢复工作线程并使用 Atomics.notify 通知其结果。

此同步添加了可衡量的时延。尽管所有这些步骤都由组件模型透明地处理，但开发人员应了解这些步骤并在设计导入的 API 表面时加以考虑。

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

基于 WebAssembly 的语言服务器

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

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

以下代码片段显示了一个基于lsp_server 仓库存储库中的示例服务器的 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 支持的工作线程，该扩展在我们的在 Web 版 VS Code 中运行 WebAssemblies 博客文章中进行了详细介绍。

扩展的 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();
}

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

需要注意的是，@vscode/wasm-wasi-lsp npm 模块会自动将文档 URI 从其工作区值转换为 WASI 预览版 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 预览版 1 目标的库代码，那么在 VS Code 在其组件模型实现中支持 WASI 0.2 预览版之前，使用自定义消息实现语言服务器可能是一个不错的选择。

接下来做什么

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

感谢！

Dirk 和 VS Code 团队

祝您编码愉快！