Use generic runtime in command examples for testability #3255
Conversation
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
When writing integration tests for Tauri commands using `tauri::test::MockRuntime`, directly calling command functions defined simply with `app: AppHandle` can lead to type mismatch errors (E0308). This occurs because the non-generic signature often defaults to expecting `AppHandle<Wry>`, while the test provides `AppHandle<MockRuntime>`. This commit updates command function examples across the documentation (where `AppHandle` or `State` are used as arguments) to utilize the generic runtime pattern: ```rust async fn command<R: Runtime>(app: AppHandle<R>, state: State<'_, MyState>, ...) ``` Adopting this generic approach makes command functions compatible with any valid Tauri runtime (`R: Runtime`), including `MockRuntime`. This significantly improves testability by allowing developers to call command logic directly in their tests, bypassing potential issues with mock invoke handlers and focusing on verifying function behavior and state interactions.
✅ Deploy Preview for tauri-v2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Hey thanks for the work, since this syntax is quite verbose and is only useful for using another tauri runtime (in this case the mock runtime), I think maybe we could add a section/tip for this instead of changing the example like this |
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.
Closes tauri-apps/tauri#12077
Description
When writing integration tests for Tauri commands using
tauri::test::MockRuntime, directly calling command functions defined simply withapp: AppHandlecan lead to type mismatch errors (E0308). This occurs because the non-generic signature often defaults to expectingAppHandle<Wry>, while the test providesAppHandle<MockRuntime>.This commit updates command function examples across the documentation (where
AppHandleis used as an argument) to utilize the generic runtime pattern:Adopting this generic approach makes command functions compatible with any valid Tauri runtime (
R: Runtime), includingMockRuntime. This significantly improves testability by allowing developers to call command logic directly in their tests, bypassing potential issues with mock invoke handlers and focusing on verifying function behavior and state interactions.