@temporalio/core-bridge 1.0.1 → 1.3.0

package/Cargo.toml

@@ -22,8 +22,8 @@ log = "0.4"
 neon = { version = "0.10", default-features = false, features = ["napi-6", "event-queue-api"] }
 opentelemetry = "0.16"
 parking_lot = "0.12"
-prost = "0.9"
-prost-types = "0.9"
+prost = "0.11"
+prost-types = "0.11"
 tokio = "1.13"
 once_cell = "1.7.2"
 temporal-sdk-core = { version = "*", path = "./sdk-core/core" }

package/common.js

@@ -29,7 +29,7 @@ class PrebuildError extends Error {
   }
 }
 
-function getPrebuiltPath() {
+function getPrebuiltTargetName() {
   const arch = archAlias[os.arch()];
   if (arch === undefined) {
     throw new PrebuildError(`No prebuilt module for arch ${os.arch()}`);
@@ -38,7 +38,11 @@ function getPrebuiltPath() {
   if (platform === undefined) {
     throw new PrebuildError(`No prebuilt module for platform ${os.platform()}`);
   }
-  const binary = path.resolve(__dirname, 'releases', `${arch}-${platform}`, 'index.node');
+  return `${arch}-${platform}`;
+}
+
+function getPrebuiltPath() {
+  const binary = path.resolve(__dirname, 'releases', getPrebuiltTargetName(), 'index.node');
   if (fs.existsSync(binary)) {
     return binary;
   } else {
@@ -46,4 +50,4 @@ function getPrebuiltPath() {
   }
 }
 
-module.exports = { targets, archAlias, platformMapping, PrebuildError, getPrebuiltPath };
+module.exports = { targets, archAlias, platformMapping, PrebuildError, getPrebuiltPath, getPrebuiltTargetName };

package/index.d.ts

@@ -241,10 +241,109 @@ export interface LogEntry {
   level: LogLevel;
 }
 
-export interface Worker {}
-export interface Runtime {}
-export interface Client {}
+/**
+ * Which version of the executable to run.
+ */
+export type EphemeralServerExecutable =
+  | {
+      type: 'cached-download';
+      /**
+       * Download destination directory or the system's temp directory if none set.
+       */
+      downloadDir?: string;
+      /**
+       * Optional version, can be set to a specific server release or "default" or "latest".
+       *
+       * At the time of writing the the server is released as part of the Java SDK - (https://github.com/temporalio/sdk-java/releases).
+       *
+       * @default "default" - get the best version for the current SDK version.
+       */
+      version?: string;
+    }
+  | {
+      type: 'existing-path';
+      /** Path to executable */
+      path: string;
+    };
+
+/**
+ * Configuration for the time-skipping test server.
+ */
+export interface TimeSkippingServerConfig {
+  type: 'time-skipping';
+  executable?: EphemeralServerExecutable;
+  /**
+   * Optional port to listen on, defaults to find a random free port.
+   */
+  port?: number;
+  /**
+   * Extra args to pass to the executable command.
+   */
+  extraArgs?: string[];
+}
+
+/**
+ * Configuration for temporalite.
+ */
+export interface TemporaliteConfig {
+  type: 'temporalite';
+  executable?: EphemeralServerExecutable;
+  /**
+   * Namespace to use - created at startup.
+   *
+   * @default "default"
+   */
+  namespace?: string;
+  /**
+   * IP to bind to.
+   *
+   * @default 127.0.0.1
+   */
+  ip?: string;
+  /**
+   * Sqlite DB filename if persisting or non-persistent if none.
+   */
+  db_filename?: string;
+  /**
+   * Whether to enable the UI.
+   */
+  ui?: boolean;
+  /**
+   * Log format and level
+   * @default { format: "pretty", level" "warn" }
+   */
+  log?: { format: string; level: string };
+  /**
+   * Optional port to listen on, defaults to find a random free port.
+   */
+  port?: number;
+  /**
+   * Extra args to pass to the executable command.
+   */
+  extraArgs?: string[];
+}
 
+/**
+ * Configuration for spawning an ephemeral Temporal server.
+ *
+ * Both the time-skipping test server and temporalite are supported.
+ */
+export type EphemeralServerConfig = TimeSkippingServerConfig | TemporaliteConfig;
+
+export interface Worker {
+  type: 'Worker';
+}
+export interface Runtime {
+  type: 'Runtime';
+}
+export interface Client {
+  type: 'Client';
+}
+export interface EphemeralServer {
+  type: 'EphemeralServer';
+}
+
+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 ClientCallback = (err: Error, result: Client) => void;
@@ -293,3 +392,11 @@ export declare function workerCompleteActivityTask(
 ): void;
 export declare function workerRecordActivityHeartbeat(worker: Worker, heartbeat: ArrayBuffer): void;
 export declare function getTimeOfDay(): [number, number];
+export declare function startEphemeralServer(
+  runtime: Runtime,
+  config: EphemeralServerConfig,
+  sdkVersion: string,
+  callback: Callback<EphemeralServer>
+): void;
+export declare function shutdownEphemeralServer(server: EphemeralServer, callback: Callback<EphemeralServer>): void;
+export declare function getEphemeralServerTarget(server: EphemeralServer): string;

package/index.js

@@ -1,12 +1,8 @@
-const { getPrebuiltPath, PrebuildError } = require('./common');
+const { getPrebuiltPath } = require('./common');
 
 try {
   const prebuiltPath = getPrebuiltPath();
   module.exports = require(prebuiltPath);
 } catch (err) {
-  if (err instanceof PrebuildError) {
-    module.exports = require('./default-build/index.node');
-  } else {
-    throw err;
-  }
+  throw err;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/core-bridge",
-  "version": "1.0.1",
+  "version": "1.3.0",
   "description": "Temporal.io SDK Core<>Node bridge",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,7 +20,7 @@
   "license": "MIT",
   "dependencies": {
     "@opentelemetry/api": "^1.1.0",
-    "@temporalio/internal-non-workflow-common": "^1.0.1",
+    "@temporalio/internal-non-workflow-common": "^1.3.0",
     "arg": "^5.0.2",
     "cargo-cp-artifact": "^0.1.6",
     "which": "^2.0.2"
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a1dae539e72b6b088b400998d7bef482e8ed52f1"
+  "gitHead": "966d51d3545a5e84102190f5b762160b9dfe99c2"
 }

package/scripts/build.js

@@ -4,7 +4,7 @@ const fs = require('fs');
 const which = require('which');
 const { spawnSync } = require('child_process');
 const { version } = require('../package.json');
-const { targets, getPrebuiltPath, PrebuildError } = require('../common');
+const { targets, getPrebuiltPath, getPrebuiltTargetName, PrebuildError } = require('../common');
 
 process.chdir(path.resolve(__dirname, '..'));
 
@@ -54,10 +54,11 @@ if (unsupportedTargets.length) {
 const forceBuild = args['--force'];
 const buildRelease = args['--release'] || process.env.BUILD_CORE_RELEASE !== undefined;
 
-function compile(target) {
+function compile(requestedTarget) {
+  const target = requestedTarget ?? getPrebuiltTargetName();
   console.log('Compiling bridge', { target, buildRelease });
 
-  const out = target ? `releases/${target}/index.node` : 'default-build/index.node';
+  const out = `releases/${target}/index.node`;
   try {
     fs.unlinkSync(out);
   } catch (err) {

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

@@ -1,8 +1,9 @@
-FROM rust:1.59
+FROM rust:1.63
 
 RUN rustup component add rustfmt && \
 	rustup component add clippy
 
 RUN cargo install cargo-tarpaulin
+RUN apt-get update && apt-get install -y protobuf-compiler
 
 WORKDIR /sdk-core

package/sdk-core/ARCHITECTURE.md

@@ -66,11 +66,11 @@ async fn hello_activity(name: &str) -> String {
 
 We define the interface between the core and lang SDKs in terms of gRPC service definitions. The actual implementations of this "service" are not generated by gRPC generators, but the messages themselves are, and make it easier to hit the ground running in new languages.
 
-See the latest API definition [here](https://github.com/temporalio/sdk-core/blob/master/protos/local/core_interface.proto)
+See the latest API definition [here](https://github.com/temporalio/sdk-core/tree/master/protos/local/temporal/sdk/core)
 
 
 ## Other topics
 - [Sticky task queues](arch_docs/sticky_queues.md)
 
 ## Workflow Processing Internals
-![Workflow Internals](arch_docs/diagrams/workflow_internals.svg)
+![Workflow Internals](arch_docs/diagrams/workflow_internals.svg)

package/sdk-core/README.md

@@ -76,6 +76,18 @@ subtree. To update it, use:
 
 Do not question why this git command is the way it is. It is not our place to interpret git's ways.
 
+The java testserver protos are also pulled from the sdk-java repo, but since we only need a
+subdirectory of that repo, we just copy the files with read-tree:
+```bash
+# add sdk-java as a remote if you have not already
+git remote add -f -t master --no-tags testsrv-protos git@github.com:temporalio/sdk-java.git
+# delete existing protos
+git rm -rf protos/testsrv_upstream
+# pull from upstream & commit
+git read-tree --prefix protos/testsrv_upstream -u testsrv-protos/master:temporal-test-server/src/main/proto
+git commit
+```
+
 ## Fetching Histories
 Tests which would like to replay stored histories rely on that history being made available in
 binary format. You can fetch histories in that format like so (from a local docker server):

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

@@ -14,11 +14,11 @@ crate-type = ["staticlib"]
 lazy_static = "1.4"
 libc = "0.2"
 log = "0.4"
-prost = "0.9"
+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"
 
 [build-dependencies]
-cbindgen = "0.20.0"
+cbindgen = "0.24"

package/sdk-core/client/Cargo.toml

@@ -19,20 +19,22 @@ derive_more = "0.99"
 futures = "0.3"
 futures-retry = "0.6.0"
 http = "0.2"
+once_cell = "1.13"
 opentelemetry = { version = "0.17", features = ["metrics"] }
 parking_lot = "0.12"
-prost-types = "0.9"
+prost-types = "0.11"
 thiserror = "1.0"
 tokio = "1.1"
-tonic = { version = "0.6", features = ["tls", "tls-roots"] }
+tonic = { version = "0.8", features = ["tls", "tls-roots"] }
 tower = "0.4"
 tracing = "0.1"
 url = "2.2"
-uuid = { version = "0.8.2", features = ["v4"] }
+uuid = { version = "1.1", features = ["v4"] }
 
 [dependencies.temporal-sdk-core-protos]
 path = "../sdk-core-protos"
 version = "0.1"
 
 [dev-dependencies]
-mockall = "0.11"
+assert_matches = "1"
+mockall = "0.11"