Skip to content

docs(s3): correct client_timeout default — 30s (object_store), not "no timeout"#1912

Merged
lukekim merged 1 commit into
trunkfrom
docs-fix-s3-client-timeout-default
Jul 9, 2026
Merged

docs(s3): correct client_timeout default — 30s (object_store), not "no timeout"#1912
lukekim merged 1 commit into
trunkfrom
docs-fix-s3-client-timeout-default

Conversation

@claudespice

Copy link
Copy Markdown
Collaborator

Summary

The S3 connector's client_timeout row says "No timeout by default." This is incorrect — the effective default is a 30-second request timeout.

client_timeout has no .default() on its ParameterSpec (crates/runtime/src/dataconnector/s3.rs:193), but "no .default()" does not mean "no timeout." When the param is unset, the S3 object store is built from ClientOptions::default() (crates/runtime-object-store/src/registry/mod.rs:321; the param only overrides via with_timeout when present, line 332). object_store 0.13.2 ClientOptions::default() sets timeout: Some(Duration::from_secs(30)) (object_store-0.13.2/src/client/mod.rs:358, with the comment "we opt for a slightly higher default timeout of 30 seconds").

The connector's own timeout error message corroborates this: when client_timeout is unset it prints the effective value as "30s (default)" (s3.rs:386, .unwrap_or("30s (default)")).

Flip-flop note

The "No timeout by default" wording was introduced by #1455, which reasoned that because the ParameterSpec has no .default(), the value is None = no timeout. That is the documented "trace the runtime default, not the ParameterSpec declaration" trap: the downstream ClientOptions::default() supplies the 30s default. This PR restores the pre-#1455 "30s" default with the behavioral evidence above (the in-source "30s (default)" string), rather than re-flipping blindly.

What changed

No timeout by default.Defaults to `30s` (the underlying object store HTTP client default) when unset. on the S3 connector page, propagated to every versioned copy that carries the row (vNext + version-1.11.x + version-2.0.x + version-2.1.x, 4 files).

Source PRs

  • Verified against spiceai/spiceai at trunk: crates/runtime/src/dataconnector/s3.rs:193,386, crates/runtime-object-store/src/registry/mod.rs:321,332, object_store-0.13.2/src/client/mod.rs:358.

Test plan

  • grep -rn "No timeout by default" website/ → 0 hits after fix
  • Prose-only cell edit; no links, tags, or frontmatter changed. Local npm run build not run in this environment (no node_modules; full versioned build is memory-constrained) — CI Deploy check is the authoritative link/tag gate.
  • Files updated: 4

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

🚀 deployed to https://78c63c7e.spiceai-org-website.pages.dev

@lukekim lukekim merged commit 00de458 into trunk Jul 9, 2026
7 of 13 checks passed
@lukekim lukekim deleted the docs-fix-s3-client-timeout-default branch July 9, 2026 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants