feat: Add noir_lsp_wasm as a WASI implementation of the LSP

.github/workflows/formatting.yml

@@ -19,7 +19,7 @@ jobs:
     timeout-minutes: 30
     env:
       RUSTFLAGS: -Dwarnings
-    
+
     strategy:
       fail-fast: false
       matrix:
@@ -32,7 +32,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup toolchain
-        uses: dtolnay/rust-toolchain@1.66.0
+        uses: dtolnay/rust-toolchain@1.67.0
         with:
           targets: ${{ matrix.target }}
           components: clippy, rustfmt
@@ -53,7 +53,7 @@ jobs:
     name: eslint
     runs-on: ubuntu-latest
     timeout-minutes: 30
-    
+
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/publish.yml

@@ -47,7 +47,7 @@ jobs:
           echo "MACOSX_DEPLOYMENT_TARGET=$(xcrun -sdk macosx$(sw_vers -productVersion) --show-sdk-platform-version)" >> $GITHUB_ENV
 
       - name: Setup toolchain
-        uses: dtolnay/rust-toolchain@1.66.0
+        uses: dtolnay/rust-toolchain@1.67.0
         with:
           targets: ${{ matrix.target }}
 
@@ -81,7 +81,7 @@ jobs:
       - name: Test built artifact
         if: matrix.target == 'x86_64-apple-darwin'
         run: |
-          cp ./target/${{ matrix.target }}/release/nargo ~/.cargo/bin/          
+          cp ./target/${{ matrix.target }}/release/nargo ~/.cargo/bin/
           yarn workspace release-tests test
 
       - name: Upload binaries to release tag
@@ -129,7 +129,7 @@ jobs:
           ref: ${{ inputs.tag || env.GITHUB_REF }}
 
       - name: Setup toolchain
-        uses: dtolnay/rust-toolchain@1.66.0
+        uses: dtolnay/rust-toolchain@1.67.0
         with:
           targets: ${{ matrix.target }}
 

.github/workflows/test.yml

@@ -31,7 +31,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup toolchain
-        uses: dtolnay/rust-toolchain@1.66.0
+        uses: dtolnay/rust-toolchain@1.67.0
         with:
           targets: ${{ matrix.target }}
 

.github/workflows/wasm.yml

@@ -23,7 +23,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup toolchain
-        uses: dtolnay/rust-toolchain@1.66.0
+        uses: dtolnay/rust-toolchain@1.67.0
 
       - uses: Swatinem/rust-cache@v2
         with:
@@ -143,7 +143,7 @@ jobs:
           cp -r ./compiler/wasm/downloaded/nodejs ./compiler/wasm
           cp -r ./compiler/wasm/downloaded/web ./compiler/wasm
           yarn workspace @noir-lang/source-resolver build
-          
+
       - name: Run node tests
         run: yarn workspace @noir-lang/noir_wasm test:node
 

Cargo.toml

@@ -15,6 +15,7 @@ members = [
     "tooling/backend_interface",
     "tooling/bb_abstraction_leaks",
     "tooling/lsp",
+    "tooling/lsp_wasm",
     "tooling/nargo",
     "tooling/nargo_cli",
     "tooling/nargo_toml",
@@ -30,7 +31,7 @@ version = "0.12.0"
 # x-release-please-end
 authors = ["The Noir Team <[email protected]>"]
 edition = "2021"
-rust-version = "1.66"
+rust-version = "1.67"
 license = "MIT OR Apache-2.0"
 
 [workspace.dependencies]
@@ -43,6 +44,7 @@ nargo = { path = "tooling/nargo" }
 nargo_cli = { path = "tooling/nargo_cli" }
 nargo_toml = { path = "tooling/nargo_toml" }
 noir_lsp = { path = "tooling/lsp" }
+noir_lsp_wasm = { path = "tooling/lsp_wasm" }
 noirc_abi = { path = "tooling/noirc_abi" }
 bb_abstraction_leaks = { path = "tooling/bb_abstraction_leaks" }
 noirc_driver = { path = "compiler/noirc_driver" }
@@ -73,3 +75,5 @@ wasm-bindgen = { version = "=0.2.86", features = ["serde-serialize"] }
 wasm-bindgen-test = "0.3.33"
 base64 = "0.21.2"
 fxhash = "0.2.1"
+futures = { version = "0.3.28", default-features = false, features = ["async-await", "std", "executor"] }
+rustix = { version = "0.38", default-features = false, features = [ "std", "fs" ] }

README.md

@@ -54,7 +54,7 @@ Concretely the following items are on the road map:
 
 ## Minimum Rust version
 
-This crate's minimum supported rustc version is 1.66.0.
+This crate's minimum supported rustc version is 1.67.0.
 
 ## Working on this project
 

flake.nix

@@ -44,7 +44,7 @@
 
       rustToolchain = fenix.packages.${system}.fromToolchainFile {
         file = ./rust-toolchain.toml;
-        sha256 = "sha256-Zk2rxv6vwKFkTTidgjPm6gDsseVmmljVt201H7zuDkk=";
+        sha256 = "sha256-riZUc+R9V35c/9e8KJUE+8pzpXyl0lRXt3ZkKlxoY0g=";
       };
 
       craneLib = (crane.mkLib pkgs).overrideToolchain rustToolchain;
@@ -125,6 +125,9 @@
       noirc-abi-wasm-cargo-artifacts = craneLib.buildDepsOnly (wasmConfig // {
         pname = "noirc_abi_wasm";
       });
