@temporalio/core-bridge 1.9.2 → 1.10.0

package/Cargo.toml

@@ -20,10 +20,10 @@ incremental = false
 futures = { version = "0.3", features = ["executor"] }
 log = "0.4"
 neon = { version = "0.10", default-features = false, features = ["napi-6", "event-queue-api"] }
-opentelemetry = "0.18"
+opentelemetry = "0.22"
 parking_lot = "0.12"
-prost = "0.11"
-prost-types = "0.11"
+prost = "0.12"
+prost-types = "0.12"
 serde_json = "1.0"
 tokio = "1.13"
 once_cell = "1.19"

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 import { LogLevel, Duration } from '@temporalio/common';
-import type { TLSConfig } from '@temporalio/common/lib/internal-non-workflow';
-export { TLSConfig };
+import type { TLSConfig, ProxyConfig, HttpConnectProxyConfig } from '@temporalio/common/lib/internal-non-workflow';
+export type { TLSConfig, ProxyConfig, HttpConnectProxyConfig };
 /** @deprecated Import from @temporalio/common instead */
 export { LogLevel };
 type Shadow<Base, New> = Base extends object ? New extends object ? {
@@ -37,6 +37,12 @@ export interface ClientOptions {
      * connect with TLS without any customization.
      */
     tls?: TLSConfig;
+    /**
+     * Proxying configuration.
+     *
+     * @experimental
+     */
+    proxy?: ProxyConfig;
     /**
      * Optional retry options for server requests.
      */
@@ -47,6 +53,13 @@ export interface ClientOptions {
      * Set statically at connection time, can be replaced later using {@link clientUpdateHeaders}.
      */
     metadata?: Record<string, string>;
+    /**
+     * API key for Temporal. This becomes the "Authorization" HTTP header with "Bearer " prepended.
+     * This is only set if RPC metadata doesn't already have an "authorization" key.
+     *
+     * Set statically at connection time, can be replaced later using {@link clientUpdateApiKey}.
+     */
+    apiKey?: string;
 }
 /**
  * Log directly to console
@@ -99,6 +112,10 @@ export interface OtelCollectorExporter {
          * @defaults 1 second
          */
         metricsExportInterval?: Duration;
+        /**
+         * If set to true, the exporter will use seconds for durations instead of milliseconds.
+         */
+        useSecondsForDurations?: boolean;
     };
 }
 /** @experimental */
