Skip to content

feat(core): add HTTP adapter headers and body accessors - #1245

Merged
dpiet-oai merged 1 commit into
mainfrom
castiron/promotions/pr-294
Oct 20, 2026
Merged

dpiet-oai merged 1 commit into
mainfrom
castiron/promotions/pr-294

Conversation

@dpiet-oai

Copy link
Copy Markdown
Contributor

Custom HttpClient adapters currently rebuild header maps and bridge HttpRequestBody.writeTo(OutputStream) into an input stream. Add the two accessors discussed in openai-java#664:

Map<String, List<String>> headers = request.headers().asMap();
try (InputStream content = body.content()) {
    // Give content to the transport and wait for consumption to finish.
}
// Close body after the final attempt, including failure or cancellation.

Headers.asMap() exposes an immutable, case-insensitive view with immutable value lists. HttpRequestBody.content() has a default implementation for existing Java implementations; that fallback buffers writeTo() output. Built-in JSON bodies reuse their encoded bytes, while multipart bodies stream raw uploads lazily. Repeatability, close-once upload cleanup, and explicitly enabled DEBUG logging are preserved. HttpResponse.body() already returns an InputStream.

Includes coverage for header immutability, Java source/binary compatibility, multipart byte equivalence, shared uploads, early close and cleanup failures, cancellation, retries, and stream-based request logging.

Builds on Sylvester Kaczmarek's headers proposal #900 and request-stream proposal #923.

Validation: 296 selected tests passed; no failures or skips. Kotlin lint passed.

SKIP_MOCK_TESTS=true ./gradlew :openai-java-core:test \
  --tests '*HttpRequestBodyContentTest' --tests '*HttpRequestBodyJavaTest' \
  --tests '*HeadersMapViewTest' --tests '*LoggingHttpClientTest' \
  --tests '*HeadersTest' --tests '*HttpRequestBodiesTest' \
  --tests '*MultipartBodyCleanupTest' --tests '*RetryingHttpClientTest' \
  --tests '*UnionUploadStreaming*' :openai-java-core:lintKotlin

@github-actions

github-actions Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Castiron custom code

Evaluated main: 623d44830879212d06e0f93d709dbcef43fec540.

Trusted main policy: 623d44830879212d06e0f93d709dbcef43fec540.

✅ No new custom-code files detected.

97 mixed files remain; 0 existing customizations changed.

Compared 623d44830879 → 97841da8e26d. Generated baselines verified.

97 existing customizations unchanged
  • openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/models/admin/organization/projects/apikeys/ApiKeyUpdateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/audio/AudioResponseFormat.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/agents/environments/EnvironmentCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/agents/vaults/credentials/CredentialAuth.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/agents/vaults/credentials/CredentialAuthCreateParam.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/agents/vaults/credentials/CredentialAuthRotateParam.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponse.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponseError.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponseInjectEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponseInjectFailedEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponseStreamEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponseToolSearchOutputItemParam.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponsesServerEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/chat/completions/ChatCompletionCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/chat/completions/ChatCompletionMessageFunctionToolCall.kt
  • openai-java-core/src/main/kotlin/com/openai/models/chat/completions/ChatCompletionToolMessageParam.kt
  • openai-java-core/src/main/kotlin/com/openai/models/conversations/ConversationCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/conversations/items/ItemCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/embeddings/Embedding.kt
  • openai-java-core/src/main/kotlin/com/openai/models/embeddings/EmbeddingCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/live/ResponseItemCreateEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/realtime/RealtimeResponseStatus.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/Response.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseError.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseFunctionToolCall.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseFunctionWebSearch.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseInputItem.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseStreamEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseTextConfig.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseToolSearchOutputItemParam.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponsesServerEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/vectorstores/filebatches/VectorStoreFileBatch.kt
  • openai-java-core/src/main/kotlin/com/openai/models/videos/Video.kt
  • openai-java-core/src/main/kotlin/com/openai/models/videos/VideoCreateError.kt
  • openai-java-core/src/main/kotlin/com/openai/models/webhooks/UnwrapWebhookEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/webhooks/WebhookEndpointWithSecret.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/BetaServiceAsync.kt

