Skip to content

Commit 496ffd9

Browse files
authored
Merge branch 'main' into typed-search-attributes
2 parents 5b75abd + 4155dad commit 496ffd9

37 files changed

+1040
-498
lines changed

package-lock.json

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/client/src/build-id-types.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { temporal } from '@temporalio/proto';
33
/**
44
* Operations that can be passed to {@link TaskQueueClient.updateBuildIdCompatibility}.
55
*
6-
* @experimental
6+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
77
*/
88
export type BuildIdOperation =
99
| AddNewIdInNewDefaultSet
@@ -16,7 +16,7 @@ export type BuildIdOperation =
1616
* Adds a new Build Id into a new set, which will be used as the default set for
1717
* the queue. This means all new workflows will start on this Build Id.
1818
*
19-
* @experimental
19+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
2020
*/
2121
export interface AddNewIdInNewDefaultSet {
2222
operation: 'addNewIdInNewDefaultSet';
@@ -28,7 +28,7 @@ export interface AddNewIdInNewDefaultSet {
2828
* the default for that compatible set, and thus new workflow tasks for workflows which have been
2929
* executing on workers in that set will now start on this new Build Id.
3030
*
31-
* @experimental
31+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
3232
*/
3333
export interface AddNewCompatibleVersion {
3434
operation: 'addNewCompatibleVersion';
@@ -47,7 +47,7 @@ export interface AddNewCompatibleVersion {
4747
* default set for the task queue. Any Build Id in the set may be used to
4848
* target it.
4949
*
50-
* @experimental
50+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
5151
*/
5252
export interface PromoteSetByBuildId {
5353
operation: 'promoteSetByBuildId';
@@ -58,7 +58,7 @@ export interface PromoteSetByBuildId {
5858
* Promotes a Build Id within an existing set to become the default ID for that
5959
* set.
6060
*
61-
* @experimental
61+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
6262
*/
6363
export interface PromoteBuildIdWithinSet {
6464
operation: 'promoteBuildIdWithinSet';
@@ -70,7 +70,7 @@ export interface PromoteBuildIdWithinSet {
7070
* compatible with one another. The default of the primary set is maintained as
7171
* the merged set's overall default.
7272
*
73-
* @experimental
73+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
7474
*/
7575
export interface MergeSets {
7676
operation: 'mergeSets';
@@ -84,7 +84,7 @@ export interface MergeSets {
8484
* Represents the sets of compatible Build Id versions associated with some
8585
* Task Queue, as fetched by {@link TaskQueueClient.getBuildIdCompatability}.
8686
*
87-
* @experimental
87+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
8888
*/
8989
export interface WorkerBuildIdVersionSets {
9090
/**
@@ -108,7 +108,7 @@ export interface WorkerBuildIdVersionSets {
108108
/**
109109
* Represents one set of compatible Build Ids.
110110
*
111-
* @experimental
111+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
112112
*/
113113
export interface BuildIdVersionSet {
114114
// All build IDs contained in the set.

packages/client/src/client.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export class Client extends BaseClient {
4747
/**
4848
* Task Queue sub-client - use to perform operations on Task Queues
4949
*
50-
* @experimental
50+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
5151
*/
5252
public readonly taskQueue: TaskQueueClient;
5353

packages/client/src/grpc-retry.ts

-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
import { InterceptingCall, Interceptor, ListenerBuilder, RequesterBuilder, StatusObject } from '@grpc/grpc-js';
22
import * as grpc from '@grpc/grpc-js';
33

4-
/**
5-
* @experimental
6-
*/
74
export interface GrpcRetryOptions {
85
/**
96
* A function which accepts the current retry attempt (starts at 1) and returns the millisecond
@@ -19,8 +16,6 @@ export interface GrpcRetryOptions {
1916

2017
/**
2118
* Options for the backoff formula: `factor ^ attempt * initialIntervalMs(status) * jitter(maxJitter)`
22-
*
23-
* @experimental
2419
*/
2520
export interface BackoffOptions {
2621
/**
@@ -79,8 +74,6 @@ function withDefaultBackoffOptions({
7974

8075
/**
8176
* Generates the default retry behavior based on given backoff options
82-
*
83-
* @experimental
8477
*/
8578
export function defaultGrpcRetryOptions(options: Partial<BackoffOptions> = {}): GrpcRetryOptions {
8679
const { maxAttempts, factor, maxJitter, initialIntervalMs, maxIntervalMs } = withDefaultBackoffOptions(options);
@@ -165,8 +158,6 @@ function defaultInitialIntervalMs({ code }: StatusObject) {
165158
* Returns a GRPC interceptor that will perform automatic retries for some types of failed calls
166159
*
167160
* @param retryOptions Options for the retry interceptor
168-
*
169-
* @experimental
170161
*/
171162
export function makeGrpcRetryInterceptor(retryOptions: GrpcRetryOptions): Interceptor {
172163
return (options, nextCall) => {

packages/client/src/task-queue-client.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,26 @@ type IUpdateWorkerBuildIdCompatibilityRequest =
1414
type GetWorkerTaskReachabilityResponse = temporal.api.workflowservice.v1.GetWorkerTaskReachabilityResponse;
1515

1616
/**
17-
* @experimental
17+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
1818
*/
1919
export type TaskQueueClientOptions = BaseClientOptions;
2020

2121
/**
22-
* @experimental
22+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
2323
*/
2424
export type LoadedTaskQueueClientOptions = LoadedWithDefaults<TaskQueueClientOptions>;
2525

2626
/**
2727
* A stand-in for a Build Id for unversioned Workers
28-
* @experimental
28+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
2929
*/
3030
export const UnversionedBuildId = Symbol.for('__temporal_unversionedBuildId');
3131
export type UnversionedBuildIdType = typeof UnversionedBuildId;
3232

3333
/**
3434
* Client for starting Workflow executions and creating Workflow handles
3535
*
36-
* @experimental
36+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
3737
*/
3838
export class TaskQueueClient extends BaseClient {
3939
public readonly options: LoadedTaskQueueClientOptions;
@@ -285,7 +285,7 @@ export function reachabilityResponseFromProto(resp: GetWorkerTaskReachabilityRes
285285
* - Id passed is incorrect
286286
* - Build Id has been scavenged by the server.
287287
*
288-
* @experimental
288+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
289289
*/
290290
@SymbolBasedInstanceOfError('BuildIdNotFoundError')
291291
export class BuildIdNotFoundError extends Error {}

packages/cloud/src/cloud-operations-client.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import pkg from './pkg';
1919
import { CloudService } from './types';
2020

2121
/**
22-
* @experimental
22+
* @experimental The Temporal Cloud Operations Client API is an experimental feature and may be subject to change.
2323
*/
2424
export interface CloudOperationsClientOptions {
2525
/**
@@ -37,7 +37,7 @@ export interface CloudOperationsClientOptions {
3737
/**
3838
* High level client for the Temporal Cloud API.
3939
*
40-
* @experimental
40+
* @experimental The Temporal Cloud Operations Client API is an experimental feature and may be subject to change.
4141
*/
4242
export class CloudOperationsClient {
4343
/**
@@ -131,7 +131,7 @@ export class CloudOperationsClient {
131131
}
132132

133133
/**
134-
* @experimental
134+
* @experimental The Temporal Cloud Operations Client API is an experimental feature and may be subject to change.
135135
*/
136136
export interface CloudOperationsConnectionOptions {
137137
/**
@@ -288,7 +288,7 @@ interface CloudOperationsConnectionCtorOptions {
288288
* ⚠️ Connections are expensive to construct and should be reused.
289289
* Make sure to {@link close} any unused connections to avoid leaking resources.
290290
*
291-
* @experimental
291+
* @experimental The Temporal Cloud Operations Client API is an experimental feature and may be subject to change.
292292
*/
293293
export class CloudOperationsConnection {
294294
private static readonly Client = grpc.makeGenericClientConstructor({}, 'CloudService', {});

packages/cloud/src/index.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
/** @experimental */
1+
/**
2+
* @experimental The Temporal Cloud Operations Client API is an experimental feature and may be subject to change.
3+
*/
24
export {
35
CloudOperationsClient,
46
CloudOperationsConnection,

packages/common/src/activity-options.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ export interface ActivityOptions {
119119
*
120120
* @default 'COMPATIBLE'
121121
*
122-
* @experimental
122+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
123123
*/
124124
versioningIntent?: VersioningIntent;
125125
}

packages/common/src/versioning-intent-enum.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { assertNever, checkExtends } from './type-helpers';
77
/**
88
* Protobuf enum representation of {@link VersioningIntentString}.
99
*
10-
* @experimental
10+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
1111
*/
1212
export enum VersioningIntent {
1313
UNSPECIFIED = 0,

packages/common/src/versioning-intent.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@
1111
* current worker. The default behavior for starting Workflows is `DEFAULT`. The default behavior for Workflows starting
1212
* Activities, starting Child Workflows, or Continuing As New is `COMPATIBLE`.
1313
*
14-
* @experimental
14+
* @experimental The Worker Versioning API is still being designed. Major changes are expected.
1515
*/
1616
export type VersioningIntent = 'COMPATIBLE' | 'DEFAULT';

0 commit comments

Comments
 (0)