@@ -121,6 +138,19 @@ export interface PrometheusMetricsExporter {
          * Metrics will be available for scraping under the standard `/metrics` route.
          */
         bindAddress: string;
+        /**
+         * If set to true, all counter names will include a "_total" suffix.
+         */
+        countersTotalSuffix?: boolean;
+        /**
+         * If set to true, all histograms will include the unit in their name as a suffix.
+         * EX: "_milliseconds"
+         */
+        unitSuffix?: boolean;
+        /**
+         * If set to true, the exporter will use seconds for durations instead of milliseconds.
+         */
+        useSecondsForDurations?: boolean;
     };
 }
 /**
@@ -416,6 +446,7 @@ 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(client: Client, headers: Record<string, string>, callback: VoidCallback): void;
+export declare function clientUpdateApiKey(client: Client, apiKey: string, callback: VoidCallback): void;
 export declare function clientClose(client: Client): void;
 export declare function runtimeShutdown(runtime: Runtime, callback: VoidCallback): void;
 export declare function pollLogs(runtime: Runtime, callback: LogsCallback): void;

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;AAsfA,mCAA0E;AAAjE,uGAAA,aAAa,OAAA;AAAE,wGAAA,cAAc,OAAA;AAAE,yGAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;AAsjBA,mCAA0E;AAAjE,uGAAA,aAAa,OAAA;AAAE,wGAAA,cAAc,OAAA;AAAE,yGAAA,eAAe,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/core-bridge",
-  "version": "1.9.2",
+  "version": "1.10.0",
   "description": "Temporal.io SDK Core<>Node bridge",
   "main": "index.js",
   "types": "lib/index.d.ts",
@@ -10,7 +10,7 @@
     "build-rust-release": "npm run build-rust -- --release",
     "install": "node ./scripts/build.js",
     "format": "cargo fmt",
-    "lint": "cargo clippy --fix",
+    "lint": "cargo clippy --fix --allow-staged",
     "lint.check": "cargo clippy"
   },
   "keywords": [
@@ -22,7 +22,7 @@
   "author": "Temporal Technologies Inc. <sdk@temporal.io>",
   "license": "MIT",
   "dependencies": {
-    "@temporalio/common": "^1.9.2",
+    "@temporalio/common": "1.10.0",
     "arg": "^5.0.2",
     "cargo-cp-artifact": "^0.1.8",
     "which": "^4.0.0"
@@ -52,5 +52,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5fd66f5787deece0b30f085808db7651187600b1"
+  "gitHead": "39d702af7ae5d7e33ee90651292aa77fa07d33ca"
 }

package/scripts/build.js

@@ -82,11 +82,12 @@ function compile(requestedTarget) {
   const cmd = which.sync('cargo-cp-artifact');
 
   console.log('Running', cmd, argv);
-  const { status } = spawnSync(cmd, argv, {
+  const { status, error } = spawnSync(cmd, argv, {
     stdio: 'inherit',
+    shell: process.platform === 'win32',
   });
-  if (status !== 0) {
-    throw new Error(`Failed to build${target ? ' for ' + target : ''}`);
+  if (status !== 0 || error) {
+    throw new Error(`Failed to build${target ? ' for ' + target : ''}: status code ${status}`, error);
   }
 }
 

package/sdk-core/.cargo/config.toml

@@ -1,8 +1,6 @@
 [alias]
 integ-test = ["run", "--package", "temporal-sdk-core", "--example", "integ_runner", "--"]
-wf-input-replay = ["run", "--package", "temporal-sdk-core", "--features", "save_wf_inputs",
-                   "--example", "wf_input_replay", "--"]
 lint = ["clippy", "--workspace", "--examples", "--all-features",
-        "--test", "integ_tests", "--test", "heavy_tests", "--", "--D", "warnings"]
+    "--test", "integ_tests", "--test", "heavy_tests", "--", "--D", "warnings"]
 test-lint = ["clippy", "--all", "--all-features", "--examples", "--workspace",
-             "--tests", "--", "--D", "warnings"]
+    "--tests", "--", "--D", "warnings"]

package/sdk-core/.github/workflows/heavy.yml

@@ -30,4 +30,4 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: integ-test
-          args: -c "--release" -c "--features=save_wf_inputs" -t heavy_tests -- --test-threads 1
+          args: -c "--release" -t heavy_tests -- --test-threads 1

package/sdk-core/.github/workflows/per-pr.yml

@@ -13,7 +13,7 @@ concurrency:
 jobs:
   build-and-test:
     name: "Format, docs, and lint"
-    timeout-minutes: 20
+    timeout-minutes: 10
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -22,7 +22,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: 1.74.0
+          toolchain: 1.77.0
           override: true
       - name: Install protoc
         uses: arduino/setup-protoc@v1
@@ -48,13 +48,14 @@ jobs:
 
   test:
     name: Unit Tests
+    timeout-minutes: 10
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: 1.74.0
+          toolchain: 1.77.0
           override: true
       - name: Install protoc
         uses: arduino/setup-protoc@v1
@@ -77,13 +78,14 @@ jobs:
 
   fmt:
     name: Integ tests
+    timeout-minutes: 20
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: 1.74.0
+          toolchain: 1.77.0
           override: true
       - name: Install protoc
         uses: arduino/setup-protoc@v1

package/sdk-core/Cargo.toml

@@ -7,7 +7,14 @@ license = "MIT"
 license-file = "LICENSE.txt"
 
 [workspace.dependencies]
+derive_builder = "0.20"
 derive_more = { version = "0.99", default-features = false, features = ["constructor", "display", "from", "into"] }
-tonic = "0.9"
-tonic-build = "0.9"
-opentelemetry = "0.21"
+once_cell = "1.16"
+tonic = "0.11"
+tonic-build = "0.11"
+opentelemetry = "0.22"
+prost = "0.12"
+prost-types = "0.12"
+
+[workspace.lints.rust]
+unreachable_pub = "warn"

package/sdk-core/README.md

@@ -1,5 +1,3 @@
-[![Build status](https://badge.buildkite.com/c23f47f4a827f04daece909963bd3a248496f0cdbabfbecee4.svg?branch=master)](https://buildkite.com/temporal/core-sdk?branch=master)
-
 # Temporal Core SDK
 
 Core SDK that can be used as a base for other Temporal SDKs. It is currently used as the base of:
@@ -34,7 +32,7 @@ This repo is composed of multiple crates:
 - temporal-sdk-core `./core` - The Core implementation
 - temporal-sdk `./sdk` - A (currently prototype) Rust SDK built on top of Core. Used for testing.
 - rustfsm `./fsm` - Implements a procedural macro used by core for defining state machines
-    (contains subcrates). It is temporal agnostic.
+  (contains subcrates). It is temporal agnostic.
 
 Visualized (dev dependencies are in blue):
 
@@ -51,7 +49,7 @@ You can build and test the project using cargo:
 Run integ tests with `cargo integ-test`. By default it will start an ephemeral server. You can also
 use an already-running server by passing `-s external`.
 
-Run load tests with `cargo test --features=save_wf_inputs --test heavy_tests`.
+Run load tests with `cargo test --test heavy_tests`.
 
 ## Formatting
 
@@ -86,8 +84,8 @@ equivalent.
 
 ## Proto files
 
-This repo uses a subtree for upstream protobuf files. The path `sdk-core-protos/protos/api_upstream` is a
-subtree. To update it, use:
+This repo uses a subtree for upstream protobuf files. The path `sdk-core-protos/protos/api_upstream`
+is a subtree. To update it, use:
 
 `git pull --squash --rebase=false -s subtree ssh://git@github.com/temporalio/api.git master --allow-unrelated-histories`
 

package/sdk-core/client/Cargo.toml

@@ -10,19 +10,24 @@ repository = "https://github.com/temporalio/sdk-core"
 keywords = ["temporal", "workflow"]
 categories = ["development-tools"]
 
+[features]
+telemetry = ["dep:opentelemetry"]
+
 [dependencies]
 anyhow = "1.0"
 async-trait = "0.1"
 backoff = "0.4"
-derive_builder = "0.12"
+base64 = "0.22"
+derive_builder = { workspace = true }
 derive_more = "0.99"
 futures = "0.3"
 futures-retry = "0.6.0"
 http = "0.2"
-once_cell = "1.13"
-opentelemetry = { workspace = true, features = ["metrics"] }
+hyper = { version = "0.14" }
+once_cell = { workspace = true }
+opentelemetry = { workspace = true, features = ["metrics"], optional = true }
 parking_lot = "0.12"
-prost-types = "0.11"
+prost-types = { workspace = true }
 slotmap = "1.0"
 thiserror = "1.0"
 tokio = "1.1"
@@ -40,4 +45,7 @@ path = "../core-api"
 
 [dev-dependencies]
 assert_matches = "1"
-mockall = "0.11"
+mockall = "0.12"
+
+[lints]
+workspace = true

package/sdk-core/client/src/lib.rs

@@ -8,12 +8,16 @@
 extern crate tracing;
 
 mod metrics;
+mod proxy;
 mod raw;
 mod retry;
 mod worker_registry;
 mod workflow_handle;
 
-pub use crate::retry::{CallType, RetryClient, RETRYABLE_ERROR_CODES};
+pub use crate::{
+    proxy::HttpConnectProxyOptions,
+    retry::{CallType, RetryClient, RETRYABLE_ERROR_CODES},
+};
 pub use raw::{HealthService, OperatorService, TestService, WorkflowService};
 pub use temporal_sdk_core_protos::temporal::api::{
     enums::v1::ArchivalState,
@@ -25,7 +29,9 @@ pub use temporal_sdk_core_protos::temporal::api::{
 };
 pub use tonic;
 pub use worker_registry::{Slot, SlotManager, SlotProvider, WorkerKey};
-pub use workflow_handle::{WorkflowExecutionInfo, WorkflowExecutionResult};
+pub use workflow_handle::{
+    GetWorkflowResultOpts, WorkflowExecutionInfo, WorkflowExecutionResult, WorkflowHandle,
+};
 
 use crate::{
     metrics::{GrpcMetricSvc, MetricsContext},
@@ -67,7 +73,7 @@ use tonic::{
     body::BoxBody,
     client::GrpcService,
     codegen::InterceptedService,
-    metadata::{MetadataKey, MetadataValue},
+    metadata::{MetadataKey, MetadataMap, MetadataValue},
     service::Interceptor,
     transport::{Certificate, Channel, Endpoint, Identity},
     Code, Status,
@@ -133,6 +139,23 @@ pub struct ClientOptions {
     /// If set (which it is by default), HTTP2 gRPC keep alive will be enabled.
     #[builder(default = "Some(ClientKeepAliveConfig::default())")]
     pub keep_alive: Option<ClientKeepAliveConfig>,
+
+    /// HTTP headers to include on every RPC call.
+    #[builder(default)]
+    pub headers: Option<HashMap<String, String>>,
+
+    /// API key which is set as the "Authorization" header with "Bearer " prepended. This will only
+    /// be applied if the headers don't already have an "Authorization" header.
+    #[builder(default)]
+    pub api_key: Option<String>,
+
+    /// HTTP CONNECT proxy to use for this client.
+    #[builder(default)]
+    pub http_connect_proxy: Option<HttpConnectProxyOptions>,
+
+    /// If set true, error code labels will not be included on request failure metrics.
+    #[builder(default)]
+    pub disable_error_code_metric_tags: bool,
 }
 
 /// Configuration options for TLS
@@ -200,7 +223,7 @@ impl Default for RetryConfig {
         Self {
             initial_interval: Duration::from_millis(100), // 100 ms wait by default.
             randomization_factor: 0.2,                    // +-20% jitter.
-            multiplier: 1.5, // each next retry delay will increase by 50%
+            multiplier: 1.7, // each next retry delay will increase by 70%
             max_interval: Duration::from_secs(5), // until it reaches 5 seconds.
             max_elapsed_time: Some(Duration::from_secs(10)), // 10 seconds total allocated time for all retries.
             max_retries: 10,
@@ -279,7 +302,7 @@ pub enum ClientInitError {
 pub struct ConfiguredClient<C> {
     client: C,
     options: Arc<ClientOptions>,
-    headers: Arc<RwLock<HashMap<String, String>>>,
+    headers: Arc<RwLock<ClientHeaders>>,
     /// Capabilities as read from the `get_system_info` RPC call made on client connection
     capabilities: Option<get_system_info_response::Capabilities>,
     workers: Arc<SlotManager>,
@@ -288,8 +311,12 @@ pub struct ConfiguredClient<C> {
 impl<C> ConfiguredClient<C> {
     /// Set HTTP request headers overwriting previous headers
     pub fn set_headers(&self, headers: HashMap<String, String>) {
-        let mut guard = self.headers.write();
-        *guard = headers;
+        self.headers.write().user_headers = headers;
+    }
+
+    /// Set API key, overwriting previous
+    pub fn set_api_key(&self, api_key: Option<String>) {
+        self.headers.write().api_key = api_key;
     }
 
     /// Returns the options the client is configured with
@@ -309,6 +336,34 @@ impl<C> ConfiguredClient<C> {
     }
 }
 
+#[derive(Debug)]
+struct ClientHeaders {
+    user_headers: HashMap<String, String>,
+    api_key: Option<String>,
+}
+
+impl ClientHeaders {
+    fn apply_to_metadata(&self, metadata: &mut MetadataMap) {
+        for (key, val) in self.user_headers.iter() {
+            // Only if not already present
+            if !metadata.contains_key(key) {
+                // Ignore invalid keys/values
+                if let (Ok(key), Ok(val)) = (MetadataKey::from_str(key), val.parse()) {
+                    metadata.insert(key, val);
+                }
+            }
+        }
+        if let Some(api_key) = &self.api_key {
+            // Only if not already present
+            if !metadata.contains_key("authorization") {
+                if let Ok(val) = format!("Bearer {}", api_key).parse() {
+                    metadata.insert("authorization", val);
+                }
+            }
+        }
+    }
+}
+
 // The configured client is effectively a "smart" (dumb) pointer
 impl<C> Deref for ConfiguredClient<C> {
     type Target = C;
@@ -331,12 +386,8 @@ impl ClientOptions {
         &self,
         namespace: impl Into<String>,
         metrics_meter: Option<TemporalMeter>,
-        headers: Option<Arc<RwLock<HashMap<String, String>>>>,
     ) -> Result<RetryClient<Client>, ClientInitError> {
-        let client = self
-            .connect_no_namespace(metrics_meter, headers)
-            .await?
-            .into_inner();
+        let client = self.connect_no_namespace(metrics_meter).await?.into_inner();
         let client = Client::new(client, namespace.into());
         let retry_client = RetryClient::new(client, self.retry_config.clone());
         Ok(retry_client)
@@ -349,7 +400,6 @@ impl ClientOptions {
     pub async fn connect_no_namespace(
         &self,
         metrics_meter: Option<TemporalMeter>,
-        headers: Option<Arc<RwLock<HashMap<String, String>>>>,
     ) -> Result<RetryClient<ConfiguredClient<TemporalServiceClientWithMetrics>>, ClientInitError>
     {
         let channel = Channel::from_shared(self.target_url.to_string())?;
@@ -367,14 +417,23 @@ impl ClientOptions {
         } else {
             channel
         };
-        let channel = channel.connect().await?;
+        // If there is a proxy, we have to connect that way
+        let channel = if let Some(proxy) = self.http_connect_proxy.as_ref() {
+            proxy.connect_endpoint(&channel).await?
+        } else {
+            channel.connect().await?
+        };
         let service = ServiceBuilder::new()
             .layer_fn(move |channel| GrpcMetricSvc {
                 inner: channel,
                 metrics: metrics_meter.clone().map(MetricsContext::new),
+                disable_errcode_label: self.disable_error_code_metric_tags,
             })
             .service(channel);
-        let headers = headers.unwrap_or_default();
+        let headers = Arc::new(RwLock::new(ClientHeaders {
+            user_headers: self.headers.clone().unwrap_or_default(),
+            api_key: self.api_key.clone(),
+        }));
         let interceptor = ServiceCallInterceptor {
             opts: self.clone(),
             headers: headers.clone(),
@@ -442,7 +501,7 @@ impl ClientOptions {
 pub struct ServiceCallInterceptor {
     opts: ClientOptions,
     /// Only accessed as a reader
-    headers: Arc<RwLock<HashMap<String, String>>>,
+    headers: Arc<RwLock<ClientHeaders>>,
 }
 
 impl Interceptor for ServiceCallInterceptor {
@@ -468,16 +527,7 @@ impl Interceptor for ServiceCallInterceptor {
                     .unwrap_or_else(|_| MetadataValue::from_static("")),
             );
         }
-        let headers = &*self.headers.read();
-        for (k, v) in headers {
-            if metadata.contains_key(k) {
-                // Don't overwrite per-request specified headers
-                continue;
-            }
-            if let (Ok(k), Ok(v)) = (MetadataKey::from_str(k), v.parse()) {
-                metadata.insert(k, v);
-            }
-        }
+        self.headers.read().apply_to_metadata(metadata);
         if !metadata.contains_key("grpc-timeout") {
             request.set_timeout(OTHER_CALL_TIMEOUT);
         }
@@ -1559,7 +1609,7 @@ mod tests {
     use super::*;
 
     #[test]
-    fn respects_per_call_headers() {
+    fn applies_headers() {
         let opts = ClientOptionsBuilder::default()
             .identity("enchicat".to_string())
             .target_url(Url::parse("https://smolkitty").unwrap())
@@ -1568,16 +1618,55 @@ mod tests {
             .build()
             .unwrap();
 
-        let mut static_headers = HashMap::new();
-        static_headers.insert("enchi".to_string(), "kitty".to_string());
-        let mut iceptor = ServiceCallInterceptor {
+        // Initial header set
+        let headers = Arc::new(RwLock::new(ClientHeaders {
+            user_headers: HashMap::new(),
+            api_key: Some("my-api-key".to_owned()),
+        }));
+        headers
+            .clone()
+            .write()
+            .user_headers
+            .insert("my-meta-key".to_owned(), "my-meta-val".to_owned());
+        let mut interceptor = ServiceCallInterceptor {
             opts,
-            headers: Arc::new(RwLock::new(static_headers)),
+            headers: headers.clone(),
         };
+
+        // Confirm on metadata
+        let req = interceptor.call(tonic::Request::new(())).unwrap();
+        assert_eq!(req.metadata().get("my-meta-key").unwrap(), "my-meta-val");
+        assert_eq!(
+            req.metadata().get("authorization").unwrap(),
+            "Bearer my-api-key"
+        );
+
+        // Overwrite at request time
         let mut req = tonic::Request::new(());
-        req.metadata_mut().insert("enchi", "cat".parse().unwrap());
-        let next_req = iceptor.call(req).unwrap();
-        assert_eq!(next_req.metadata().get("enchi").unwrap(), "cat");
+        req.metadata_mut()
+            .insert("my-meta-key", "my-meta-val2".parse().unwrap());
+        req.metadata_mut()
+            .insert("authorization", "my-api-key2".parse().unwrap());
+        let req = interceptor.call(req).unwrap();
+        assert_eq!(req.metadata().get("my-meta-key").unwrap(), "my-meta-val2");
+        assert_eq!(req.metadata().get("authorization").unwrap(), "my-api-key2");
+
+        // Overwrite auth on header
+        headers
+            .clone()
+            .write()
+            .user_headers
+            .insert("authorization".to_owned(), "my-api-key3".to_owned());
+        let req = interceptor.call(tonic::Request::new(())).unwrap();
+        assert_eq!(req.metadata().get("my-meta-key").unwrap(), "my-meta-val");
+        assert_eq!(req.metadata().get("authorization").unwrap(), "my-api-key3");
+
+        // Remove headers and auth and confirm gone
+        headers.clone().write().user_headers.clear();
+        headers.clone().write().api_key.take();
+        let req = interceptor.call(tonic::Request::new(())).unwrap();
+        assert!(!req.metadata().contains_key("my-meta-key"));
+        assert!(!req.metadata().contains_key("authorization"));
     }
 
     #[test]