feat(core): improved command matching with macros, fixes #1157 - #1301
Merged
Conversation
lucasfernog
reviewed
Feb 26, 2021
chippers
reviewed
Feb 27, 2021
instead of guessing based on type
also remove webview type inference
chippers
reviewed
Feb 28, 2021
Co-authored-by: chip <chip@chip.sh>
Co-authored-by: chip <chip@chip.sh>
lucasfernog
approved these changes
Feb 28, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
The PR fulfills these requirements:
fix: #xxx[,#xxx], where "xxx" is the issue number)If adding a new feature, the PR's description includes:
Other information:
This PR adds two macros,
#[command]andgenerate_handler![]. Combined, these allow command handling to look like this:#[command]adds a second function,NAME_wrapperto function with nameNAME. This wrapper function accepts theWebviewManagerandserde_json::Valueas args, and returns atauri::InvokeResponse. Theserde_json::Valueshould match the names and types of the original function args, ie the JSON forfn original(name: String)would be{"name": "some string"}. The wrapper function casts the value to a typed struct that contains all the function args, and passes them to the original function. It also passes theWebviewManageras the first arg if it is awith_webviewcommand. It then converts the response from the original function to atauri::InvokeResponse, and then returns it.The
generate_handler![]macro takes an array of paths to#[command]functions and returns a closure compatible withinvoke_handler. This closure parses the arg string into atauri::DispatchInstructions, a simple struct with two params:cmd, a string andargs, aserde_json::Value. Thecmdparam is used in a generated match statement that matches it to one of the functions passed to this macro. It then calls that function's wrapper function with theWebviewManagerandargs, the JSON value that should hold all of that function's arguments. It returns the output from that function back to the webview.TODO:
Resultfor better error handlingSupport for inferring webview arg typeWe decided to not include thiswith_webviewcommands