@temporalio/core-bridge 0.22.0 → 1.0.0-rc.1

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

@@ -25,6 +25,7 @@ use crate::{
 use backoff::{ExponentialBackoff, SystemClock};
 use http::uri::InvalidUri;
 use opentelemetry::metrics::Meter;
+use parking_lot::RwLock;
 use std::{
     collections::HashMap,
     fmt::{Debug, Formatter},
@@ -34,10 +35,10 @@ use std::{
     time::{Duration, Instant},
 };
 use temporal_sdk_core_protos::{
-    coresdk::{common::Payload, workflow_commands::QueryResult, IntoPayloadsExt},
+    coresdk::{workflow_commands::QueryResult, IntoPayloadsExt},
     temporal::api::{
         command::v1::Command,
-        common::v1::{Payloads, WorkflowExecution, WorkflowType},
+        common::v1::{Payload, Payloads, WorkflowExecution, WorkflowType},
         enums::v1::{TaskQueueKind, WorkflowTaskFailedCause},
         failure::v1::Failure,
         query::v1::{WorkflowQuery, WorkflowQueryResult},
@@ -74,23 +75,18 @@ pub struct ClientOptions {
 
     /// The name of the SDK being implemented on top of core. Is set as `client-name` header in
     /// all RPC calls
+    #[builder(setter(into))]
     pub client_name: String,
 
     /// The version of the SDK being implemented on top of core. Is set as `client-version` header
     /// in all RPC calls. The server decides if the client is supported based on this.
+    #[builder(setter(into))]
     pub client_version: String,
 
-    /// Other non-required static headers which should be attached to every request
-    #[builder(default)]
-    pub static_headers: HashMap<String, String>,
-
     /// A human-readable string that can identify this process. Defaults to empty string.
     #[builder(default)]
     pub identity: String,
 
-    /// A string that should be unique to this process' binary
-    pub worker_binary_id: String,
-
     /// If specified, use TLS as configured by the [TlsConfig] struct. If this is set core will
     /// attempt to use TLS when connecting to the Temporal server. Lang SDK is expected to pass any
     /// certs or keys as bytes, loading them from disk itself if needed.
@@ -252,11 +248,18 @@ impl From<ConfiguredClient<WorkflowServiceClientWithMetrics>> for AnyClient {
 pub struct ConfiguredClient<C> {
     client: C,
     options: ClientOptions,
+    headers: Arc<RwLock<HashMap<String, String>>>,
     /// Capabilities as read from the `get_system_info` RPC call made on client connection
     capabilities: Option<get_system_info_response::Capabilities>,
 }
 
 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;
+    }
+
     /// Returns the options the client is configured with
     pub fn options(&self) -> &ClientOptions {
         &self.options
@@ -295,8 +298,12 @@ impl ClientOptions {
         &self,
         namespace: impl Into<String>,
         metrics_meter: Option<&Meter>,
+        headers: Option<Arc<RwLock<HashMap<String, String>>>>,
     ) -> Result<RetryClient<Client>, ClientInitError> {
-        let client = self.connect_no_namespace(metrics_meter).await?.into_inner();
+        let client = self
+            .connect_no_namespace(metrics_meter, headers)
+            .await?
+            .into_inner();
         let client = Client::new(client, namespace.into());
         let retry_client = RetryClient::new(client, self.retry_config.clone());
         Ok(retry_client)
@@ -309,6 +316,7 @@ impl ClientOptions {
     pub async fn connect_no_namespace(
         &self,
         metrics_meter: Option<&Meter>,
+        headers: Option<Arc<RwLock<HashMap<String, String>>>>,
     ) -> Result<RetryClient<ConfiguredClient<WorkflowServiceClientWithMetrics>>, ClientInitError>
     {
         let channel = Channel::from_shared(self.target_url.to_string())?;
@@ -320,9 +328,14 @@ impl ClientOptions {
                 metrics: metrics_meter.map(|mm| MetricsContext::new(vec![], mm)),
             })
             .service(channel);
-        let interceptor = ServiceCallInterceptor { opts: self.clone() };
+        let headers = headers.unwrap_or_default();
+        let interceptor = ServiceCallInterceptor {
+            opts: self.clone(),
+            headers: headers.clone(),
+        };
 
         let mut client = ConfiguredClient {
+            headers,
             client: WorkflowServiceClient::with_interceptor(service, interceptor),
             options: self.clone(),
             capabilities: None,
@@ -394,6 +407,8 @@ pub struct WorkflowTaskCompletion {
 #[derive(Clone)]
 pub struct ServiceCallInterceptor {
     opts: ClientOptions,
+    /// Only accessed as a reader
+    headers: Arc<RwLock<HashMap<String, String>>>,
 }
 
 impl Interceptor for ServiceCallInterceptor {
@@ -415,7 +430,8 @@ impl Interceptor for ServiceCallInterceptor {
                 .parse()
                 .unwrap_or_else(|_| MetadataValue::from_static("")),
         );
-        for (k, v) in &self.opts.static_headers {
+        let headers = &*self.headers.read();
+        for (k, v) in headers {
             if let (Ok(k), Ok(v)) = (MetadataKey::from_str(k), MetadataValue::from_str(v)) {
                 metadata.insert(k, v);
             }
@@ -439,6 +455,8 @@ pub struct Client {
     inner: ConfiguredClient<WorkflowServiceClientWithMetrics>,
     /// The namespace this client interacts with
     namespace: String,
+    /// If set, attach as the worker build id to relevant calls
+    bound_worker_build_id: Option<String>,
 }
 
 impl Client {
@@ -450,6 +468,7 @@ impl Client {
         Client {
             inner: client,
             namespace,
+            bound_worker_build_id: None,
         }
     }
 
@@ -477,6 +496,17 @@ impl Client {
     pub fn options(&self) -> &ClientOptions {
         &self.inner.options
     }
+
+    /// Return the options this client was initialized with mutably
+    pub fn options_mut(&mut self) -> &mut ClientOptions {
+        &mut self.inner.options
+    }
+
+    /// Set a worker build id to be attached to relevant requests. Unlikely to be useful outside
+    /// of core.
+    pub fn set_worker_build_id(&mut self, id: String) {
+        self.bound_worker_build_id = Some(id)
+    }
 }
 
 /// This trait provides higher-level friendlier interaction with the server.
@@ -614,6 +644,7 @@ pub trait WorkflowClientTrait {
         &self,
         workflow_id: String,
         run_id: Option<String>,
+        reason: String,
     ) -> Result<RequestCancelWorkflowExecutionResponse>;
 
     /// Terminate a currently executing workflow
@@ -693,7 +724,7 @@ impl WorkflowClientTrait for Client {
                 } as i32,
             }),
             identity: self.inner.options.identity.clone(),
-            binary_checksum: self.inner.options.worker_binary_id.clone(),
+            binary_checksum: self.bound_worker_build_id.clone().unwrap_or_default(),
         };
 
         Ok(self
@@ -757,7 +788,7 @@ impl WorkflowClientTrait for Client {
             sticky_attributes: request.sticky_attributes,
             return_new_workflow_task: request.return_new_workflow_task,
             force_create_new_workflow_task: request.force_create_new_workflow_task,
-            binary_checksum: self.inner.options.worker_binary_id.clone(),
+            binary_checksum: self.bound_worker_build_id.clone().unwrap_or_default(),
             query_results: request
                 .query_responses
                 .into_iter()
@@ -845,6 +876,8 @@ impl WorkflowClientTrait for Client {
                 failure,
                 identity: self.inner.options.identity.clone(),
                 namespace: self.namespace.clone(),
+                // TODO: Implement - https://github.com/temporalio/sdk-core/issues/293
+                last_heartbeat_details: None,
             })
             .await?
             .into_inner())
@@ -861,7 +894,7 @@ impl WorkflowClientTrait for Client {
             cause: cause as i32,
             failure,
             identity: self.inner.options.identity.clone(),
-            binary_checksum: self.inner.options.worker_binary_id.clone(),
+            binary_checksum: self.bound_worker_build_id.clone().unwrap_or_default(),
             namespace: self.namespace.clone(),
         };
         Ok(self
@@ -978,6 +1011,7 @@ impl WorkflowClientTrait for Client {
         &self,
         workflow_id: String,
         run_id: Option<String>,
+        reason: String,
     ) -> Result<RequestCancelWorkflowExecutionResponse> {
         Ok(self
             .wf_svc()
@@ -990,6 +1024,7 @@ impl WorkflowClientTrait for Client {
                 identity: self.inner.options.identity.clone(),
                 request_id: "".to_string(),
                 first_execution_run_id: "".to_string(),
+                reason,
             })
             .await?
             .into_inner())