docs: Update CHANGELOG for v1.4 (#892)

Author: lorensr

CHANGELOG.md

@@ -4,6 +4,65 @@ All notable changes to this project will be documented in this file.
 
 Breaking changes marked with a :boom:
 
+## [1.4.0] - 2022-09-28
+
+### Features
+
+- :boom: Make client gRPC retry more configurable ([#879](https://github.com/temporalio/sdk-typescript/pull/879))
+
+  BREAKING CHANGE: [`GrpcRetryOptions.retryableDecider`](https://typescript.temporal.io/api/interfaces/client.grpcretryoptions/#retryabledecider) now gets the `attempt` number as the first argument. This is an advanced/rare option, and the change should be caught at compile time.
+
+  Also adds [`BackoffOptions`](https://typescript.temporal.io/api/interfaces/client.backoffoptions/) and [`defaultGrpcRetryOptions`](https://typescript.temporal.io/api/namespaces/client/#defaultgrpcretryoptions).
+
+  NOTE: This feature is experimental and its API may change.
+
+- [`client`] Delete search attributes with empty array values in describe() response ([#878](https://github.com/temporalio/sdk-typescript/pull/878))
+
+  :warning: This fixes a bug where empty/deleted Custom Search Attributes were returned as `[]` from [`workflowHandle.describe()`](https://typescript.temporal.io/api/interfaces/client.workflowhandle/#describe). Such attribute properties will no longer be present in the [`WorkflowExecutionDescription.searchAttributes`](https://typescript.temporal.io/api/interfaces/client.WorkflowExecutionDescription#searchattributes) object. Note that this behavior is consistent with what you'll see if using a pre-1.4 version of the SDK with Server version 1.18.
+
+- Add support for custom failure converters ([#887](https://github.com/temporalio/sdk-typescript/pull/887))
+
+  Adds [`DataConverter.failureConverterPath`](https://typescript.temporal.io/api/interfaces/worker.dataconverter/#failureconverterpath) and [`FailureConverter`](https://typescript.temporal.io/api/interfaces/common.FailureConverter), which converts from proto Failure instances to JS Errors and back.
+
+  We recommended going with the default (i.e. not using the `failureConverterPath` option) in order to maintain cross-language Failure serialization compatibility.
+
+  NOTE: This feature is experimental and its API may change.
+
+- [`workflow`] Add [`workflowInfo().unsafe.now()`](https://typescript.temporal.io/api/interfaces/workflow.UnsafeWorkflowInfo/#now) ([#882](https://github.com/temporalio/sdk-typescript/pull/882))
+
+  It returns the current system time in milliseconds. The safe version of time is `new Date()` and `Date.now()`, which are set on the first invocation of a Workflow Task and stay constant for the duration of the Task and during replay.
+
+- Upgrade core, add support for OTEL metric temporality ([#891](https://github.com/temporalio/sdk-typescript/pull/891))
+
+  - Upgraded otel and other deps ([temporalio/sdk-core#402](https://github.com/temporalio/sdk-core/pull/402))
+  - Fix incorrect string names for polling methods ([temporalio/sdk-core#401](https://github.com/temporalio/sdk-core/pull/401))
+
+### Miscellaneous Tasks
+
+- Remove `internal-*` packages ([#881](https://github.com/temporalio/sdk-typescript/pull/881))
+
+  :warning: Any imports from `@temporalio/internal-*` need to be updated. As noted in their named and READMEs, they're not meant to be used to directly, so we don't imagine this is a common case. However, if you do find instances, they should be changed to importing from:
+
+  ```
+  @temporalio/internal-non-workflow-common ➡️ @temporalio/common/lib/internal-non-workflow
+  @temporalio/internal-workflow-common ➡️ @temporalio/common
+  ```
+
+- [`common`] Deprecate internal functions that should have never been exported ([#893](https://github.com/temporalio/sdk-typescript/pull/889))
+
+  Some time-related and binary conversion internal helper functions were exported from `@temporalio/common`. They are now deprecated and hidden from the API reference, as they're meant for internal use only.
+
+- [`workflow`] Export `LoggerSinks` from `@temporalio/workflow` ([#889](https://github.com/temporalio/sdk-typescript/pull/889))
+- [`client`] Add [max retry interval](https://typescript.temporal.io/api/interfaces/client.backoffoptions/#maxintervalms) for client ([#883](https://github.com/temporalio/sdk-typescript/pull/883))
+- Label grpc-retry API as experimental ([#891](https://github.com/temporalio/sdk-typescript/pull/891))
+- Make the failure-converter code symmetric ([#891](https://github.com/temporalio/sdk-typescript/pull/891))
+
+### Bug Fixes
+
+- Fix double import of long in generated proto TS files ([#891](https://github.com/temporalio/sdk-typescript/pull/891))
+- Fix bundler with default workflow interceptors ([#891](https://github.com/temporalio/sdk-typescript/pull/891))
+- Limit eager activity requests to 3 ([#891](https://github.com/temporalio/sdk-typescript/pull/891))
+
 ## [1.3.0] - 2022-09-20
 
 ### Bug Fixes

packages/common/src/converter/data-converter.ts

@@ -38,6 +38,8 @@ export interface DataConverter {
    * Path of a file that has a `failureConverter` named export.
    * `failureConverter` should be an object that implements {@link FailureConverter}.
    * If no path is provided, {@link defaultFailureConverter} is used.
+   *
+   * @experimental
    */
   failureConverterPath?: string;
 

packages/common/src/converter/failure-converter.ts

@@ -53,6 +53,8 @@ export function cutoffStackTrace(stack?: string): string {
  *
  * It is recommended to use the {@link DefaultFailureConverter} and not attempt to customize the default implementation
  * in order to maintain cross language failure serialization compatibility.
+ *
+ * @experimental
  */
 export interface FailureConverter {
   /**
@@ -94,6 +96,8 @@ export interface DefaultFailureConverterOptions {
  * By default, it will leave error messages and stack traces as plain text. In order to encrypt those, set
  * `encodeCommonAttributes` to `true` in the constructor options and make sure to use a {@link PayloadCodec} that can
  * encrypt / decrypt payloads in your Worker and Client options.
+ *
+ * @experimental
  */
 export class DefaultFailureConverter implements FailureConverter {
   public readonly options: DefaultFailureConverterOptions;

packages/core-bridge/index.d.ts

@@ -110,13 +110,12 @@ export interface PrometheusMetricsExporter {
 
 /**
  * Metrics exporters supported by Core
+ *
+ * `temporality` is the type of aggregation temporality for metric export. Applies to both Prometheus and OpenTelemetry exporters.
+ *
+ * See the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/ce50e4634efcba8da445cc23523243cb893905cb/specification/metrics/datamodel.md#temporality) for more information.
  */
 export type MetricsExporter = {
-  /**
-   * Type of aggregation temporality for metric export.
-   *
-   * See the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/ce50e4634efcba8da445cc23523243cb893905cb/specification/metrics/datamodel.md#temporality) for more information.
-   */
   temporality?: 'cumulative' | 'delta';
 } & (PrometheusMetricsExporter | OtelCollectorExporter);
 

packages/workflow/src/index.ts

@@ -50,7 +50,7 @@ export {
   ActivityCancellationType,
   ActivityFailure,
   ActivityFunction,
-  ActivityInterface, // eslint-disable-line deprecation/deprecation
+  ActivityInterface,
   ActivityOptions,
   ApplicationFailure,
   CancelledFailure,
@@ -77,14 +77,15 @@ export {
   ChildWorkflowOptions,
   ContinueAsNew,
   ContinueAsNewOptions,
+  EnhancedStackTrace,
+  FileLocation,
+  FileSlice,
   ParentClosePolicy,
   ParentWorkflowInfo,
-  WorkflowInfo,
-  FileSlice,
-  FileLocation,
-  StackTrace,
-  EnhancedStackTrace,
   SDKInfo,
+  StackTrace,
+  UnsafeWorkflowInfo,
+  WorkflowInfo,
 } from './interfaces';
 export { LoggerSinks, Sink, SinkCall, SinkFunction, Sinks } from './sinks';
 export { Trigger } from './trigger';

packages/workflow/src/interfaces.ts

@@ -140,7 +140,7 @@ export interface UnsafeWorkflowInfo {
    * Current system time in milliseconds
    *
    * The safe version of time is `new Date()` and `Date.now()`, which are set on the first invocation of a Workflow
-   * Task.
+   * Task and stay constant for the duration of the Task and during replay.
    */
   now(): number;