Skip to content

Commit 7698540

Browse files
mjameswhlorensr
andauthored
chore: Add changelog entries in prep for release 1.7.0 (#1093)
--------- Co-authored-by: Loren ☺️ <251288+lorensr@users.noreply.github.com>
1 parent 23fe827 commit 7698540

File tree

1 file changed

+70
-1
lines changed

1 file changed

+70
-1
lines changed

CHANGELOG.md

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,75 @@ All notable changes to this project will be documented in this file.
44

55
Breaking changes marked with a :boom:
66

7+
## [1.7.0] - 2023-04-02
8+
9+
### Features
10+
11+
- :boom: [`worker`] The experimental `Worker.runReplayHistories` method, which allows efficient replay of a large number
12+
of workflow histories, now returns an `AsyncIterableIterator` ([#1067](https://github.com/temporalio/sdk-typescript/pull/1067))
13+
14+
**EXAMPLE USAGE**
15+
16+
```ts
17+
const histories = client.workflow.list({ query: 'WorkflowType="MyWorkflow"' }).intoHistories({ concurrency: 10 });
18+
const replayResults = Worker.runReplayHistories(
19+
{
20+
workflowsPath: require.resolve('./workflows'),
21+
// ...
22+
},
23+
histories
24+
);
25+
for await (const result of replayResults) {
26+
const { workflowId, runId, error } = result;
27+
// error is either undefined, a ReplayError, or a DeterminismViolationError
28+
}
29+
```
30+
31+
- :boom: [`worker`] `WorkerOptions.shutdownGraceTime` no longer forcefully shuts the worker down. Now, when `shutdownGraceTime` passes, the worker just sends Cancellation to running Activities.
32+
Set `WorkerOptions.shutdownForceTime` to force shutdown. ([#1072](https://github.com/temporalio/sdk-typescript/pull/1072))
33+
34+
- :boom: [`testing`] Use [Temporal CLI](https://github.com/temporalio/cli/#temporal-cli) to power local test environment ([#1077](https://github.com/temporalio/sdk-typescript/pull/1077))
35+
36+
### Bug Fixes
37+
38+
- Fail Workflow on `WorkflowExecutionAlreadyStartedError` ([#1068](https://github.com/temporalio/sdk-typescript/pull/1068))
39+
40+
- [`create-project`] While fixing dependencies on a newly instantiated project, we now recursively search for
41+
package.json and tsconfig.json ([#1089](https://github.com/temporalio/sdk-typescript/pull/1089) thanks to [`@jhubbardsf`](https://github.com/jhubbardsf) 🙏)
42+
43+
- [`create-project`] Remove the `.post-create` file (if it exists), before committing to git ([#1018](https://github.com/temporalio/sdk-typescript/pull/1018))
44+
45+
- Completetly removed support for Node versions <= 14.17. Lot of our dependencies were already
46+
requiring Node 14.18+ anyway. ([#1070](https://github.com/temporalio/sdk-typescript/pull/1070))
47+
48+
- Load package `abort-controller` as a polyfill rather than a complete substitution.
49+
This will ensure using native implementation of that class in Node 16+ ([#1070](https://github.com/temporalio/sdk-typescript/pull/1070))
50+
51+
:boom: This change might cause TypeScript to warn about incompatible types when working with libraries that are using
52+
custom type definitions for the `AbortSignal` interface.
53+
54+
```ts
55+
import type { AbortSignal as FetchAbortSignal } from 'node-fetch/externals';
56+
// ...
57+
const response = await fetch(url, { signal: Context.current().cancellationSignal as FetchAbortSignal });
58+
```
59+
60+
- [`client`] Get rid of experimental `AsyncLocalStorage.enterWith` call ([#1080](https://github.com/temporalio/sdk-typescript/pull/1080))
61+
62+
- [`core`] Fix slot metrics appearing to be off-by-one because of reservation ([#479](https://github.com/temporalio/sdk-core/pull/479))
63+
64+
- [`core`] Fix misnamed metric `workflow_task_execution_failed` ([#481](https://github.com/temporalio/sdk-core/pull/481))
65+
66+
- [`core`] Added an internal patching mechanism for adjusting SDK behavior based on what version of the SDK has previously processed the workflow. Note that this new mechanism requires server Temporal 1.20.0 or above. Any change that depends on such an internal patch will not be effective with older servers. ([#482](https://github.com/temporalio/sdk-core/pull/482))
67+
68+
- :boom: [`core`] Make activity (and child workflow) type / id mismatches will results in a non-deterministic change. That means that renaming an activity or a child workflow will now require a patch. Note that this change has been gated with an internal patch to avoid suddently failing with nondeterminism errors on older activity rename (see details above) ([#475](https://github.com/temporalio/sdk-core/pull/475), [#482](https://github.com/temporalio/sdk-core/pull/482))
69+
70+
- [`core`] Auto-fail new workflow tasks which encounter a problem upon their application, but before any activation has been issued to lang. This may fix some scenarios where previously a WFT would simply time out. ([#482](https://github.com/temporalio/sdk-core/pull/482))
71+
72+
### Documentation
73+
74+
- Add install protocal buffers step to CONTRIBUTING.md doc ([#1086](https://github.com/temporalio/sdk-typescript/pull/1086), thanks to [`@jhubbardsf`](https://github.com/jhubbardsf) 🙏)
75+
776
## [1.6.0] - 2023-01-30
877

978
### Features
@@ -59,7 +128,7 @@ Breaking changes marked with a :boom:
59128

60129
- [`core`] Fixed some rare case where sdk-core would panic on unexpected history fetching responses from the server ([#468](https://github.com/temporalio/sdk-core/pull/468)).
61130

62-
- [`core`] Fixed some rare case where an activation completion might get blocked if fetching history pages failed ([#475](https://github.com/temporalio/sdk-core/pull/475)).
131+
- [`core`] Fixed some rare case where an activation completion might get blocked if fetching history pages failed ([#478](https://github.com/temporalio/sdk-core/pull/478)).
63132

64133
## [1.5.2] - 2022-12-07
65134

0 commit comments

Comments
 (0)