Skip to content

Clarify Go Payload Codec failure handling - #5150

Merged
flippedcoder merged 3 commits into
mainfrom
docs/payload-codec-failure-guidance
Aug 21, 2026
Merged

Clarify Go Payload Codec failure handling#5150
flippedcoder merged 3 commits into
mainfrom
docs/payload-codec-failure-guidance

Conversation

@yuandrew

Copy link
Copy Markdown
Contributor

What changed

Add Go-specific guidance for handling Payload Codec failures:

  • Prefer bounded local handling for transient failures.
  • Explain how returned errors can affect Workflow Executions.
  • Explain how codec panics interact with WorkflowPanicPolicy.
  • Clarify the difference between BlockWorkflow and FailWorkflow.
  • Warn that panicking outside Workflow Task processing does not request a Workflow Task retry.

Why

An unhandled Payload Codec exception during Workflow Task processing generally causes the Workflow Task to fail across Temporal SDKs. This change documents the Go-specific mechanism for that behavior, including how codec panics interact with WorkflowPanicPolicy and how the behavior differs in Client and Activity contexts.

Companion SDK API documentation: temporalio/sdk-go#2592.

Related to temporalio/sdk-go#2506.

Validation

  • git diff --check
  • Vale was unavailable locally because the configured wrapper is absent from the current main checkout.

Copilot AI balanced review requested due to automatic review settings August 20, 2026 16:09
@vercel

vercel Bot commented Aug 20, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview Aug 21, 2026 2:55pm

Request Review

Copilot AI 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.

Pull request overview

Adds Go-specific guidance for handling Payload Codec failures across Workflow Task, Client, and Activity contexts.

Changes:

  • Recommends bounded handling for transient codec failures.
  • Documents returned-error and panic behavior under WorkflowPanicPolicy.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/develop/go/best-practices/data-handling/data-encryption.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

@yuandrew
yuandrew marked this pull request as ready for review August 21, 2026 14:33
@yuandrew
yuandrew requested a review from a team as a code owner August 21, 2026 14:33
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@flippedcoder
flippedcoder merged commit a2cc899 into main Aug 21, 2026
14 checks passed
@flippedcoder
flippedcoder deleted the docs/payload-codec-failure-guidance branch August 21, 2026 14:58
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.

4 participants