+      noir-lsp-wasm-cargo-artifacts = craneLib.buildDepsOnly (wasmConfig // {
+        pname = "noir_lsp_wasm";
+      });
 
       nargo = craneLib.buildPackage (nativeConfig // {
         pname = "nargo";
@@ -179,6 +182,19 @@
         doCheck = false;
       });
 
+      noir_lsp_wasm = craneLib.buildPackage (wasmConfig // rec {
+        pname = "noir_lsp_wasm";
+
+        inherit GIT_COMMIT GIT_DIRTY;
+
+        cargoArtifacts = noir-lsp-wasm-cargo-artifacts;
+
+        cargoExtraArgs = "--package ${pname} --target wasm32-wasi";
+
+        # We don't want to run tests because they don't work in the Nix sandbox
+        doCheck = false;
+      });
+
       wasm-bindgen-cli = pkgs.callPackage ./wasm-bindgen-cli.nix {
         rustPlatform = pkgs.makeRustPlatform {
           rustc = rustToolchain;
@@ -211,17 +227,19 @@
 
         # Nix flakes cannot build more than one derivation in one command (see https://github.com/NixOS/nix/issues/5591)
         # so we use `symlinkJoin` to build everything as the "all" package.
-        all = pkgs.symlinkJoin { name = "all"; paths = [ nargo noir_wasm noirc_abi_wasm ]; };
+        all = pkgs.symlinkJoin { name = "all"; paths = [ nargo noir_wasm noirc_abi_wasm noir_lsp_wasm ]; };
 
         # We also export individual packages to enable `nix build .#nargo -L`, etc.
         inherit nargo;
         inherit noir_wasm;
         inherit noirc_abi_wasm;
+        inherit noir_lsp_wasm;
 
         # We expose the `*-cargo-artifacts` derivations so we can cache our cargo dependencies in CI
         inherit native-cargo-artifacts;
         inherit noir-wasm-cargo-artifacts;
         inherit noirc-abi-wasm-cargo-artifacts;
+        inherit noir-lsp-wasm-cargo-artifacts;
       };
 
       # Setup the environment to match the environment settings, the inputs from our checks derivations,

rust-toolchain.toml

@@ -1,5 +1,5 @@
 [toolchain]
-channel = "1.66.1"
+channel = "1.67.0"
 components = [ "rust-src" ]
 targets = [ "wasm32-unknown-unknown", "wasm32-wasi", "aarch64-apple-darwin" ]
 profile = "default"

tooling/backend_interface/Cargo.toml

@@ -4,7 +4,7 @@ description = "The definition of the backend CLI interface which Nargo uses for
 version = "0.11.0"
 authors.workspace = true
 edition.workspace = true
-rust-version = "1.66"
+rust-version = "1.67"
 license.workspace = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tooling/lsp/src/lib.rs

@@ -160,7 +160,7 @@ fn on_initialize(
     state: &mut LspState,
     params: InitializeParams,
 ) -> impl Future<Output = Result<InitializeResult, ResponseError>> {
-    state.root_path = params.root_uri.and_then(|root_uri| root_uri.to_file_path().ok());
+    state.root_path = params.root_uri.and_then(|root_uri| uri_to_file_path(&root_uri).ok());
 
     async {
         let text_document_sync =
@@ -355,7 +355,7 @@ fn on_code_lens_request(
     state: &mut LspState,
     params: CodeLensParams,
 ) -> impl Future<Output = Result<CodeLensResult, ResponseError>> {
-    let file_path = match params.text_document.uri.to_file_path() {
+    let file_path = match uri_to_file_path(&params.text_document.uri) {
         Ok(file_path) => file_path,
         Err(()) => {
             return future::ready(Err(ResponseError::new(
@@ -571,7 +571,7 @@ fn on_did_save_text_document(
     state: &mut LspState,
     params: DidSaveTextDocumentParams,
 ) -> ControlFlow<Result<(), async_lsp::Error>> {
-    let file_path = match params.text_document.uri.to_file_path() {
+    let file_path = match uri_to_file_path(&params.text_document.uri) {
         Ok(file_path) => file_path,
         Err(()) => {
             return ControlFlow::Break(Err(ResponseError::new(
@@ -709,6 +709,8 @@ fn get_package_tests_in_crate(
         package_tests.push(NargoTest {
             id: NargoTestId::new(crate_name.clone(), func_name.clone()),
             label: func_name,
+            // These `file://` URIs are currently normalized inside of the vscode extension
+            // TODO: Do proper normalization inside the LSP instead of at the extension
             uri: Url::from_file_path(file_path)
                 .expect("Expected a valid file path that can be converted into a URI"),
             range,
@@ -746,6 +748,15 @@ fn byte_span_to_range<'a, F: files::Files<'a> + ?Sized>(
     }
 }
 
+// This smooths over `vscode-test-web://` or other schemes that may be sent from a browser client
+fn uri_to_file_path(uri: &Url) -> Result<PathBuf, ()> {
+    if uri.scheme() == "vscode-test-web" {
+        Ok(PathBuf::from("/").join(uri.path()))
+    } else {
+        uri.to_file_path()
+    }
+}
+
 #[cfg(test)]
 mod lsp_tests {
     use lsp_types::TextDocumentSyncCapability;

tooling/lsp_wasm/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "noir_lsp_wasm"
+description = "Language server for Noir compiled to WASI"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+acvm.workspace = true
+noir_lsp.workspace = true
+tower.workspace = true
+futures.workspace = true
+rustix.workspace = true
+async-lsp = { version = "0.0.5", default-features = false, features = ["omni-trait"] }

tooling/lsp_wasm/src/backend.rs

@@ -0,0 +1,35 @@
+use acvm::BlackBoxFunctionSolver;
+
+pub struct MockBackend;
+
+impl BlackBoxFunctionSolver for MockBackend {
+    fn schnorr_verify(
+        &self,
+        _public_key_x: &acvm::FieldElement,
+        _public_key_y: &acvm::FieldElement,
+        _signature: &[u8],
+        _message: &[u8],
+    ) -> Result<bool, acvm::BlackBoxResolutionError> {
+        unimplemented!(
+            "schnorr_verify blackbox function is not currently supported in the Wasm LSP"
+        )
+    }
+
+    fn pedersen(
+        &self,
+        _inputs: &[acvm::FieldElement],
+        _domain_separator: u32,
+    ) -> Result<(acvm::FieldElement, acvm::FieldElement), acvm::BlackBoxResolutionError> {
+        unimplemented!("pedersen blackbox function is not currently supported in the Wasm LSP")
+    }
+
+    fn fixed_base_scalar_mul(
+        &self,
+        _low: &acvm::FieldElement,
+        _high: &acvm::FieldElement,
+    ) -> Result<(acvm::FieldElement, acvm::FieldElement), acvm::BlackBoxResolutionError> {
+        unimplemented!(
+            "fixed_base_scalar_mul blackbox function is not currently supported in the Wasm LSP"
+        )
+    }
+}

tooling/lsp_wasm/src/main.rs

@@ -0,0 +1,27 @@
+use async_lsp::{concurrency::ConcurrencyLayer, panic::CatchUnwindLayer, server::LifecycleLayer};
+use noir_lsp::NargoLspService;
+use tower::ServiceBuilder;
+
+mod backend;
+mod stdio;
+
+fn main() {
+    // let blackbox_solver = acvm::blackbox_solver::BarretenbergSolver::initialize().await;
+    let blackbox_solver = backend::MockBackend;
+    let (server, _) = async_lsp::MainLoop::new_server(|client| {
+        let router = NargoLspService::new(&client, blackbox_solver);
+
+        ServiceBuilder::new()
+            .layer(LifecycleLayer::default())
+            .layer(CatchUnwindLayer::default())
+            .layer(ConcurrencyLayer::default())
+            .service(router)
+    });
+
+    let stdin = stdio::PipeStdin::lock().expect("stdin to lock");
+    let stdout = stdio::PipeStdout::lock().expect("stdout to lock");
+
+    futures::executor::block_on(async {
+        server.run_buffered(stdin, stdout).await.expect("server should start");
+    })
+}