@temporalio/core-bridge 0.21.1 → 1.0.0-rc.0

package/Cargo.lock

@@ -43,6 +43,17 @@ version = "1.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "c5d78ce20460b82d3fa150275ed9d55e21064fc7951177baacf86a145c4a4b1f"
 
+[[package]]
+name = "async-channel"
+version = "1.6.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2114d64672151c0c5eaa5e131ec84a74f06e1e559830dabba01ca30605d66319"
+dependencies = [
+ "concurrent-queue",
+ "event-listener",
+ "futures-core",
+]
+
 [[package]]
 name = "async-stream"
 version = "0.3.3"
@@ -134,6 +145,15 @@ version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
+[[package]]
+name = "concurrent-queue"
+version = "1.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "30ed07550be01594c6026cff2a1d7fe9c8f683caa798e12b68694ac9e88286a3"
+dependencies = [
+ "cache-padded",
+]
+
 [[package]]
 name = "convert_case"
 version = "0.4.0"
@@ -225,12 +245,6 @@ dependencies = [
  "lazy_static",
 ]
 
-[[package]]
-name = "cslice"
-version = "0.2.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "697c714f50560202b1f4e2e09cd50a421881c83e9025db75d15f276616f04f40"
-
 [[package]]
 name = "darling"
 version = "0.14.0"
@@ -361,6 +375,12 @@ dependencies = [
  "syn",
 ]
 
+[[package]]
+name = "event-listener"
+version = "2.5.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "77f3309417938f28bf8228fcff79a4a37103981e3e186d2ccd19c74b38f4eb71"
+
 [[package]]
 name = "fastrand"
 version = "1.7.0"
@@ -489,6 +509,12 @@ version = "0.3.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "57c66a976bf5909d801bbef33416c41372779507e7a6b3a5e25e4749c58f776a"
 
+[[package]]
+name = "futures-timer"
+version = "3.0.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e64b03909df88034c26dc1547e8970b91f98bdb65165d6a4e9110d94263dbb2c"
+
 [[package]]
 name = "futures-util"
 version = "0.3.21"
@@ -518,6 +544,23 @@ dependencies = [
  "wasi 0.10.2+wasi-snapshot-preview1",
 ]
 
+[[package]]
+name = "governor"
+version = "0.4.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "19775995ee20209163239355bc3ad2f33f83da35d9ef72dea26e5af753552c87"
+dependencies = [
+ "dashmap 5.2.0",
+ "futures",
+ "futures-timer",
+ "no-std-compat",
+ "nonzero_ext",
+ "parking_lot 0.12.0",
+ "quanta",
+ "rand",
+ "smallvec",
+]
+
 [[package]]
 name = "h2"
 version = "0.3.13"
@@ -744,6 +787,15 @@ dependencies = [
  "hashbrown",
 ]
 
+[[package]]
+name = "mach"
+version = "0.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b823e83b2affd8f40a9ee8c29dbc56404c1e34cd2710921f2801e2cf29527afa"
+dependencies = [
+ "libc",
+]
+
 [[package]]
 name = "matchers"
 version = "0.1.0"
@@ -832,11 +884,10 @@ checksum = "e5ce46fe64a9d73be07dcbe690a38ce1b293be448fd8ce1e6c1b8062c9f72c6a"
 
 [[package]]
 name = "neon"
