Skip to content

Add cross-language encoded tracing header coverage - #943

Draft
Sushisource wants to merge 7 commits into
mainfrom
cross-language-encoded-headers
Draft

Sushisource wants to merge 7 commits into
mainfrom
cross-language-encoded-headers

Conversation

@Sushisource

Copy link
Copy Markdown
Member

What was changed

  • Add a run-cross-language subcommand for feature folders marked with "crossLanguage": true. A conventional driver/ program chooses scenarios and pairs; the runner discovers participant files and prepares each selected SDK once. No separate interop folder, embedded language sources, or runner-owned Cartesian product.
  • Add independently invocable client/worker harness roles and tracing/encoded_headers participants using real tracing integrations for .NET, Go, Java, Python, Ruby, Rust, and TypeScript. The feature verifies encoded history, caller/workflow trace identity, input/result round-trip, and absence of failed Workflow Tasks. It rejects double encoding and never decodes headers on an SDK's behalf.
  • Use published Rust SDK 1.2.0 in the harness and refresh its lockfile; refresh the Python lockfile to 1.36.0. Merge current features main, retaining Go 1.51.0, Python 3.11/strict SDK-install failures, and .NET cleanup fixes alongside the role support.
  • Document exact released-SDK invocations and the releases still needed. Preserve the full seven-language matrix rather than silently removing unsupported participants.

Why?

Regression coverage for temporalio/sdk-typescript#514, especially the reported .NET → TypeScript encoded tracing header failure, and cross-SDK evidence for the producer-specific opt-ins merged in temporalio/sdk-typescript#2579, temporalio/sdk-go#2818, temporalio/sdk-java#3165, and temporalio/sdk-rust#1734.

The feature driver owns pair policy so the runner can also support future cross-language replay, activity, or chained scenarios without hardcoding a matrix model.

Draft: waiting for published SDKs

Checked GitHub releases and the actual package registries on 2026-11-13. Merged is not the same as published:

SDK Latest published version Remaining blocker
TypeScript npm 1.25.0 Missing the merged codecHeaders / encodeClientHeaders support
Java Maven Central 1.40.0 Missing OpenTracingOptions.Builder.setEncodeHeaders(boolean)
Go OpenTelemetry integration go.temporal.io/sdk/contrib/opentelemetry v0.8.1 Missing TracerOptions.EncodeHeaders; Go SDK v1.51.0 itself already includes the core changes

Before marking ready:

  • Publish the Go OpenTelemetry module with the opt-in; update features/go.mod and sums.
  • Publish TypeScript with the fixes; update the TypeScript package selections/lockfile.
  • Publish Java with the opt-in (latest.release is selected by the harness).
  • Rerun all 49 pairs using published versions only.

PHP has no participant because its inspected SDK has no tracing integration; no synthetic implementation is substituted.

Checklist

  1. Related issue: Normalize Header Data Conversion across languages #850. This PR remains draft until the releases above are available.

  2. How was this tested:

    Passed after merging current features main: all 16 released-SDK client/worker pairs, .NET 1.22.0 × Python 1.36.0 × Ruby 1.11.0 × Rust 1.2.0, against Temporal CLI 1.10.0 / Server 1.32.2. No local SDK checkout, snapshot dependency, or temporary SDK source patch was used for this matrix.

    go run . run-cross-language \
      --sdk-language cs --sdk-language py --sdk-language rb --sdk-language rs \
      --sdk-version cs=1.22.0 --sdk-version py=1.36.0 \
      --sdk-version rb=1.11.0 --sdk-version rs=1.2.0 tracing/encoded_headers

    Also passed:

    • go test ./cmd ./sdkbuild
    • From harness/go: go test ./crosslanguage ./cmd ./harness
    • From the encoded-headers driver: go test .
    • dotnet test tests/dotnet/Temporalio.Features.Harness.Tests.csproj: 9 passed
    • From harness/rust: cargo test --locked --features cross-language (7 passed), cargo clippy --locked --features cross-language -- -D warnings, and cargo fmt --check
    • npm run build, targeted TypeScript ESLint, Python preparation's mypy check (221 source files), and git diff --check

    Confirmed actual release blockers (these runs failed and are not counted as passes):

    • Go 1.51.0 with published OTel 0.8.1 fails compilation: unknown field EncodeHeaders.
    • Java 1.40.0 fails with NoSuchMethodException for setEncodeHeaders(boolean).
    • .NET 1.22.0 → TS 1.25.0 reproduces Unknown encoding: binary/encrypted in extractContextFromHeaders.

    Earlier branch development validated all 49 combinations using local SDK changes; that is not evidence that the current published versions support the full matrix. Full cross-language release validation remains blocked as listed above. Remote PR CI has not yet been verified.

  3. Any docs updates needed? Runner usage is in the root README; the feature README documents the codec contract, participant roles, released-version command, and outstanding release requirements.

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.

1 participant