feat(debugger): debug tests functions (#5208)

[anaPerezGhiglia]

Description

Expand debugger funcionality to support debugging test functions and configure an external oracle-resolver url.
This will allow to debug contract tests using the TXE as oracle resolver

Problem*

Resolves noir-lang#5208

Summary*

• Add the possibility to compile and debug a test function
• Add a new config parameter to configure an external oracle resolver when debugging
• REPL: execute the debugger in a separate thread than the repl cli
• Add new Debug test codelens request. Related vscode-noir PR (feat(codelens): add debug test codelens vscode-noir#3))

Additional Context

Debugger changes

• add test-name and oracle-resolver arg options to debugger (both repl and dap interfaces)
• modify DebugForeignCallExecutor to support setting a resolver_url
• modify the debugger to know how to compile a specific function that's not the main function
• create a new DebugExecutionResult enum that represents the possible outcomes of debugging a program
• modify the debugger to expose the execution result once the debug session ends
• add the responsibility of analyzing the execution result once the debugger finishes with the execution to analyze whether the execution matches the test expectations (some test may be marked to should_fail)
• convert ReplDebugger into AsyncReplDebugger
  • this involved spawining a new thread and communicating with the debugger through a mpsc channel
    • this implied moving some responsibility from the _cmd to the debugger mod, and from the repl to the context- like creating the Bn254BlackBoxSolver or restarting the debugging context
  • the async debugger entry points are defined by the DebugCommandAPI enum

Modifications in nargo module

• extract logic of mapping a OpcodeResolutionError to an ExecutionError from nargo::ops::execute into a new function nargo::errors::execution_error_from. Use this new function in debugger::context and nargo::ops::execute
• create a new nargo::ops::debug module. Extract reused debug functions into it.
  The moved functions are mostly about knowing how to compile or prepare the package for compiling for debugging. This also avoids generating inter-dependencies between debug_cmd and dap_cmd
• extract check_crate_and_report_errors from check_cmd to nargo::ops since it was being used in different commands
• make some test functions and structs public to be able to use them from debugger cli commands
  • make some nargo::ops::test functions public
  • create TestResult::new function to be able to construct one from dap
• modify RPCForeignCallExecutor to apply workaround for RPCForeignCallExecutor fails on long delays between requests noir-lang/noir#7463

Modifications in noirc_frontend::debug module

• Modify the DebugInstrumenter to instrument contract functions in addition to top-level functions

Observations

• This PR has a workaround for RPCForeignCallExecutor fails on long delays between requests noir-lang/noir#7463 applied

Things to improve down the road

• both the repl and the dap are keeping track of the last_result. Perhaps this is something that could be moved to the context

Documentation*

Check one:

• No documentation needed.
• Documentation included in this PR.
• [For Experimental Features] Documentation to be submitted in a separate PR.

PR Checklist*

• I have tested the changes locally.
• I have formatted the changes with Prettier and/or cargo fmt on default settings.

[github-actions]

Thank you for your contribution to the Noir language.

Please do not force push to this branch after the Noir team have started review of this PR. Doing so will only delay us merging your PR as we will need to start the review process from scratch.

Thanks for your understanding.

[mverzilli]

Left some suggestions to enhance the docs

[mverzilli]

Suggested change

	JSON RPC url to solve oracle calls
	JSON RPC URL to solve oracle calls.

[mverzilli]

Let's add a little more explanation, it is true that this sets the target for oracle calls, but from the perspective of users/newcomers it is kind of obscure. I'd expand telling that this lets you interact with a TXE, which enables debugging tests that use aztec-contracts

[anaPerezGhiglia]

Mmmh, I'm not sure about that. I thought about it when writing this, but then I changed my mind because these docs are about noir-lang, not about aztec framework.
I definitively think that there should be a "How to debug aztec contracts tests" guide, but I think that that guide should live in aztec's docs, not in noir's.

[mverzilli]

Looking great!

[mverzilli]

Nit (only if it doesn't generate a borrow checker headache, which I can't tell without trying): maybe refactor to get the Vec<VecDeque<&str>> from a string array of arrays, to reduce the "visual noise" in this.

It could be a good idea to add a trim somewhere so the test isn't sensitive to white space, which should also help make it easier to maintain this test and/or add new ones

[mverzilli]

This maybe a good use case for a macro?

[anaPerezGhiglia]

I changed it to VecDeque becuase it has the pop_front method that consumes the first element from the vector
I got to it by reading the Vec::pop doc that says

/// If you'd like to pop the first element, consider using
/// [VecDeque::pop_front] instead.

[anaPerezGhiglia]

On the other hand, I removed the useless whitespace on the expected lines and replaced the trim_start() with a trim() on the other branch (and cherry-picked it here for later)