v1.26.0-rc.4

Note: This is a release candidate, we encourage users to test out this release to be prepared for upcoming changes and to report any bugs.

Typed search attributes

Previously, search attributes were untyped maps with string keys and interface values. This causes ambiguity on what types a search attribute key represents and leads to errors. Also, the way search attributes were created or upserted allowed mistakes to occur and was not clear to the server exactly what was expected.

• Added TypedSearchAttributes to client.ScheduleOptions and deprecated SearchAttributes
• Added GetTypedSearchAttributes to workflow and deprecated WorkflowInfo.SearchAttributes
• Added UpsertTypedSearchAttributes to workflow and deprecated UpsertSearchAttributes
• Added TypedSearchAttributes to client.StartWorkflowOptions and deprecated SearchAttributes
• Added several new things to temporal package including:
  • SearchAttributes collection with methods and constructor
  • SearchAttributeKey and SearchAttributeUpdate interfaces
  • SearchAttributeKeyX types and constructors for typed keys

💥 BREAKING CHANGES

gogo/protobuf

gogo/protobuf has been replaced with Google's official proto compiler.

Users may notice:

• time.Time in proto structs will now be timestamppb.Timestamp
• time.Duration will now be durationpb.Duration
• V2-generated structs embed locks, so you cannot dereference them.
• Proto enums will, when formatted to JSON, now be in SCREAMING_SNAKE_CASE rather than PascalCase.

Note on invalid UTF-8 data stored as proto strings

Prior to SDK version v1.26.0 our protobuf code generator allowed invalid UTF-8 data to be stored as proto strings. This isn't actually allowed by the proto3 spec, so if you're using our SDK and think you may store arbitrary binary data in our strings you should set -tags protolegacy when building against our SDK.
Example:

$ go build -tags protolegacy myworker/main.go

If you see an error like grpc: error unmarshalling request: string field contains invalid UTF-8 then you will need to enable this when building your code.
If you're unsure then you should specify it anyways as there's no harm in doing so unless you relied on the protobuf compiler to ensure all strings were valid UTF-8.

HTTP/2 Keep Alive

HTTP/2 Keep alive is now enabled by default. This should help avoid request timeouts on previously idle connections. If users want to revert to the old behavior they can set ConnectionOptions.DisableKeepAliveCheck to false.

See also: #1299

Typed search attributes

As part of typed search attributes most old untyped search attributes API were deprecated, but will continue to function as they always have been going forward some breaking changes were required.

See also: #1368

Breaking changes include:

