sdk-go/v1/binding/example_implementing_test.go

115 lines
3.5 KiB
Go

package binding_test
import (
"bytes"
"context"
"encoding/json"
"io"
"io/ioutil"
"github.com/cloudevents/sdk-go/v1/binding"
"github.com/cloudevents/sdk-go/v1/binding/format"
"github.com/cloudevents/sdk-go/v1/cloudevents/transport"
)
// ExMessage is a json.RawMessage, a byte slice containing a JSON encoded event.
// It implements binding.MockStructuredMessage
//
// Note: a good binding implementation should provide an easy way to convert
// between the Message implementation and the "native" message format.
// In this case it's as simple as:
//
// native = ExMessage(impl)
// impl = json.RawMessage(native)
//
// For example in a HTTP binding it should be easy to convert between
// the HTTP binding.Message implementation and net/http.Request and
// Response types. There are no interfaces for this conversion as it
// requires the use of unknown types.
type ExMessage json.RawMessage
func (m ExMessage) GetParent() binding.Message {
return nil
}
func (m ExMessage) Encoding() binding.Encoding {
return binding.EncodingStructured
}
func (m ExMessage) Structured(ctx context.Context, b binding.StructuredEncoder) error {
return b.SetStructuredEvent(ctx, format.JSON, bytes.NewReader(m))
}
func (m ExMessage) Binary(context.Context, binding.BinaryEncoder) error {
return binding.ErrNotBinary
}
func (m ExMessage) Finish(error) error { return nil }
var _ binding.Message = (*ExMessage)(nil)
// ExSender sends by writing JSON encoded events to an io.Writer
// ExSender supports transcoding
// ExSender implements directly StructuredEncoder & EventEncoder
type ExSender struct {
encoder *json.Encoder
transformers binding.TransformerFactories
}
func NewExSender(w io.Writer, factories ...binding.TransformerFactory) binding.Sender {
return &ExSender{encoder: json.NewEncoder(w), transformers: factories}
}
func (s *ExSender) Send(ctx context.Context, m binding.Message) error {
// Encode tries the various encodings, starting with provided root encoder factories.
// If a sender doesn't support a specific encoding, a null root encoder factory could be provided.
_, err := binding.Encode(
ctx,
m,
s,
nil,
s.transformers,
)
return err
}
func (s *ExSender) SetStructuredEvent(ctx context.Context, f format.Format, event io.Reader) error {
if f == format.JSON {
b, err := ioutil.ReadAll(event)
if err != nil {
return err
}
return s.encoder.Encode(json.RawMessage(b))
} else {
return binding.ErrNotStructured
}
}
func (s *ExSender) Close(context.Context) error { return nil }
var _ binding.Sender = (*ExSender)(nil)
var _ binding.StructuredEncoder = (*ExSender)(nil)
// ExReceiver receives by reading JSON encoded events from an io.Reader
type ExReceiver struct{ decoder *json.Decoder }
func NewExReceiver(r io.Reader) binding.Receiver { return &ExReceiver{json.NewDecoder(r)} }
func (r *ExReceiver) Receive(context.Context) (binding.Message, error) {
var rm json.RawMessage
err := r.decoder.Decode(&rm) // This is just a byte copy.
return ExMessage(rm), err
}
func (r *ExReceiver) Close(context.Context) error { return nil }
// NewExTransport returns a transport.Transport which is implemented by
// an ExSender and an ExReceiver
func NewExTransport(r io.Reader, w io.Writer) transport.Transport {
return binding.NewTransportAdapter(NewExSender(w), NewExReceiver(r), []func(ctx context.Context) context.Context{})
}
// Example of implementing a transport including a simple message type,
// and a transport sender and receiver.
func Example_implementing() {}