Skip to content

fix(taskbroker): Replace worker_map Default Instead of Merging #756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
george-sentry merged 4 commits into from
Jul 16, 2026
Merged

fix(taskbroker): Replace worker_map Default Instead of Merging #756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
db9979f
Remove `worker_map` Default
george-sentry Jul 16, 2026
e8b663a
Better Worker Connection Logging
george-sentry Jul 16, 2026
779da43
Replace `worker_map` Instead of Merge
george-sentry Jul 16, 2026
30237f5
Add Worker Map Validation, Update Tests
george-sentry Jul 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 55 additions & 28 deletions src/config/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ pub struct Config {
pub status_update_interval_ms: u64,

/// Maps every application to its worker endpoint, both represented as strings.
#[validate(length(min = 1))]
pub worker_map: BTreeMap<String, String>,

/// The namespace to assign to raw mode activations.
Expand Down Expand Up @@ -276,7 +277,7 @@ impl Default for Config {
batch_status_updates: false,
status_update_batch_size: 1,
status_update_interval_ms: 100,
worker_map: [("sentry".into(), "http://127.0.0.1:50052".into())].into(),
worker_map: [].into(),
raw_namespace: None,
raw_application: None,
raw_taskname: None,
Expand All @@ -300,6 +301,15 @@ impl Config {
builder = builder.merge(Env::prefixed("TASKBROKER_").split("__"));
let mut config: Config = builder.extract()?;

let worker_map_provided = builder
.find_metadata("worker_map")
.is_some_and(|metadata| metadata.name != DEFAULT_CONFIG_PROVIDER);

// Only provide a default worker map if the user didn't provide one.
if !worker_map_provided {
config.worker_map = [("sentry".into(), "http://127.0.0.1:50052".into())].into();
}

Comment thread
cursor[bot] marked this conversation as resolved.
// Map deprecated fields to current fields
config.map_deprecated_options(&mut builder);

Expand Down Expand Up @@ -894,7 +904,6 @@ mod tests {
use figment::Jail;
use validator::Validate;

use crate::config::fetch::FetchConfig;
use crate::logging::LogFormat;
use crate::{Args, Run};

Expand All @@ -915,23 +924,21 @@ mod tests {
assert_eq!(config.store.max_pending_count, 2048);
assert_eq!(config.store.max_processing_count, 2048);
assert_eq!(config.store.sqlite.vacuum_page_count, None);
assert_eq!(
config.worker_map.get("sentry").map(String::as_str),
Some("http://127.0.0.1:50052")
);
assert!(config.worker_map.is_empty());
}

#[test]
fn test_validate_rejects_invalid_fields() {
let mut config = Config {
fetch: FetchConfig {
threads: 0,
..Default::default()
},
..Default::default()
};
let mut config = Config::default();

// Worker map cannot be empty
assert!(config.validate().is_err());

config.worker_map = [("sentry".into(), "http://sentry:50052".into())].into();
assert!(config.validate().is_ok());

// Fetch threads cannot be zero
config.fetch.threads = 0;
assert!(config.validate().is_err());

config.fetch.threads = 1;
Expand Down Expand Up @@ -1027,8 +1034,8 @@ mod tests {
vacuum_page_count: 1000
full_vacuum_on_start: true
worker_map:
sentry: http://worker-sentry:50052
launchpad: http://worker-launchpad:50053
sentry: http://sentry:50052
launchpad: http://launchpad:50052
"#,
)?;
// Env vars always override config file
Expand Down Expand Up @@ -1067,18 +1074,42 @@ mod tests {
assert_eq!(
config.worker_map,
BTreeMap::from([
("sentry".to_owned(), "http://worker-sentry:50052".to_owned(),),
(
"launchpad".to_owned(),
"http://worker-launchpad:50053".to_owned(),
),
("sentry".to_owned(), "http://sentry:50052".to_owned(),),
("launchpad".to_owned(), "http://launchpad:50052".to_owned(),),
])
);

Ok(())
});
}

#[test]
fn test_worker_map_from_config_file_replaces_default() {
Jail::expect_with(|jail| {
jail.create_file(
"config.yaml",
r#"
worker_map:
launchpad: http://launchpad:50052
"#,
)?;

let args = Args {
run: Run::Broker,
config: Some("config.yaml".to_owned()),
};

let config = Config::from_args(&args).unwrap();

assert_eq!(
config.worker_map,
BTreeMap::from([("launchpad".to_owned(), "http://launchpad:50052".to_owned(),)])
);

Ok(())
});
}

#[test]
fn test_from_args_env_and_args() {
Jail::expect_with(|jail| {
Expand Down Expand Up @@ -1133,9 +1164,8 @@ mod tests {
BTreeMap::from([("key".to_owned(), "value".to_owned())])
);
assert_eq!(
config.worker_map.get("sentry").map(String::as_str),
Some("http://127.0.0.1:50052"),
"partial env override must not drop worker_map defaults"
config.worker_map,
BTreeMap::from([("sentry".to_owned(), "http://127.0.0.1:50052".to_owned(),)])
);

Ok(())
Expand All @@ -1149,7 +1179,7 @@ mod tests {
jail.set_env("TASKBROKER_LOG_FILTER", "error");
jail.set_env(
"TASKBROKER_WORKER_MAP",
"{sentry=http://127.0.0.1:60052,launchpad=http://127.0.0.1:60053}",
"{launchpad=http://127.0.0.1:50052}",
);

let args = Args {
Expand All @@ -1159,10 +1189,7 @@ mod tests {
let config = Config::from_args(&args).unwrap();
assert_eq!(
config.worker_map,
BTreeMap::from([
("sentry".to_owned(), "http://127.0.0.1:60052".to_owned(),),
("launchpad".to_owned(), "http://127.0.0.1:60053".to_owned(),),
])
BTreeMap::from([("launchpad".to_owned(), "http://127.0.0.1:50052".to_owned(),)])
);

Ok(())
Expand Down
11 changes: 8 additions & 3 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,14 +318,19 @@ async fn main() -> Result<(), Error> {
let mut map = HashMap::new();

for (application, endpoint) in config.worker_map.clone() {
let worker = match Worker::connect(config.clone(), endpoint).await {
let worker = match Worker::connect(config.clone(), endpoint.clone()).await {

@evanh evanh Jul 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good point, can we have the startup fail if the worker map is empty?

@george-sentry george-sentry Jul 16, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yepp, I added a validate attribute to the worker_map field to make sure it has at least one entry. Also, I changed the code to use a default when the user doesn't provide anything. But this time, the user's worker_map replaces the default instead of merging with it.

Ok(w) => {
Comment thread
sentry[bot] marked this conversation as resolved.
debug!("Connected to worker!");
debug!(application, endpoint, "Connected to worker!");
Box::new(w) as Box<dyn WorkerClient>
}

Err(e) => {
error!(error = ?e, "Failed to connect to worker");
error!(
application,
endpoint,
error = ?e,
"Failed to connect to worker"
);
return Err(e);
}
};
Expand Down
Loading