@temporalio/core-bridge 1.8.5 → 1.9.0-rc.0

package/Cargo.toml

@@ -24,6 +24,7 @@ opentelemetry = "0.18"
 parking_lot = "0.12"
 prost = "0.11"
 prost-types = "0.11"
+serde_json = "1.0"
 tokio = "1.13"
 once_cell = "1.7.2"
 temporal-sdk-core = { version = "*", path = "./sdk-core/core", features = ["ephemeral-server"] }

package/lib/index.d.ts

@@ -1,4 +1,3 @@
-import { SpanContext } from '@opentelemetry/api';
 import { LogLevel, Duration } from '@temporalio/common';
 import type { TLSConfig } from '@temporalio/common/lib/internal-non-workflow';
 export { TLSConfig };
@@ -103,12 +102,6 @@ export interface OtelCollectorExporter {
     };
 }
 /** @experimental */
-export type CompiledOtelTraceExporter = Shadow<OtelCollectorExporter, {
-    otel: {
-        metricsExportInterval?: never;
-    };
-}>;
-/** @experimental */
 export type CompiledOtelMetricsExporter = Shadow<OtelCollectorExporter, {
     otel: {
         metricsExportInterval: number;
@@ -142,12 +135,6 @@ export interface PrometheusMetricsExporter {
 export type MetricsExporter = {
     temporality?: 'cumulative' | 'delta';
 } & (PrometheusMetricsExporter | OtelCollectorExporter);
-/**
- * Trace exporters supported by Core
- *
- * @experimental
- */
-export type TraceExporter = OtelCollectorExporter;
 /** @experimental */
 export interface TelemetryOptions {
     /**
@@ -156,7 +143,7 @@ export interface TelemetryOptions {
      *
      * Which determines what tracing data is collected in the Core SDK.
      *
-     * @deprecated Use either `logging.filter` or `tracing.filter` instead
+     * @deprecated Use `logging.filter` instead
      */
     tracingFilter?: string;
     /**
@@ -188,35 +175,16 @@ export interface TelemetryOptions {
          */
         filter?: string;
     } & Partial<Logger>;
-    /**
-     * Control where to send traces generated by Rust Core, optional and turned off by default.
-     *
-     * This is typically used for profiling SDK internals.
-     */
-    tracing?: {
-        /**
-         * A string in (env filter format)[https://docs.rs/tracing-subscriber/0.2.20/tracing_subscriber/struct.EnvFilter.html]
-         * which determines what tracing data is collected in the Core SDK.
-         *
-         * You can use {@link Runtime.makeTelemetryFilterString()} to easily build a correctly formatted filter
-         * string based on desired log level for Core SDK and other native packages.
-         *
-         * **BACKWARD COMPATIBILITY**
-         *
-         * If `tracing.filter` is missing, the following legacy values (if present) will be used instead (in the given order):
-         * - {@link TelemetryOptions.tracingFilter}
-         * - Default value of `makeTelemetryFilterString({ core: 'INFO', other: 'INFO'})`
-         *
-         * @default `makeTelemetryFilterString({ core: 'INFO', other: 'INFO'})` (with some exceptions, as described in backward compatibility note above)
-         */
-        filter?: string;
-    } & Partial<TraceExporter>;
     /**
      * Control exporting {@link NativeConnection} and {@link Worker} metrics.
      *
      * Turned off by default
      */
     metrics?: MetricsExporter;
+    /**
+     * @deprecated Core SDK tracing is no longer supported. This option is ignored.
+     */
+    tracing?: unknown;
 }
 /** @experimental */
 export type CompiledTelemetryOptions = {
@@ -228,9 +196,6 @@ export type CompiledTelemetryOptions = {
     } | {
         forward: {};
     });
-    tracing?: {
-        filter: string;
-    } & CompiledOtelTraceExporter;
     metrics?: {
         temporality?: 'cumulative' | 'delta';
     } & (PrometheusMetricsExporter | CompiledOtelMetricsExporter);
@@ -258,6 +223,7 @@ export interface WorkerOptions {
     maxConcurrentActivityTaskExecutions: number;
     maxConcurrentWorkflowTaskExecutions: number;
     maxConcurrentLocalActivityExecutions: number;
+    nonStickyToStickyPollRatio: number;
     /**
      * Maximum number of Workflow tasks to poll concurrently.
      */
@@ -307,6 +273,9 @@ export interface WorkerOptions {
      */
     maxActivitiesPerSecond?: number;
 }
+export type LogEntryMetadata = {
+    [key: string]: string | number | boolean | LogEntryMetadata;
+};
 export interface LogEntry {
     /** Log message */
     message: string;
@@ -318,6 +287,10 @@ export interface LogEntry {
     timestamp: [number, number];
     /** Log level */
     level: LogLevel;
+    /** Name of the Core subsystem that emitted that log entry */
+    target: string;
+    /*** Metadata fields */
+    fields: LogEntryMetadata;
 }
 /**
  * Which version of the executable to run.
@@ -446,10 +419,10 @@ export declare function clientUpdateHeaders(client: Client, headers: Record<stri
 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;
-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 workerPollWorkflowActivation(worker: Worker, callback: PollCallback): void;
+export declare function workerCompleteWorkflowActivation(worker: Worker, result: ArrayBuffer, callback: VoidCallback): void;
+export declare function workerPollActivityTask(worker: Worker, callback: PollCallback): void;
+export declare function workerCompleteActivityTask(worker: Worker, result: ArrayBuffer, callback: VoidCallback): 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;

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;AAqhBA,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":";;;AAsfA,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.8.5",
+  "version": "1.9.0-rc.0",
   "description": "Temporal.io SDK Core<>Node bridge",
   "main": "index.js",
   "types": "lib/index.d.ts",
@@ -22,8 +22,7 @@
   "author": "Temporal Technologies Inc. <sdk@temporal.io>",
   "license": "MIT",
   "dependencies": {
-    "@opentelemetry/api": "^1.4.1",
-    "@temporalio/common": "1.8.5",
+    "@temporalio/common": "1.9.0-rc.0",
     "arg": "^5.0.2",
     "cargo-cp-artifact": "^0.1.6",
     "which": "^2.0.2"
@@ -53,5 +52,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1a03096ceb2d63345c3f2c190d975c2a54c7b4a5"
+  "gitHead": "ca3e508e62de02b2c9bb40d0d889003cebba282d"
 }

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

@@ -6,6 +6,10 @@ on: # rebuild any PRs and main branch changes
     branches:
       - master
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build-and-test:
     timeout-minutes: 20

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

@@ -0,0 +1,96 @@
+name: Per merge CI
+
+on: # rebuild any PRs and main branch changes
+  pull_request:
+  push:
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-and-test:
+    name: "Format, docs, and lint"
+    timeout-minutes: 20
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: 1.74.0
+          override: true
+      - name: Install protoc
+        uses: arduino/setup-protoc@v1
+        with:
+          version: '3.x'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - run: rustup component add rustfmt clippy
+      - uses: Swatinem/rust-cache@v2
+      - uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+      - uses: actions-rs/cargo@v1
+        with:
+          command: doc
+          args: --workspace --all-features --no-deps
+      - uses: actions-rs/cargo@v1
+        with:
+          command: lint
+      - uses: actions-rs/cargo@v1
+        with:
+          command: test-lint
+
+  test:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: 1.74.0
+          override: true
+      - name: Install protoc
+        uses: arduino/setup-protoc@v1
+        with:
+          version: '3.x'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: Swatinem/rust-cache@v2
+      - uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: -- --include-ignored
+      - uses: actions/upload-artifact@v3
+        with:
+          name: coverage-report
+          path: tarpaulin-report.html
+      - uses: actions/upload-artifact@v3
+        with:
+          name: state-machine-coverage
+          path: machine_coverage/
+
+  fmt:
+    name: Integ tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: 1.74.0
+          override: true
+      - name: Install protoc
+        uses: arduino/setup-protoc@v1
+        with:
+          version: '3.x'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: Swatinem/rust-cache@v2
+      - uses: actions-rs/cargo@v1
+        with:
+          command: integ-test

package/sdk-core/ARCHITECTURE.md

@@ -66,7 +66,7 @@ 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/tree/master/protos/local/temporal/sdk/core)
+See the latest API definition [here](https://github.com/temporalio/sdk-core/tree/master/sdk-core-protos/protos/local/temporal/sdk/core)
 
 
 ## Other topics

package/sdk-core/Cargo.toml

@@ -1,2 +1,8 @@
 [workspace]
 members = ["core", "client", "core-api", "fsm", "test-utils", "sdk-core-protos", "sdk"]
+resolver = "2"
+
+[workspace.dependencies]
+tonic = "0.9"
+tonic-build = "0.9"
+opentelemetry = "0.21"

package/sdk-core/README.md

@@ -1,5 +1,7 @@
 [![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:
 
 - [TypeScript SDK](https://github.com/temporalio/sdk-typescript/)
@@ -7,24 +9,31 @@ Core SDK that can be used as a base for other Temporal SDKs. It is currently use
 - [.NET SDK](https://github.com/temporalio/sdk-dotnet/)
 - [Ruby SDK](https://github.com/temporalio/sdk-ruby/)
 
-For the reasoning behind the Core SDK, see: 
+# Documentation
 
-- [Why Rust powers Temporal’s new Core SDK](https://temporal.io/blog/why-rust-powers-core-sdk).
+Core SDK documentation can be generated with `cargo doc`, output will be placed in the
+`target/doc` directory.
 
-See the [Architecture](ARCHITECTURE.md) doc for some high-level information about how Core works
+[Architecture](ARCHITECTURE.md) doc provides some high-level information about how Core SDK works
 and how language layers interact with it.
 
+For the reasoning behind the Core SDK, see blog post:
+
+- [Why Rust powers Temporal’s new Core SDK](https://temporal.io/blog/why-rust-powers-core-sdk).
+
 # Development
 
-You will need the `protoc` protobuf compiler installed to build Core.
+You will need the `protoc` [protobuf compiler](https://grpc.io/docs/protoc-installation)
+installed to build Core.
 
 This repo is composed of multiple crates:
-* temporal-sdk-core-protos `./sdk-core-protos` - Holds the generated proto code and extensions
-* temporal-client `./client` - Defines client(s) for interacting with the Temporal gRPC service
-* temporal-sdk-core-api `./core-api` - Defines the API surface exposed by Core
-* 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
+
+- temporal-sdk-core-protos `./sdk-core-protos` - Holds the generated proto code and extensions
+- temporal-client `./client` - Defines client(s) for interacting with the Temporal gRPC service
+- temporal-sdk-core-api `./core-api` - Defines the API surface exposed by Core
+- 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.
 
 Visualized (dev dependencies are in blue):
@@ -35,25 +44,28 @@ All the following commands are enforced for each pull request:
 
 ## Building and testing
 
-You can buld and test the project using cargo:
+You can build and test the project using cargo:
 `cargo build`
 `cargo test`
 
-Run integ tests with `cargo integ-test`. You will need to already be running the server:
-`docker-compose -f .buildkite/docker/docker-compose.yaml up`
+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`.
 
 ## Formatting
+
 To format all code run:
 `cargo fmt --all`
 
 ## Linting
+
 We are using [clippy](https://github.com/rust-lang/rust-clippy) for linting.
 You can run it using:
 `cargo clippy --all -- -D warnings`
 
 ## Debugging
+
 The crate uses [tracing](https://github.com/tokio-rs/tracing) to help with debugging. To enable
 it for a test, insert the below snippet at the start of the test. By default, tracing data is output
 to stdout in a (reasonably) pretty manner.
@@ -67,14 +79,14 @@ The passed in options to initialization can be customized to export to an OTel c
 To run integ tests with OTel collection on, you can use `integ-with-otel.sh`. You will want to make
 sure you are running the collector via docker, which can be done like so:
 
-`docker-compose -f .buildkite/docker/docker-compose.yaml -f .buildkite/docker/docker-compose-telem.yaml up`
+`docker-compose -f docker/docker-compose.yaml -f docker/docker-compose-telem.yaml up`
 
 If you are working on a language SDK, you are expected to initialize tracing early in your `main`
 equivalent.
 
 ## Proto files
 
-This repo uses a subtree for upstream protobuf files. The path `protos/api_upstream` is a
+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 -s subtree ssh://git@github.com/temporalio/api.git master --allow-unrelated-histories`
@@ -83,17 +95,19 @@ Do not question why this git command is the way it is. It is not our place to in
 
 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
+git rm -rf sdk-core-protos/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 read-tree --prefix sdk-core-protos/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):
 
@@ -104,16 +118,18 @@ You can change the `TEMPORAL_SERVICE_ADDRESS` env var to fetch from a different
 ## Style Guidelines
 
 ### Error handling
-Any error which is returned from a public interface should be well-typed, and we use 
+
+Any error which is returned from a public interface should be well-typed, and we use
 [thiserror](https://github.com/dtolnay/thiserror) for that purpose.
 
-Errors returned from things only used in testing are free to use 
+Errors returned from things only used in testing are free to use
 [anyhow](https://github.com/dtolnay/anyhow) for less verbosity.
 
-
 # The Rust "SDK"
+
 This repo contains a *prototype* Rust sdk in the `sdk/` directory. This SDK should be considered
 pre-alpha in terms of its API surface. Since it's still using Core underneath, it is generally
 functional. We do not currently have any firm plans to productionize this SDK. If you want to write
 workflows and activities in Rust, feel free to use it - but be aware that the API may change at any
-time without warning and we do not provide any support guarantees.
+time without warning and we do not provide any support guarantees.
+

package/sdk-core/client/Cargo.toml

@@ -20,12 +20,13 @@ futures = "0.3"
 futures-retry = "0.6.0"
 http = "0.2"
 once_cell = "1.13"
-opentelemetry = { version = "0.18", features = ["metrics"] }
+opentelemetry = { workspace = true, features = ["metrics"] }
 parking_lot = "0.12"
 prost-types = "0.11"
+slotmap = "1.0"
 thiserror = "1.0"
 tokio = "1.1"
-tonic = { version = "0.8", features = ["tls", "tls-roots"] }
+tonic = { workspace = true, features = ["tls", "tls-roots"] }
 tower = "0.4"
 tracing = "0.1"
 url = "2.2"
@@ -33,7 +34,9 @@ uuid = { version = "1.1", features = ["v4"] }
 
 [dependencies.temporal-sdk-core-protos]
 path = "../sdk-core-protos"
-version = "0.1"
+
+[dependencies.temporal-sdk-core-api]
+path = "../core-api"
 
 [dev-dependencies]
 assert_matches = "1"