@temporalio/core-bridge 1.4.4 → 1.5.1

package/{index.d.ts → ts/index.ts}

@@ -1,8 +1,22 @@
 import { SpanContext } from '@opentelemetry/api';
-import { TLSConfig } from '@temporalio/common/lib/internal-non-workflow';
+import type { TLSConfig } from '@temporalio/common/lib/internal-non-workflow';
 
 export { TLSConfig };
 
+type Shadow<Base, New> = Base extends object
+  ? New extends object
+    ? {
+        [K in keyof Base | keyof New]: K extends keyof Base
+          ? K extends keyof New
+            ? Shadow<Base[K], New[K]>
+            : Base[K]
+          : K extends keyof New
+          ? New[K]
+          : never;
+      }
+    : New
+  : New;
+
 export interface RetryOptions {
   /** Initial wait time before the first retry. */
   initialInterval: number;
@@ -53,32 +67,40 @@ export interface ClientOptions {
 
 /**
  * Log directly to console
+ *
+ * @experimental
  */
 export interface ConsoleLogger {
-  console: {};
+  console: {}; // eslint-disable-line @typescript-eslint/ban-types
 }
 
 /**
  * Forward logs to {@link Runtime} logger
+ *
+ * @experimental
  */
 export interface ForwardLogger {
   forward: {
     /**
      * What level, if any, logs should be forwarded from core at
      *
+     * @deprecated Use {@link TelemetryOptions.logging.filter} instead
      */
-    // These strings should match the log::LevelFilter enum in rust
-    level: LogLevel;
+    level?: LogLevel;
   };
 }
 
 /**
  * Logger types supported by Core
+ *
+ * @experimental
  */
 export type Logger = ConsoleLogger | ForwardLogger;
 
 /**
  * OpenTelemetry Collector options for exporting metrics or traces
+ *
+ * @experimental
  */
 export interface OtelCollectorExporter {
   otel: {
@@ -90,11 +112,26 @@ export interface OtelCollectorExporter {
      * Optional set of HTTP request headers to send to Collector (e.g. for authentication)
      */
     headers?: Record<string, string>;
+    /**
+     * Specify how frequently in metrics should be exported.
+     *
+     * @format number of milliseconds or {@link https://www.npmjs.com/package/ms | ms-formatted string}
+     * @defaults 1 second
+     */
+    metricsExportInterval?: string | number;
   };
 }
 
+/** @experimental */
+export type CompiledOtelTraceExporter = Shadow<OtelCollectorExporter, { otel: { metricsExportInterval?: never } }>;
+
+/** @experimental */
+export type CompiledOtelMetricsExporter = Shadow<OtelCollectorExporter, { otel: { metricsExportInterval: number } }>;
+
 /**
  * Prometheus metrics exporter options
+ *
+ * @experimental
  */
 export interface PrometheusMetricsExporter {
   prometheus: {
@@ -114,6 +151,8 @@ export interface PrometheusMetricsExporter {
  * `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.
+ *
+ * @experimental
  */
 export type MetricsExporter = {
   temporality?: 'cumulative' | 'delta';
@@ -121,17 +160,20 @@ export type MetricsExporter = {
 
 /**
  * Trace exporters supported by Core
+ *
+ * @experimental
  */
 export type TraceExporter = OtelCollectorExporter;
 
+/** @experimental */
 export interface TelemetryOptions {
   /**
    * A string in the env filter format specified here:
    * https://docs.rs/tracing-subscriber/0.2.20/tracing_subscriber/struct.EnvFilter.html
    *
-   * Which determines what tracing data is collected in the Core SDK
+   * Which determines what tracing data is collected in the Core SDK.
    *
-   * @default `temporal_sdk_core=WARN`
+   * @deprecated Use either `logging.filter` or `tracing.filter` instead
    */
   tracingFilter?: string;
 
@@ -145,17 +187,50 @@ export interface TelemetryOptions {
 
   /**
    * Control where to send Rust Core logs
-   *
-   * @default log to console
    */
-  logging?: Logger;
+  logging?: {
+    /**
+     * A string in (env filter format)[https://docs.rs/tracing-subscriber/0.2.20/tracing_subscriber/struct.EnvFilter.html]
+     * which determines the verboseness of logging output.
+     *
+     * You can use {@link Runtime.makeTelemetryFilterString()} to easily build a correctly formatted filter
+     * string based on desired log level for Core SDK and other native packages.
+     *
+     * **BACKWARD COMPATIBILITY**
+     *
+     * If `logging.filter` is missing, the following legacy values (if present) will be used instead (in the given order):
+     * - {@link ForwardLogger.forward.level} => `makeTelemetryFilterString({ core: level, other: level })`
+     * - {@link TelemetryOptions.tracingFilter}
+     * - Default value of `makeTelemetryFilterString({ core: 'INFO', other: 'INFO'})`
+     *
+     * @default `makeTelemetryFilterString({ core: 'INFO', other: 'INFO'})` (with some exceptions, as described in backward compatibility note above)
+     */
+    filter?: string;
+  } & Partial<Logger>;
 
   /**
    * Control where to send traces generated by Rust Core, optional and turned off by default.
    *
    * This is typically used for profiling SDK internals.
    */
-  tracing?: TraceExporter;
+  tracing?: {
+    /**
+     * A string in (env filter format)[https://docs.rs/tracing-subscriber/0.2.20/tracing_subscriber/struct.EnvFilter.html]
+     * which determines what tracing data is collected in the Core SDK.
+     *
+     * You can use {@link Runtime.makeTelemetryFilterString()} to easily build a correctly formatted filter
+     * string based on desired log level for Core SDK and other native packages.
+     *
+     * **BACKWARD COMPATIBILITY**
+     *
+     * If `tracing.filter` is missing, the following legacy values (if present) will be used instead (in the given order):
+     * - {@link TelemetryOptions.tracingFilter}
+     * - Default value of `makeTelemetryFilterString({ core: 'INFO', other: 'INFO'})`
+     *
+     * @default `makeTelemetryFilterString({ core: 'INFO', other: 'INFO'})` (with some exceptions, as described in backward compatibility note above)
+     */
+    filter?: string;
+  } & Partial<TraceExporter>;
 
   /**
    * Control exporting {@link NativeConnection} and {@link Worker} metrics.
@@ -165,6 +240,23 @@ export interface TelemetryOptions {
   metrics?: MetricsExporter;
 }
 
+/** @experimental */
+export type CompiledTelemetryOptions = {
+  noTemporalPrefixForMetrics?: boolean;
+  logging: {
+    filter: string;
+  } & (
+    | { console: {} /* eslint-disable-line @typescript-eslint/ban-types */ }
+    | { forward: {} /* eslint-disable-line @typescript-eslint/ban-types */ }
+  );
+  tracing?: {
+    filter: string;
+  } & CompiledOtelTraceExporter;
+  metrics?: {
+    temporality?: 'cumulative' | 'delta';
+  } & (PrometheusMetricsExporter | CompiledOtelMetricsExporter);
+};
+
 export interface WorkerOptions {
   /**
    * A human-readable string that can identify your worker
@@ -348,26 +440,38 @@ export interface Client {
 export interface EphemeralServer {
   type: 'EphemeralServer';
 }
+export interface HistoryPusher {
+  type: 'HistoryPusher';
+}
+export interface ReplayWorker {
+  type: 'ReplayWorker';
+  worker: Worker;
+  pusher: HistoryPusher;
+}
 
 export declare type Callback<T> = (err: Error, result: T) => void;
 export declare type PollCallback = (err: Error, result: ArrayBuffer) => void;
 export declare type WorkerCallback = (err: Error, result: Worker) => void;
+export declare type ReplayWorkerCallback = (err: Error, worker: ReplayWorker) => void;
 export declare type ClientCallback = (err: Error, result: Client) => void;
 export declare type VoidCallback = (err: Error, result: void) => void;
 export declare type LogsCallback = (err: Error, result: LogEntry[]) => void;
 
-// TODO: improve type, for some reason Error is not accepted here
-export declare function registerErrors(errors: Record<string, any>): void;
-export declare function initTelemetry(telemOptions: TelemetryOptions): void;
-export declare function newRuntime(): Runtime;
+export declare function newRuntime(telemOptions: CompiledTelemetryOptions): Runtime;
 export declare function newClient(runtime: Runtime, clientOptions: ClientOptions, callback: ClientCallback): void;
 export declare function newWorker(client: Client, workerOptions: WorkerOptions, callback: WorkerCallback): void;
 export declare function newReplayWorker(
   runtime: Runtime,
   workerOptions: WorkerOptions,
+  callback: ReplayWorkerCallback
+): void;
+export declare function pushHistory(
+  pusher: HistoryPusher,
+  workflowId: string,
   history: ArrayBuffer,
-  callback: WorkerCallback
+  callback: VoidCallback
 ): void;
+export declare function closeHistoryStream(pusher: HistoryPusher): void;
 export declare function workerInitiateShutdown(worker: Worker, callback: VoidCallback): void;
 export declare function workerFinalizeShutdown(worker: Worker): void;
 export declare function clientUpdateHeaders(
@@ -406,3 +510,5 @@ export declare function startEphemeralServer(
 ): void;
 export declare function shutdownEphemeralServer(server: EphemeralServer, callback: Callback<EphemeralServer>): void;
 export declare function getEphemeralServerTarget(server: EphemeralServer): string;
+
+export { ShutdownError, TransportError, UnexpectedError } from './errors';

package/sdk-core/core/src/log_export.rs

@@ -1,62 +0,0 @@
-use log::{LevelFilter, Log, Metadata, Record};
-use ringbuf::{Consumer, Producer, RingBuffer};
-use std::{sync::Mutex, time::SystemTime};
-use temporal_sdk_core_api::CoreLog;
-
-pub(crate) struct CoreExportLogger {
-    logs_in: Mutex<Producer<CoreLog>>,
-    logs_out: Mutex<Consumer<CoreLog>>,
-    level_filter: LevelFilter,
-}
-
-impl CoreExportLogger {
-    pub(crate) fn new(level: LevelFilter) -> Self {
-        let (lin, lout) = RingBuffer::new(2048).split();
-        Self {
-            logs_in: Mutex::new(lin),
-            logs_out: Mutex::new(lout),
-            level_filter: level,
-        }
-    }
-
-    pub(crate) fn drain(&self) -> Vec<CoreLog> {
-        let mut lout = self
-            .logs_out
-            .lock()
-            .expect("Logging output mutex must be acquired");
-        let mut retme = Vec::with_capacity(lout.len());
-        lout.pop_each(
-            |el| {
-                retme.push(el);
-                true
-            },
-            None,
-        );
-        retme
-    }
-}
-
-impl Log for CoreExportLogger {
-    fn enabled(&self, metadata: &Metadata) -> bool {
-        // Never forward logging from other crates
-        if !metadata.target().contains("temporal_sdk_core") {
-            return false;
-        }
-        metadata.level() <= self.level_filter
-    }
-
-    fn log(&self, record: &Record) {
-        let clog = CoreLog {
-            message: format!("[{}] {}", record.target(), record.args()),
-            timestamp: SystemTime::now(),
-            level: record.level(),
-        };
-        let _ = self
-            .logs_in
-            .lock()
-            .expect("Logging mutex must be acquired")
-            .push(clog);
-    }
-
-    fn flush(&self) {}
-}

package/sdk-core/core/src/worker/workflow/machines/mutable_side_effect_state_machine.rs

@@ -1,127 +0,0 @@
-use rustfsm::{fsm, TransitionResult};
-
-fsm! {
-    pub(super) name MutableSideEffectMachine; command MutableSideEffectCommand; error MutableSideEffectMachineError;
-
-    Created --(CheckExecutionState, on_check_execution_state) --> Replaying;
-    Created --(CheckExecutionState, on_check_execution_state) --> Executing;
-
-    Executing --(Schedule, on_schedule) --> MarkerCommandCreated;
-    Executing --(Schedule, on_schedule) --> Skipped;
-
-    MarkerCommandCreated --(CommandRecordMarker, on_command_record_marker) --> ResultNotified;
-
-    MarkerCommandCreatedReplaying --(CommandRecordMarker) --> ResultNotifiedReplaying;
-
-    Replaying --(Schedule, on_schedule) --> MarkerCommandCreatedReplaying;
-
-    ResultNotified --(MarkerRecorded, on_marker_recorded) --> MarkerCommandRecorded;
-
-    ResultNotifiedReplaying --(NonMatchingEvent, on_non_matching_event) --> SkippedNotified;
-    ResultNotifiedReplaying --(MarkerRecorded, on_marker_recorded) --> MarkerCommandRecorded;
-    ResultNotifiedReplaying --(MarkerRecorded, on_marker_recorded) --> SkippedNotified;
-
-    Skipped --(CommandRecordMarker, on_command_record_marker) --> SkippedNotified;
-}
-
-#[derive(thiserror::Error, Debug)]
-pub(super) enum MutableSideEffectMachineError {}
-
-pub(super) enum MutableSideEffectCommand {}
-
-#[derive(Default, Clone)]
-pub(super) struct Created {}
-
-impl Created {
-    pub(super) fn on_check_execution_state(
-        self,
-    ) -> MutableSideEffectMachineTransition<ReplayingOrExecuting> {
-        unimplemented!()
-    }
-}
-
-#[derive(Default, Clone)]
-pub(super) struct Executing {}
-
-impl Executing {
-    pub(super) fn on_schedule(
-        self,
-    ) -> MutableSideEffectMachineTransition<MarkerCommandCreatedOrSkipped> {
-        unimplemented!()
-    }
-}
-
-#[derive(Default, Clone)]
-pub(super) struct MarkerCommandCreated {}
-
-impl MarkerCommandCreated {
-    pub(super) fn on_command_record_marker(
-        self,
-    ) -> MutableSideEffectMachineTransition<ResultNotified> {
-        unimplemented!()
-    }
-}
-
-#[derive(Default, Clone)]
-pub(super) struct MarkerCommandCreatedReplaying {}
-
-#[derive(Default, Clone)]
-pub(super) struct MarkerCommandRecorded {}
-
-#[derive(Default, Clone)]
-pub(super) struct Replaying {}
-
-impl Replaying {
-    pub(super) fn on_schedule(
-        self,
-    ) -> MutableSideEffectMachineTransition<MarkerCommandCreatedReplaying> {
-        unimplemented!()
-    }
-}
-
-#[derive(Default, Clone)]
-pub(super) struct ResultNotified {}
-
-impl ResultNotified {
-    pub(super) fn on_marker_recorded(
-        self,
-    ) -> MutableSideEffectMachineTransition<MarkerCommandRecorded> {
-        unimplemented!()
-    }
-}
-
-#[derive(Default, Clone)]
-pub(super) struct ResultNotifiedReplaying {}
-
-impl ResultNotifiedReplaying {
-    pub(super) fn on_non_matching_event(
-        self,
-    ) -> MutableSideEffectMachineTransition<SkippedNotified> {
-        unimplemented!()
-    }
-    pub(super) fn on_marker_recorded(
-        self,
-    ) -> MutableSideEffectMachineTransition<MarkerCommandRecordedOrSkippedNotified> {
-        unimplemented!()
-    }
-}
-
-impl From<MarkerCommandCreatedReplaying> for ResultNotifiedReplaying {
-    fn from(_: MarkerCommandCreatedReplaying) -> Self {
-        Self::default()
-    }
-}
-
-#[derive(Default, Clone)]
-pub(super) struct Skipped {}
-
-impl Skipped {
-    pub(super) fn on_command_record_marker(
-        self,
-    ) -> MutableSideEffectMachineTransition<SkippedNotified> {
-        unimplemented!()
-    }
-}
-
-#[derive(Default, Clone)]
-pub(super) struct SkippedNotified {}

package/sdk-core/core/src/worker/workflow/machines/side_effect_state_machine.rs

@@ -1,71 +0,0 @@
-use rustfsm::{fsm, TransitionResult};
-
-fsm! {
-    pub(super) name SideEffectMachine; command SideEffectCommand; error SideEffectMachineError;
-
-    Created --(Schedule, on_schedule) --> MarkerCommandCreated;
-    Created --(Schedule, on_schedule) --> MarkerCommandCreatedReplaying;
-
-    MarkerCommandCreated --(CommandRecordMarker, on_command_record_marker) --> ResultNotified;
-
-    MarkerCommandCreatedReplaying --(CommandRecordMarker) --> ResultNotifiedReplaying;
-
-    ResultNotified --(MarkerRecorded, on_marker_recorded) --> MarkerCommandRecorded;
-
-    ResultNotifiedReplaying --(MarkerRecorded, on_marker_recorded) --> MarkerCommandRecorded;
-}
-
-#[derive(thiserror::Error, Debug)]
-pub(super) enum SideEffectMachineError {}
-
-pub(super) enum SideEffectCommand {}
-
-#[derive(Default, Clone)]
-pub(super) struct Created {}
-
-impl Created {
-    pub(super) fn on_schedule(
-        self,
-    ) -> SideEffectMachineTransition<MarkerCommandCreatedOrMarkerCommandCreatedReplaying> {
-        unimplemented!()
-    }
-}
-
-#[derive(Default, Clone)]
-pub(super) struct MarkerCommandCreated {}
-
-impl MarkerCommandCreated {
-    pub(super) fn on_command_record_marker(self) -> SideEffectMachineTransition<ResultNotified> {
-        unimplemented!()
-    }
-}
-
-#[derive(Default, Clone)]
-pub(super) struct MarkerCommandCreatedReplaying {}
-
-#[derive(Default, Clone)]
-pub(super) struct MarkerCommandRecorded {}
-
-#[derive(Default, Clone)]
-pub(super) struct ResultNotified {}
-
-impl ResultNotified {
-    pub(super) fn on_marker_recorded(self) -> SideEffectMachineTransition<MarkerCommandRecorded> {
-        unimplemented!()
-    }
-}
-
-#[derive(Default, Clone)]
-pub(super) struct ResultNotifiedReplaying {}
-
-impl ResultNotifiedReplaying {
-    pub(super) fn on_marker_recorded(self) -> SideEffectMachineTransition<MarkerCommandRecorded> {
-        unimplemented!()
-    }
-}
-
-impl From<MarkerCommandCreatedReplaying> for ResultNotifiedReplaying {
-    fn from(_: MarkerCommandCreatedReplaying) -> Self {
-        Self::default()
-    }
-}

package/sdk-core/protos/api_upstream/temporal/api/cluster/v1/message.proto

@@ -1,83 +0,0 @@
-// The MIT License
-//
-// Copyright (c) 2022 Temporal Technologies Inc.  All rights reserved.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-
-syntax = "proto3";
-
-package temporal.api.cluster.v1;
-
-option go_package = "go.temporal.io/api/cluster/v1;cluster";
-option java_package = "io.temporal.api.cluster.v1";
-option java_multiple_files = true;
-option java_outer_classname = "MessageProto";
-option ruby_package = "Temporal::Api::Cluster::V1";
-option csharp_namespace = "Temporal.Api.Cluster.V1";
-
-import "dependencies/gogoproto/gogo.proto";
-import "google/protobuf/timestamp.proto";
-
-import "temporal/api/enums/v1/cluster.proto";
-import "temporal/api/enums/v1/common.proto";
-import "temporal/api/version/v1/message.proto";
-
-// data column
-message ClusterMetadata {
-  string cluster = 1;
-  int32 history_shard_count = 2;
-  string cluster_id = 3;
-  temporal.api.version.v1.VersionInfo version_info = 4;
-  map<string,IndexSearchAttributes> index_search_attributes = 5;
-  string cluster_address = 6;
-  int64 failover_version_increment = 7;
-  int64 initial_failover_version = 8;
-  bool is_global_namespace_enabled = 9;
-  bool is_connection_enabled = 10;
-}
-
-message IndexSearchAttributes{
-  map<string,temporal.api.enums.v1.IndexedValueType> custom_search_attributes = 1;
-}
-
-message HostInfo {
-  string identity = 1;
-}
-
-message RingInfo {
-  string role = 1;
-  int32 member_count = 2;
-  repeated HostInfo members = 3;
-}
-
-message MembershipInfo {
-  HostInfo current_host = 1;
-  repeated string reachable_members = 2;
-  repeated RingInfo rings = 3;
-}
-
-message ClusterMember {
-  temporal.api.enums.v1.ClusterMemberRole role = 1;
-  string host_id = 2;
-  string rpc_address = 3;
-  int32 rpc_port = 4;
-  google.protobuf.Timestamp session_start_time = 5 [(gogoproto.stdtime) = true];
-  google.protobuf.Timestamp last_heartbit_time = 6 [(gogoproto.stdtime) = true];
-  google.protobuf.Timestamp record_expiry_time = 7 [(gogoproto.stdtime) = true];
-}

package/sdk-core/protos/api_upstream/temporal/api/enums/v1/cluster.proto

@@ -1,40 +0,0 @@
-// The MIT License
-//
-// Copyright (c) 2022 Temporal Technologies Inc.  All rights reserved.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-
-syntax = "proto3";
-
-package temporal.api.enums.v1;
-
-option go_package = "go.temporal.io/api/enums/v1;enums";
-option java_package = "io.temporal.api.enums.v1";
-option java_multiple_files = true;
-option java_outer_classname = "ClusterProto";
-option ruby_package = "Temporal::Api::Enums::V1";
-option csharp_namespace = "Temporal.Api.Enums.V1";
-
-enum ClusterMemberRole {
-  CLUSTER_MEMBER_ROLE_UNSPECIFIED = 0;
-  CLUSTER_MEMBER_ROLE_FRONTEND = 1;
-  CLUSTER_MEMBER_ROLE_HISTORY = 2;
-  CLUSTER_MEMBER_ROLE_MATCHING = 3;
-  CLUSTER_MEMBER_ROLE_WORKER = 4;
-}