Skip to content

Commit 1ce84a1

Browse files
bergundybergundy
authored
chore: Prepare CHANGELOG for 1.0.0-rc.0 release (#708)
1 parent ab763d4 commit 1ce84a1

File tree

2 files changed

+200
-3
lines changed

2 files changed

+200
-3
lines changed

‎CHANGELOG.md

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

55
Breaking changes marked with a :boom:
66

7+
## [1.0.0-rc.0] - 2022-06-17
8+
9+
### Bug Fixes
10+
11+
- :boom: Use firstExecutionRunId and signaledRunId instead of originalRunId ([#664](https://github.com/temporalio/sdk-typescript/pull/664))
12+
13+
`originalRunId` is a concept related to resetting workflows. None of the instances of `originalRunId` in the SDK seem to do with resetting, so they were changed to `firstExecutionRunId` and `signaledRunId` for handles returned by `WorkflowClient.start` / `@temporalio/workflow:startChild` and `WorkflowClient.signalWithStart` respectively.
14+
15+
- Various improvements and fixes ([#660](https://github.com/temporalio/sdk-typescript/pull/660))
16+
17+
- Record memory usage in stress tests
18+
- Run nightly at night (PST)
19+
- Don't block runtime loop when creating new client
20+
- Don't include proto converter in test workflows `index.ts` - cuts the **test** bundle size by half
21+
- Fix inflight activity tracking
22+
- Expose `WorkerStatus.numHeartbeatingActivities`
23+
- Handle ShutdownError by name - closes [#614](https://github.com/temporalio/sdk-typescript/pull/614)
24+
- Fix TS initiated activity cancellation not creating a proper `ApplicationFailure`
25+
- Closes [#667](https://github.com/temporalio/sdk-typescript/pull/667)
26+
27+
- Validate that RetryPolicy maximumAttempts is an integer ([#674](https://github.com/temporalio/sdk-typescript/pull/674))
28+
29+
Added a quick check that `maximumAttempts` is a number using [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger). This check explicitly excludes numbers like 3.1415 and `Number.POSITIVE_INFINITY`.
30+
31+
`maximumAttempts` should always be an integer, doesn't make much sense for it to have a decimal component. And `maximumAttempts = 0` is the preferred alternative for `maximumAttempts = Number.POSITIVE_INFINITY`.
32+
33+
- Use JSON.stringify() for non-error objects and String() for other values ([#681](https://github.com/temporalio/sdk-typescript/pull/681))
34+
- [`workflow`] Import @temporalio/common ([#688](https://github.com/temporalio/sdk-typescript/pull/688))
35+
36+
- Fixes [#687](https://github.com/temporalio/sdk-typescript/pull/687)
37+
38+
- [`worker`] Throw error when importing a node built-in module from a Workflow ([#689](https://github.com/temporalio/sdk-typescript/pull/689))
39+
40+
- Closes [#685](https://github.com/temporalio/sdk-typescript/issues/685)
41+
42+
- Recreate TransportErrors in initial connection to provide better stack traces ([#693](https://github.com/temporalio/sdk-typescript/pull/693))
43+
- [`docs`] Add links to API and other categories ([#676](https://github.com/temporalio/sdk-typescript/pull/676))
44+
- [`docs`] `Connection.service` -> `.workflowService` ([#696](https://github.com/temporalio/sdk-typescript/pull/696))
45+
- [`docs`] Remove maxIsolateMemoryMB ([#700](https://github.com/temporalio/sdk-typescript/pull/700))
46+
- Use error constructor name as `applicationFailureInfo.type` ([#683](https://github.com/temporalio/sdk-typescript/pull/683))
47+
- Don't drop details from core errors ([#705](https://github.com/temporalio/sdk-typescript/pull/705))
48+
49+
### Features
50+
51+
- [`worker`] Upgrade neon to 0.10 ([#675](https://github.com/temporalio/sdk-typescript/pull/675))
52+
- :boom: Do not allow undefined in PayloadConverter.toPayload ([#672](https://github.com/temporalio/sdk-typescript/pull/672))
53+
54+
BREAKING CHANGE: `PayloadConverter.toPayload` can no longer return `undefined`.
55+
56+
NOTE: This change doesn't apply to `PayloadConverterWithEncoding.toPayload` where the function should return `undefined` to mark that the converter doesn't handle a value.
57+
58+
- :boom: Add upsertSearchAttributes and more ([#657](https://github.com/temporalio/sdk-typescript/pull/657))
59+
60+
- Added and changed `WorkflowInfo` fields
61+
- Added `taskInfo` function to `@temporalio/workflow`
62+
- `Datetime` search attributes are converted to Date objects
63+
- Add `upsertSearchAttributes` Workflow function
64+
- Make Search Attributes always arrays
65+
66+
- Fixes [#314](https://github.com/temporalio/sdk-typescript/pull/314)
67+
- Fixes [#445](https://github.com/temporalio/sdk-typescript/pull/445)
68+
- Closes [#576](https://github.com/temporalio/sdk-typescript/pull/576)
69+
- Closes [#357](https://github.com/temporalio/sdk-typescript/pull/357)
70+
71+
- :boom: Eager and lazy Connection variants + static metadata + worker shutdown refactor ([#682](https://github.com/temporalio/sdk-typescript/pull/682))
72+
73+
- Upgrade to latest sdk-core
74+
- Fix test-payload-converter not awaiting on promises
75+
- Simplify Connection metadata API and support static metadata
76+
- Deprecate `NativeConnection.create` in favor of `connect` method
77+
- Add lint rule: `@typescript-eslint/no-floating-promises`
78+
- Close `TestEnvironment.nativeConnection` in `teardown` method
79+
80+
BREAKING CHANGE:
81+
82+
- `Connection` constructor is no longer public, and is replaced with `async Connection.connect` and `Connection.lazy` factory methods.
83+
- `Connection.service` was renamed `Connection.workflowService`
84+
- `WorkflowClient` constructor now accepts a single options param
85+
86+
BEFORE:
87+
88+
```ts
89+
const connection = new Connection(...);
90+
const client = new WorkflowClient(connection.service, options);
91+
```
92+
93+
AFTER:
94+
95+
```ts
96+
const connection = await Connection.create(...);
97+
const client = new WorkflowClient({ connection, ...options });
98+
```
99+
100+
- Added `Connection.close` and made `Connection.client` protected
101+
102+
NOTE: It is recommended to reuse `Connection` instances as much as possible.
103+
When done using a `Connection`, call `close()` to release any resources held by it.
104+
105+
- `LOCAL_DOCKER_TARGET` constant was renamed `LOCAL_TARGET`
106+
107+
- Metrics are now emitted with the `temporal_` prefix by default to be consistent with other SDKs, in the near future this can be disabled by setting `TelemetryOptions.noTemporalPrefixForMetrics` to `true`.
108+
109+
- Closes [#607](https://github.com/temporalio/sdk-typescript/pull/607)
110+
- Closes [#677](https://github.com/temporalio/sdk-typescript/pull/677)
111+
- Closes [#452](https://github.com/temporalio/sdk-typescript/pull/452)
112+
113+
- :boom: Implement stack trace query ([#690](https://github.com/temporalio/sdk-typescript/pull/690))
114+
115+
- Improved stack traces for workflows
116+
- Closes [#167](https://github.com/temporalio/sdk-typescript/pull/167)
117+
- Stack trace query works on node `>=16.14` because is depends on the [V8 promise hooks API](https://nodejs.org/api/v8.html#promise-hooks)
118+
- `@temporalio/worker` now depends on `source-map` and `source-map-loader`
119+
120+
BREAKING CHANGE: `WorkerOptions.workflowBundle` now accepts both code and source maps
121+
122+
Before:
123+
124+
```ts
125+
await Worker.create({
126+
workflowBundle: { code },
127+
...rest,
128+
});
129+
130+
// -- OR --
131+
132+
await Worker.create({
133+
workflowBundle: { path },
134+
...rest,
135+
});
136+
```
137+
138+
After:
139+
140+
```ts
141+
await Worker.create({
142+
workflowBundle: { code, sourceMap },
143+
...rest
144+
})
145+
146+
// -- OR --
147+
148+
await Worker.create({
149+
workflowBundle: { codePath, sourceMapPath }
150+
...rest
151+
})
152+
```
153+
154+
The return value of `bundleWorkflowCode` is now `{ code: string, sourceMap: string }`
155+
156+
BREAKING CHANGE: `WorkflowInternalsInterceptor.activate` is now synchronous
157+
158+
- Support Jest mock Activity functions ([#704](https://github.com/temporalio/sdk-typescript/pull/704))
159+
- [`worker`] Add `runUntil` method ([#703](https://github.com/temporalio/sdk-typescript/pull/703))
160+
161+
Useful helper especially in tests.
162+
163+
Usage:
164+
165+
```ts
166+
const worker = await Worker.create(opts);
167+
168+
// Wait on an async function
169+
await worker.runUntil(async () => {
170+
client.execute(someWorkflow, wopts);
171+
});
172+
173+
// -- OR --
174+
175+
// Wait on a promise
176+
await worker.runUntil(client.execute(someWorkflow, wopts));
177+
```
178+
179+
- :boom: [`worker`] Rename headers to metadata for `NativeConnection` ([#706](https://github.com/temporalio/sdk-typescript/pull/706))
180+
181+
To use the same term as `@temporalio/client.Connection`
182+
183+
BREAKING CHANGE:
184+
185+
- `NativeConnectionOptions.headers` was renamed to `NativeConnectionOptions.metadata`
186+
- `NativeConnection.updateHeaders` was renamed to `NativeConnection.updateMetadata`
187+
188+
### Miscellaneous Tasks
189+
190+
- Address feedback from connection refactor PR ([#686](https://github.com/temporalio/sdk-typescript/pull/686))
191+
- Upgrade to latest Core ([#701](https://github.com/temporalio/sdk-typescript/pull/701))
192+
193+
- Closes [#697](https://github.com/temporalio/sdk-typescript/pull/697)
194+
- Exposes `operatorService` on client `Connection`
195+
196+
- Build bridge for arm linux ([#698](https://github.com/temporalio/sdk-typescript/pull/698))
197+
198+
### Refactor
199+
200+
- Make SearchAttributesValue an array ([#692](https://github.com/temporalio/sdk-typescript/pull/692))
201+
202+
### Testing
203+
204+
- Reduce smorgasbord timeout sensitivity for CI ([#673](https://github.com/temporalio/sdk-typescript/pull/673))
205+
- Write to provided worker memory log file ([#680](https://github.com/temporalio/sdk-typescript/pull/680))
206+
7207
## [0.23.2] - 2022-05-17
8208

9209
### Miscellaneous Tasks

‎cliff.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ body = """
3030
{% for commit in commits %}
3131
- {% if commit.breaking %}:boom: {% endif %}{% if commit.scope %}[`{{ commit.scope }}`] {% endif %}\
3232
{{ commit.message | upper_first }}\
33-
{% if commit.body %}
34-
- {{ commit.body }}
35-
{% endif %}\
3633
{% endfor %}
3734
{% endfor %}\n
3835
"""

0 commit comments

Comments
 (0)