-version = "0.8.3"
+version = "0.10.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "05c562b89fa7f9707f02056abe25a37ec290ca4a4f1596edbd7aa1aa7b87af1d"
+checksum = "28e15415261d880aed48122e917a45e87bb82cf0260bb6db48bbab44b7464373"
 dependencies = [
- "cslice",
  "neon-build",
  "neon-macros",
  "neon-runtime",
@@ -846,31 +897,44 @@ dependencies = [
 
 [[package]]
 name = "neon-build"
-version = "0.8.3"
+version = "0.10.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f9c55f6d310757b9fe6cd96a376609548a252da31828f935a7f59106533a89e9"
+checksum = "8bac98a702e71804af3dacfde41edde4a16076a7bbe889ae61e56e18c5b1c811"
 
 [[package]]
 name = "neon-macros"
-version = "0.8.3"
+version = "0.10.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "47065bc93b16f41fcfe29cad7d4d2a3e299b4389a3c9b429ba7a55f69a057fff"
+checksum = "b7288eac8b54af7913c60e0eb0e2a7683020dffa342ab3fd15e28f035ba897cf"
 dependencies = [
  "quote",
  "syn",
+ "syn-mid",
 ]
 
 [[package]]
 name = "neon-runtime"
-version = "0.8.3"
+version = "0.10.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "be313e6cf11f469653ee1b137b9203f5d604f2b496d423e96c5e251b51eead03"
+checksum = "4676720fa8bb32c64c3d9f49c47a47289239ec46b4bdb66d0913cc512cb0daca"
 dependencies = [
  "cfg-if",
  "libloading",
  "smallvec",
 ]
 
+[[package]]
+name = "no-std-compat"
+version = "0.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b93853da6d84c2e3c7d730d6473e8817692dd89be387eb01b94d7f108ecb5b8c"
+
+[[package]]
+name = "nonzero_ext"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "38bf9645c8b145698bb0b18a4637dcacbc421ea49bef2317e4fd8065a387cf21"
+
 [[package]]
 name = "normalize-line-endings"
 version = "0.3.0"
@@ -1201,6 +1265,22 @@ version = "2.27.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "cf7e6d18738ecd0902d30d1ad232c9125985a3422929b16c65517b38adc14f96"
 
+[[package]]
+name = "quanta"
+version = "0.9.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "20afe714292d5e879d8b12740aa223c6a88f118af41870e8b6196e39a02238a8"
+dependencies = [
+ "crossbeam-utils",
+ "libc",
+ "mach",
+ "once_cell",
+ "raw-cpuid",
+ "wasi 0.10.2+wasi-snapshot-preview1",
+ "web-sys",
+ "winapi",
+]
+
 [[package]]
 name = "quote"
 version = "1.0.18"
@@ -1240,6 +1320,15 @@ dependencies = [
  "getrandom",
 ]
 
+[[package]]
+name = "raw-cpuid"
+version = "10.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "738bc47119e3eeccc7e94c4a506901aea5e7b4944ecd0829cbebf4af04ceda12"
+dependencies = [
+ "bitflags",
+]
+
 [[package]]
 name = "redox_syscall"
 version = "0.2.13"
@@ -1550,6 +1639,17 @@ dependencies = [
  "unicode-xid",
 ]
 
+[[package]]
+name = "syn-mid"
+version = "0.5.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baa8e7560a164edb1621a55d18a0c59abf49d360f47aa7b821061dd7eea7fac9"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "tempfile"
 version = "3.3.0"
@@ -1568,6 +1668,7 @@ dependencies = [
 name = "temporal-client"
 version = "0.1.0"
 dependencies = [
+ "anyhow",
  "async-trait",
  "backoff",
  "derive_builder",
@@ -1576,6 +1677,7 @@ dependencies = [
  "futures-retry",
  "http",
  "opentelemetry 0.17.0",
+ "parking_lot 0.12.0",
  "prost-types",
  "temporal-sdk-core-protos",
  "thiserror",
@@ -1593,6 +1695,7 @@ version = "0.1.0"
 dependencies = [
  "anyhow",
  "arc-swap",
+ "async-channel",
  "async-trait",
  "base64",
  "crossbeam",
@@ -1601,6 +1704,7 @@ dependencies = [
  "derive_more",
  "enum_dispatch",
  "futures",
+ "governor",
  "http",
  "hyper",
  "itertools",
@@ -1682,11 +1786,13 @@ dependencies = [
  "neon",
  "once_cell",
  "opentelemetry 0.16.0",
+ "parking_lot 0.12.0",
  "prost",
  "prost-types",
  "temporal-client",
  "temporal-sdk-core",
  "tokio",
+ "tokio-stream",
 ]
 
 [[package]]

package/Cargo.toml

@@ -19,11 +19,13 @@ incremental = false
 [dependencies]
 futures = { version = "0.3", features = ["executor"] }
 log = "0.4"
-neon = { version = "0.8.0", default-features = false, features = ["napi-4", "event-queue-api"] }
+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"
 tokio = "1.13"
 once_cell = "1.7.2"
 temporal-sdk-core = { version = "*", path = "./sdk-core/core" }
 temporal-client = { version = "*", path = "./sdk-core/client" }
+tokio-stream = "0.1"

package/README.md

@@ -2,4 +2,4 @@
 
 [![NPM](https://img.shields.io/npm/v/@temporalio/core-bridge?style=for-the-badge)](https://www.npmjs.com/package/@temporalio/core-bridge)
 
-Part of [Temporal](https://temporal.io)'s [TypeScript SDK](https://docs.temporal.io/docs/typescript/introduction/).
+Part of [Temporal](https://temporal.io)'s [TypeScript SDK](https://docs.temporal.io/typescript/introduction/).

package/index.d.ts

@@ -27,15 +27,6 @@ export interface ClientOptions {
    */
   url: 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;
 
@@ -51,35 +42,133 @@ export interface ClientOptions {
    * Optional retry options for server requests.
    */
   retry?: RetryOptions;
-}
 
-export interface TelemetryOptions {
   /**
-   * If set, telemetry is turned on and this URL must be the URL of a gRPC
-   * OTel collector.
+   * Optional mapping of gRPC metadata (HTTP headers) to send with each request to the server.
+   *
+   * Set statically at connection time, can be replaced later using {@link clientUpdateHeaders}.
    */
-  oTelCollectorUrl?: string;
+  metadata?: Record<string, string>;
+}
+
+/**
+ * Log directly to console
+ */
+export interface ConsoleLogger {
+  console: {};
+}
+
+/**
+ * Forward logs to {@link Runtime} logger
+ */
+export interface ForwardLogger {
+  forward: {
+    /**
+     * What level, if any, logs should be forwarded from core at
+     *
+     */
+    // These strings should match the log::LevelFilter enum in rust
+    level: LogLevel;
+  };
+}
+
+/**
+ * Logger types supported by Core
+ */
+export type Logger = ConsoleLogger | ForwardLogger;
+
+/**
+ * OpenTelemetry Collector options for exporting metrics or traces
+ */
+export interface OtelCollectorExporter {
+  otel: {
+    /**
+     * URL of a gRPC OpenTelemetry collector.
+     */
+    url: string;
+    /**
+     * Optional set of HTTP request headers to send to Collector (e.g. for authentication)
+     */
+    headers?: Record<string, string>;
+  };
+}
+
+/**
+ * Prometheus metrics exporter options
+ */
+export interface PrometheusMetricsExporter {
+  prometheus: {
+    /**
+     * Address to bind the Prometheus HTTP metrics exporter server
+     * (for example, `0.0.0.0:1234`).
+     *
+     * Metrics will be available for scraping under the standard `/metrics` route.
+     */
+    bindAddress: string;
+  };
+}
+
+/**
+ * Metrics exporters supported by Core
+ */
+export type MetricsExporter = PrometheusMetricsExporter | OtelCollectorExporter;
+
+/**
+ * Trace exporters supported by Core
+ */
+export type TraceExporter = OtelCollectorExporter;
+
+export interface TelemetryOptions {
   /**
    * 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
+   *
+   * @default `temporal_sdk_core=WARN`
    */
   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.
+
+  /**
+   * If set true, do not prefix metrics with `temporal_`. Will be removed eventually as
+   * the prefix is consistent with other SDKs.
+   *
+   * @default `false`
+   */
+  noTemporalPrefixForMetrics?: boolean;
+
+  /**
+   * Control where to send Rust Core logs
+   *
+   * @default log to console
+   */
+  logging?: Logger;
+
+  /**
+   * Control where to send traces generated by Rust Core, optional and turned off by default.
    *
-   *  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.
+   * This is typically used for profiling SDK internals.
    */
-  prometheusMetricsBindAddress?: string;
+  tracing?: TraceExporter;
+
+  /**
+   * Control exporting {@link NativeConnection} and {@link Worker} metrics.
+   *
+   * Turned off by default
+   */
+  metrics?: MetricsExporter;
 }
 
 export interface WorkerOptions {
+  /**
+   * 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
+   */
+  buildId: string;
+
   /**
    * The task queue the worker will pull from
    */
@@ -87,16 +176,14 @@ export interface WorkerOptions {
 
   maxConcurrentActivityTaskExecutions: number;
   maxConcurrentWorkflowTaskExecutions: number;
-  maxConcurrentWorkflowTaskPolls: number;
-  maxConcurrentActivityTaskPolls: number;
+  maxConcurrentLocalActivityExecutions: 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.
+   * If set to `false` this worker will only handle workflow tasks and local activities, it will not
+   * poll for activity tasks.
    */
-  nonStickyToStickyPollRatio: number;
+  enableNonLocalActivities: boolean;
+
   /**
    * 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.
@@ -121,6 +208,21 @@ export interface WorkerOptions {
    * @default 30 seconds
    */
   defaultHeartbeatThrottleIntervalMs: number;
+
+  /**
+   * Sets the maximum number of activities per second the task queue will dispatch, controlled
+   * server-side. Note that this only takes effect upon an activity poll request. If multiple
+   * workers on the same queue have different values set, they will thrash with the last poller
+   * winning.
+   */
+  maxTaskQueueActivitiesPerSecond?: number;
+
+  /**
+   * Limits the number of activities per second that this worker will process. The worker will
+   * not poll for new activities if by doing so it might receive and execute an activity which
+   * would cause it to exceed this limit. Must be a positive floating point number.
+   */
+  maxActivitiesPerSecond?: number;
 }
 
 /** Log level - must match rust log level names */
@@ -161,7 +263,13 @@ export declare function newReplayWorker(
   history: ArrayBuffer,
   callback: WorkerCallback
 ): void;
-export declare function workerShutdown(worker: Worker, callback: VoidCallback): void;
+export declare function workerInitiateShutdown(worker: Worker, callback: VoidCallback): void;
+export declare function workerFinalizeShutdown(worker: Worker): void;
+export declare function clientUpdateHeaders(
+  client: Client,
+  headers: Record<string, string>,
+  callback: VoidCallback
+): void;
 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/core-bridge",
-  "version": "0.21.1",
+  "version": "1.0.0-rc.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.0.3",
-    "@temporalio/internal-non-workflow-common": "^0.21.0",
+    "@temporalio/internal-non-workflow-common": "^1.0.0-rc.0",
     "arg": "^5.0.1",
     "cargo-cp-artifact": "^0.1.4",
     "which": "^2.0.2"
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c241ab2f8e92966555dbd6d01dc072c8965ee6f4"
+  "gitHead": "c25e91309b980f2118df4048d760306982019871"
 }

package/sdk-core/.buildkite/docker/docker-compose.yaml

@@ -9,7 +9,7 @@ services:
   #      - '9042:9042'
 
   temporal:
-    image: temporalio/auto-setup:1.15.0
+    image: temporalio/auto-setup:1.16.2
     ports:
       - "7233:7233"
       - "7234:7234"
@@ -21,17 +21,20 @@ services:
 #      - "6939:6939"
     environment:
       - "CASSANDRA_SEEDS=cassandra"
-      - "DYNAMIC_CONFIG_FILE_PATH=config/dynamicconfig/development.yaml"
+      - "DYNAMIC_CONFIG_FILE_PATH=/etc/dynamic-config.yaml"
+    volumes:
+      - ../../etc/dynamic-config.yaml:/etc/dynamic-config.yaml
     depends_on:
       - cassandra
 
   temporal-web:
-    image: temporalio/web:1.13.0
+    image: temporalio/ui:0.10.2
     logging:
       driver: none
     ports:
-      - "8088:8088"
+      - "8080:8080"
     environment:
-      - "TEMPORAL_GRPC_ENDPOINT=temporal:7233"
+      - TEMPORAL_ADDRESS=temporal:7233
+      - TEMPORAL_CORS_ORIGINS=http://localhost:3000
     depends_on:
       - temporal

package/sdk-core/ARCHITECTURE.md

@@ -20,10 +20,9 @@ There are many concepts involved in the chain of communication from server->core
 * `HistoryEvent` (often referred to simply as an `Event`): These events come from the server and represent the history of the workflow. They are defined in the protobuf definitions for the Temporal service itself.
 * `Command`: These are the commands defined in the temporal service protobufs that are returned by clients upon completing a `WorkflowTask`. For example, starting a timer or an activity.
 * `WorkflowTask`: These are how the server represents the need to run user workflow code (or the result of it executing). See the `HistoryEvent` proto definition for more.
-* `WfActivation` (said "WorkflowActivation"): These are produced by the Core SDK when the lang sdk needs to "activate" the user's workflow code, either running it from the beginning or resuming a cached workflow.
-* `WfActivationJob` (shorthand: `Job`s): These are included in `WfActivation`s and represent the actual things that have happened since the last time the workflow was activated (if ever). EX: Firing a timer, proceeding with the result of an activity, etc. They are all ultimately derived from `HistoryEvent`s.
-* `Task`: Returned from calls to `Core::poll_task`, these tasks represent work for the lang SDK to perform, which includes both workflow activations, and instructions to run activities (`ActivityTask`).
-* `TaskCompletion`: Provided by the lang side when calling `Core::complete_task`. Can be the result of a `WfActivation` or an `ActivityTask`. In the case of workflow activations, the (successful) completion contains one or more `Command`s, which may be literal `Command`s as defined in the Temporal service protobufs, or may be `CoreCommand`s, which support things like query responses.
+* `WorkflowActivation`: These are produced by the Core SDK when the lang sdk needs to "activate" the user's workflow code, either running it from the beginning or resuming a cached workflow.
+* `WorkflowActivationJob` (shorthand: `Job`s): These are included in `WorkflowActivation`s and represent the actual things that have happened since the last time the workflow was activated (if ever). EX: Firing a timer, proceeding with the result of an activity, etc. They are typically derived from `HistoryEvent`s, but also include things like evicting a run from the cache.
+* `WorkflowActivationCompletion`: Provided by the lang side when completing an activation. The (successful) completion contains one or more `WorkflowCommand`s, which are often translated into `Command`s as defined in the Temporal service protobufs, but also include things like query responses.
 
 Additional clarifications that are internal to Core:
 * `StateMachine`s also handle events and produce commands, which often map directly to the above `HistoryEvent`s and `Command`s, but are distinct types. The state machine library is Temporal agnostic - but all interactions with the machines pass through a `TemporalStateMachine` trait, which accepts `HistoryEvent`s, and produces `WorkflowTrigger`s.
@@ -33,7 +32,7 @@ Additional clarifications that are internal to Core:
 ### Core SDK Responsibilities
 
 - Communication with Temporal service using a generated gRPC client, which is wrapped with somewhat more ergonomic traits.
-- Provide interface for language-specific SDK to drive event loop and handle returned commands. The lang sdk will continuously call/poll the core SDK to receive new `Task`s, which are either represent workflows being started or awoken (`WFActivation`) or activities to execute (`ActivityTask`). It will then call it's workflow/activity functions with the provided information as appropriate, and will then push completed tasks back into the core SDK.
+- Provide interface for language-specific SDK to drive event loop and handle returned commands. The lang sdk will continuously call/poll the core SDK to receive new tasks, which either represent workflows being started or awoken (`WorkflowActivation`) or activities to execute (`ActivityTask`). It will then call its workflow/activity functions with the provided information as appropriate, and will then push completed tasks back into the core SDK.
 - Advance state machines and report back to the temporal server as appropriate when handling events and commands
 
 ### Language Specific SDK Responsibilities
@@ -61,7 +60,7 @@ async fn hello_activity(name: &str) -> String {
 }
 ```
 
-[![](https://mermaid.ink/img/eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG4gICAgcGFydGljaXBhbnQgUyBhcyBUZW1wb3JhbCBTZXJ2aWNlXG4gICAgcGFydGljaXBhbnQgQyBhcyBDb3JlIFNES1xuICAgIHBhcnRpY2lwYW50IEwgYXMgTGFuZyBTREtcblxuICAgIEwgLT4-IEM6IEluaXRpYWxpemUgd29ya2VyXG4gICAgTCAtPj4gUzogZ3JwYzogU3RhcnRXb3JrZmxvd0V4ZWN1dGlvblxuXG4gICAgbG9vcCB3b3JrZmxvdyB0YXNrIHByb2Nlc3NpbmdcbiAgICBDIC0-PiBTOiBncnBjOiBQb2xsV29ya2Zsb3dUYXNrUXVldWVcbiAgICBTIC0tPj4gQzogVGFza3MgJiBoaXN0b3J5ICAgXG4gICAgQyAtPj4gQzogQXBwbHkgaGlzdG9yeSB0byBzdGF0ZSBtYWNoaW5lc1xuICAgIFxuICAgIGxvb3AgZXZlbnQgbG9vcFxuICAgIEwgLT4-IEM6IFBvbGwgZm9yIHNkayBldmVudHNcbiAgICBMIC0-PiBMOiBSdW4gd29ya2Zsb3csIHByb2R1Y2VzIGNvbW1hbmRzXG4gICAgTCAtLT4-IEM6IFdvcmtmbG93IEFjdGl2YXRpb24gZG9uZSB3LyBjb21tYW5kc1xuICAgIEMgLT4-IEM6IEFkdmFuY2Ugc3RhdGUgbWFjaGluZXNcbiAgICBlbmRcblxuICAgIEMgLT4-IFM6IGdycGM6IFJlc3BvbmRXb3JrZmxvd1Rhc2tDb21wbGV0ZWRcbiAgICBlbmRcblxuICAgIEwgLT4-IEM6IFNodXRkb3duXG4iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ)](https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG4gICAgcGFydGljaXBhbnQgUyBhcyBUZW1wb3JhbCBTZXJ2aWNlXG4gICAgcGFydGljaXBhbnQgQyBhcyBDb3JlIFNES1xuICAgIHBhcnRpY2lwYW50IEwgYXMgTGFuZyBTREtcblxuICAgIEwgLT4-IEM6IEluaXRpYWxpemUgd29ya2VyXG4gICAgTCAtPj4gUzogZ3JwYzogU3RhcnRXb3JrZmxvd0V4ZWN1dGlvblxuXG4gICAgbG9vcCB3b3JrZmxvdyB0YXNrIHByb2Nlc3NpbmdcbiAgICBDIC0-PiBTOiBncnBjOiBQb2xsV29ya2Zsb3dUYXNrUXVldWVcbiAgICBTIC0tPj4gQzogVGFza3MgJiBoaXN0b3J5ICAgXG4gICAgQyAtPj4gQzogQXBwbHkgaGlzdG9yeSB0byBzdGF0ZSBtYWNoaW5lc1xuICAgIFxuICAgIGxvb3AgZXZlbnQgbG9vcFxuICAgIEwgLT4-IEM6IFBvbGwgZm9yIHNkayBldmVudHNcbiAgICBMIC0-PiBMOiBSdW4gd29ya2Zsb3csIHByb2R1Y2VzIGNvbW1hbmRzXG4gICAgTCAtLT4-IEM6IFdvcmtmbG93IEFjdGl2YXRpb24gZG9uZSB3LyBjb21tYW5kc1xuICAgIEMgLT4-IEM6IEFkdmFuY2Ugc3RhdGUgbWFjaGluZXNcbiAgICBlbmRcblxuICAgIEMgLT4-IFM6IGdycGM6IFJlc3BvbmRXb3JrZmxvd1Rhc2tDb21wbGV0ZWRcbiAgICBlbmRcblxuICAgIEwgLT4-IEM6IFNodXRkb3duXG4iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ)
+[![](https://mermaid.ink/img/pako:eNptk81O6zAQhV9l5AWr8gIRqoQCC0QXQJDuJpvBnrZWbY-vf9rbi3h3bJqE0JKVlfP5zMyx_S4kKxKNiPQ3k5N0p3ET0PYOyucxJC21R5egA4zwStZzQAMdhb2WdIm1FWs5EHR3j5fyqsordJuTfAJWcL1cQtvAg9NJo9H_CQ4cdhTmetfAJnjZQJeK4Z-irw0f7v-RzEmzG80Ms__aXVVIGHfgA0uKUbvNCWl_-j2xMaPda-GfM-Vhsg6uh9aqEOEKtjomDseizb0KcOu9OU5yYogJE4FFudWO4ometUh7KnnU5VkItR1YcwCUSe-xzhanWpVZNTC2ezshc5MCvGQ3hbCoAahcIgDJ1qJTcaKHmpd-LVtvqK5u3sJSskuoXUnwzOJ7fLXHcn1-nZqcGk_nLPoXip6dmqc_FCZ1sXdKqNvmpPhQfouFsBQsalWu8HvFepG2ZKkXTVkqDLte9O6jcNmr0tm90uV8RLNGE2khMCfujk6KJoVMIzS8gYH6-ASOZQf0)](https://mermaid-js.github.io/mermaid-live-editor/edit#pako:eNptk81O6zAQhV9l5AWr8gIRqoQCC0QXQJDuJpvBnrZWbY-vf9rbi3h3bJqE0JKVlfP5zMyx_S4kKxKNiPQ3k5N0p3ET0PYOyucxJC21R5egA4zwStZzQAMdhb2WdIm1FWs5EHR3j5fyqsordJuTfAJWcL1cQtvAg9NJo9H_CQ4cdhTmetfAJnjZQJeK4Z-irw0f7v-RzEmzG80Ms__aXVVIGHfgA0uKUbvNCWl_-j2xMaPda-GfM-Vhsg6uh9aqEOEKtjomDseizb0KcOu9OU5yYogJE4FFudWO4ometUh7KnnU5VkItR1YcwCUSe-xzhanWpVZNTC2ezshc5MCvGQ3hbCoAahcIgDJ1qJTcaKHmpd-LVtvqK5u3sJSskuoXUnwzOJ7fLXHcn1-nZqcGk_nLPoXip6dmqc_FCZ1sXdKqNvmpPhQfouFsBQsalWu8HvFepG2ZKkXTVkqDLte9O6jcNmr0tm90uV8RLNGE2khMCfujk6KJoVMIzS8gYH6-ASOZQf0)
 
 ## API Definition
 
@@ -71,4 +70,7 @@ See the latest API definition [here](https://github.com/temporalio/sdk-core/blob
 
 
 ## Other topics
-- [Sticky task queues](arch_docs/sticky_queues.md)
+- [Sticky task queues](arch_docs/sticky_queues.md)
+
+## Workflow Processing Internals
+![Workflow Internals](arch_docs/diagrams/workflow_internals.svg)

package/sdk-core/README.md

@@ -61,6 +61,7 @@ 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`
 
 If you are working on a language SDK, you are expected to initialize tracing early in your `main`
@@ -70,7 +71,10 @@ equivalent.
 
 This repo uses a subtree for upstream protobuf files. The path `protos/api_upstream` is a
 subtree. To update it, use:
-`git subtree pull --prefix protos/api_upstream/ git://github.com/temporalio/api.git master --squash`
+
+`git pull --squash -s subtree ssh://git@github.com/temporalio/api.git master --allow-unrelated-histories`
+
+Do not question why this git command is the way it is. It is not our place to interpret git's ways.
 
 ## Fetching Histories
 Tests which would like to replay stored histories rely on that history being made available in