57 more in the full report.

A changed generated baseline means this report cannot reliably identify which handwritten lines changed.

Inspect the custom-code diff

Download the exact patch produced by this run (requires repository access):

gh run download 39447368248 --repo openai/openai-java \
  --name castiron-custom-code-39447368248-1 --dir /tmp/castiron-custom-code-39447368248-1
git apply --stat /tmp/castiron-custom-code-39447368248-1/custom-code.patch
cat /tmp/castiron-custom-code-39447368248-1/custom-code.patch

Or reproduce it from an SDK checkout containing the vendored reporter:

git fetch --no-tags origin 623d44830879212d06e0f93d709dbcef43fec540 97841da8e26d358f79e6bd19e75bc5b2936b1edf
python3 scripts/castiron/custom_code_report.py report \
  --base 623d44830879212d06e0f93d709dbcef43fec540 \
  --head 97841da8e26d358f79e6bd19e75bc5b2936b1edf --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-97841da8e26d
cat /tmp/castiron-custom-code-97841da8e26d/custom-code.patch

This is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR.

Full report and patch

Castiron-Internal-PR: openai/openai-java-internal#294
Castiron-Source-SHA: 8f83dec63cbd69c095ca0fdd359aefea7ec4a09c
Castiron-Public-Base-SHA: 623d448
@dpiet-oai
dpiet-oai force-pushed the castiron/promotions/pr-294 branch from 21d5645 to 97841da Compare October 20, 2026 15:05
@dpiet-oai
dpiet-oai marked this pull request as ready for review October 20, 2026 15:18
@dpiet-oai
dpiet-oai requested a review from a team as a code owner October 20, 2026 15:18
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-20T15:22:49.087788Z 97841da Draft marked ready
🔒 Security Review ✅ Completed 2026-10-20T15:22:16.214919Z 97841da Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@openai-sdks

openai-sdks Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

OkTest Summary

✅ 236/236 SDK tests passed in 13.721s for Java SDK PR #1245.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 177ms
tests/chat-completions-create.test.ts ✅ Passed 515ms
tests/chat-completions-stream.test.ts ✅ Passed 709ms
tests/files-content-binary.test.ts ✅ Passed 261ms
tests/files-create-multipart.test.ts ✅ Passed 281ms
tests/files-list-pagination.test.ts ✅ Passed 247ms
tests/initialize-config.test.ts ✅ Passed 155ms
tests/instance-isolation.test.ts ✅ Passed 233ms
tests/models-list.test.ts ✅ Passed 336ms
tests/responses-background-lifecycle.test.ts ✅ Passed 683ms
tests/responses-body-method-errors.test.ts ✅ Passed 463ms
tests/responses-cancel-timeout.test.ts ✅ Passed 223ms
tests/responses-cancel.test.ts ✅ Passed 234ms
tests/responses-compact-retries.test.ts ✅ Passed 543ms
tests/responses-compact.test.ts ✅ Passed 292ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 590ms
tests/responses-create-advanced.test.ts ✅ Passed 1.424s
tests/responses-create-disconnect.test.ts ✅ Passed 990ms
tests/responses-create-errors.test.ts ✅ Passed 332ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 265ms
tests/responses-create-retries.test.ts ✅ Passed 220ms
tests/responses-create-stream-failures.test.ts ✅ Passed 235ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 196ms
tests/responses-create-stream-wire.test.ts ✅ Passed 4.828s
tests/responses-create-stream.test.ts ✅ Passed 110ms
tests/responses-create-terminal-states.test.ts ✅ Passed 362ms
tests/responses-create-timeout.test.ts ✅ Passed 210ms
tests/responses-create.test.ts ✅ Passed 270ms
tests/responses-delete.test.ts ✅ Passed 263ms
tests/responses-input-items-errors.test.ts ✅ Passed 296ms
tests/responses-input-items-list.test.ts ✅ Passed 340ms
tests/responses-input-items-options.test.ts ✅ Passed 286ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 210ms
tests/responses-input-tokens-count.test.ts ✅ Passed 322ms
tests/responses-malformed-inputs.test.ts ✅ Passed 3.717s
tests/responses-not-found-errors.test.ts ✅ Passed 346ms
tests/responses-parse.test.ts ✅ Passed 405ms
tests/responses-retrieve-retries.test.ts ✅ Passed 234ms
tests/responses-retrieve.test.ts ✅ Passed 188ms
tests/responses-stored-method-errors.test.ts ✅ Passed 931ms
tests/retry-behavior.test.ts ✅ Passed 3.204s
tests/sdk-error-shape.test.ts ✅ Passed 421ms

