@temporalio/core-bridge 1.5.2 → 1.7.0

package/src/conversions.rs

@@ -14,14 +14,15 @@ use temporal_sdk_core::{
     },
     api::worker::{WorkerConfig, WorkerConfigBuilder},
     ephemeral_server::{
-        TemporaliteConfig, TemporaliteConfigBuilder, TestServerConfig, TestServerConfigBuilder,
+        TemporalDevServerConfig, TemporalDevServerConfigBuilder, TestServerConfig,
+        TestServerConfigBuilder,
     },
     ClientOptions, ClientOptionsBuilder, ClientTlsConfig, RetryConfig, TlsConfig, Url,
 };
 
 pub enum EphemeralServerConfig {
     TestServer(TestServerConfig),
-    Temporalite(TemporaliteConfig),
+    DevServer(TemporalDevServerConfig),
 }
 
 pub trait ArrayHandleConversionsExt {
@@ -323,6 +324,10 @@ impl ObjectHandleConversionsExt for Handle<'_, JsObject> {
             js_optional_getter!(cx, self, "maxTaskQueueActivitiesPerSecond", JsNumber)
                 .map(|num| num.value(cx) as f64);
 
+        let graceful_shutdown_period =
+            js_optional_getter!(cx, self, "shutdownGraceTimeMs", JsNumber)
+                .map(|num| Duration::from_millis(num.value(cx) as u64));
+
         match WorkerConfigBuilder::default()
             .worker_build_id(js_value_getter!(cx, self, "buildId", JsString))
             .client_identity_override(Some(js_value_getter!(cx, self, "identity", JsString)))
@@ -332,6 +337,7 @@ impl ObjectHandleConversionsExt for Handle<'_, JsObject> {
             .max_outstanding_local_activities(max_outstanding_local_activities)
             .max_cached_workflows(max_cached_workflows)
             .sticky_queue_schedule_to_start_timeout(sticky_queue_schedule_to_start_timeout)
+            .graceful_shutdown_period(graceful_shutdown_period)
             .namespace(namespace)
             .task_queue(task_queue)
             .max_heartbeat_throttle_interval(max_heartbeat_throttle_interval)
@@ -374,7 +380,7 @@ impl ObjectHandleConversionsExt for Handle<'_, JsObject> {
 
                 let exec_version = match version.as_str() {
                     "default" => {
-                        temporal_sdk_core::ephemeral_server::EphemeralExeVersion::Default {
+                        temporal_sdk_core::ephemeral_server::EphemeralExeVersion::SDKDefault {
                             sdk_name: "sdk-typescript".to_owned(),
                             sdk_version,
                         }
@@ -398,8 +404,8 @@ impl ObjectHandleConversionsExt for Handle<'_, JsObject> {
 
         let server_type = js_value_getter!(cx, self, "type", JsString);
         match server_type.as_str() {
-            "temporalite" => {
-                let mut config = TemporaliteConfigBuilder::default();
+            "dev-server" => {
+                let mut config = TemporalDevServerConfigBuilder::default();
                 config.exe(executable).port(port);
 
                 if let Some(extra_args) = js_optional_getter!(cx, self, "extraArgs", JsArray) {
@@ -422,9 +428,9 @@ impl ObjectHandleConversionsExt for Handle<'_, JsObject> {
                 }
 
                 match config.build() {
-                    Ok(config) => Ok(EphemeralServerConfig::Temporalite(config)),
+                    Ok(config) => Ok(EphemeralServerConfig::DevServer(config)),
                     Err(err) => {
-                        cx.throw_type_error(format!("Invalid temporalite config: {:?}", err))
+                        cx.throw_type_error(format!("Invalid dev server config: {:?}", err))
                     }
                 }
             }
@@ -445,7 +451,7 @@ impl ObjectHandleConversionsExt for Handle<'_, JsObject> {
                 }
             }
             s => cx.throw_type_error(format!(
-                "Invalid ephemeral server type: {}, expected 'temporalite' or 'time-skipping'",
+                "Invalid ephemeral server type: {}, expected 'dev-server' or 'time-skipping'",
                 s
             )),
         }

package/src/runtime.rs

@@ -144,13 +144,16 @@ pub fn start_bridge_loop(
                     headers,
                     callback,
                 } => {
-                    // `metrics_meter` (second arg) can be None here since we don't use the
-                    // returned client directly at the moment, when we repurpose the client to be
-                    // used by a Worker, `init_worker` will attach the correct metrics meter for
-                    // us.
+                    // `metrics_meter` can be None here since we don't use the returned client
+                    // directly at the moment, when we repurpose the client to be used by a Worker,
+                    // `init_worker` will attach the correct metrics meter for us.
                     core_runtime.tokio_handle().spawn(async move {
+                        let metrics_meter = None;
                         match options
-                            .connect_no_namespace(None, headers.map(|h| Arc::new(RwLock::new(h))))
+                            .connect_no_namespace(
+                                metrics_meter,
+                                headers.map(|h| Arc::new(RwLock::new(h))),
+                            )
                             .await
                         {
                             Err(err) => {
@@ -270,9 +273,7 @@ pub fn start_bridge_loop(
                             EphemeralServerConfig::TestServer(config) => {
                                 config.start_server().await
                             }
-                            EphemeralServerConfig::Temporalite(config) => {
-                                config.start_server().await
-                            }
+                            EphemeralServerConfig::DevServer(config) => config.start_server().await,
                         };
                         match result {
                             Err(err) => {

package/ts/index.ts

@@ -381,10 +381,10 @@ export interface TimeSkippingServerConfig {
 }
 
 /**
- * Configuration for temporalite.
+ * Configuration for the Temporal CLI dev server.
  */
-export interface TemporaliteConfig {
-  type: 'temporalite';
+export interface DevServerConfig {
+  type: 'dev-server';
   executable?: EphemeralServerExecutable;
   /**
    * Namespace to use - created at startup.
@@ -399,11 +399,13 @@ export interface TemporaliteConfig {
    */
   ip?: string;
   /**
-   * Sqlite DB filename if persisting or non-persistent if none.
+   * Sqlite DB filename if persisting or non-persistent if none (default).
    */
   db_filename?: string;
   /**
    * Whether to enable the UI.
+   *
+   * @default false
    */
   ui?: boolean;
   /**
@@ -424,9 +426,9 @@ export interface TemporaliteConfig {
 /**
  * Configuration for spawning an ephemeral Temporal server.
  *
- * Both the time-skipping test server and temporalite are supported.
+ * Both the time-skipping test server and Temporal CLI dev server are supported.
  */
-export type EphemeralServerConfig = TimeSkippingServerConfig | TemporaliteConfig;
+export type EphemeralServerConfig = TimeSkippingServerConfig | DevServerConfig;
 
 export interface Worker {
   type: 'Worker';

package/sdk-core/bridge-ffi/Cargo.toml

@@ -1,24 +0,0 @@
-[package]
-name = "temporal-sdk-core-bridge-ffi"
-version = "0.1.0"
-edition = "2021"
-license-file = "LICENSE.txt"
-description = "FFI Bridge for Core"
-homepage = "https://temporal.io/"
-repository = "https://github.com/temporalio/sdk-core"
-
-[lib]
-crate-type = ["staticlib"]
-
-[dependencies]
-lazy_static = "1.4"
-libc = "0.2"
-prost = "0.11"
-temporal-sdk-core = { version = "0.1", path = "../core" }
-temporal-sdk-core-api = { version = "0.1", path = "../core-api" }
-temporal-sdk-core-protos = { version = "0.1", path = "../sdk-core-protos" }
-tokio = "1"
-tracing = "0.1"
-
-[build-dependencies]
-cbindgen = "0.24"

package/sdk-core/bridge-ffi/LICENSE.txt

@@ -1,23 +0,0 @@
-Temporal Core SDK
-
-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.

package/sdk-core/bridge-ffi/build.rs

@@ -1,25 +0,0 @@
-extern crate cbindgen;
-
-use std::env;
-
-fn main() {
-    let crate_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
-
-    let changed = cbindgen::Builder::new()
-        .with_crate(crate_dir)
-        .with_pragma_once(true)
-        .with_language(cbindgen::Language::C)
-        .generate()
-        .expect("Unable to generate bindings")
-        .write_to_file("include/sdk-core-bridge.h");
-
-    // If this changed and an env var disallows change, error
-    if let Ok(env_val) = env::var("TEMPORAL_SDK_CORE_BRIDGE_FFI_DISABLE_HEADER_CHANGE") {
-        if changed && env_val == "true" {
-            println!(
-                "cargo:warning=bridge-ffi's header file changed unexpectedly from what's on disk"
-            );
-            std::process::exit(1);
-        }
-    }
-}

package/sdk-core/bridge-ffi/include/sdk-core-bridge.h

@@ -1,224 +0,0 @@
-#pragma once
-
-#include <stdarg.h>
-#include <stdbool.h>
-#include <stdint.h>
-#include <stdlib.h>
-
-/**
- * A client instance owned by Core. This must be passed to [tmprl_client_free]
- * when no longer in use which will free the resources.
- */
-typedef struct tmprl_client_t tmprl_client_t;
-
-/**
- * A runtime owned by Core. This must be passed to [tmprl_runtime_free] when no longer in use. This
- * should not be freed until every call to every [tmprl_worker_t] instance created with this
- * runtime has been shutdown. In practice, since the actual runtime is behind an [Arc], it's
- * currently OK, but that's an implementation detail.
- */
-typedef struct tmprl_runtime_t tmprl_runtime_t;
-
-/**
- * A worker instance owned by Core. This must be passed to [tmprl_worker_shutdown]
- * when no longer in use which will free the resources.
- */
-typedef struct tmprl_worker_t tmprl_worker_t;
-
-/**
- * A set of bytes owned by Core. No fields within nor any bytes references must
- * ever be mutated outside of Core. This must always be passed to
- * tmprl_bytes_free when no longer in use.
- */
-typedef struct tmprl_bytes_t {
-  const uint8_t *bytes;
-  size_t len;
-  /**
-   * For internal use only.
-   */
-  size_t cap;
-  /**
-   * For internal use only.
-   */
-  bool disable_free;
-} tmprl_bytes_t;
-
-/**
- * Callback called by [tmprl_worker_init] on completion. The first parameter of the
- * callback is user data passed into the original function. The second
- * parameter is a worker instance if the call is successful or null if not. If
- * present, the worker instance must be freed via [tmprl_worker_shutdown] when no
- * longer in use. The third parameter of the callback is a byte array for a
- * [InitResponse] protobuf message which must be freed via [tmprl_bytes_free].
- */
-typedef void (*tmprl_worker_init_callback)(void *user_data, struct tmprl_worker_t *worker, const struct tmprl_bytes_t *resp);
-
-/**
- * Callback called on function completion. The first parameter of the callback
- * is user data passed into the original function. The second parameter of the
- * callback is a never-null byte array for a response protobuf message which
- * must be freed via [tmprl_bytes_free].
- */
-typedef void (*tmprl_callback)(void *user_data, const struct tmprl_bytes_t *core);
-
-/**
- * Callback called by [tmprl_client_init] on completion. The first parameter of the
- * callback is user data passed into the original function. The second
- * parameter is a client instance if the call is successful or null if not. If
- * present, the client instance must be freed via [tmprl_client_free] when no
- * longer in use. The third parameter of the callback is a byte array for a
- * [InitResponse] protobuf message which must be freed via [tmprl_bytes_free].
- */
-typedef void (*tmprl_client_init_callback)(void *user_data, struct tmprl_client_t *client, const struct tmprl_bytes_t *resp);
-
-/**
- * Free a set of bytes. The first parameter can be null in cases where a [tmprl_worker_t] instance
- * isn't available. If the second parameter is null, this is a no-op.
- */
-void tmprl_bytes_free(struct tmprl_worker_t *worker, const struct tmprl_bytes_t *bytes);
-
-/**
- * Create a new runtime. The result is never null and must be freed via
- * tmprl_runtime_free when no longer in use.
- */
-struct tmprl_runtime_t *tmprl_runtime_new(void);
-
-/**
- * Free a previously created runtime.
- */
-void tmprl_runtime_free(struct tmprl_runtime_t *runtime);
-
-/**
- * Create a new worker instance.
- *
- * `runtime` and `client` are both required and must outlive this instance.
- * `req_proto` and `req_proto_len` represent a byte array for a [CreateWorkerRequest] protobuf
- * message.
- * The callback is invoked on completion.
- */
-void tmprl_worker_init(struct tmprl_runtime_t *runtime,
-                       struct tmprl_client_t *client,
-                       const uint8_t *req_proto,
-                       size_t req_proto_len,
-                       void *user_data,
-                       tmprl_worker_init_callback callback);
-
-/**
- * Shutdown and free a previously created worker.
- *
- * The req_proto and req_proto_len represent a byte array for a [bridge::ShutdownWorkerRequest]
- * protobuf message, which currently contains nothing and are unused, but the parameters are kept
- * for now.
- *
- * The callback is invoked on completion with a ShutdownWorkerResponse protobuf message.
- *
- * After the callback has been called, the worker struct will be freed and the pointer will no
- * longer be valid.
- */
-void tmprl_worker_shutdown(struct tmprl_worker_t *worker,
-                           const uint8_t *req_proto,
-                           size_t req_proto_len,
-                           void *user_data,
-                           tmprl_callback callback);
-
-/**
- * Initialize a client connection to the Temporal service.
- *
- * The runtime is required and must outlive this instance. The `req_proto` and `req_proto_len`
- * represent a byte array for a [CreateClientRequest] protobuf message. The callback is invoked on
- * completion.
- */
-void tmprl_client_init(struct tmprl_runtime_t *runtime,
-                       const uint8_t *req_proto,
-                       size_t req_proto_len,
-                       void *user_data,
-                       tmprl_client_init_callback callback);
-
-/**
- * Free a previously created client
- */
-void tmprl_client_free(struct tmprl_client_t *client);
-
-/**
- * Poll for a workflow activation.
- *
- * The `req_proto` and `req_proto_len` represent a byte array for a
- * [bridge::PollWorkflowActivationRequest] protobuf message, which currently contains nothing and
- * is unused, but the parameters are kept for now.
- *
- * The callback is invoked on completion with a [bridge::PollWorkflowActivationResponse] protobuf
- * message.
- */
-void tmprl_poll_workflow_activation(struct tmprl_worker_t *worker,
-                                    const uint8_t *req_proto,
-                                    size_t req_proto_len,
-                                    void *user_data,
-                                    tmprl_callback callback);
-
-/**
- * Poll for an activity task.
- *
- * The `req_proto` and `req_proto_len` represent a byte array for a
- * [bridge::PollActivityTaskRequest] protobuf message, which currently contains nothing and is
- * unused, but the parameters are kept for now.
- *
- * The callback is invoked on completion with a [bridge::PollActivityTaskResponse] protobuf
- * message.
- */
-void tmprl_poll_activity_task(struct tmprl_worker_t *worker,
-                              const uint8_t *req_proto,
-                              size_t req_proto_len,
-                              void *user_data,
-                              tmprl_callback callback);
-
-/**
- * Complete a workflow activation.
- *
- * The `req_proto` and `req_proto_len` represent a byte array for a
- * [bridge::CompleteWorkflowActivationRequest] protobuf message. The callback is invoked on
- * completion with a [bridge::CompleteWorkflowActivationResponse] protobuf message.
- */
-void tmprl_complete_workflow_activation(struct tmprl_worker_t *worker,
-                                        const uint8_t *req_proto,
-                                        size_t req_proto_len,
-                                        void *user_data,
-                                        tmprl_callback callback);
-
-/**
- * Complete an activity task.
- *
- * The `req_proto` and `req_proto_len` represent a byte array for a
- * [bridge::CompleteActivityTaskRequest] protobuf message. The callback is invoked on completion
- * with a [bridge::CompleteActivityTaskResponse] protobuf message.
- */
-void tmprl_complete_activity_task(struct tmprl_worker_t *worker,
-                                  const uint8_t *req_proto,
-                                  size_t req_proto_len,
-                                  void *user_data,
-                                  tmprl_callback callback);
-
-/**
- * Record an activity heartbeat.
- *
- * `req_proto` and `req_proto_len` represent a byte array for a
- * [bridge::RecordActivityHeartbeatRequest] protobuf message. The callback is invoked on completion
- * with a RecordActivityHeartbeatResponse protobuf message.
- */
-void tmprl_record_activity_heartbeat(struct tmprl_worker_t *worker,
-                                     const uint8_t *req_proto,
-                                     size_t req_proto_len,
-                                     void *user_data,
-                                     tmprl_callback callback);
-
-/**
- * Request a workflow eviction.
- *
- * The `req_proto` and `req_proto_len` represent a byte array for a
- * [bridge::RequestWorkflowEvictionRequest] protobuf message. The callback is invoked on completion
- * with a [bridge::RequestWorkflowEvictionResponse] protobuf message.
- */
-void tmprl_request_workflow_eviction(struct tmprl_worker_t *worker,
-                                     const uint8_t *req_proto,
-                                     size_t req_proto_len,
-                                     void *user_data,
-                                     tmprl_callback callback);