@temporalio/core-bridge 0.13.0 → 0.16.3

package/index.d.ts

@@ -0,0 +1,195 @@
+import { TLSConfig } from '@temporalio/common';
+import { SpanContext } from '@opentelemetry/api';
+
+export { TLSConfig };
+
+export interface RetryOptions {
+  /** Initial wait time before the first retry. */
+  initialInterval: number;
+  /**
+   * Randomization jitter that is used as a multiplier for the current retry interval
+   * and is added or subtracted from the interval length.
+   */
+  randomizationFactor: number;
+  /** Rate at which retry time should be increased, until it reaches max_interval. */
+  multiplier: number;
+  /** Maximum amount of time to wait between retries. */
+  maxInterval: number;
+  /** Maximum total amount of time requests should be retried for, if None is set then no limit will be used. */
+  maxElapsedTime?: number;
+  /** Maximum number of retry attempts. */
+  maxRetries: number;
+}
+
+export interface ServerOptions {
+  /**
+   * The URL of the Temporal server to connect to
+   */
+  url: string;
+  /**
+   * What namespace will we operate under
+   */
+  namespace: string;
+
+  /**
+   * A human-readable string that can identify your worker
+   */
+  identity: string;
+  /**
+   * A string that should be unique to the exact worker code/binary being executed
+   */
+  workerBinaryId: string;
+
+  /** Version string for the whole node SDK. Should never be set by user */
+  sdkVersion: string;
+
+  /**
+   * TLS configuration options.
+   *
+   * Pass undefined to use a non-encrypted connection or an empty object to
+   * connect with TLS without any customization.
+   */
+  tls?: TLSConfig;
+
+  /**
+   * Optional retry options for server requests.
+   */
+  retry?: RetryOptions;
+}
+
+/**
+ * Configure a Core instance
+ */
+export interface CoreOptions {
+  /**
+   * Options for communicating with the Temporal server
+   */
+  serverOptions: ServerOptions;
+  /**
+   * Telemetry options
+   */
+  telemetryOptions: TelemetryOptions;
+}
+
+export interface TelemetryOptions {
+  /**
+   * If set, telemetry is turned on and this URL must be the URL of a gRPC
+   * OTel collector.
+   */
+  oTelCollectorUrl?: string;
+  /**
+   * 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
+   */
+  tracingFilter?: string;
+  /** What level, if any, logs should be forwarded from core at */
+  // These strings should match the log::LevelFilter enum in rust
+  logForwardingLevel: 'OFF' | LogLevel;
+  /** If set, metrics will be exposed on an http server in this process for direct scraping by
+   *  prometheus. If used in conjunction with the OTel collector, metrics will *not* be exported
+   *  to the collector, but traces will be.
+   *
+   *  The string provided must be an address the server will bind to. For example, `0.0.0.0:1234`.
+   *  Metrics will be available for scraping under the standard `/metrics` route.
+   */
+  prometheusMetricsBindAddress?: string;
+}
+
+export interface WorkerOptions {
+  /**
+   * The task queue the worker will pull from
+   */
+  taskQueue: string;
+
+  maxConcurrentActivityTaskExecutions: number;
+  maxConcurrentWorkflowTaskExecutions: number;
+  maxConcurrentWorkflowTaskPolls: number;
+  maxConcurrentActivityTaskPolls: number;
+  /**
+   * `maxConcurrentWorkflowTaskPolls` * this number = the number of max pollers that will
+   * be allowed for the nonsticky queue when sticky tasks are enabled. If both defaults are used,
+   * the sticky queue will allow 4 max pollers while the nonsticky queue will allow one. The
+   * minimum for either poller is 1, so if `max_concurrent_wft_polls` is 1 and sticky queues are
+   * enabled, there will be 2 concurrent polls.
+   */
+  nonStickyToStickyPollRatio: number;
+  /**
+   * How long a workflow task is allowed to sit on the sticky queue before it is timed out
+   * and moved to the non-sticky queue where it may be picked up by any worker.
+   */
+  stickyQueueScheduleToStartTimeoutMs: number;
+
+  /**
+   * Maximum number of Workflow instances to cache before automatic eviction
+   */
+  maxCachedWorkflows: number;
+  /**
+   * Longest interval for throttling activity heartbeats
+   * @default 60 seconds
+   */
+  maxHeartbeatThrottleIntervalMs: number;
+
+  /**
+   * Default interval for throttling activity heartbeats in case
+   * `ActivityOptions.heartbeat_timeout` is unset.
+   * When the timeout *is* set in the `ActivityOptions`, throttling is set to
+   * `heartbeat_timeout * 0.8`.
+   * @default 30 seconds
+   */
+  defaultHeartbeatThrottleIntervalMs: number;
+}
+
+/** Log level - must match rust log level names */
+export type LogLevel = 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR';
+
+export interface LogEntry {
+  /** Log message */
+  message: string;
+  /**
+   * Time since epoch [seconds, nanos].
+   *
+   * Should be switched to bigint once it is supported in neon.
+   */
+  timestamp: [number, number];
+  /** Log level */
+  level: LogLevel;
+}
+
+export interface Worker {}
+export interface Core {}
+
+export declare type PollCallback = (err: Error, result: ArrayBuffer) => void;
+export declare type WorkerCallback = (err: Error, result: Worker) => void;
+export declare type CoreCallback = (err: Error, result: Core) => 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 newCore(coreOptions: CoreOptions, callback: CoreCallback): void;
+export declare function newWorker(core: Core, workerOptions: WorkerOptions, callback: WorkerCallback): void;
+export declare function workerShutdown(worker: Worker, callback: VoidCallback): void;
+export declare function coreShutdown(core: Core, callback: VoidCallback): void;
+export declare function corePollLogs(core: Core, callback: LogsCallback): void;
+export declare function workerPollWorkflowActivation(
+  worker: Worker,
+  spanContext: SpanContext,
+  callback: PollCallback
+): void;
+export declare function workerCompleteWorkflowActivation(
+  worker: Worker,
+  spanContext: SpanContext,
+  result: ArrayBuffer,
+  callback: VoidCallback
+): void;
+export declare function workerPollActivityTask(worker: Worker, spanContext: SpanContext, callback: PollCallback): void;
+export declare function workerCompleteActivityTask(
+  worker: Worker,
+  spanContext: SpanContext,
+  result: ArrayBuffer,
+  callback: VoidCallback
+): void;
+export declare function workerRecordActivityHeartbeat(worker: Worker, heartbeat: ArrayBuffer): void;
+export declare function getTimeOfDay(): [number, number];

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@temporalio/core-bridge",
-  "version": "0.13.0",
+  "version": "0.16.3",
   "description": "Temporal.io SDK Core<>Node bridge",
   "main": "index.node",
   "types": "index.d.ts",
   "scripts": {
-    "build-rust": "TEMPORAL_WORKER_FORCE_BUILD=true node ./scripts/build.js",
+    "build-rust": "node ./scripts/build.js --force",
     "build": "npm run build-rust",
     "install": "node ./scripts/build.js"
   },