View OkTest run #39447270153

SDK merge (779328b26510) · head (97841da8e26d) · base (623d44830879) · OkTest (5d04a66b7423)

@jbeckwith-oai jbeckwith-oai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed 97841da. No actionable findings. Checked immutable case-insensitive header views, default-method Java compatibility, push/pull multipart byte equivalence, lazy upload reads, shared-stream close-once behavior, cancellation/cleanup, repeatability, and logging. Hosted SDK CI passed; separate OkTest run 39447270153 is still running. Static review only; no local tests executed.

@markstuart-oai markstuart-oai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed 97841da8e26d358f79e6bd19e75bc5b2936b1edf. No actionable findings.

The header accessor preserves case-insensitive lookup and immutable values. The body accessor keeps the default path compatible with existing Java implementations while built-in bodies support fresh byte streams or lazy uploads. Multipart cleanup retains shared-stream and close-once behavior, and request logging stays on the streaming path.

I checked the Java compatibility, byte-equivalence, retry, cancellation and cleanup regression coverage. Validation was source review and exact-head hosted CI; I did not run candidate code locally.

@dpiet-oai
dpiet-oai added this pull request to the merge queue Oct 20, 2026
Merged via the queue into main with commit 04f464e Oct 20, 2026
19 checks passed
@openai-sdks openai-sdks Bot mentioned this pull request Oct 20, 2026
jaredosgood pushed a commit to jaredosgood/openai-java that referenced this pull request Oct 22, 2026
Automated Release PR
---


##
[4.87.0](openai/openai-java@v4.86.0...v4.87.0)
(2026-10-20)


### Features

* **api:** add 30-minute cache-write usage counts
([openai#1233](openai#1233))
([2f3608a](openai@2f3608a))
* **api:** add compaction trigger IDs
([openai#1243](openai#1243))
([623d448](openai@623d448))
* **api:** add complete JSON property access
([openai#1241](openai#1241))
([98eacfb](openai@98eacfb))
* **core:** add HTTP adapter headers and body accessors
([openai#1245](openai#1245))
([04f464e](openai@04f464e))


### Bug Fixes

* **api:** accept canonical file batch discriminator
([openai#1224](openai#1224))
([f886d7a](openai@f886d7a))
* **api:** accept compaction trigger payload fields
([openai#1226](openai#1226))
([caa95e1](openai@caa95e1))
* **api:** close responses from void-returning calls
([openai#1242](openai#1242))
([fc5b772](openai@fc5b772))
* complete WebSocket receives before closing failed transport
([openai#1240](openai#1240))
([973fd4e](openai@973fd4e))


### Chores

* restore generated budget-checker explanation
([openai#1235](openai#1235))
([479972a](openai@479972a))


### Documentation

* checkpoint generated-code transition after initial merges
([openai#1238](openai#1238))
([b79d85f](openai@b79d85f))
* inventory Java custom patches and plan generated-code transition
([openai#1234](openai#1234))
([1499ace](openai@1499ace))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: openai-sdks[bot] <284451331+openai-sdks[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants