Skip to content

Commit f755701

Browse files
authored
chore: Add v1.3.0 to CHANGELOG (#875)
1 parent 3fd5f9b commit f755701

File tree

1 file changed

+109
-0
lines changed

1 file changed

+109
-0
lines changed

CHANGELOG.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,115 @@ All notable changes to this project will be documented in this file.
44

55
Breaking changes marked with a :boom:
66

7+
## [1.3.0] - 2022-09-20
8+
9+
### Bug Fixes
10+
11+
- :boom: Various bug fixes ([#873](https://github.com/temporalio/sdk-typescript/pull/873))
12+
13+
BREAKING CHANGE: Makes `WorkflowExecutionDescription.historyLength` a number. This was a `Long` before, but shouldn't
14+
have been. If you're currently calling:
15+
16+
```ts
17+
(await workflowHandle.describe()).historyLength.toNumber();
18+
```
19+
20+
then remove the `.toNumber()` call.
21+
22+
This PR also included:
23+
24+
- Make `protobufjs` a dev dependency of `@temporalio/client`
25+
- Use simple version of Core's `cancelChildWorkflowExecution` command
26+
27+
- :boom: Update Core from [`e261`](https://github.com/temporalio/sdk-core/tree/e261de3c38b47b29be0db209e9a4758250593034) to [`b437`](https://github.com/temporalio/sdk-core/tree/b437737) ([#865](https://github.com/temporalio/sdk-typescript/pull/865) and [#873](https://github.com/temporalio/sdk-typescript/pull/873))
28+
29+
BREAKING CHANGE: This fixes a bug where values (memo, search attributes, and retry policy) were not being passed on to
30+
the next Run during Continue-As-New. Now they are, unless you specify different values when calling
31+
[`continueAsNew`](https://typescript.temporal.io/api/namespaces/workflow/#continueasnew)
32+
([temporalio/sdk-core#376](https://github.com/temporalio/sdk-core/pull/376)). _[We believe this is unlikely to break
33+
users code—the code would have to be depending on the absence of these values in Continued-As-New Runs.]_
34+
35+
This update also have various fixes and features:
36+
37+
- Don't dispatch eager activity if task queue is not the "current" ([temporalio/sdk-core#397](https://github.com/temporalio/sdk-core/pull/397))
38+
- Fix cancelling of started-but-lang-doesn't-know workflows ([temporalio/sdk-core#379](https://github.com/temporalio/sdk-core/pull/379))
39+
- Protect worker from more network errors ([temporalio/sdk-core#396](https://github.com/temporalio/sdk-core/pull/396))
40+
- Use tokio-rustls for request ([temporalio/sdk-core#395](https://github.com/temporalio/sdk-core/pull/395))
41+
- Fix for ephemeral test server zombie ([temporalio/sdk-core#392](https://github.com/temporalio/sdk-core/pull/392))
42+
- Ephemeral server lazy-downloader and runner ([temporalio/sdk-core#389](https://github.com/temporalio/sdk-core/pull/389))
43+
- Fix health service getter ([temporalio/sdk-core#387](https://github.com/temporalio/sdk-core/pull/387))
44+
- Expose HealthService ([temporalio/sdk-core#386](https://github.com/temporalio/sdk-core/pull/386))
45+
- Add more missing workflow options and add request_id as parameter for some calls ([temporalio/sdk-core#365](https://github.com/temporalio/sdk-core/pull/365))
46+
- Correct API definition link ([temporalio/sdk-core#381](https://github.com/temporalio/sdk-core/pull/381))
47+
- Add grpc health checking service/fns to client ([temporalio/sdk-core#377](https://github.com/temporalio/sdk-core/pull/377))
48+
- Respect per-call gRPC headers ([temporalio/sdk-core#375](https://github.com/temporalio/sdk-core/pull/375))
49+
- More client refactoring & add versioning-opt-in config flag ([temporalio/sdk-core#374](https://github.com/temporalio/sdk-core/pull/374))
50+
- Publicly expose the new client traits ([temporalio/sdk-core#371](https://github.com/temporalio/sdk-core/pull/371))
51+
- Add Test Server client & update deps ([temporalio/sdk-core#370](https://github.com/temporalio/sdk-core/pull/370))
52+
- Added test confirming act. w/o heartbeats times out ([temporalio/sdk-core#369](https://github.com/temporalio/sdk-core/pull/369))
53+
- Add Operator API machinery to client ([temporalio/sdk-core#366](https://github.com/temporalio/sdk-core/pull/366))
54+
55+
- [`client`] Only require `signalArgs` in [`signalWithStart`](https://typescript.temporal.io/api/classes/client.workflowclient/#signalwithstart) when needed ([#847](https://github.com/temporalio/sdk-typescript/pull/847))
56+
57+
### Features
58+
59+
- :boom: Improvements to `@temporalio/testing` ([#865](https://github.com/temporalio/sdk-typescript/pull/865) and [#873](https://github.com/temporalio/sdk-typescript/pull/873))
60+
61+
BREAKING CHANGE: Breaking for the testing package in some of the more advanced and rarely used options:
62+
63+
- No longer accepting `runInNormalTime` when waiting for workflow result
64+
- `TestWorkflowEnvironmentOptions` is completely redone
65+
66+
_[Given that these were rarely used and the testing package isn't meant for production use, we don't think this change warrants a major version bump.]_
67+
68+
`TestWorkflowEnvironment.create` is deprecated in favor of:
69+
70+
- [`TestWorkflowEnvironment.createTimeSkipping`](https://typescript.temporal.io/api/classes/testing.TestWorkflowEnvironment#createtimeskipping)
71+
- [`TestWorkflowEnvironment.createLocal`](https://typescript.temporal.io/api/classes/testing.TestWorkflowEnvironment#createlocal)
72+
73+
Added [`TestWorkflowEnvironment.currentTimeMs`](https://typescript.temporal.io/api/classes/testing.TestWorkflowEnvironment#currenttimems).
74+
75+
- Various minor features ([#865](https://github.com/temporalio/sdk-typescript/pull/865))
76+
- Add [`Connection.healthService`](https://typescript.temporal.io/api/classes/client.Connection#healthservice) and generate testservice and health in proto package
77+
- Updated ci to use sdk-ci namespace for testing with cloud.
78+
- Use ephemeral server from Core (supports both time skipping and temporalite)
79+
- Test server is now only downloaded on first use
80+
- Removed some unused dependencies
81+
- Refactored core bridge into multiple files
82+
- Closes [#834](https://github.com/temporalio/sdk-typescript/issues/834)
83+
- Closes [#844](https://github.com/temporalio/sdk-typescript/issues/844)
84+
- [`client`] Add a high-level meta [`Client`](https://typescript.temporal.io/api/classes/client.Client) class ([#870](https://github.com/temporalio/sdk-typescript/pull/870))
85+
86+
We now recommend using this instead of our other clients:
87+
88+
```ts
89+
import { Client } from '@temporalio/client';
90+
91+
const client = new Client(options);
92+
93+
await client.workflow.start();
94+
await client.activity.heartbeat();
95+
await client.activity.complete();
96+
```
97+
98+
- `client.workflow` is a [`WorkflowClient`](https://typescript.temporal.io/api/classes/client.workflowclient/).
99+
- `client.activity` is an [`AsyncCompletionClient`](https://typescript.temporal.io/api/classes/client.asynccompletionclient/).
100+
- We will be adding `client.schedule.*` (see the [`ScheduleClient` proposal](https://github.com/temporalio/proposals/pull/62)).
101+
102+
- Add [`ActivityOptions.allowEagerDispatch`](https://typescript.temporal.io/api/interfaces/common.activityoptions/#alloweagerdispatch) (default true) ([#873](https://github.com/temporalio/sdk-typescript/pull/873))
103+
- [`testing`] Use `temporal.download` for downloading test server ([#864](https://github.com/temporalio/sdk-typescript/pull/864))
104+
- Add Webpack rule to auto instrument Workflows for code coverage, add `augmentWorkerOptions()` ([#858](https://github.com/temporalio/sdk-typescript/pull/858), thanks to [`@vkarpov15`](https://github.com/vkarpov15) 🙏)
105+
106+
### Documentation
107+
108+
- Improve API reference ([#871](https://github.com/temporalio/sdk-typescript/pull/871))
109+
- Publish unchanged packages ([#862](https://github.com/temporalio/sdk-typescript/pull/862))
110+
- Update `nyc-test-coverage` README ([#866](https://github.com/temporalio/sdk-typescript/pull/866))
111+
112+
### Miscellaneous Tasks
113+
114+
- In-process verdaccio server ([#861](https://github.com/temporalio/sdk-typescript/pull/861), thanks to [`@mjameswh`](https://github.com/mjameswh) 🙏)
115+
7116
## [1.2.0] - 2022-09-01
8117

9118
### Features

0 commit comments

Comments
 (0)