Releases: temporalio/sdk-go
v1.38.0
Breaking Changes
When using sessions, deployment info is no longer sent on the worker specific task queue. This should reduce load on the server due to less temporary task queues. No changes in behaviour is expected for session workers.
Bugfixes
Fixed a bug in Poller autoscaling causing maxNumberOfPollers to not be respected.
What’s Changed
2025-10-09 - 2d05a73 - Use macOS 15 intel runners (#2072)
2025-10-13 - a117802 - Set worker version on eager start requests (#2075)
2025-10-13 - d61d5ef - Remove experimental warnings from worker tuners (#2077)
2025-10-14 - ad990a3 - Include failure details in query failure. Improved gRPC message too large detection. Fix flaky TestGrpcMessageTooLarge. (#2078)
2025-10-15 - 09e0634 - Upgrade to Nexus SDK 0.5.1 and inline the client implementation for tests (#2079)
2025-10-17 - f7eff2a - Remove Nexus deprecated APIs (#2081)
2025-10-22 - 8a24b22 - Add nightly throughput stress (#2087)
2025-10-24 - f34365e - Replace tctl references with Temporal CLI (#2080)
2025-10-27 - 2c43194 - Fix envconf docs path (#2093)
2025-10-29 - 5cd20cf - Set explicit permissions for GitHub Actions workflows (#2095)
2025-10-30 - 82be7bc - Cleanup nightly tps workflow (#2091)
2025-11-06 - 4b5d758 - Add actions-read permission to CI workflow (#2100)
2025-11-07 - a451bef - Remove experimental notes from poller behavior docs (#2096)
2025-11-12 - 9efde41 - fix: run maxNumberOfPollers poller routines instead of initialNumberOfPollers (#2105)
2025-11-14 - 7c0ebcf - OpenTelemetry: Specify span kind and don't set error type for benign exception (#2048)
2025-11-19 - 7025a6a - Stop sending deployment info for session per-worker task queue (#2088)
v1.37.0
Breaking Changes
Versioning - Small API Rename
Renamed BuildId to BuildID in WorkerDeploymentVersion to match all other instances and Go naming convention.
Bugfixes
Reverting behavior for unblockSelectorSignal SDK flag
The previous fix introduced with the SDK flag unblockSelectorSignal was found to have a different bug with losing signals. For now the flag is getting turned off, and a more robust solution will be re-introduced in a future release. If anyone happens to rely on this new behavior already, the UNBLOCK_SIGNAL_SELECTOR env var can be set to enable the SDK flag.
What’s Changed
2025-08-27 - b2d1477 - Disable some flaky tests (#2037)
2025-09-02 - a2ac97f - Changes to gRPC message too large error handling (#2042)
2025-09-12 - ef85fee - 💥 Rename BuildId -> BuildID in WorkerDeploymentVersion (#2051)
2025-09-19 - 96d9f2b - Activity reset (#2056)
2025-09-22 - 1528c32 - Add NexusInfo (#2054)
2025-09-23 - ff709e4 - Added retry policy to activity info (#2057)
2025-09-24 - aecdca8 - Fix CA cert config validation (#2052)
2025-10-02 - 8d43143 - populate ManagerIdentity from Describe (#2063)
2025-10-07 - 0968a50 - Pass AllowNoPollers flag to SetCurrentVersion and SetRampingVersion (#2067)
2025-10-07 - 3e46cbd - Fix activity cancelation check (#2069)
2025-10-07 - 5ed31b6 - Revert setting unblockSelectorSignal SDK flag by default (#2070)
2025-10-07 - f88bdd3 - Implement SetWorkerDeploymentManagerIdentity (#2068)
New Contributors
- @kaijchang made their first contribution in #2052
Full Changelog: v1.36.0...v1.37.0
v1.36.0
Task Queue Fairness (Pre-release)
This release adds support for Task Queue Fairness. Fairness is a new feature of Temporal’s task queues that allows for more control over the order that tasks are dispatched from a backlog. It’s intended to address common situations like multi-tenant applications and reserved capacity bands. For more details see the go doc's on temporal.Priority.
Fairness is currently not supported in any OSS Temporal release, but support will be coming soon. To experiment with this feature please see the pre-release development server or if you are a Temporal Cloud customer reach out to your SA to be enabled once it is available in Temporal Cloud.
Bugfixes
No longer retry "gRPC message size to large" error
The SDK will no longer retry "gRPC message size to large" errors or related errors. These errors occur if the user tries to make a gRPC request that exceeds the Temporal Service limits (typically 4 MB).
What’s Changed
2025-07-09 - 76f7c68 - Update test server to version 1.4.0 (#1994)
2025-07-09 - 7acd4d4 - Restore features branch to main (#1995)
2025-07-10 - 2ce5137 - Omit version token if empty (#1998)
2025-07-15 - 1dc8b10 - Fix data converter ToPayload error management (#2000)
2025-07-17 - 45621f4 - Remove experimental notice for UwS (#2004)
2025-07-21 - ce09baa - Add poller autoscaler (#1956)
2025-07-24 - 9ce618c - Accept search attributes for dev server (#2002)
2025-07-30 - f92dde1 - add compile time assertion (#2008)
2025-08-05 - 4026e02 - Move Nexus operation token generation outside of callback conditional (#2009)
2025-08-06 - 573d6de - Fix event type typo in Nexus cancellation types test (#2014)
2025-08-18 - f458e8a - Improve Nexus cancellation type test assertions (#2016)
2025-08-19 - 49ee963 - Upgraded go-grpc-middleware to v2.3.2 and x/tools to v0.36.0 (#2022)
2025-08-19 - 9ca81c6 - Add Fairness Keys/Weights (#2012)
2025-08-26 - 3080f44 - Add Go to Waitgroup (#2032)
2025-08-26 - 6d00d48 - Do not auto-retry gRPC-message-size-too-large errors (#2026)
v1.35.0
Breaking Changes
Nexus - Deprecate API removed
Some Nexus APIs previously deprecated are now removed. Most notably OperationID was removed, users should switch to OperationToken .
Highlights
Nexus Operation Cancellation Types (Pre-release)
Users can now specify the cancellation type when cancelling a Nexus operations from a workflow. This allows for more granular control over how Nexus operations are cancelled, and how the caller is notified of the cancellation.
Dynamic Workflow and Activities
Dynamic workflow and activities, which are nameless, can now be registered with RegisterDynamicWorkflow and RegisterDynamicActivity. This allows users to specify a default workflow to run if a worker does not recognize the workflow or activity being run on it.
Workflow Metadata - Local Activity Summary
Local activities now support a Summary like normal activities and child workflows.
Application Error Category
Application errors can specify a category, called ApplicationErrorCategory, to control logging and metrics behavior of activity failures
What’s Changed
2025-04-18 - 0517ec9 - Make doc comment name match code name (#1920)
2025-04-21 - a921890 - Add support for root workflow execution to workflow info (#1923)
2025-04-23 - 50118c6 - Remove old Nexus workflow run operation token format (#1927)
2025-04-25 - ee78d25 - Add application err category (#1925)
2025-04-28 - 3db4820 - Add missing lock (#1938)
2025-04-29 - f3fcc94 - Update [golang.org/x/net](http://golang.org/x/net) for CVE-2025-22872 (#1939)
2025-04-30 - 2c90009 - Fix trying to decode nil summary fields (#1941)
2025-04-30 - 4a43228 - Handle mix of RawValue and non-RawValue inputs for CompositeDataConverter (#1937)
2025-04-30 - 5a87f01 - Remove deprecated nexus APIs (#1944)
2025-04-30 - e2dfd9d - Add high level workflow describe (#1924)
2025-05-01 - 5de51a1 - Support for RequestIdReference in Link (#1877)
2025-05-02 - a10de39 - Encode the event type short string in the links (#1949)
2025-05-05 - 876aaaf - Remove per-file copyright headers (#1950)
2025-05-06 - 6d2cb6a - Implement Nexus operation cancellation types (#1917)
2025-05-07 - 52c7523 - Set Nexus links in the callback (#1945)
2025-05-08 - 46420c2 - Handle links from ExecuteWorkflow in Nexus WorkflowRunOperation (#1934)
2025-05-15 - b13a953 - Add SearchAttributes.Copy exception to workflowcheck (#1958)
2025-05-16 - f55d382 - Dynamic workflows and activities (#1946)
2025-05-27 - 71ce2dc - fix comments and grammar (#1959)
2025-05-28 - df05d05 - Mark Nexus operation cancellation type as Experimental. (#1960)
2025-05-30 - 22952b3 - Don't heartbeat local activity on non-graceful worker shutdown (#1933)
2025-06-03 - b955aa8 - Improve docs on NexusOperationCancellationTypeTryCancel (#1964)
2025-06-04 - 9de36a9 - Handle activity cancel due to worker shutdown properly (#1910)
2025-06-04 - a15c294 - 💥 [Breaking] Update versioning APIs to use struct (#1962)
2025-06-05 - f3b6fd4 - Use system time as started time (#1952)
2025-06-09 - 918fea8 - Fix missed spot w/ versioning string (#1969)
2025-06-10 - 28be770 - Deprecate versioning intents (#1970)
2025-06-10 - 2fb80f2 - Enable SDKFlagBlockedSelectorSignalReceive by default (#1762)
2025-06-17 - 46d0b10 - Stop Nexus worker. (#1974)
2025-06-18 - 4a4b322 - Deprecate more old versioning APIs (#1979)
2025-06-20 - 9682a69 - fix a typo (#1981)
2025-06-22 - a569259 - Clarify WithTags behaviour in metrics handler (#1975)
2025-06-25 - a1a14b9 - Fix GetWorkerStopChannel() for Local Activities (#1965)
2025-07-03 - 5be3364 - Plumb Summary through LocalActivityOptions (#1987)
2025-07-03 - f7174c2 - Fix TestActivityPause for Temporal Server v1.28.0 (#1989)
2025-07-04 - 8ee3a8a - Expose StartToCloseTimeout in ActivityInfo struct (#1990)
2025-07-07 - 4736849 - Release Go SDK v1.35.0
2025-07-07 - d68db26 - Apply context to data converter in update (#1991)
v1.34.0
Highlights
Priority (Pre-release)
User can now set a priority key when scheduling a workflow, activity or child workflow. The priority key will be used to help prioritize certain tasks over others when there is a backlog. Priority is currently not supported in any OSS Temporal release, but support will be coming soon. To experiment with this feature please see the pre-release development server or if you are a Temporal Cloud customer reach out to your SA.
Activity Pause (Pre-release)
The Go SDK now supports activity pause for heart beating activities. If an activity is paused while an attempt is running and the activity is heart-beating the activity context will be cancelled like the activity was cancelled.
Breaking Changes
Workflow Metadata Query
The built in __temporal_workflow_metadata will now use RawValue to encoded the query response. This should help with issues when a users data converter did not support protobuf payloads. The SDK's default data converter will already handle RawValue, but users custom data converter may need to be updated to handle RawValue correctly.
What’s Changed
2025-02-26 - 9ce2508 - Remove WithStartOperation from docs (#1850)
2025-02-27 - 884681f - Add assertions for labels on Nexus metrics and logs (#1855)
2025-03-12 - 5371970 - Unblock using conflict policy UseExisting for Nexus WorkflowRunOperation (#1858)
2025-03-13 - 9f876e3 - Replace github.com/pborman/uuid with github.com/google/uuid (#1854)
2025-03-13 - efa70b9 - Add WorkflowExecutionAlreadyStarted error type to description (#1866)
2025-03-14 - 2dcb1b9 - Fix possibly failing to reserve slots due to stale issued number (#1870)
2025-03-14 - 54571a2 - Fix broken docstring (#1871)
2025-03-14 - 76cebd8 - Better Nexus error message (#1863)
2025-03-17 - 08d04be - Doc: Add blank lines before "Optional", "default", and "note" lines for clarity (#1873)
2025-03-17 - 695e720 - Point to WorkflowExecutionErrorWhenAlreadyStarted in WorkflowIDReusePolicy/ConflictPolicy docstrings (#1872)
2025-03-20 - 07a817f - Add summary to Nexus operation (#1878)
2025-03-25 - 61cafbd - Allow local activities to finish running when stopping a worker (#1875)
2025-03-26 - 132f356 - Extract BuilID from Version (#1881)
2025-03-26 - a80e6d5 - Add note that NewPayloadCodecGRPCClientInterceptor comes before NewFailureGRPCClientInterceptor (#1888)
2025-03-27 - 4b15a0c - Add RawValue support (#1879)
2025-03-27 - 9cd4d23 - Add FIPs to CI (#1892)
2025-03-28 - 31c4c30 - Disable some know flaky tests (#1893)
2025-03-28 - 9f5a441 - Make sure schedule Update treats CatchupWindow properly (#1896)
2025-03-28 - ceab52c - Fix WorkflowId being wrongly capitalized on example comments (#1891)
2025-03-31 - 0c9f60d - Add warning about anonymous functions as local activities (#1897)
2025-03-31 - 84f7482 - Update documentation for Next history iterator (#1853)
2025-04-01 - 4c897cd - Support environment configuration (#1849)
2025-04-02 - 5d5b2ff - Use RawValue for built-in query responses (#1894)
2025-04-02 - 9ba19ac - Make sure GetSystemInfo uses client timeout (#1900)
2025-04-03 - b9afba9 - Add Task Queue Priority (#1902)
2025-04-07 - 729bc24 - Add worker shutdown cause to context (#1904)
2025-04-09 - 797e9aa - Clarify ReusePolicy and ConflictPolicy doc comments (#1907)
2025-04-10 - 0ead7f5 - [doclink] Fix interface parsing (#1909)
2025-04-14 - 5940638 - Add support for activity pause (#1903)
2025-04-14 - a507124 - Update golang.org/x/net (#1913)
2025-04-14 - bba43df - don't try to call nil functions for TestUpdateCallback (#1914)
v1.33.1
v1.33.0
Breaking Changes
Nexus
⚠️ IMPORTANT⚠️ This SDK release requires server>=1.27.0to properly support the full set of changes from the previous SDK release. Most notably the built-in error translation logic changed in a way that may cause Nexus tasks to retry until the caller specified schedule-to-close timeout on certain failures, see more below.- Setting
WorkflowIDConflictPolicytoWORKFLOW_ID_CONFLICT_POLICY_USE_EXISTINGhas been temporarily disabled, and will fail requests with a retryable internal error.- This is to protect users from making a false assumption that the same workflow can be used to back multiple operations. This capability will be enabled in a follow up release.
- Error translation logic changed in the following ways:
serviceerrorsreturned by the client withcodes.AlreadyExists, codes.FailedPrecondition, codes.OutOfRangenow get translated to non retryable internal Nexus handler errors.
- Non retryable
ApplicationErrorsget translated to non retryable internal Nexus handler errors instead of bad request errors. QueryRejectedErrorandWorkflowExecutionErrorno longer get translated to a bad request automatically.- Removed operation and service labels from Nexus schedule to start metric.
Versioning / Safe Deploy
This release introduces a preview of new APIs that gracefully manage code changes and worker pools that support them. The goal is to better control which workers should execute new, and existing, workflows and activities tasks, based on their code and configuration.
A Worker Deployment is a collection of Worker Deployment Versions, typically associated with a single application. Each Version abstracts away the multiple Task Queues associated with this application, providing a common interface to set versioning policy to the workers polling those queues for tasks. A Worker Deployment has a Current Version, where tasks for new workflows and activities, and also tasks for AutoUpgrade existing workflows, are dispatched. A Worker Deployment can also have a Ramping Version to gradually move tasks from the Current Version to another one.
AutoUpgrade and Pinned are two Versioning Behaviors that can be specified when registering a workflow type. Pinned workflows are typically short lived, and are never affected by new versions, i.e., they do not need to use the patch API for compatibility. AutoUpgrade workflows are mostly long running, but they need to use patching to safely transition to new versions. The choice of Pinned vs AutoUpgrade ultimately depends on your willingness to keep old worker fleets running vs the complexity of patching.
In cases when you need to override the existing Versioning Behavior for a workflow, or a set of workflows, you can use the new UpdateWorkflowExecutionOptions API, which also operates on batches.
The following EXPERIMENTAL Versioning APIs implement Worker Deployments and Workflow Versioning Behavior annotations. It requires a server with version v1.27.0 or later.
Client.WorkerDeploymentClient():Delete(): Remove a Worker Deployment.GetHandle(): Return a handle to a Worker Deployment.List(): Enumerate Worker Deployments in the client's namespace
Client.WorkerDeploymentHandle():SetCurrentVersion(): Set the Current Version for a Worker Deployment.SetRampingVersion(): Set the Ramping Version for a Worker Deployment.Describe(): Return a description of this Worker Deployment.DescribeVersion(): Return a description of a Version in this Worker Deployment.DeleteVersion(): Remove a Version in this Worker Deployment.UpdateVersionMetadata(): Change user-provided metadata associated with a Version.
UpdateWorkflowExecutionOptions: Override options of a workflow execution.Worker.Options.DeploymentOptions: Set Deployment Version and Workflow Behavior defaults.Workflow.RegisterOptions.VersioningBehavior: Annotate Workflow Behavior.
Documentation is coming soon. Do not use above APIs in production.
Cloud Operator API
Removed the Cloud Operations Client from this SDK. Users should use https://github.com/temporalio/cloud-sdk-go instead.
Highlights
Nexus
🎉 Nexus is now generally available 🎉
- Added experimental support for Nexus operation interceptors.
- Added experimental tracing interceptor support for tracing calls from a workflow to a Nexus handler through client operations, such as starting a workflow.
- The test environment behavior is now more consistent with the server behavior, especially with changes made since the 1.25 release.
- Main Nexus APIs are no longer marked as experimental.
- The Nexus APIs and fields were marked as deprecated and will be removed in the next minor release:
OperationIDwas renamed toOperationTokenand the content of it was changed to a structured token instead of copying the workflow ID directly.temporalnexus.NewSyncOperationis now deprecated, usenexus.NewSyncOperationin combination withtemporalnexus.GetClientto get similar functionality.
- Nexus now supports full error rehydration from the handler back to the caller workflow including support for the SDK’s
FailureConverter. - Upgraded Nexus SDK from
0.1.0to0.3.0, see changes here:
Workflow Reset
This release fixes a long standing issue in the Go SDK where workflows reset with a completed child workflow with the default WorkflowID would fail to replay due to a non-determinism error.
Note: This change will cause workflows that were previously stuck by #723 to become unstuck.
What’s Changed
2025-01-16 - 1c6e01b - Disable TestPinnedBehaviorThreeWorkers() test (#1780)
2025-01-17 - 2bf36d6 - Expose user metadata fields on scheduling workflows (#1782)
2025-01-17 - 454a8a8 - Add Nexus SignalWorkflowOperation (#1770)
2025-01-21 - 3befe6b - Upgrade api to 1.43.2 and Nexus to 0.1.1 (#1784)
2025-01-22 - b43588c - Fix update docstring to include context (#1785)
2025-01-23 - d2f4c14 - Update bug issue template to use bug label (#1787)
2025-01-24 - 34bbbbf - Clarify warning log on activity deadlone (#1786)
2025-01-25 - 751fa9a - Remove protolegacy build tag and InvalidUTF8Suite (#1789)
2025-01-28 - 7728bd7 - Unpin CLI (#1794)
2025-01-28 - c0ac008 - Expose workflow client from Activity (#1783)
2025-01-31 - 0262297 - Enable speculative workflow task with commands (#1724)
2025-02-03 - 349283d - Fix Update-with-Start grpc deadline (#1798)
2025-02-03 - 8f05d01 - Don't replay commands from non-completed task (#1750)
2025-02-03 - bfd12ac - Fail Nexus Operation for incompatible input type (#1800)
2025-02-04 - 2030f9b - Revert WorkflowSignalOperation (#1801)
2025-02-04 - 24542f7 - Set Temporal-Namespace header on every namespace-specific gRPC request (#1467)
2025-02-06 - 6e75f6d - Expand arguments in UpdateWorkflow call when args equal one (#1799)
2025-02-07 - 150b4bd - Reserve _temporal prefix (#1806)
2025-02-07 - b8bc1c5 - Fix missing variadic ellipsis, added test to validate (#1804)
2025-02-08 - b9ad14a - Add option to override UI port (#1793)
2025-02-10 - 1540ba4 - Fix doc links on pkg.go.dev (#1795)
2025-02-10 - 22ebdc0 - Upgrade to Nexus SDK 0.2.0 (#1802)
2025-02-10 - e5ce2c4 - Replace golang.org/x/exp with stdlib (#1807)
2025-02-11 - 9d4a99a - Add note that SetOnActivityHeartbeatListener may be called concurrently (#1818)
2025-02-11 - f29a8c5 - Rename operationID to token in TestWorkflowEnvironment (#1813)
2025-02-12 - 8101b82 - Remove Experimental annotation on Nexus APIs (#1816)
2025-02-13 - 82c56a9 - Only fallback to workflow ID as operation token when needed (#1821)
2025-02-13 - e5bc298 - Stop checking for definitions inside of functions (#1819)
2025-02-14 - 4fb50dc - Properly convert Nexus HandlerErrors in the test env (#1822)
2025-02-14 - b19fc66 - Catchup tasks for Nexus features in the test env (#1824)
2025-02-14 - f223359 - temporarily disable TestNumPollersCounter while I look into why it's flaking (#1826)
2025-02-18 - 617de7e - Add tests for nexus error rehydration (#1767)
2025-02-18 - 623badd - Remove cloud ops client (#1831)
2025-02-18 - 8f38795 - Remove operation and service labels from Nexus schedule to start metric (#1830)
2025-02-19 - 7e3d821 - Fix child WF ID generation (#1803)
2025-02-19 - e44e74e - Move SetStickyWorkflowCacheSize to global config setup (#1836)
2025-02-20 - c99ec47 - Translate relevant errors to non retryable internal Nexus handler errors (#1833)
2025-02-21 - 1720257 - More user-friendly NDE error message (#1837)
2025-02-21 - f5882aa - Support Worker Deployments 3.1 (#1832)
2025-02-22 - d32c252 - Nexus interceptors (#1841)
2025-02-24 - 2449502 - Support conflict options for starting Nexus operations in test framework (#1828)
2025-02-24 - 61c10ce - Fix AsTime() for nil proto timestamp (#1847)
2025-02-24 - b2b75c9 - [Nexus] Set OnConflictOptions for WorkflowRunOperation (#1797)
2025-02-25 - 24db567 - Release Go SDK v1.33.0
2025-02-25 - ab1c356 - Block using conflict policy UseExisting for Nexus WorkflowRunOperation (#1845)
2025-02-25 - f3da1f5 - Add Nexus tracing interceptor (#1844)
v1.32.1
Versioning / Safe Deploy (pre-release)
This release introduces a preview of new APIs that gracefully manage code changes and worker pools that support them. The goal is to better control which workers should execute new, and existing, workflows and activities tasks, based on their code and configuration.
Worker Deployments provide a consistent interface to set versioning policy for multiple Task Queues within a versioned application. Versioning Behaviors eliminate the need of patching short-running Workflows by pinning them to a particular version. The new UpdateWorkflowExecutionOptions API overrides versioning attributes for a particular workflow, or, using a batch command, for a set of workflows.
The following EXPERIMENTAL Versioning APIs implement Worker Deployments and Workflow Versioning Behavior annotations. It requires a server with version v1.26.2 or later.
Client.DeploymentClient():Describe(): Show properties of a Worker Deployment.GetReachability(): Return information to safely decommission Workers.List(): Enumerate Worker Deployments in the client's namespaceSetCurrent(): Set the current Deployment for a Deployment Series.GetCurrent(): Find the current Deployment for a Deployment Series.
UpdateWorkflowExecutionOptions: Override options of a workflow execution.Worker.Options.DeploymentOptions: Set Deployment and Workflow Behavior defaults.Workflow.RegisterOptions.VersioningBehavior: Annotate Workflow Behavior
Documentation is coming soon. Do not use above APIs in production.
Workflow Update
Workflow Update, excluding Update-with-Start, is no longer marked as experimental.
What’s Changed
2024-12-12 - ccb28ef - Versioning 3 (#1744)
2024-12-20 - 380add9 - Add Nexus links tests (#1613)
2025-01-08 - 423a9a3 - Remove Nexus OpCanceledBeforeStarted test (#1763)
2025-01-08 - 4dd46b8 - Resolve workflow name alias in Nexus WorkflowRunOperation (#1766)
2025-01-08 - 938dcad - Fix versioning override with AutoUpgrade behavior (#1765)
2025-01-10 - 815c648 - small docs/rendering fixes (#1769)
2025-01-10 - a708f7e - Remove docker flag that disables versioning tests (#1771)
2025-01-10 - b8f9b44 - docs: fix bullets in intellisense (#1768)
2025-01-14 - 3506cd2 - Fix doclink tool's duplicate docstring generation issue (#1773)
New Contributors
- @GSmithApps made their first contribution in #1768
Full Changelog: v1.31.0...v1.32.1
v1.31.0
Nexus Breaking Changes
Add support for full Temporal error rehydration to provide a more consistent experience for Temporal users and on par debugging experience with workflows and activities..
Any Temporal errors returned over the Nexus boundary will now automatically be fully rehydrated on the caller side.
Some notable points:
- The Nexus SDK was upgraded to
v0.1.0, which is a breaking change. Temporal Nexus users should refer to the release notes before upgrading the Temporal SDK. nexus.HandlerErrornow has aFailurerepresentation and is visible to the caller workflow.- Arbitrary errors are translated to
ApplicationErroras they do in the rest of the Temporal SDK. WorkflowExecutionError,QueryRejectedError, and non retryableApplicationErrors are no longer translated to bad request handler errors, instead they're translated toOperationErrors.
Update With Start
UpdateWithStartWorkflow issues an update-with-start request. A WorkflowIDConflictPolicy must be set in the options. If the specified workflow execution is not running, then a new workflow execution is started and the update is sent in the first workflow task. Alternatively if the specified workflow execution is running then, if the WorkflowIDConflictPolicy is USE_EXISTING, the update is issued against the specified workflow, and if the WorkflowIDConflictPolicy is FAIL, an error is returned. The call will block until the update has reached the WaitForStage in the options. Note that this means that the call will notreturn successfully until the update has been delivered to a worker.
Changes in this release:
Instead of using the ExecuteWorkflow client method, update-with-start is invoked via a new client method UpdateWithStartWorkflow.
To use this method, you should first use NewWithStartWorkflowOperation to define the start-workflow operation. A workflow ID conflict policy is required. Then call UpdateWithStartWorkflow, passing it an UpdateWithStartWorkflowOptions containing your WithStartWorkflowOperation, together with an UpdateWorkflowOptions defining the update operation. This will return an UpdateHandle. The WithStartWorkflowOperation exposes a blocking .Get(ctx) method to obtain the workflow run targeted by the update.
New Contributors
What's Changed
2024-12-02 - 2c6bc1d - Introduce separate slot supplier for session activities (#1736)
2024-12-03 - 9c4dde8 - Use constant case in Nexus link URL eventType query param (#1741)
2024-12-03 - aa4535d - WorkflowTestSuite.UpdateWorkflow generate an update ID if none (#1738)
2024-12-05 - 01b52a2 - Tweak UpdateWorfklow docs (#1745)
2024-12-05 - 9d59447 - New Update-With-Start API (#1731)
2024-12-06 - 1f35a5b - mock: in order mock calls using new testify mock.InOrder() method (#1743)
2024-12-06 - 7828e06 - Update Godoc for internal structs/funcs to clarify the package they are exposed under (#1735)
2024-12-09 - 41e9b33 - Tweak Update-with-Start error reporting (#1746)
2024-12-10 - 1b21084 - Bump SDKVersion to 1.31.0 (#1753)
2024-12-10 - d21ede2 - Nexus error rehydration (#1751)
Full Changelog: v1.30.1...v1.31.0
v1.30.1
Breaking Changes
Nexus async Operations backed by ExecuteUntypedWorkflow (i.e. NewWorkflowRunOperation and NewWorkflowRunOperationWithOptions) are now required to set the workflow ID on the StartWorkflowOptions parameter. If workflow ID is unset, the new error ErrMissingWorkflowID will be returned.
What's Changed
- Update mac intel runner to macos-13 by @Quinn-With-Two-Ns in #1702
- Fix lost signal from Selector when Default path blocks by @yuandrew in #1682
- Support user metadata on activities and child/scheduled workflows by @Quinn-With-Two-Ns in #1719
- Added SpanFromWorkflowContext function by @cdimitroulas in #1711
- Improve Update Workflow testing UX by @yuandrew in #1721
- Dedup duplicate update IDs for test environment by @yuandrew in #1695
- When evicting workflows from cache make sure all go routines are evicted serially by @Quinn-With-Two-Ns in #1718
- Add accessors for ChildWorkflowExecutionError fields by @yuandrew in #1726
- Fix worker leak in eager dispatcher by @Quinn-With-Two-Ns in #1723
- Set Nexus operation ID on callback headers by @pdoerner in #1710
New Contributors
- @cdimitroulas made their first contribution in #1711
Full Changelog: v1.30.0...v1.30.1