v1.16.0

Highlights

This release brings an experimental Spring Boot module. This is an alpha for a preview and feedback and there are no compatibility guarantees.

Fixes

• A rare case of a Query that is arriving to a Worker with an outdated meta-information is handled gracefully now (#1371)

What's Changed

• Port static and jacoco synthetic methods fix from Activity interfaces to Workflows interfaces by @Spikhalskiy in #1356
• Rework POJOWorkflowMetadata classes, add test coverage, use in Spring Boot by @Spikhalskiy in #1362
• Upgrade dependencies & code cleanup by @Spikhalskiy in #1355
• Additional Spring Boot wiring by @Spikhalskiy in #1363
• Add an ability to register custom DataConverter in Spring Boot Autoconfiguration by @Spikhalskiy in #1372
• Upgrade protoc for Apple Silicone builds by @Spikhalskiy in #1376
• Revisit Sprint Boot Readme by @Spikhalskiy in #1379
• Spring Boot Autoconfiguration doesn't require temporal-testing module to be in classpath anymore by @Spikhalskiy in #1380
• Refactor WorkflowContext classes by @Spikhalskiy in #1381
• Specify some standard Spring AutoConfiguration before Temporal ones explicitly by @Spikhalskiy in #1384
• Switch to using opentelemetry bom and Spring Boot upgrade by @Spikhalskiy in #1385
• Fix situation when direct query comes outdated (inconsistent) and applied to a more advanced cached workflow instance by @Spikhalskiy in #1375
• Release v1.16.0 by @Spikhalskiy in #1386

Full Changelog: v1.15.1...v1.16.0

v1.15.1

Highlights

This release fixes the native distribution of the test server. No changes for java users.

What's Changed

• Cleanup dead code by @Spikhalskiy in #1353
• Fix graal reflection config for new protobuf version by @Spikhalskiy in #1359

Full Changelog: v1.15.0...v1.15.1

v1.15.0

Highlights

This release brings PayloadCodec and Remote Data Converter capabilities to JavaSDK.
GlobalDataConverter got decoupled from DefaultDataConverter.

Fixes

• Stacktrace query responses are not encoded using a custom encoder anymore which makes them always decodable by the WebUI and tctl
• Upgraded grpc-java 1.48 and netty 4.1.77 come with a fix for grpc crash on Alpine: #1332 grpc/grpc-java#8751

Migration notes

Users which were specifying a Custom Converter globally will get some deprecation warnings to resolve,
which should be trivial like replacing DefaultDataConverter#setDefaultDataConverter with GlobalDataConverter#register

What's Changed

• Cleanup dead state machines code by @Spikhalskiy in #1302
• Add tests and javadocs for WorkflowStub#signal by @Spikhalskiy in #1292
• Make stacktrace query result to be serialized using standard data converter only by @Spikhalskiy in #1304
• Add initial Spring Boot implementation by @Spikhalskiy in #1305
• Fix javadoc for WorkflowReusePolicy stating an incorrect default by @Spikhalskiy in #1307
• Cleanup worker creation for Spring Boot Auto Configuration and add validation of the explicit worker config by @Spikhalskiy in #1308
• Switch from dependency version ranges to specific versions by @Spikhalskiy in #1314
• Implement fetching server capabilities before the first server call is made by @Spikhalskiy in #1313
• Refactor GrpcRetryer to enforce usage of GrpcRetryerOptions by @Spikhalskiy in #1316
• No retrying on INTERNAL gRPC errors with new Server versions by @Spikhalskiy in #1317
• Fix Test Server erroneously propagates some timeouts from the parent to the child workflow by @Spikhalskiy in #1320
• Separate Global DefaultDataConverter and Standard DataConverter notion by @Spikhalskiy in #1327
• Fix TestActivityEnvironmentInternal#close preventing subsequent usages of the class by @Spikhalskiy in #1329
• Upgrade Gradle, deps and cleanup duplicated outdated license files by @Spikhalskiy in #1340
• Upgrade Graal options by @Spikhalskiy in #1343
• Remote Data Converter & PayloadCodec by @Spikhalskiy in #1330
• Replays of workflow failures caused by queries don't spam worker logs anymore by @Spikhalskiy in #1351
• Add Jacoco code-coverage reports generation and aggregation by @Spikhalskiy in #1171
• Release v1.15.0 by @Spikhalskiy in #1352

Full Changelog: v1.14.0...v1.15.0

v1.14.0

Highlights

This release fixes a bug that may lead to workflows being stuck when sequential synchronous calls of local activities are present.
See #1262 for more details.

What's Changed

• Fix erroneous closing of workflow tasks instead of heartbeating in some edge cases by @Spikhalskiy in #1295

Full Changelog: v1.13.0...v1.14.0

v1.13.0

Highlights

The release focused on the resiliency of Workflow Workers.

Fixes:

• Version State Machine ignored a range check during replay if the history was unversioned
• Cancellation of child workflows didn't work in some edge cases
• Awaiting on child workflow start promise was not throwing exceptions if the start is not possible leading to stuck workflows
• and more

What's Changed

• Test Server responds NOT_FOUND if the activity is in incorrect state by @Spikhalskiy in #1228
• Add WorkerInterceptorBase and improve WorkerInterceptor docs to help new users of interceptors by @Spikhalskiy in #1231
• Fix Version State Machine ignoring range check during replay if the history was unversioned by @Spikhalskiy in #1240
• Fix WorkflowStub.getResultAsync leading to unbalanced time locking in test environment by @Spikhalskiy in #1244
• Make Temporal standard non-retryable gRPC codes not configurable by @Spikhalskiy in #1247
• Improve io.temporal.internal.worker package structure and worker shutdown by @Spikhalskiy in #1253
• Fix sticky poller using unique id from the sticky queue as a workerIdentity by @Spikhalskiy in #1254
• Make DeterministicRunner#close always block until the closing is done by @Spikhalskiy in #1255
• Simplify code and error handling between ActivityWorker and LocalActivityWorker by @Spikhalskiy in #1263
• Cleanup never used confusing ActivityTaskHandler#Result#requestRetryOptions by @Spikhalskiy in #1264
• Invalidate cached workflow state if worker fails to send the result to the server by @Spikhalskiy in #1265
• Throw if the server workflow progress is below the progress known to the Workflow Worker by @Spikhalskiy in #1267
• Guard against applying new events to workflow state machines if there is a gap by @Spikhalskiy in #1268
• Fix state machines NullPointerException during one of the modes of child workflow cancellation by @Spikhalskiy in #1269
• Fix build on aarch64 (M1) by @AndreevDm in #1274
• Add toString method to ActivityInfo and WorkflowInfo by @AndreevDm in #1275
• Fix child workflow execution start promise not throwing exceptions by @Spikhalskiy in #1271
• Rework LocalActivities waiting code to use nanoseconds by @Spikhalskiy in #1277
• Add log waring if workflow eviction / closure is taking too long time to close by @Spikhalskiy in #1282
• Fix test server publishing the Completion of child workflows before the Start sometimes by @Spikhalskiy in #1289

New Contributors

• @AndreevDm made their first contribution in #1274

Full Changelog: v1.12.0...v1.13.0

v1.12.0

Highlights

This release mostly contains changes and fixes for the WorkflowClient and WorkflowStub behavior.

Fixes

• sticky_cache_size metric behavior, stale value may be observed before
• Fixed a problem with test server not respecting disabled time skipping introduced in 1.9.0
• SDK doesn't log exceptions internally that are getting propagated to the user code anymore
• The behavior of Workflow#getResult, WorkflowStub#cancel and WorkflowStub#terminate got aligned with their contract for exceptions

What's Changed

• Add documentation to ManualActivityCompletionClient, fix absent service call retries by @Spikhalskiy in #1181
• Polish ConnectedWorkflowServiceStubs method by @GreyTeardrop in #1186
• Fix workflow_active_thread_count, abstract WorkflowThreadExecutor instead of using a broad thread pool by @Spikhalskiy in #1185
• Fix absent request level metrics not logging with incorrectly implemented custom grpc interceptor by @Spikhalskiy in #1188
• Align Test Server direct query behavior with the real server by @Spikhalskiy in #1191
• Local Activity uses Server time and elapsed period to update workflow task timestamp by @Spikhalskiy in #1196
• Make signalWithStart set search attributes if it starts a new execution by @Spikhalskiy in #1199
• Rework async long poll to use the same configuration as the main long poll by @Spikhalskiy in #1204
• Fix Test Server throwing on queries without a deadline by @Spikhalskiy in #1207
• Fix test server with disabled time skipping mode by @Spikhalskiy in #1210
• Make getResult methods to throw TimeoutException instead of raw gRPC DEADLINE_EXCEEDED by @Spikhalskiy in #1209
• Add unit test verifying behavior of finishing Activity with CancellationType=ABANDON if it was canceled by the workflow by @Spikhalskiy in #1217
• Implement firstExecutionRunId attribute in TestServer by @Spikhalskiy in #1225
• Fix WorkflowStub#cancel and WorkflowStub#terminate exceptions contract by @Spikhalskiy in #1218
• Deescalate GrpcRetryer logging to trace level by @Spikhalskiy in #1227

Full Changelog: v1.11.0...v1.12.0

v1.11.0

Highlights

This release changes the default preferred behavior of WorkflowServiceStubs from eager connectivity and throwing error if the Temporal Server is not available to a lazy connectivity on the first request. See migration notes.

Fixes

• sticky_cache_size was updating only during forced evictions
• test service stubs were time-sensitive to time skipping that may require long execution of application code and were throwing DEADLINE_EXCEEDED
• OpenTracing was logging forced thread evictions from the cache as errors

Migration notes

WorkflowServiceStubs#newInstance, WorkflowServiceStubsOptions.Builder#setDisableHealthCheck,
WorkflowServiceStubsOptions.Builder#setHealthCheckAttemptTimeout and WorkflowServiceStubsOptions.Builder#setHealthCheckTimeout
are deprecated.

• The new preferred default is WorkflowServiceStubs#newServiceStubs.
• Switch to WorkflowServiceStubs#newServiceStubs if you were disabling health check on the client start previously.
• Switch to WorkflowServiceStubs#newConnectedServiceStubs if you prefer an explicit health check call on client creation. Pass your old WorkflowServiceStubsOptions.Builder#setHealthCheckTimeout as a timeout parameter value to this method (null supported for default).

What's Changed

• Add trivial describeNamespace test server implementation by @Spikhalskiy in #1160
• Fix sticky_cache_size gauge behavior by @Spikhalskiy in #1159
• Add TestEnvironmentOptions#registerSearchAttribute by @Spikhalskiy in #1161
• Evictions are not logged as errors in opentracing anymore by @Spikhalskiy in #1164
• Rework #setChannelInitializer method for easier access, remove old deprecated classes and methods by @Spikhalskiy in #1170
• Add a clear message to signal user mistake if newWorkflowThread is overridden to null by @Spikhalskiy in #1173
• Fix test service stubs throwing DEADLINE_EXCEEDED by @Spikhalskiy in #1174
• Improve illegal custom interceptors error reporting by @Spikhalskiy in #1175
• Unify the limit on gRPC incoming message across SDKs to 128Mb by @Spikhalskiy in #1176
• Explicit methods for lazy and eager connecting client, new #healthCheck method on stubs by @Spikhalskiy in #1168
• Improve javadocs around interceptors by @Spikhalskiy in #1180

Full Changelog: v1.10.0...v1.11.0

v1.10.0

Highlights

This release contains fixes for performance and stability issues

What's Changed

• Moved NO_COMPLETION counter reporting to handle all cases by @Spikhalskiy in #1149
• Refactor and cleanup "exception to failure" conversion code by @Spikhalskiy in #1148
• Make WorkflowThreadContext#destroy non-blocking and remove deadlock detector from the call by @Spikhalskiy in #1151
• Rework PotentialDeadlockException to don't override the original stacktrace by @Spikhalskiy in #1152
• Reimplemented WorkflowRunLockManager to fix design flaw with an unsafe unlock by @Spikhalskiy in #1147
• Fix for Worker#isSuspended not returning the correct state by @Spikhalskiy in #1155

Full Changelog: v1.9.1...v1.10.0

v1.9.1

Highlights

Test server not timing out workflow task in case of subsequent "unhandled command" failures anymore fixing the behavior introduced in Test Server 1.9.0 and Temporal Server 1.16

What's Changed

• Don't time out WFT in case of subsequent UNHANDLED_COMMAND failures by @Spikhalskiy in #1140
• Align Test Server describeWorkflowExecution message with Temporal Server by @Spikhalskiy in #1142
• Fix workflow thread name strategy to append a clear marker of truncation by @Spikhalskiy in #1144
• setMetricsScope is wired into test rules by @Spikhalskiy in #1143
• Release v1.9.1 by @Spikhalskiy in #1145

Full Changelog: v1.9.0...v1.9.1

v1.9.0

Highlights

This release is focused on providing new Search Attributes functionality:

• New Workflow.getSearchAttribute(String), Workflow.getSearchAttributeValues(String),
  Workflow.getSearchAttributes() methods to get deserialized search attributes
• Unit tests can register new search attributes on both Test Server and dockerized Temporal Server
• Unit tests can use Test Server to verify search attributes behavior and implementation.

Test server exposes new gRPC TestService providing time skipping API to be used in other SDKs.

An upgrade of Temporal Server and Temporal docker-compose to 1.16 is highly recommended to use the new Search Attribute APIs.

Fixes

• Edge case of "unexpected event WORKFLOW_TASK_COMPLETED" when querying a non-completed workflow evicted from sticky cache #1134
• Deadlock Detection may cause "Operation allowed only while eventLoop is running" in the workflow code #1127
• Protobuf version range that was making 1.8.x release hard to use with Maven

Migration notes

Previously unit tests setting search attributes were running using the test server without any setup. The test server previously didn't use search attributes at all. This release brings full support for search attributes in the test server and the attributes need to be registered now before they are used in unit tests (as with the real Temporal server).
See: TestWorkflowRule.Builder#registerSearchAttribute, TestWorkflowExtension.Builder#registerSearchAttribute, TestWorkflowEnvironment#registerSearchAttribute.

What's Changed

• Improve operation resilience of prepare-release by @mmcshane in #1058
• Expose OrchestratorServiceStubs by @Spikhalskiy in #1057
• Code cleanup around Pollers by @Spikhalskiy in #1070
• Synchronize GrpcSyncRetryer and GrpcAsyncRetryer behavior, make non-final exceptions INFO level by @Spikhalskiy in #1065
• Implement Test Operator Service by @Spikhalskiy in #1071
• Fix flake with dockerized temporal when signal gets reordered with the first workflow task by @Spikhalskiy in #1075
• Fix comments for newUntypedExternalWorkflowStub by @tsurdilo in #1077
• Time Skipping Service by @Spikhalskiy in #1076
• Fix Search in Javadocs by @Spikhalskiy in #1078
• Fix for WorkerOptions Builder using maxConcurrentActivityExecutionSize for local activities in partial build() by @Spikhalskiy in #1082
• Exclude synthetic and static methods from Activity Interface Hierarchy by @Spikhalskiy in #1083
• Add support for UpsertSearchAttributes to describe in the test service by @nagl-stripe in #1090
• Improve context propagator javadocs by @Spikhalskiy in #1092
• Improve client WorkflowFailedException message with the reason by @Spikhalskiy in #1095
• Swallow "Subchannel shutdown" gRPC errors during worker shutdown by @Spikhalskiy in #1089
• Improve Poller's shutdown log message with a poll task class by @Spikhalskiy in #1108
• Tests verifying that getVersion inside a signal handler works correctly by @Spikhalskiy in #1121
• Test Server times out workflow task in case of workflow task failure after the second attempt by @Spikhalskiy in #1124
• Improve PotentialDeadlockException message with timestamps by @Spikhalskiy in #1122
• Fix "Operation allowed only while eventLoop is running" exception if deadlock is detected by @Spikhalskiy in #1127
• State Machines now don't try to handle already handled events a second time by @Spikhalskiy in #1134
• Deserialized Search Attributes API and full Test Server implementation for Search Attributes by @Spikhalskiy in #1067

Full Changelog: v1.8.1...v1.9.0