• Added TypedSearchAttributes to client.ScheduleWorkflowAction and 💥removed SearchAttributes and added UntypedSearchAttributes (needed until temporalio/temporal#4787 is fixed)

Workflow Update (Experimental)

Workflow update handlers are now processed eagerly before the main workflow function instead of after. When calling workflow.SetUpdateHandler and an update was received during that workflow task, and no other handlers have been set before, workflow.SetUpdateHandler will trigger the queued update handlers to run.

Activity and Workflow mock name collision in Test Suite

Fixed a bug in the workflow test suite that would cause workflow and activity mocks that shared the same name to override each other. If your test was doing this and asserting on the number of times a mock was called you may notice a change in behavior as activity and workflow mocks are now stored in separate maps.

see also: #1371

💥 Rollback Note

Due to this change in update processing , rolling back the SDK to a pre v1.26.0 version may cause workflow using workflow update (receiving update requests or registering an update handler) to get stuck with non determinism errors until they roll forward again.

Other changes

• Tag workflow_task_execution_failed metric with error type to help differentiate workflow task failures caused by non determinism from other task failures

• Dump coroutine stack on deadlock timeout. When the SDK detects a deadlock it will now try to dump the stack trace of the coroutine it detected as deadlocked.

• Add deterministic range over map helper. Iterating over Go's standard maps is not deterministic and therefore cannot be done in a workflow context. The SDK now includes helpers DeterministicKeys and DeterministicKeysFunc to get the keys of a map in a deterministic order.

Specific Changes

2023-10-13 - 06c90fb - Propagate Baggage in OTEL tracing interceptor (#1260)
2023-10-26 - 3cccbdd - Fix error documentation typos and enum values (#1276)
2023-10-31 - 0352634 - Add EmitDefault option for ProtoJson converter (#1286)
2023-11-08 - 0e432a9 - Add context propagators to local activity executions through test environments (#1291)
2023-11-08 - 4663bab - Fix typo in documentation (#1288)
2023-11-17 - 8068455 - Delete .github/workflows/semgrep.yml (#1294)
2023-11-21 - f9d73bf - Replace gogo protobuf (#1256)
2023-11-22 - 7db0d87 - Use the official features repo (#1298)
2023-11-27 - 745e948 - Add NotBefore function to testsuite.MockCallWrapper (#1301)
2023-11-27 - f5a0127 - Edit docstrings (#1302)
2023-11-28 - 33e8360 - Multi-platform CI and Makefile removal (#1293)
2023-11-28 - 70c8400 - Fix doc typo (#1305)
2023-11-28 - 8f2a3c8 - Use our new JSON coding stack (#1307)
2023-11-29 - 288a04f - Bump api-go version to fix Payload marshaling (#1308)
2023-11-29 - 89c8dba - Enabled keep alive by default (#1299)
2023-11-30 - 266e049 - Fix race in WaitSignalReturnParam (#1309)
2023-11-30 - 802d32e - Run cloud tests in series to avoid wfID conflict (#1311)
2023-11-30 - a309e59 - Tag workflow_task_execution_failed with error type (#1295)
2023-12-04 - 5fdbecc - Handle updates immediately when registered (#1306)
2023-12-04 - 838121a - Don't run workflowCancelHandler in test harness (#1296)
2023-12-04 - 987379d - Make remoteDataConverter implement PayloadCodec (#1303)
2023-12-04 - eb05747 - Fix flaky test (#1314)
2023-12-07 - 5d5b9c4 - Fix typo in docstring (#1317)
2023-12-14 - 7a9640d - Fix typo in update docstring (#1321)
2023-12-15 - f823b64 - Cleanup dead code and incorrect use of go routine in context pkg (#1320)
2023-12-27 - 95fe6ab - Fix bad Update mock in NamespaceClient (#1328)
2023-12-30 - 5a64898 - Failed Read-Only check causes a WFT failure in validator (#1329)
2024-01-04 - cb1d35e - Update dd-trace-go.v1 (#1332)
2024-01-05 - 2f61d2f - Add last BuildID to workflow info (#1335)
2024-01-07 - 7fc12d3 - Add otel metrics support (#1336)
2024-01-08 - 6244097 - Include update state machine fields in panic (#1327)
2024-01-08 - c1744ee - Bump go-api version to fix protojson vuln (#1333)
2024-01-09 - 1fe10d5 - Fix flaky build id issue (#1338)
2024-01-09 - 5ca9a4d - Add deterministic range over map helper (#1340)
2024-01-13 - fac7f7f - Update WorkflowRun.Get Doc String (#1346)
2024-01-16 - 0f12265 - Replace go.uber.org/atomic with sync/atomic (#1344)
2024-01-16 - 41d2288 - Evict workflow from cache on RespondTaskCompleted failure (#1358)
2024-01-16 - 54e131e - Make dataConverterWithoutDeadlock context aware (#1348)
2024-01-17 - 14103e0 - regenerate mocks with latest mockery (#1361)
2024-01-17 - 50ab40d - regenerate mocks under client to allow dynamic returns based on arguments (#1353)
2024-01-17 - 55c39b5 - Disable eager activities if tq rate limits is set (#1350)
2024-01-17 - b50cce9 - Replace some Sprintfs with string concatenation (#1345)
2024-01-17 - e3a3d95 - Always yield when registering update handles (#1325)
2024-01-19 - 14ddd7b - Dump coroutine stack on deadlock timeout (#1356)
2024-01-22 - 171504d - Fail task on unknown event when HistoryEvent.worker_may_ignore is false (#1363)
2024-01-22 - 30b2681 - Exit coroutine in order (#1362)
2024-01-22 - 94a5f5f - Allow client to suggest delay until next retry (#1319)
2024-01-26 - 536b875 - Exclude codes.DeadlineExceeded from the list of retryable gRPC codes (#1366)
2024-02-01 - 57b6679 - Typed Search Attributes (#1368)
2024-02-01 - 86764f8 - Handle nil valuePtr case in update handler Get (#1373)
2024-02-01 - a7c9528 - Prefix some errors with rule identifiers (#1281)
2024-02-01 - e2bec16 - Fix testing suite name conflict for workflow and activity (#887) (#1371)
2024-02-02 - 5c8c9a3 - Release Go SDK version 1.26.0-RC.1 (#1374)
2024-02-05 - 262766c - Fix data race on desiredWorkflowCacheSize (#1377)
2024-02-08 - 246a7d2 - Rectify the default values for keep-alive timeout (#1381)
2024-02-08 - 72a5b6f - workflowcheck: bump golang.org/x/tools from 0.13.0 to 0.17.0 (#1379)
2024-02-13 - d39fa9d - Add support for typed search attributes to the test suite (#1378)
2024-02-14 - 30da688 - Introduce a new constructor to override retry policy in ContinueAsNewError (#1383)
2024-02-20 - 5621b7f - Clarify OnUpsertTypedSearchAttributes (#1391)
2024-02-20 - 65aae9b - Document GetSearchAttributes is not supported on cloud (#1388)
2024-02-21 - 6d4ec2d - Make it possible to cancel workflows by ID when testing (#1392)
2024-02-22 - a71e4c4 - Update CI to Go lang 1.22 (#1389)
2024-02-27 - 34ef0a7 - Only set SDKPriorityUpdateHandling if workflow update is being used (#1398)
2024-02-27 - 54b2336 - Add note NextRetryDelay is not supported on the server (#1400)
2024-02-29 - d9a574d - Update workflow check with new function added ...

v1.26.0-rc.3

Note: This is a release candidate, we encourage users to test out this release to be prepared for upcoming changes and to report any bugs.

Typed search attributes

Previously, search attributes were untyped maps with string keys and interface values. This causes ambiguity on what types a search attribute key represents and leads to errors. Also, the way search attributes were created or upserted allowed mistakes to occur and was not clear to the server exactly what was expected.

• Added TypedSearchAttributes to client.ScheduleOptions and deprecated SearchAttributes
• Added GetTypedSearchAttributes to workflow and deprecated WorkflowInfo.SearchAttributes
• Added UpsertTypedSearchAttributes to workflow and deprecated UpsertSearchAttributes
• Added TypedSearchAttributes to client.StartWorkflowOptions and deprecated SearchAttributes
• Added several new things to temporal package including:
  • SearchAttributes collection with methods and constructor
  • SearchAttributeKey and SearchAttributeUpdate interfaces
  • SearchAttributeKeyX types and constructors for typed keys

💥 BREAKING CHANGES

gogo/protobuf

gogo/protobuf has been replaced with Google's official proto compiler.

Users may notice:

• time.Time in proto structs will now be timestamppb.Timestamp
• time.Duration will now be durationpb.Duration
• V2-generated structs embed locks, so you cannot dereference them.
• Proto enums will, when formatted to JSON, now be in SCREAMING_SNAKE_CASE rather than PascalCase.

HTTP/2 Keep Alive

HTTP/2 Keep alive is not enabled by default. This should help avoid request timeouts on previously idle connections. If users want to revert to the old behaviour they can set ConnectionOptions.DisableKeepAliveCheck to false.

See also: #1299

Typed search attributes

As part of typed search attributes most old untyped search attributes API were deprecated, but will continue to function as they always have been going forward some breaking changes were required.

Breaking changes include:

• Added TypedSearchAttributes to client.ScheduleWorkflowAction and 💥removed SearchAttributes and added UntypedSearchAttributes (needed until temporalio/temporal#4787 is fixed)

Workflow Update (Experimental)

Workflow update handlers are now processed eagerly before the main workflow function instead of after. When calling workflow.SetUpdateHandler and an update was received during that workflow task, and no other handlers have been set before, workflow.SetUpdateHandler will trigger the queued update handlers to run.

Activity and Workflow mock name collision in Test Suite

Fixed a bug in the workflow test suite that would cause workflow and activity mocks that shared the same name to override each other. If your test was doing this and asserting on the number of times a mock was called you may notice a change in behavior as activity and workflow mocks are now stored in separate maps.

see also: #1371

💥 Rollback Note

Due to this change in update processing , rolling back the SDK to a pre v1.26.0 version may cause workflow using workflow update (receiving update requests or registering an update handler) to get stuck with non determinism errors until they roll forward again.

Other changes

• Tag workflow_task_execution_failed metric with error type to help differentiate workflow task failures caused by non determinism from other task failures

• Dump coroutine stack on deadlock timeout. When the SDK detects a deadlock it will now try to dump the stack trace of the coroutine it detected as deadlocked.

• Add deterministic range over map helper. Iterating over Go's standard maps is not deterministic and therefore cannot be done in a workflow context. The SDK now includes helpers DeterministicKeys and DeterministicKeysFunc to get the keys of a map in a deterministic order.

Specific Changes

2023-10-13 - 06c90fb - Propagate Baggage in OTEL tracing interceptor (#1260)
2023-10-26 - 3cccbdd - Fix error documentation typos and enum values (#1276)
2023-10-31 - 0352634 - Add EmitDefault option for ProtoJson converter (#1286)
2023-11-08 - 0e432a9 - Add context propagators to local activity executions through test environments (#1291)
2023-11-08 - 4663bab - Fix typo in documentation (#1288)
2023-11-17 - 8068455 - Delete .github/workflows/semgrep.yml (#1294)
2023-11-21 - f9d73bf - Replace gogo protobuf (#1256)
2023-11-22 - 7db0d87 - Use the official features repo (#1298)
2023-11-27 - 745e948 - Add NotBefore function to testsuite.MockCallWrapper (#1301)
2023-11-27 - f5a0127 - Edit docstrings (#1302)
2023-11-28 - 33e8360 - Multi-platform CI and Makefile removal (#1293)
2023-11-28 - 70c8400 - Fix doc typo (#1305)
2023-11-28 - 8f2a3c8 - Use our new JSON coding stack (#1307)
2023-11-29 - 288a04f - Bump api-go version to fix Payload marshaling (#1308)
2023-11-29 - 89c8dba - Enabled keep alive by default (#1299)
2023-11-30 - 266e049 - Fix race in WaitSignalReturnParam (#1309)
2023-11-30 - 802d32e - Run cloud tests in series to avoid wfID conflict (#1311)
2023-11-30 - a309e59 - Tag workflow_task_execution_failed with error type (#1295)
2023-12-04 - 5fdbecc - Handle updates immediately when registered (#1306)
2023-12-04 - 838121a - Don't run workflowCancelHandler in test harness (#1296)
2023-12-04 - 987379d - Make remoteDataConverter implement PayloadCodec (#1303)
2023-12-04 - eb05747 - Fix flaky test (#1314)
2023-12-07 - 5d5b9c4 - Fix typo in docstring (#1317)
2023-12-14 - 7a9640d - Fix typo in update docstring (#1321)
2023-12-15 - f823b64 - Cleanup dead code and incorrect use of go routine in context pkg (#1320)
2023-12-27 - 95fe6ab - Fix bad Update mock in NamespaceClient (#1328)
2023-12-30 - 5a64898 - Failed Read-Only check causes a WFT failure in validator (#1329)
2024-01-04 - cb1d35e - Update dd-trace-go.v1 (#1332)
2024-01-05 - 2f61d2f - Add last BuildID to workflow info (#1335)
2024-01-07 - 7fc12d3 - Add otel metrics support (#1336)
2024-01-08 - 6244097 - Include update state machine fields in panic (#1327)
2024-01-08 - c1744ee - Bump go-api version to fix protojson vuln (#1333)
2024-01-09 - 1fe10d5 - Fix flaky build id issue (#1338)
2024-01-09 - 5ca9a4d - Add deterministic range over map helper (#1340)
2024-01-13 - fac7f7f - Update WorkflowRun.Get Doc String (#1346)
2024-01-16 - 0f12265 - Replace go.uber.org/atomic with sync/atomic (#1344)
2024-01-16 - 41d2288 - Evict workflow from cache on RespondTaskCompleted failure (#1358)
2024-01-16 - 54e131e - Make dataConverterWithoutDeadlock context aware (#1348)
2024-01-17 - 14103e0 - regenerate mocks with latest mockery (#1361)
2024-01-17 - 50ab40d - regenerate mocks under client to allow dynamic returns based on arguments (#1353)
2024-01-17 - 55c39b5 - Disable eager activities if tq rate limits is set (#1350)
2024-01-17 - b50cce9 - Replace some Sprintfs with string concatenation (#1345)
2024-01-17 - e3a3d95 - Always yield when registering update handles (#1325)
2024-01-19 - 14ddd7b - Dump coroutine stack on deadlock timeout (#1356)
2024-01-22 - 171504d - Fail task on unknown event when HistoryEvent.worker_may_ignore is false (#1363)
2024-01-22 - 30b2681 - Exit coroutine in order (#1362)
2024-01-22 - 94a5f5f - Allow client to suggest delay until next retry (#1319)
2024-01-26 - 536b875 - Exclude codes.DeadlineExceeded from the list of retryable gRPC codes (#1366)
2024-02-01 - 57b6679 - Typed Search Attributes (#1368)
2024-02-01 - 86764f8 - Handle nil valuePtr case in update handler Get (#1373)
2024-02-01 - a7c9528 - Prefix some errors with rule identifiers (#1281)
2024-02-01 - e2bec16 - Fix testing suite name conflict for workflow and activity (#887) (#1371)
2024-02-02 - 5c8c9a3 - Release Go SDK version 1.26.0-RC.1 (#1374)
2024-02-05 - 262766c - Fix data race on desiredWorkflowCacheSize (#1377)
2024-02-08 - 246a7d2 - Rectify the default values for keep-alive timeout (#1381)
2024-02-08 - 72a5b6f - workflowcheck: bump golang.org/x/tools from 0.13.0 to 0.17.0 (#1379)
2024-02-13 - d39fa9d - Add support for typed search attributes to the test suite (#1378)
2024-02-14 - 30da688 - Introduce a new constructor to override retry policy in ContinueAsNewError (#1383)
2024-02-20 - 5621b7f - Clarify OnUpsertTypedSearchAttributes (#1391)
2024-02-20 - 65aae9b - Document GetSearchAttributes is not supported on cloud (#1388)
2024-02-21 - 6d4ec2d - Make it possible to cancel workflows by ID when testing (#1392)
2024-02-22 - a71e4c4 - Update CI to Go lang 1.22 (#1389)
2024-02-27 - 34ef0a7 - Only set SDKPriorityUpdateHandling if workflow update is being used (#1398)
2024-02-27 - 54b2336 - Add note NextRetryDelay is not supported on the server (#1400)

v1.26.0-rc.2

For release notes see:

https://github.com/temporalio/sdk-go/releases/tag/v1.26.0-rc.1

Publishing a new tag to fix a mismatch in the sum.db checksum

v1.26.0-rc.1

Note: This is a release candidate, we encourage users to test out this release to be prepared for upcoming changes and to report any bugs.

Typed search attributes

Previously, search attributes were untyped maps with string keys and interface values. This causes ambiguity on what types a search attribute key represents and leads to errors. Also, the way search attributes were created or upserted allowed mistakes to occur and was not clear to the server exactly what was expected.

• Added TypedSearchAttributes to client.ScheduleOptions and deprecated SearchAttributes
• Added GetTypedSearchAttributes to workflow and deprecated WorkflowInfo.SearchAttributes
• Added UpsertTypedSearchAttributes to workflow and deprecated UpsertSearchAttributes
• Added TypedSearchAttributes to client.StartWorkflowOptions and deprecated SearchAttributes
• Added several new things to temporal package including:
  • SearchAttributes collection with methods and constructor
  • SearchAttributeKey and SearchAttributeUpdate interfaces
  • SearchAttributeKeyX types and constructors for typed keys

💥 BREAKING CHANGES

gogo/protobuf

gogo/protobuf has been replaced with Google's official proto compiler.

Users may notice:

• time.Time in proto structs will now be timestamppb.Timestamp
• time.Duration will now be durationpb.Duration
• V2-generated structs embed locks, so you cannot dereference them.
• Proto enums will, when formatted to JSON, now be in SCREAMING_SNAKE_CASE rather than PascalCase.

Typed search attributes

As part of typed search attributes most old untyped search attributes API were deprecated, but will continue to function as they always have been going forward some breaking changes were required.

Breaking changes include:

• Added TypedSearchAttributes to client.ScheduleWorkflowAction and 💥removed SearchAttributes and added UntypedSearchAttributes (needed until temporalio/temporal#4787 is fixed)

Workflow Update (Experimental)

Workflow update handlers are now processed eagerly before the main workflow function instead of after. When calling workflow.SetUpdateHandler and an update was received during that workflow task, and no other handlers have been set before, workflow.SetUpdateHandler will trigger the queued update handlers to run.

Activity and Workflow mock name collision in Test Suite

Fixed a bug in the workflow test suite that would cause workflow and activity mocks that shared the same name to override each other. If your test was doing this and asserting on the number of times a mock was called you may notice a change in behavior as activity and workflow mocks are now stored in separate maps.

see also: #1371

Other changes

• Tag workflow_task_execution_failed metric with error type to help differentiate workflow task failures caused by non determinism from other task failures

• Dump coroutine stack on deadlock timeout. When the SDK detects a deadlock it will now try to dump the stack trace of the coroutine it detected as deadlocked.

• Add deterministic range over map helper. Iterating over Go's standard maps is not deterministic and therefore cannot be done in a workflow context. The SDK now includes helpers DeterministicKeys and DeterministicKeysFunc to get the keys of a map in a deterministic order.

Specific Changes

2023-10-13 - 06c90fb - Propagate Baggage in OTEL tracing interceptor (#1260)
2023-10-26 - 3cccbdd - Fix error documentation typos and enum values (#1276)
2023-10-31 - 0352634 - Add EmitDefault option for ProtoJson converter (#1286)
2023-11-08 - 0e432a9 - Add context propagators to local activity executions through test environments (#1291)
2023-11-08 - 4663bab - Fix typo in documentation (#1288)
2023-11-17 - 8068455 - Delete .github/workflows/semgrep.yml (#1294)
2023-11-21 - f9d73bf - Replace gogo protobuf (#1256)
2023-11-22 - 7db0d87 - Use the official features repo (#1298)
2023-11-27 - 745e948 - Add NotBefore function to testsuite.MockCallWrapper (#1301)
2023-11-27 - f5a0127 - Edit docstrings (#1302)
2023-11-28 - 33e8360 - Multi-platform CI and Makefile removal (#1293)
2023-11-28 - 70c8400 - Fix doc typo (#1305)
2023-11-28 - 8f2a3c8 - Use our new JSON coding stack (#1307)
2023-11-29 - 288a04f - Bump api-go version to fix Payload marshaling (#1308)
2023-11-29 - 89c8dba - Enabled keep alive by default (#1299)
2023-11-30 - 266e049 - Fix race in WaitSignalReturnParam (#1309)
2023-11-30 - 802d32e - Run cloud tests in series to avoid wfID conflict (#1311)
2023-11-30 - a309e59 - Tag workflow_task_execution_failed with error type (#1295)
2023-12-04 - 5fdbecc - Handle updates immediately when registered (#1306)
2023-12-04 - 838121a - Don't run workflowCancelHandler in test harness (#1296)
2023-12-04 - 987379d - Make remoteDataConverter implement PayloadCodec (#1303)
2023-12-04 - eb05747 - Fix flaky test (#1314)
2023-12-07 - 5d5b9c4 - Fix typo in docstring (#1317)
2023-12-14 - 7a9640d - Fix typo in update docstring (#1321)
2023-12-15 - f823b64 - Cleanup dead code and incorrect use of go routine in context pkg (#1320)
2023-12-27 - 95fe6ab - Fix bad Update mock in NamespaceClient (#1328)
2023-12-30 - 5a64898 - Failed Read-Only check causes a WFT failure in validator (#1329)
2024-01-04 - cb1d35e - Update dd-trace-go.v1 (#1332)
2024-01-05 - 2f61d2f - Add last BuildID to workflow info (#1335)
2024-01-07 - 7fc12d3 - Add otel metrics support (#1336)
2024-01-08 - 6244097 - Include update state machine fields in panic (#1327)
2024-01-08 - c1744ee - Bump go-api version to fix protojson vuln (#1333)
2024-01-09 - 1fe10d5 - Fix flaky build id issue (#1338)
2024-01-09 - 5ca9a4d - Add deterministic range over map helper (#1340)
2024-01-13 - fac7f7f - Update WorkflowRun.Get Doc String (#1346)
2024-01-16 - 0f12265 - Replace go.uber.org/atomic with sync/atomic (#1344)
2024-01-16 - 41d2288 - Evict workflow from cache on RespondTaskCompleted failure (#1358)
2024-01-16 - 54e131e - Make dataConverterWithoutDeadlock context aware (#1348)
2024-01-17 - 14103e0 - regenerate mocks with latest mockery (#1361)
2024-01-17 - 50ab40d - regenerate mocks under client to allow dynamic returns based on arguments (#1353)
2024-01-17 - 55c39b5 - Disable eager activities if tq rate limits is set (#1350)
2024-01-17 - b50cce9 - Replace some Sprintfs with string concatenation (#1345)
2024-01-17 - e3a3d95 - Always yield when registering update handles (#1325)
2024-01-19 - 14ddd7b - Dump coroutine stack on deadlock timeout (#1356)
2024-01-22 - 171504d - Fail task on unknown event when HistoryEvent.worker_may_ignore is false (#1363)
2024-01-22 - 30b2681 - Exit coroutine in order (#1362)
2024-01-22 - 94a5f5f - Allow client to suggest delay until next retry (#1319)
2024-01-26 - 536b875 - Exclude codes.DeadlineExceeded from the list of retryable gRPC codes (#1366)
2024-02-01 - 57b6679 - Typed Search Attributes (#1368)
2024-02-01 - 86764f8 - Handle nil valuePtr case in update handler Get (#1373)
2024-02-01 - a7c9528 - Prefix some errors with rule identifiers (#1281)
2024-02-01 - e2bec16 - Fix testing suite name conflict for workflow and activity (#887) (#1371)
2024-02-01 - f144428 - Release Go SDK version 1.26.0-RC.1

v1.25.1

Highlights

Bugfixes

Fix a regression causing some custom logger implementations to log key-values as a list.

Specific Changes

2023-10-11 - 83199af - Small docs tweaks. (#1262)
2023-10-12 - a6cdcd7 - Add UpdateWorkflowByID to TestWorkflowEnvironment (#1264)
2023-10-13 - b484666 - loggerWith.WithCallerSkip expand keyvals (#1267)

v1.25.0

Highlights

Integration with slog

If using Go version 1.21+ the Go SDK provides built in integration with the standard slog package.

package main
import (
	"log/slog"
	"os"

	"go.temporal.io/sdk/client"
	"go.temporal.io/sdk/log"
	"go.temporal.io/sdk/worker"
)

func main() {
	clientOptions := client.Options{
		Logger: log.NewStructuredLogger(
			slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
				AddSource: true,
				Level:     slog.LevelDebug,
			}))),
	}
	temporalClient, err := client.Dial(clientOptions)
	// ...
}

New WorkflowInfo fields

Added GetContinueAsNewSuggested() and GetCurrentHistorySize() to WorkflowInfo.

(Experimental) Start delay

Added StartDelay option to StartWorkflowOptions. StartDelay will cause Temporal to wait before dispatching the first workflow task.
If the workflow gets a signal before the delay, a workflow task will be dispatched and the rest
of the delay will be ignored.

Specific Changes

2023-08-02 - 1ec43ad - Fix LA start to close timeout (#1180)
2023-08-04 - 3aba985 - Remove mentions of elasticsearch (#1186)
2023-08-06 - 66946b9 - fixing spelling errors in comments (#1188)
2023-08-07 - 23ff5a7 - Add option to ignore invalid parent spans (#1178)
2023-08-08 - 654e872 - Fix testsuite package docs (#1192)
2023-08-08 - 793489f - Fix race condition with eager workflow start and close (#1191)
2023-08-10 - 1fccf9c - Fix race condition in eager dispatch (#1195)
2023-08-10 - 90fcc71 - Enabled worker versioning tests (#1193)
2023-08-10 - c0a947b - Add note on heart beating and async activities (#1198)
2023-08-11 - 7dbde86 - Fix flaky TestAsyncActivityCompletion (#1199)
2023-08-11 - d5d6d3e - Update CI to Golang v1.21 (#1200)
2023-08-19 - 9bd67dd - Add new fields to workflow info (#1202)
2023-08-21 - 27895a9 - Clarify what happens if an error and result are returned (#1203)
2023-08-22 - 20c550a - Fix flake in TestQueryOnlyCoroutineUsage (#1204)
2023-08-23 - b9e5e24 - Refactor NextCommandEvents (#1205)
2023-08-28 - d5a2f8f - Fix race condition during cache eviction (#1210)
2023-08-29 - a7f9cdf - Add test for child wf cancel and update (#1214)
2023-08-30 - 9345e81 - Check all functions with workflow.Context as first parameter (#1215)
2023-08-31 - 0939af2 - Update Temporal API to v1.24.0 (#1220)
2023-09-01 - 7485282 - Fix the documentation of ListWorkflow for querying open workflows (#1217)
2023-09-01 - 90e7399 - Add slog adapter (#1219)
2023-09-01 - 9dc99ed - Update readme for slog (#1222)
2023-09-01 - c514225 - Add replay option to disable deadlock detection (#1221)
2023-09-05 - 591ce7e - Clarify GetLastCompletionResult works with schedule (#1225)
2023-09-05 - 6bdfec6 - chore: create UpdateCallbacks binding for the RoadRunner (#1223)
2023-09-05 - b7931cb - Handle generic maps and channels (#1224)
2023-09-07 - bc5e57d - Remove binary file (#1226)
2023-09-08 - 7bf78b8 - Edit doc comments (#1228)
2023-09-11 - 8ef6db7 - Stop using the tinycicd namespace for tests (#1233)
2023-09-13 - ecfaa65 - Code inside workflow.SideEffect is deterministic (#1230)
2023-09-18 - 22435a7 - Add doc links throughout our user-facing APIs (#1239)
2023-09-18 - f1d6480 - feat(contrib/opentelemetry): add TraceID and SpanID fields to the logger (#1232)
2023-09-23 - 6039cd3 - Disable running sessions on a versioned worker (#1241)
2023-09-23 - a5ee832 - Decrease iterations of TestVersionLoopWorkflow (#1242)
2023-09-23 - bfb39ac - Expose SetContinuedAsNewRunID in the TestWorkflowEnvironment (#1246)
2023-09-23 - ff9b3f4 - Expose StartDelay in StartWorkflowOptions (#1244)
2023-09-25 - 59d8488 - Add SDK version and name to history (#1245)
2023-09-27 - 159a69f - Don't register a versioned worker for eager start (#1251)
2023-10-02 - 9228307 - Convert panics in update protocol state machine to errors (#1253)
2023-10-03 - fecfba8 - Fix selector AddSend docs (#1254)
2023-10-04 - a001e5f - Add TaskReachability API (#1247)
2023-10-05 - df09c35 - Allow eager workflow start on versioned worker (#1255)

v1.24.0

Highlights

Readonly Protection

Added protection in the SDK against running mutating workflow functions in a read only context.
A read only context is a query handler, update validator, side effect, or mutable side effect.
Previously, in some cases, the SDK would seem to allow it but silently generate an invalid workflow history.
This change allows developers to quickly catch their mistake and prevents generating invalid workflow histories

Experimental - Eager Workflow Dispatch

Eager Workflow Dispatch (EWD) is a mechanism that minimizes the duration from starting a workflow to the processing of the first workflow task, making Temporal more suitable for latency sensitive applications. Eager workflow Dispatch can be enabled by setting EnableEagerStart in StartWorkflowOptions and if the server supports it and a local worker is available the task is fed directly to the worker.

Note: Requires Temporal Server 1.20+

Specific Changes

2023-06-23 - d56a1ca - Use getNextID() when handling mutable side effects (#1146)
2023-06-23 - e720652 - Fix history paging on looking for WFT Fail (#1147)
2023-06-27 - f223247 - Update workflowcheck dependencies (#1148)
2023-06-28 - 435b192 - Document when the activity context is cancelled (#1150)
2023-06-29 - 1923300 - Start version numbers at 0 in godoc (#987)
2023-06-29 - 261f652 - Add missing schedule types (#1151)
2023-06-30 - 524b4d1 - Add more mocks (#1152)
2023-07-05 - e1d76b7 - Add docs on update (#1154)
2023-07-17 - 023af0e - Move commit info to env var to mitigate run injection vulnerability. (#1165)
2023-07-17 - 4714f38 - Prevent modifying workflow state in read only contexts (#1159)
2023-07-17 - 57d29ee - Expose update interceptor input (#1166)
2023-07-17 - 930cc2b - Reassign runningWorkflows workflow ID in test environment (#1163)
2023-07-17 - ca05fcd - Add interceptors for Await and AwaitWithTimeout (#1161)
2023-07-17 - dd24fd5 - Add support for update info (#1162)
2023-07-23 - 3ba8110 - Hardcode noop metrics handler to avoid logs (#1169)
2023-07-24 - 899f6d0 - Add IsLocalActivity to ActivityInfo (#1170)
2023-07-24 - a059d88 - Unlock before panicking (#1168)
2023-07-24 - a649812 - Make QueryWorkflowWithOptions go through interceptor (#1171)
2023-07-26 - 746bcf2 - Add eager workflow start (#1164)
2023-07-31 - 30c8ca2 - Rework cancellation counting (#1181)
2023-07-31 - 6523916 - Expand WF context locking to cover WFT responses (#1182)
2023-07-31 - 7fe0679 - Clarify ScheduleToStartTimeout in ActivityOptions (#1183)

v1.23.1

Highlights

Various bug fixes and usability improvements on the alpha feature Sync Update and Worker Versioning

Specific Changes

2023-06-01 - ddd33fc - Add Semgrep scanning (#1124)
2023-06-05 - eb68bb8 - Remove coveralls link (#1126)
2023-06-07 - 24f2c86 - Aligning OnWorkflow with OnActivity and adding unit tests to confirm behavior is coherent (#1128)
2023-06-09 - a3499c8 - Treat UpdateWorkflow as a long-poll (#1123)
2023-06-12 - 11c2cb9 - Allow ignoring function ref issues (#1135)
2023-06-12 - 5075346 - Fix stopping dev server on Windows (#1129)
2023-06-14 - 1a0d5f9 - Do not send original request msg back to server (#1139)
2023-06-14 - 2990ebf - Change message look ahead (#1136)
2023-06-15 - ae9ed7b - Fix inconsistent BuildID field name & empty TQ in intent check (#1141)
2023-06-16 - 00e8cec - Isolate Ctrl+Break to dev server instead of console (#1140)

v1.23.0

Highlights

Worker Versioning

This version adds support for our new Worker Versioning feature. Please note that this feature's API is subject to change. This feature allows you to assign build identifiers to workers, and ensure that workers operating on a task queue do not receive tasks that they will be incompatible with. You declare the relative [in]compatibility of build identifiers. We will be publishing documentation on this feature soon (and these notes will be updated with a link).

Note: worker versioning will require support from the Temporal server, to be available in release v1.21.0

Specific Changes

2023-05-18 - 269b55b - Set Update ID client side (#1106)
2023-05-18 - eb8ccc1 - Add option to ignore unknown fields when protojson unmarshalling (#1105)
2023-05-19 - a3cd0d1 - Allow update panics to bubble up (#1108)
2023-05-22 - f709720 - Make sure SDK flags are applied to the correct WFT (#1112)
2023-05-22 - febeb48 - Write sdk flags directly during replay (#1116)
2023-05-22 - ff67cdb - Ignore errors from uploading to coveralls (#1115)
2023-05-23 - 55ef398 - Switch to the official coveralls uploader (#1117)
2023-05-24 - 720dab0 - Send ProtocolMessageCommands where appropriate (#1107)
2023-05-25 - 76377c7 - Worker Versioning (#1120)
2023-05-25 - ed13374 - Update panic handling (#1119)
2023-05-25 - fc09967 - Check for child workflow already started error when setting env.testError (#1109)

v1.22.2

Specific Changes

2023-04-14 - a090256 - Remove version_set_id from CompatibleVersionSet (#1089)
2023-04-19 - 29aecb3 - Async Update Polling (#1088)
2023-04-19 - 528337f - Allow unknown fields while parsing json history (#1092)
2023-04-21 - 52be9f5 - Fix typo in NewDisconnectedContext documentation. (#1094)
2023-04-24 - a1f826a - Error on Registering Activity with Workflow Context (#1093)
2023-04-24 - ad1af5e - Exposing WorkflowExecution Started Event attributes on the Workflow Info (#1090)
2023-04-25 - 5cf9af3 - Clarify description of With function (#1096)
2023-05-11 - 95c81bd - Properly store the original failurepb on decode (#1101)