@@ -18,8 +18,11 @@
   "author": "Roey Berman <roey@temporal.io>",
   "license": "MIT",
   "dependencies": {
-    "@temporalio/common": "^0.13.0",
-    "cargo-cp-artifact": "^0.1.4"
+    "@opentelemetry/api": "^1.0.3",
+    "@temporalio/common": "^0.16.0",
+    "arg": "^5.0.1",
+    "cargo-cp-artifact": "^0.1.4",
+    "which": "^2.0.2"
   },
   "bugs": {
     "url": "https://github.com/temporalio/sdk-typescript/issues"
@@ -31,10 +34,11 @@
     "releases",
     "sdk-core",
     "Cargo.toml",
-    "Cargo.lock"
+    "Cargo.lock",
+    "index.d.ts"
   ],
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "bbb8d36ad9d310eb44bd19f3f8bb9356e1dd9dfb"
+  "gitHead": "af54140a4da7e191c06627c5e06b92a3fd929bcc"
 }

package/scripts/build.js

@@ -1,27 +1,71 @@
 const path = require('path');
+const arg = require('arg');
 const os = require('os');
 const fs = require('fs');
+const which = require('which');
 const { spawnSync } = require('child_process');
+const { version } = require('../package.json');
 
 process.chdir(path.resolve(__dirname, '..'));
 
