codecserver

README

Steps to run this sample:

This sample shows how to decode payloads that have been encoded by a codec so they can be displayed by tctl and Temporal Web. The sample codec server supports OIDC authentication (via JWT in the Authorization header). Temporal Web can be configured to pass the user's OIDC access token to the codec server, see: https://github.com/temporalio/web#configuration Configuring OIDC is outside of the scope of this sample, but please see ../serverjwtauth for more details about authentication.

1. You need a Temporal service running. See details in README.md
2. Run the following command to start the worker

go run worker/main.go

1. Run the following command to start the example

go run starter/main.go

1. Run the following command and see that tctl cannot display the payloads as they are encoded (compressed)

tctl workflow show --wid codecserver_workflowID

1. Run the following command to start the remote codec server

go run ./codec-server

1. Run the following command to see that tctl can now decode (uncompress) the payloads via the remote codec server

tctl --codec_endpoint 'http://localhost:8081/{namespace}' workflow show --wid codecserver_workflowID

Codec Server Protocol

Summary

This document outlines the HTTP protocol for codec servers. This functionality allows users to deploy a codec centrally rather than the previous architecture that required a tctl plugin on developer workstations. This makes it easier to secure access to any required encryption keys and simplifies the developer experience.

Protocol

The codec HTTP protocol specifies two endpoints, one for encoding a Payloads object and one for decoding.

Implementations MUST:

1. Send and receive Payloads protobuf as JSON per https://developers.google.com/protocol-buffers/docs/proto3#json. Implementations should not rely on the standard JSON encoding of objects in their language but must use Protobuf specific JSON encoders. Libraries are available to handle this for most languages.
2. Only check the final part of the incoming URL to determine if the request is for /encode or /decode. This makes deployment more flexible by allowing the endpoints to be mounted at any depth in a URL hierarchy, for example to allow encoders for different namespaces to be served from the same hostname.

Implementations MAY:

1. Support codec for different namespaces under different URLs.
2. Read the X-Namespace header sent to the /encode or /decode endpoints as an alternative to differentiating namespaces based on URL. The current tctl and Temporal Web UI codec client code will set X-Namespace appropriately for each request.

In the endpoint sequence diagrams below we are using tctl as an example of the client side, but Temporal Web and all other consumers will follow the same protocol.

Encode

sequenceDiagram;
	participant tctl
	participant Server as Codec Server

	tctl->>Server: HTTP POST /encode
	Note right of tctl: Content-Type: application/json
	Note right of tctl: Body: Payloads protobuf as JSON
	alt invalid JSON
		Server-->>tctl: HTTP 400 BadRequest
    else encoder error
		Server-->>tctl: HTTP 400 BadRequest
    else
		Server-->>tctl: HTTP 200 OK
		Note left of Server: Content-Type: application/json
		Note left of Server: Body: Encoded Payloads protobuf as JSON
	end

Decode

sequenceDiagram;
	participant tctl
	participant Server as Codec Server

	tctl->>Server: HTTP POST /decode
	Note right of tctl: Content-Type: application/json
	Note right of tctl: Body: Payloads protobuf as JSON
	alt invalid JSON
		Server-->>tctl: HTTP 400 BadRequest
  else decoder error
		Server-->>tctl: HTTP 400 BadRequest
  else
		Server-->>tctl: HTTP 200 OK
		Note left of Server: Content-Type: application/json
		Note left of Server: Body: Decoded Payloads protobuf as JSON
	end

Documentation

Index

• Variables
• func Activity(ctx context.Context, input string) (string, error)
• func NewDataConverter(underlying converter.DataConverter) converter.DataConverter
• func NewPayloadCodec() converter.PayloadCodec
• func Workflow(ctx workflow.Context, input string) (string, error)
• type Codec
  • func (*Codec) Decode(payloads []*commonpb.Payload) ([]*commonpb.Payload, error)
  • func (e *Codec) Encode(payloads []*commonpb.Payload) ([]*commonpb.Payload, error)

Variables

var DataConverter = NewDataConverter(converter.GetDefaultDataConverter())

Functions

func Activity

func Activity(ctx context.Context, input string) (string, error)

func NewDataConverter

func NewDataConverter(underlying converter.DataConverter) converter.DataConverter

NewDataConverter creates a new data converter that wraps the given data converter with snappy compression.

func NewPayloadCodec

func NewPayloadCodec() converter.PayloadCodec

func Workflow

func Workflow(ctx workflow.Context, input string) (string, error)

Workflow is a standard workflow definition. Note that the Workflow and Activity don't need to care that their inputs/results are being encoded.

Types

type Codec

type Codec struct{}

Codec implements converter.PayloadEncoder for snappy compression.

func (*Codec) Decode

func (*Codec) Decode(payloads []*commonpb.Payload) ([]*commonpb.Payload, error)

Decode implements converter.PayloadCodec.Decode.

func (*Codec) Encode

func (e *Codec) Encode(payloads []*commonpb.Payload) ([]*commonpb.Payload, error)

Encode implements converter.PayloadCodec.Encode.