housekeeping: Update module go.temporal.io/sdk to v1.31.0 #3188
Conversation
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
ℹ Artifact update noticeFile name: backend/go.modIn order to perform the update(s) described in the table above, Renovate ran the
Details:
|
|
This PR has been marked as stale after 7 or more days of inactivity. Please have a maintainer add the |
renovate
bot
force-pushed
the
renovate/go.temporal.io-sdk-1.x
branch
from
58df46c to
c9e5853
Compare
renovate
bot
changed the title
|
This PR has been marked as stale after 7 or more days of inactivity. Please have a maintainer add the |
Renovate Ignore NotificationBecause you closed this PR without merging, Renovate will ignore this update ( If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR. |
This PR contains the following updates:
v1.26.1->v1.31.0Release Notes
temporalio/sdk-go (go.temporal.io/sdk)
v1.31.0Compare Source
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:
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.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
UpdateWithStartWorkflowissues an update-with-start request. AWorkflowIDConflictPolicymust 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 theWorkflowIDConflictPolicyisUSE_EXISTING, the update is issued against the specified workflow, and if theWorkflowIDConflictPolicyisFAIL, an error is returned. The call will block until the update has reached theWaitForStagein 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
ExecuteWorkflowclient method, update-with-start is invoked via a new client methodUpdateWithStartWorkflow.To use this method, you should first use
NewWithStartWorkflowOperationto define the start-workflow operation. A workflow ID conflict policy is required. Then callUpdateWithStartWorkflow, passing it anUpdateWithStartWorkflowOptionscontaining yourWithStartWorkflowOperation, together with anUpdateWorkflowOptionsdefining the update operation. This will return anUpdateHandle. TheWithStartWorkflowOperationexposes 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: temporalio/sdk-go@v1.30.1...v1.31.0
v1.30.1Compare Source
Breaking Changes
Nexus async Operations backed by
ExecuteUntypedWorkflow(i.e.NewWorkflowRunOperationandNewWorkflowRunOperationWithOptions) are now required to set the workflow ID on theStartWorkflowOptionsparameter. If workflow ID is unset, the new errorErrMissingWorkflowIDwill be returned.What's Changed
New Contributors
Full Changelog: temporalio/sdk-go@v1.30.0...v1.30.1
v1.30.0Compare Source
Highlights
Nexus
We have made some improvements in Nexus metrics,
nexus_task_execution_failedis now tagged with afailure_reasonto help users understand the cause of the task failure.see also: https://docs.temporal.io/references/sdk-metrics#nexus_task_execution_failed
Test Environment
Improved support for mocking Nexus operations so you won’t need to have access to the operation itself or implementing a dummy operation. You can mock by calling
OnNexusOperationand, when appropriate,RegisterNexusAsyncOperationCompletion.Docs coming soon.
Worker shutdown
When a Go SDK worker s shutting down it will now communicate to the Temporal service through a new
ShutdownWorkerAPI that the worker is no longer taking more tasks. If the Temporal service supports this feature all sticky workflow tasks will be assigned back to the normal task queue. This should reduce latency caused by shutting down a worker due to stick task queue timeout.What's Changed
2024-09-17 -
03e0341- Use stable CLI for tests (#1637)2024-09-17 -
8283604- Remove DISABLE_NEXUS_TESTS env var from test code (#1640)2024-09-23 -
d10e871- Update workflowcheck and allow it to handle aliased context (#1642)2024-09-24 -
cf3153e- expose ScheduleDescription (#1649)2024-10-01 -
974ccc0- Call the ShutdownWorker API as part of workflow worker cleanup (#1645)2024-10-01 -
f0ac2ee- Fix Nexus test env to respect ScheduleToCloseTimeout (#1636)2024-10-02 -
772bc83- MultiOperation retries non-durable Update (#1652)2024-10-03 -
4e8380c- Error for unused Update operation (#1655)2024-10-03 -
cdd3070- Remove history truncation (#1656)2024-10-03 -
d7a2128- Enforce nexus request timeout in workflow test suite (#1653)2024-10-03 -
ea60ad5- Evict the workflow from cache if their is a panic in the SDK (#1654)2024-10-04 -
7d57a66- ensure WorkflowTaskExecutionFailureCounter is called with a tag (#1658)2024-10-08 -
75bd94b- Panic if endpoint or service is empty in NewNexusClient (#1661)2024-10-08 -
b300e50- Nexus: Fix link not being attached to a workflow started via a Handler function (#1659)2024-10-08 -
b4e934e- Include updateID and updateName in update logger (#1660)2024-10-08 -
c82a8ac- Error if history contains unexpected events after the StartedEventId (#1662)2024-10-09 -
3671c99- fix link (#1665)2024-10-14 -
e503995- Fix nexus_task_execution_failed to include OperationError outcome in start requests (#1664)2024-10-15 -
7432064- Add regression test to validate temporal_workflow_task_execution_failed on replay (#1669)2024-10-16 -
959f581- Read cgroups for resource tuner limits (#1632)2024-10-16 -
cfc38de- Fix TestNonDeterminismFailureCauseReplay integration test (#1674)2024-10-18 -
1a13bf3- Add Nexusfailure_reasonmetric tag (#1671)2024-10-24 -
5505d04- Fix failure_reason label for nexus_task_execution_failed metric on task timeout (#1684)2024-10-24 -
56b601d- Bump Nexus sdk-go to v0.0.11 (#1685)2024-10-25 -
2bd372c- Upgrade API to v1.40.0 (#1688)2024-10-25 -
c0a1b59- Translate gRPC Canceled code to Nexus HandlerErrorTypeInternal (#1680)2024-10-28 -
37d1775- Support for mocking nexus operations (#1666)2024-10-28 -
4afb587- Update-with-Start incompatible options (#1690)v1.29.1Compare Source
What's Changed
Full Changelog: temporalio/sdk-go@v1.29.0...v1.29.1
v1.29.0Compare Source
Highlights
Workflow Update-With-Start (Private Preview)
Note: This feature requires a server version 1.24+ and must be enabled. For self hosted you can set
frontend.enableExecuteMultiOperationfor Temporal Cloud please reach out to your Temporal account team or Temporal Support Team to enable update with start in your namespace.This release add support for Workflow Update-With-Start. Update-With-Start allows users to send a Workflow Update request along with a Start Workflow request in the same RPC. Users can think of Update-With-Start as analogous to Signal-With-Start except for Updates instead of Signals. To create a Update with start request users call
client.NewUpdateWithStartWorkflowOperationand pass it toWorkflowOptions.WithStartOperation.Slot auto tuning (Private Preview)
Added
WorkerOptions.Tunerwhich is aWorkerTunercomposed ofSlotSuppliers. These interfaces can be used to customize how the worker decides to make slots available for Workflow and Activity Tasks. Some default slot suppliers are included:ResourceBasedSlotSuppliercan be used to tune the workers slot count based on available memory and cpu resources. Make a ready-to-goWorkerTunerby usingNewResourceBasedTuner. You can set a memory/cpu target and the worker will automatically try to reach those target usage levels.FixedSizeSlotSupplieralways hands out slots until an upper boundCompositeTunercan be used to combine different kinds ofSlotSuppliersto implementWorkerTuner.Please give the resource based tuning a try and let us know how it works for you (feedback on community slack is welcome)! It'll work best if the worker is the only thing on your host using significant resources. Try setting the thresholds to a reasonable value like 0.8
Note: Resource based tuning and custom Slot Supplier implementations are currently considered experimental.
User Metadata (Public Preview)
Note: This feature requires a server version 1.25+
This release add support for user metadata inside Workflows. This lets users set custom metadata on Workflow executions and certain APIs inside workflow that will be visible on the UI
Currently the Go SDK support:
workflow.NewTimerWithOptionsworkflow.SignalChannelOptions,workflow.QueryHandlerOptionsandworkflow.UpdateHandlerOptionsSee also: https://github.com/temporalio/features/issues/486
What's Changed
2024-07-23 -
9c40461- Add utility to get metrics handler for a Nexus operation (#1559)2024-07-25 -
bcc623d- Add support for managing schedule search attributes when when updating a schedule (#1562)2024-07-26 -
1f0296c- Support for WorkflowIdConflictPolicy (#1563)2024-07-29 -
2baa60e- Test duplicate rejected updates (#1569)2024-07-29 -
6bb8f99- Add rule code to warning (#1572)2024-07-29 -
dd28ced- Protect against legacy queries when state is destroyed (#1568)2024-08-05 -
9b9201f- Use correct branch when not a pull request (#1578)2024-08-05 -
c5b519e- Build omes worker image w/ pending changes (#1577)2024-08-06 -
a1d05a6- WorkerTuner & Resource based autotuning (#1546)2024-08-06 -
c2ce2e6- Do not warn on unfinished handlers if workflow failed (#1581)2024-08-08 -
2927574- Switch omes to post-merge (#1583)2024-08-09 -
0b7928d- Fix UpsertTypedSearchAttributes docs typo (#1585)2024-08-14 -
bb42a8b- Fix Go SDK CI (#1590)2024-08-14 -
c3ac511- Improve docs and tests for HandlerUnfinishedPolicy (#1589)2024-08-15 -
2a02c48- Removing wording saying a signal will ignore start delay (#1592)2024-08-15 -
b5db2b7- Add TaskQueueStats to DescribeTaskQueueEnhanced (#1553)2024-08-20 -
edc3c6c- Allow workflow interceptors to add nexus headers (#1604)2024-08-21 -
1fe6141- Support updates in tracing interceptor (#1595)2024-08-21 -
a31f86d- Address flaky tests (#1607)2024-08-22 -
9bcc1a9- Minor docstring grammar updates in activity.go (#1608)2024-08-23 -
94f2100- Minor correction to TQ stats docs (#1606)2024-08-28 -
5364a47- Handle Nexus links (#1605)2024-08-29 -
e85a098- Update-with-Start operation (#1579)2024-08-30 -
1b6220d- Mark Nexus link converter functions as experimental (#1615)2024-08-30 -
f47e644- Experimental user metadata and workflow metadata query support (#1597)2024-09-03 -
2af8c72- Narrow scope of used slots lock for tracking slot supplier (#1617)2024-09-03 -
52ea97f- Mark NewTimerWithOptions as Experimental (#1619)2024-09-03 -
eb41d13- Expose QueryRejectedError (#1616)2024-07-23 -
9c40461- Add utility to get metrics handler for a Nexus operation (#1559)2024-07-25 -
bcc623d- Add support for managing schedule search attributes when when updating a schedule (#1562)2024-07-26 -
1f0296c- Support for WorkflowIdConflictPolicy (#1563)2024-07-29 -
2baa60e- Test duplicate rejected updates (#1569)2024-07-29 -
6bb8f99- Add rule code to warning (#1572)2024-07-29 -
dd28ced- Protect against legacy queries when state is destroyed (#1568)2024-08-05 -
9b9201f- Use correct branch when not a pull request (#1578)2024-08-05 -
c5b519e- Build omes worker image w/ pending changes (#1577)2024-08-06 -
a1d05a6- WorkerTuner & Resource based autotuning (#1546)2024-08-06 -
c2ce2e6- Do not warn on unfinished handlers if workflow failed (#1581)2024-08-08 -
2927574- Switch omes to post-merge (#1583)2024-08-09 -
0b7928d- Fix UpsertTypedSearchAttributes docs typo (#1585)2024-08-14 -
bb42a8b- Fix Go SDK CI (#1590)2024-08-14 -
c3ac511- Improve docs and tests for HandlerUnfinishedPolicy (#1589)2024-08-15 -
2a02c48- Removing wording saying a signal will ignore start delay (#1592)2024-08-15 -
b5db2b7- Add TaskQueueStats to DescribeTaskQueueEnhanced (#1553)2024-08-20 -
edc3c6c- Allow workflow interceptors to add nexus headers (#1604)2024-08-21 -
1fe6141- Support updates in tracing interceptor (#1595)2024-08-21 -
a31f86d- Address flaky tests (#1607)2024-08-22 -
9bcc1a9- Minor docstring grammar updates in activity.go (#1608)2024-08-23 -
94f2100- Minor correction to TQ stats docs (#1606)2024-08-28 -
5364a47- Handle Nexus links (#1605)2024-08-29 -
e85a098- Update-with-Start operation (#1579)2024-08-30 -
1b6220d- Mark Nexus link converter functions as experimental (#1615)2024-08-30 -
f47e644- Experimental user metadata and workflow metadata query support (#1597)2024-09-03 -
2af8c72- Narrow scope of used slots lock for tracking slot supplier (#1617)2024-09-03 -
52ea97f- Mark NewTimerWithOptions as Experimental (#1619)2024-09-03 -
eb41d13- Expose QueryRejectedError (#1616)2024-09-05 -
6f8719a- Improve active task queue definition (#1621)v1.28.1Compare Source
Specific Changes
v1.28.0Compare Source
Nexus pre-release
See the proposal for usage instructions.
Self hosted users can try Nexus out in single cluster deployments with server version
1.25.0-rc.0- not meant for production use.Temporal Cloud users may reach out and open a support ticket to request access to the pre-release.
To use Nexus with the
temporalCLI dev server:download CLI
0.14.0-nexus.0to the current directory:run the dev server with the required configs:
Warn on unfinished handlers
The SDK will now
WARNby default if a workflow is completed by the SDK with unfinished update handlers. Users can useworkflow.AllHandlersFinishedto wait for all handlers to be finished or setUnfinishedPolicyinUpdateHandlerOptions.Add Workflow safe Mutex and Semaphore
This release includes new helper interfaces
workflow.Mutexandworkflow.Semaphorethat are workflow safe versions of a mutex and semaphore. These interfaces are to help users synchronize sensitive business logic across multiple coroutines or update handlers.What's Changed
v1.27.0Compare Source
Reset workflow with Updates
The Go SDK now supports reapplying Workflow Updates when resetting a workflow execution.
Note: Support for reapplying updates on workflow reset require a server version ≥1.24.0
Request failure code labeled metrics
gRPC request failure metrics (
*request_failure) emitted by the Go SDK now include the error status code as a tag understatus_code. This can be disabled by settingDisableErrorCodeMetricTagsonclient.Options.See also: #1472
💥 BREAKING CHANGES
This release includes some breaking changes for the experimental features Workflow Update and Worker Versioning. Users of these features should read the release notes carefully before upgrading.
Workflow Update (Experimental)
Based on users feedback this release makes some breaking changes to the Workflow Update API used by client and workflows code.
Client API changes
Client.UpdateWorkflowWithOptionsandClient.UpdateWorkflowinto one API calledClient.UpdateWorkflowthat takes aclient.UpdateWorkflowOptionsstruct.WaitPolicyinclient.UpdateWorkflowOptionswas replaced withWaitForStage.WaitForStageis now a required parameter inclient.UpdateWorkflowOptions.WaitForStageis now properly respected byClient.UpdateWorkflow. PreviouslyClient.UpdateWorkflowmay have returned a handle before the desiredWaitForStagewas reached.Workflow API changes
workflow.SetUpdateHandlerandworkflow.SetUpdateHandlerWithOptionsNow require update handles to take aworkflow.Contextas the first argument.workflow.GetUpdateInfohas been renamed toworkflow.GetCurrentUpdateInfo.Worker Versioning (Experimental)
Worker Versioning is a pre-release, experimental feature that simplifies managing code changes by allowing you to peg workflows to build versions. This change revamps and improves the API and deprecates the existing experience.
The new APIs introduced with worker versioning are:
GetWorkerVersioningRulesreturns assignment and redirect rules for a given task queue.UpdateWorkerVersioningRulesupdates assignment and redirect rules for a given task queue.DescribeTaskQueueEnhancedextends the functionality ofDescribeTaskQueuewith workflow reachability status.A few APIs associated with legacy worker versioning have been deprecated:
UpdateWorkerBuildIdCompatibilityreplaced byUpdateWorkerVersioningRules.GetWorkerBuildIdCompatibilityreplaced byGetWorkerVersioningRules.GetWorkerTaskReachabilityreplaced byDescribeTaskQueueEnhanced.Note: These new Worker Versioning APIs require a server version ≥1.24.0
Internally call
grpc.NewClientinstead ofgrpc.DialInternally the SDK now calls
grpc.NewClientinstead ofgrpc.Dialbecause it was deprecated in google.golang.org/grpcThis should be a transparent change to most users,
google.golang.org/grpcdoes call out one subtle difference:Some deprecated dial options like
WithBlock,WithTimeout,WithReturnConnectionError, andFailOnNonTempDialErrorare now ignored bygrpc.NewClient. See https://github.com/grpc/grpc-go/blob/master/Documentation/anti-patterns.md for more context.See also: #1488
Child workflows now properly Continue-As-New in the
TestWorkflowEnvironmentIn previous version of the Go SDK when a child workflow running in the test environment tried to continue as new the parent workflow would receive an error from the child workflow. Now the child workflow properly continues as new and the parent workflow will not receive an error.
See also: #1437
Specific Changes
2024-04-12 -
c4bf074- datadog: Add tracer option to check error eligibility in the span (#1438)2024-04-17 -
69bc6c3- Update reapply (#1436)2024-04-23 -
93c08b0- Ensure consistent labels for rpc metrics (#1444)2024-04-24 -
8361067- Disable UTF8-invalid tests when running CLI dev server (#1448)2024-04-30 -
fe44a47- Improve error message for missing body (#1451)2024-05-01 -
d051de6- Option to redirect devserver stdout/stderr to a file (#1452)2024-05-09 -
386a6d3- Require update handler to have a context (#1457)2024-05-09 -
ded70a3- Add support for NextRetryDelay for local activities (#1456)2024-05-10 -
81cd5dc- Fix QueryRejectCondition parameter in QueryWorkflowWithOptions (#1461)2024-05-10 -
c69831e- Remove DisableStickyExecution (#1464)2024-05-14 -
3b68c6d- Add request failure code label to metrics (#1472)2024-05-17 -
aa17647- get-free-port: prevent duplicate ports on Linux (#1478)2024-05-21 -
06c0ebc- AddSetFailureConverterto the activity and workflow test environments (#1484)2024-05-21 -
222d4cf- Fix gauge metrics with latest otel SDK (#1482)2024-05-21 -
725b428- Only record activity_succeed_endtoend_latency on success (#1481)2024-05-21 -
fb06909- Send original update request back in response (#1480)2024-05-22 -
bf2c79d- Switch to using Float64Gauge in otel integration (#1485)2024-05-24 -
a6ca6a5- Replace grpc.Dial with grpc.NewClient (#1488)2024-05-28 -
bcfa85a- Workflow update client API refactor (#1489)2024-05-31 -
486c233- Minor logger improovments (#1495)2024-05-31 -
4dd1ed8- Fix bugs when using a customFailureConverterin tests (#1490)2024-06-06 -
0df7ad5- Bump GitHub Actions (#1503)2024-06-06 -
17193aa- Manually copy proxy options (#1502)2024-06-06 -
5c171b7- Make backfill tests more robust (#1504)2024-06-06 -
9ecb2a4- Change GetUpdateInfo to GetCurrentUpdateInfo (#1505)2024-06-06 -
bf29944- testsuite.StartDevServer: Respect timeout during dial (#1498)2024-06-07 -
c73a007- Support the new versioning API (#1494)2024-06-10 -
d4ff1f6- Fix flake in TestUpdateAdmittedNoWorker (#1506)2024-06-12 -
38fe879- Always run all the versioning tests (#1510)2024-06-12 -
a7c8208- Allow SDK to handle speculative WFT with command events (#1509)2024-06-13 -
2720358- Improve CI action (#1512)2024-06-13 -
30a29ce- Add integration test for reset with update events (#1507)2024-06-13 -
4c8b9e1- Update API to v1.34.0 (#1511)Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.