Skip to content

plugins-guide: concrete patterns for duplicate-side-effect testing #4481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brianmacdonald-temporal merged 2 commits into from
May 4, 2026
+4 −1
Merged

plugins-guide: concrete patterns for duplicate-side-effect testing #4481

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01f4c9d
plugins-guide: concrete patterns for duplicate-side-effect testing
donald-pinckney Apr 23, 2026
fa56efb
Merge branch 'main' into docs/plugins-side-effect-testing
brianmacdonald-temporal May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/develop/plugins-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -976,6 +976,9 @@ worker = Temporalio::Worker.new(
</SdkTabs.Ruby>
</SdkTabs>

Check for duplicate side effects or other types of failures.
Inside this replay regime, you should test for duplicate side effects or other types of failures. When testing for duplicate side effects, it may not be sufficient to simply have a counter that increments once per effect, as activities may be retried. Instead, consider these patterns:

- count `ActivityTaskScheduled` events of the expected activity type in workflow history (one per intended call, independent of retries),
- or accumulate activity IDs in a concurrency-safe set and assert on its size (different scheduled activities get different IDs; retries of the same scheduled activity share one).

It's harder to test against side effects to global variables, so this practice is best avoided entirely.
Loading