Move core-specific test utilities out of the common crate to sdk-core crate

Author: mjameswh

crates/common/Cargo.toml

@@ -14,7 +14,6 @@ exclude = ["protos/*/.github/*"]
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [features]
-history_builders = ["dep:rand"]
 otel = ["dep:opentelemetry", "dep:opentelemetry_sdk", "dep:opentelemetry-otlp"]
 prometheus = [
   "dep:prometheus",
@@ -25,7 +24,6 @@ prometheus = [
 ]
 envconfig = ["dep:toml", "dep:dirs"]
 serde_serialize = []
-test-utilities = ["history_builders"]
 core-telemetry-bridge = ["dep:ringbuf", "dep:futures-channel"]
 core-based-sdk = ["core-telemetry-bridge", "prometheus", "envconfig"]
 
@@ -70,7 +68,6 @@ prometheus = { version = "0.14", optional = true, default-features = false }
 prost = { workspace = true }
 prost-wkt = "0.7"
 prost-types = { workspace = true }
-rand = { version = "0.10", optional = true }
 ringbuf = { version = "0.4", optional = true }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = { workspace = true }

crates/common/src/protos/mod.rs

@@ -6,26 +6,10 @@ pub mod constants;
 /// Utility functions for working with protobuf types.
 pub mod utilities;
 
-#[cfg(feature = "test-utilities")]
-/// Pre-built test histories for common workflow patterns.
-pub mod canned_histories;
-#[cfg(feature = "history_builders")]
-mod history_builder;
-#[cfg(feature = "history_builders")]
-mod history_info;
 mod task_token;
-#[cfg(feature = "test-utilities")]
-pub mod test_utils;
 
 use std::time::Duration;
 
-#[cfg(feature = "history_builders")]
-pub use history_builder::{
-    DEFAULT_ACTIVITY_TYPE, DEFAULT_WORKFLOW_TYPE, TestHistoryBuilder, default_act_sched,
-    default_wes_attribs,
-};
-#[cfg(feature = "history_builders")]
-pub use history_info::HistoryInfo;
 pub use task_token::TaskToken;
 
 /// Payload metadata key that identifies the encoding format.

crates/sdk-core/Cargo.toml

@@ -27,6 +27,9 @@ otel = [
 ]
 ephemeral-server = ["dep:flate2", "dep:reqwest", "dep:tar", "dep:zip"]
 debug-plugin = ["dep:reqwest", "dep:hyper"]
+# Exposes mocks and helpers used by sdk-core's own integration tests, benches,
+# and the `histfetch` binary. Not part of the public API surface; downstream
+# crates should not enable this feature.
 test-utilities = ["dep:assert_matches", "dep:bimap"]
 antithesis_assertions = ["dep:antithesis_sdk"]
 
@@ -119,7 +122,7 @@ zip = { version = "8.4", optional = true, default-features = false, features = [
 path = "../common"
 version = "0.3"
 default-features = false
-features = ["core-telemetry-bridge", "history_builders"]
+features = ["core-telemetry-bridge"]
 
 [dependencies.temporalio-client]
 path = "../client"
@@ -149,9 +152,7 @@ hyper-util = { version = "0.1", features = [
 rstest = "0.26"
 semver = "1.0"
 temporalio-sdk = { path = "../sdk" }
-temporalio-common = { path = "../common", version = "0.3", default-features = false, features = [
-  "test-utilities",
-] }
+temporalio-common = { path = "../common", version = "0.3", default-features = false }
 tokio = { version = "1.47", default-features = false, features = [
   "rt",
   "rt-multi-thread",

crates/sdk-core/benches/workflow_replay_bench.rs

@@ -12,13 +12,13 @@ use std::{
     thread,
     time::Duration,
 };
-use temporalio_common::{
-    protos::{DEFAULT_WORKFLOW_TYPE, canned_histories},
-    telemetry::metrics::{MetricKeyValue, MetricParameters, NewAttributes},
-};
+use temporalio_common::telemetry::metrics::{MetricKeyValue, MetricParameters, NewAttributes};
 use temporalio_macros::{workflow, workflow_methods};
 use temporalio_sdk::{SyncWorkflowContext, WorkflowContext, WorkflowResult};
-use temporalio_sdk_core::{CoreRuntime, replay::HistoryForReplay};
+use temporalio_sdk_core::{
+    CoreRuntime,
+    replay::{DEFAULT_WORKFLOW_TYPE, HistoryForReplay, canned_histories},
+};
 
 pub fn criterion_benchmark(c: &mut Criterion) {
     let tokio_runtime = tokio::runtime::Builder::new_current_thread()

crates/sdk-core/src/core_tests/activity_tasks.rs

@@ -1,10 +1,11 @@
 use crate::{
     ActivityHeartbeat, CompleteActivityError, Worker, advance_fut, job_assert, prost_dur,
+    replay::{TestHistoryBuilder, canned_histories},
     test_help::{
         FakeWfResponses, MockPollCfg, MockWorkerInputs, MocksHolder, QueueResponse, WorkerExt,
         WorkflowCachingPolicy, build_fake_worker, build_mock_pollers, build_multihist_mock_sg,
         fanout_tasks, gen_assert_and_reply, mock_manual_poller, mock_poller, mock_worker,
-        poll_and_reply, single_hist_mock_sg, test_worker_cfg,
+        poll_and_reply, single_hist_mock_sg, start_timer_cmd, test_worker_cfg,
     },
     worker::{
         PollerBehavior,
@@ -26,7 +27,6 @@ use std::{
 };
 use temporalio_common::{
     protos::{
-        TestHistoryBuilder, canned_histories,
         coresdk::{
             ActivityTaskCompletion,
             activity_result::{
@@ -52,7 +52,6 @@ use temporalio_common::{
                 RespondActivityTaskFailedResponse, RespondWorkflowTaskCompletedResponse,
             },
         },
-        test_utils::start_timer_cmd,
     },
     worker::WorkerTaskTypes,
 };

crates/sdk-core/src/core_tests/mod.rs

@@ -8,6 +8,7 @@ mod workflow_tasks;
 
 use crate::{
     PollError, Worker,
+    replay::{TestHistoryBuilder, canned_histories},
     test_help::{
         MockPollCfg, build_mock_pollers, mock_worker, single_hist_mock_sg, test_worker_cfg,
     },
@@ -19,7 +20,6 @@ use crate::{
 use futures_util::FutureExt;
 use std::{sync::LazyLock, time::Duration};
 use temporalio_common::protos::{
-    TestHistoryBuilder, canned_histories,
     coresdk::{
         workflow_activation::{WorkflowActivationJob, workflow_activation_job},
         workflow_completion::WorkflowActivationCompletion,

crates/sdk-core/src/core_tests/queries.rs

@@ -1,7 +1,9 @@
 use crate::{
+    replay::{TestHistoryBuilder, canned_histories},
     test_help::{
         MockPollCfg, MocksHolder, ResponseType, WorkerExt, WorkerTestHelpers, build_mock_pollers,
-        hist_to_poll_resp, mock_worker, single_hist_mock_sg,
+        hist_to_poll_resp, mock_worker, query_ok, schedule_activity_cmd, single_hist_mock_sg,
+        start_timer_cmd,
     },
     worker::{
         LEGACY_QUERY_ID, WorkerVersioningStrategy,
@@ -19,7 +21,6 @@ use std::{
 };
 use temporalio_client::MESSAGE_TOO_LARGE_KEY;
 use temporalio_common::protos::{
-    TestHistoryBuilder, canned_histories,
     coresdk::{
         workflow_activation::{
             WorkflowActivationJob, remove_from_cache::EvictionReason, workflow_activation_job,
@@ -40,7 +41,6 @@ use temporalio_common::protos::{
             GetWorkflowExecutionHistoryResponse, RespondWorkflowTaskCompletedResponse,
         },
     },
-    test_utils::{query_ok, schedule_activity_cmd, start_timer_cmd},
 };
 
 #[rstest::rstest]

crates/sdk-core/src/core_tests/replay_flag.rs

@@ -1,16 +1,18 @@
 use crate::{
-    test_help::{MockPollCfg, ResponseType, build_mock_pollers, hist_to_poll_resp, mock_worker},
+    replay::{TestHistoryBuilder, canned_histories},
+    test_help::{
+        MockPollCfg, ResponseType, build_mock_pollers, hist_to_poll_resp, mock_worker, query_ok,
+        start_timer_cmd,
+    },
     worker::{LEGACY_QUERY_ID, client::mocks::mock_worker_client},
 };
 use std::{collections::VecDeque, time::Duration};
 use temporalio_common::protos::{
-    TestHistoryBuilder, canned_histories,
     coresdk::{
         workflow_activation::{WorkflowActivationJob, workflow_activation_job},
         workflow_completion::WorkflowActivationCompletion,
     },
     temporal::api::{enums::v1::EventType, query::v1::WorkflowQuery},
-    test_utils::{query_ok, start_timer_cmd},
 };
 
 #[tokio::test]

crates/sdk-core/src/core_tests/updates.rs

@@ -1,13 +1,13 @@
 use crate::{
     prost_dur,
+    replay::{DEFAULT_ACTIVITY_TYPE, TestHistoryBuilder},
     test_help::{
         MockPollCfg, PollWFTRespExt, ResponseType, WorkerTestHelpers, build_mock_pollers,
         hist_to_poll_resp, mock_worker,
     },
     worker::client::mocks::mock_worker_client,
 };
 use temporalio_common::protos::{
-    DEFAULT_ACTIVITY_TYPE, TestHistoryBuilder,
     coresdk::{
         workflow_activation::{WorkflowActivationJob, workflow_activation_job},
         workflow_commands::{

crates/sdk-core/src/core_tests/workers.rs

@@ -1,8 +1,10 @@
 use crate::{
     CompleteNexusError, PollError, prost_dur,
+    replay::canned_histories,
     test_help::{
         MockPollCfg, MockWorkerInputs, MocksHolder, QueueResponse, ResponseType, WorkerExt,
-        WorkerTestHelpers, build_fake_worker, build_mock_pollers, mock_worker, test_worker_cfg,
+        WorkerTestHelpers, build_fake_worker, build_mock_pollers, mock_worker, start_timer_cmd,
+        test_worker_cfg,
     },
     worker::{
         self, PollerBehavior,
@@ -24,7 +26,6 @@ use temporalio_common::protos::temporal::api::{
 };
 use temporalio_common::{
     protos::{
-        canned_histories,
         coresdk::{
             ActivityTaskCompletion,
             activity_result::ActivityExecutionResult,
@@ -55,7 +56,6 @@ use temporalio_common::{
                 RespondWorkflowTaskCompletedResponse, ShutdownWorkerResponse,
             },
         },
-        test_utils::start_timer_cmd,
     },
     worker::WorkerTaskTypes,
 };