-const targets = ['x86_64-apple-darwin', 'aarch64-apple-darwin', 'x86_64-unknown-linux-gnu', 'x86_64-pc-windows-gnu'];
-
-const requestedTargets =
-  process.env.TEMPORAL_WORKER_BUILD_TARGETS === 'all'
-    ? targets
-    : process.env.TEMPORAL_WORKER_BUILD_TARGETS
-    ? process.env.TEMPORAL_WORKER_BUILD_TARGETS.split(':')
-    : [];
-
-// Only applicable if TEMPORAL_WORKER_BUILD_TARGETS is not specified
-const forceBuild = new Set(['y', 't', '1', 'yes', 'true']).has(
-  (process.env.TEMPORAL_WORKER_FORCE_BUILD || '').toLowerCase()
-);
+// List of tested compile targets
+const targets = [
+  'x86_64-apple-darwin',
+  'aarch64-apple-darwin',
+  'x86_64-unknown-linux-gnu',
+  'aarch64-unknown-linux-gnu',
+  // TODO: this is not supported on macos
+  'x86_64-pc-windows-msvc',
+  'x86_64-pc-windows-gnu',
+];
 
 const archAlias = { x64: 'x86_64', arm64: 'aarch64' };
 const platformMapping = { darwin: 'apple-darwin', linux: 'unknown-linux-gnu', win32: 'pc-windows-gnu' };
 
+const args = arg({
+  '--help': Boolean,
+  '-h': '--help',
+  '--version': Boolean,
+  '-v': '--version',
+  '--target': [String],
+  '--force': Boolean,
+  '-f': '--force',
+});
+
+const HELP_STRING = `${path.basename(
+  process.argv[1]
+)} compiles the Core SDK and temporal-sdk-typescript-bridge Rust libraries
+
+Options:
+
+-h, --help     Show this help message and exit
+-v, --version  Show program's version number and exit
+-f, --force    Forces a build instead of using a prebuilt binary
+-t, --target   Compilation targets, choose any of:
+  ${targets.concat('all').join('\n  ')}
+
+Happy compiling!`;
+
+if (args['--help']) {
+  console.log(HELP_STRING);
+  process.exit();
+}
+if (args['--version']) {
+  console.log(version);
+  process.exit();
+}
+// });
+
+// prepare recompile options
+const targetsArg = args['--target'] || [];
+const requestedTargets = targetsArg.includes('all') ? targets : targetsArg;
+const unsupportedTargets = requestedTargets.filter((t) => !targets.includes(t));
+if (unsupportedTargets.length) {
+  console.error(`Unsupported targets ${JSON.stringify(unsupportedTargets)}`);
+  process.exit(1);
+}
+const forceBuild = args['--force'];
+
 function compile(target) {
   console.log('Compiling bridge', { target });
 
@@ -33,26 +77,25 @@ function compile(target) {
       throw err;
     }
   }
-  const { status, error } = spawnSync(
-    'cargo-cp-artifact',
-    [
-      '--artifact',
-      'cdylib',
-      'temporal_sdk_typescript_bridge',
-      out,
-      '--',
-      'cargo',
-      'build',
-      '--message-format=json-render-diagnostics',
-      '--release',
-      ...(target ? ['--target', target] : []),
-    ],
-    { stdio: 'inherit' }
-  );
-  if (error !== undefined) {
-    console.error(`Failed to build${target ? ' for ' + target : ''}`);
-    throw error;
-  }
+
+  const argv = [
+    '--artifact',
+    'cdylib',
+    'temporal_sdk_typescript_bridge',
+    out,
+    '--',
+    'cargo',
+    'build',
+    '--message-format=json-render-diagnostics',
+    '--release',
+    ...(target ? ['--target', target] : []),
+  ];
+  const cmd = which.sync('cargo-cp-artifact');
+
+  console.log('Running', cmd, argv);
+  const { status } = spawnSync(cmd, argv, {
+    stdio: 'inherit',
+  });
   if (status !== 0) {
     throw new Error(`Failed to build${target ? ' for ' + target : ''}`);
   }
@@ -104,7 +147,7 @@ if (requestedTargets.length > 0) {
       }
     }
   } else {
-    console.log('Force build via TEMPORAL_WORKER_FORCE_BUILD env var');
+    console.log('Forced the build via --force');
     compile();
   }
 }

package/sdk-core/.buildkite/docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM rust:1.54
+FROM rust:1.56
 
 RUN rustup component add rustfmt && \
 	rustup component add clippy

package/sdk-core/CODEOWNERS

@@ -1,3 +1,3 @@
 # Primary owners
 
-* @vitarb @Sushisource @bergundy
+* @vitarb @Sushisource @bergundy @cretz

package/sdk-core/Cargo.toml

@@ -2,7 +2,7 @@
 name = "temporal-sdk-core"
 version = "0.1.0-alpha.1"
 authors = ["Spencer Judge <spencer@temporal.io>", "Vitaly Arbuzov <vitaly@temporal.io>"]
-edition = "2018"
+edition = "2021"
 license-file = "LICENSE.txt"
 description = "Library for building new Temporal SDKs"
 homepage = "https://temporal.io/"
@@ -36,15 +36,16 @@ opentelemetry-otlp = { version = "0.9.0", features = ["tokio", "metrics"] }
 opentelemetry-prometheus = "0.9.0"
 parking_lot = { version = "0.11", features = ["send_guard"] }
 prometheus = "0.12"
-prost = "0.8"
-prost-types = "0.8"
+prost = "0.9"
+prost-types = "0.9"
 rand = "0.8.3"
 ringbuf = "0.2"
 slotmap = "1.0"
 thiserror = "1.0"
 tokio = { version = "1.1", features = ["rt", "rt-multi-thread", "parking_lot", "time", "fs"] }
+tokio-util = { version = "0.6.9" }
 tokio-stream = "0.1"
-tonic = { version = "0.5", features = ["tls", "tls-roots"] }
+tonic = { version = "0.6", features = ["tls", "tls-roots"] }
 tower = "0.4"
 tracing = { version = "0.1", features = ["log-always"] }
 tracing-futures = "0.2"
@@ -70,7 +71,7 @@ rstest = "0.10"
 test_utils = { path = "test_utils" }
 
 [build-dependencies]
-tonic-build = "0.5"
+tonic-build = "0.6"
 
 [workspace]
 members = [".", "fsm", "test_utils", "sdk-core-protos"]

package/sdk-core/fsm/Cargo.toml

@@ -2,7 +2,7 @@
 name = "rustfsm"
 version = "0.1.0"
 authors = ["Spencer Judge <spencer@temporal.io>"]
-edition = "2018"
+edition = "2021"
 license-file = "LICENSE.txt"
 description = "Define state machines that can accept events and produce commands"
 homepage = "https://temporal.io/"

package/sdk-core/fsm/rustfsm_procmacro/Cargo.toml

@@ -2,7 +2,7 @@
 name = "rustfsm_procmacro"
 version = "0.1.0"
 authors = ["Spencer Judge <spencer@temporal.io>"]
-edition = "2018"
+edition = "2021"
 license-file = "LICENSE.txt"
 description = "Procmacro sub-crate of the `rustfsm` crate"
 
@@ -24,4 +24,4 @@ rustfsm_trait = { version = "0.1", path = "../rustfsm_trait" }
 trybuild = { version = "1.0", features = ["diff"] }
 
 [package.metadata.workspaces]
-independent = true
+independent = true

package/sdk-core/fsm/rustfsm_procmacro/src/lib.rs

@@ -1,5 +1,3 @@
-extern crate proc_macro;
-
 use proc_macro::TokenStream;
 use quote::{quote, quote_spanned};
 use std::collections::{hash_map::Entry, HashMap, HashSet};
@@ -82,7 +80,7 @@ use syn::{
 ///                     ReadingCard { card_data: data.clone() }.into(),
 ///                     SharedState { last_id: Some(data) }
 ///                 )
-///             }   
+///             }
 ///         }
 ///     }
 /// }
@@ -200,7 +198,7 @@ impl Parse for StateMachineDefinition {
         // Parse visibility if present
         let visibility = input.parse()?;
         // parse the state machine name, command type, and error type
-        let (name, command_type, error_type, shared_state_type) = parse_machine_types(&input)
+        let (name, command_type, error_type, shared_state_type) = parse_machine_types(input)
             .map_err(|mut e| {
                 e.combine(Error::new(
                     e.span(),
@@ -235,7 +233,7 @@ impl Parse for StateMachineDefinition {
     }
 }
 
-fn parse_machine_types(input: &ParseStream) -> Result<(Ident, Ident, Ident, Option<Type>)> {
+fn parse_machine_types(input: ParseStream) -> Result<(Ident, Ident, Ident, Option<Type>)> {
     let _: kw::name = input.parse()?;
     let name: Ident = input.parse()?;
     input.parse::<Token![;]>()?;
@@ -443,7 +441,7 @@ impl StateMachineDefinition {
                                         },
                             multi_dests => {
                                 let string_dests: Vec<_> = multi_dests.iter()
-                                    .map(|i| i.to_string()).collect();
+                                    .map(ToString::to_string).collect();
                                 let enum_ident = Ident::new(&string_dests.join("Or"),
                                                             multi_dests[0].span());
                                 let multi_dest_enum = quote! {
@@ -558,6 +556,7 @@ impl StateMachineDefinition {
                 fn state(&self) -> &Self::State {
                     &self.state
                 }
+
                 fn set_state(&mut self, new: Self::State) {
                     self.state = new
                 }
@@ -590,7 +589,7 @@ impl StateMachineDefinition {
             #trait_impl
         };
 
-        output.into()
+        TokenStream::from(output)
     }
 
     fn all_states(&self) -> HashSet<Ident> {
@@ -628,7 +627,7 @@ impl StateMachineDefinition {
 /// Merge transition's dest state lists for those with the same from state & handler
 fn merge_transition_dests(transitions: Vec<Transition>) -> Vec<Transition> {
     let mut map = HashMap::<_, Transition>::new();
-    transitions.into_iter().for_each(|t| {
+    for t in transitions {
         // We want to use the transition sans-destinations as the key
         let without_dests = {
             let mut wd = t.clone();
@@ -643,6 +642,6 @@ fn merge_transition_dests(transitions: Vec<Transition>) -> Vec<Transition> {
                 v.insert(t);
             }
         }
-    });
+    }
     map.into_iter().map(|(_, v)| v).collect()
 }

package/sdk-core/fsm/rustfsm_procmacro/tests/trybuild/no_handle_conversions_require_into_fail.stderr

@@ -1,8 +1,14 @@
 error[E0277]: the trait bound `One: From<Two>` is not satisfied
-  --> $DIR/no_handle_conversions_require_into_fail.rs:11:18
-   |
-11 |     Two --(B)--> One;
-   |                  ^^^ the trait `From<Two>` is not implemented for `One`
-   |
-   = note: required because of the requirements on the impl of `Into<One>` for `Two`
-   = note: required by `TransitionResult::<Sm, Ds>::from`
+   --> tests/trybuild/no_handle_conversions_require_into_fail.rs:11:18
+    |
+11  |     Two --(B)--> One;
+    |                  ^^^ the trait `From<Two>` is not implemented for `One`
+    |
+    = note: required because of the requirements on the impl of `Into<One>` for `Two`
+note: required by `TransitionResult::<Sm, Ds>::from`
+   --> $WORKSPACE/fsm/rustfsm_trait/src/lib.rs
+    |
+    | /     pub fn from<CurrentState>(current_state: CurrentState) -> Self
+    | |     where
+    | |         CurrentState: Into<Ds>,
+    | |_______________________________^

package/sdk-core/fsm/rustfsm_trait/Cargo.toml

@@ -2,7 +2,7 @@
 name = "rustfsm_trait"
 version = "0.1.0"
 authors = ["Spencer Judge <spencer@temporal.io>"]
-edition = "2018"
+edition = "2021"
 license-file = "LICENSE.txt"
 description = "Trait sub-crate of the `rustfsm` crate"
 
@@ -11,4 +11,4 @@ description = "Trait sub-crate of the `rustfsm` crate"
 [dependencies]
 
 [package.metadata.workspaces]
-independent = true
+independent = true

package/sdk-core/fsm/rustfsm_trait/src/lib.rs

@@ -112,7 +112,7 @@ where
     pub fn unwrap(self) -> Vec<M::Command> {
         match self {
             Self::Ok { commands } => commands,
-            _ => panic!("Transition was not successful!"),
+            Self::InvalidTransition => panic!("Transition was not successful!"),
         }
     }
 }

package/sdk-core/protos/local/activity_result.proto

@@ -13,6 +13,7 @@ message ActivityResult {
         Success completed = 1;
         Failure failed = 2;
         Cancellation cancelled = 3;
+        WillCompleteAsync will_complete_async = 4;
     }
 }
 
@@ -34,4 +35,12 @@ message Failure {
  */
 message Cancellation {
     temporal.api.failure.v1.Failure failure = 1;
-}
+}
+
+/**
+ * Used in ActivityResult to notify Core that this Activity will complete asynchronously.
+ * Core will forget about this Activity and free up resources used to track this Activity.
+ */
+message WillCompleteAsync {
+}
+

package/sdk-core/protos/local/workflow_activation.proto

@@ -59,9 +59,8 @@ message WFActivationJob {
         /// after performing the activation.
         ///
         /// If other job variant are present in the list, this variant will be the last job in the
-        /// job list. The boolean value is irrelevant, since the variant type is what matters. It
-        /// will be set to true if this is the variant.
-        bool remove_from_cache = 50;
+        /// job list. The string value is a reason for eviction.
+        RemoveFromCache remove_from_cache = 50;
     }
 }
 
@@ -187,3 +186,7 @@ message ResolveRequestCancelExternalWorkflow {
     /// type / info.
     temporal.api.failure.v1.Failure failure = 2;
 }
+
+message RemoveFromCache {
+    string reason = 1;
+}

package/sdk-core/sdk-core-protos/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "temporal-sdk-core-protos"
 version = "0.1.0"
-edition = "2018"
+edition = "2021"
 authors = ["Spencer Judge <spencer@temporal.io>"]
 license-file = "LICENSE.txt"
 description = "Protobuf definitions for Temporal SDKs Core/Lang interface"
@@ -12,9 +12,9 @@ categories = ["development-tools"]
 
 [dependencies]
 derive_more = "0.99"
-prost = "0.8"
-prost-types = "0.8"
-tonic = "0.5"
+prost = "0.9"
+prost-types = "0.9"
+tonic = "0.6"
 
 [build-dependencies]
 tonic-build = "0.5"