baz_simpleservice_method_transheaders.go

// Code generated by zanzibar
// @generated

// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package workflow

import (
	"context"
	"net/textproto"

	"github.com/uber/zanzibar/config"

	zanzibar "github.com/uber/zanzibar/runtime"

	clientsIDlClientsBazBase "github.com/uber/zanzibar/examples/example-gateway/build/gen-code/clients-idl/clients/baz/base"
	clientsIDlClientsBazBaz "github.com/uber/zanzibar/examples/example-gateway/build/gen-code/clients-idl/clients/baz/baz"
	endpointsIDlEndpointsBazBaz "github.com/uber/zanzibar/examples/example-gateway/build/gen-code/endpoints-idl/endpoints/baz/baz"

	module "github.com/uber/zanzibar/examples/example-gateway/build/endpoints/baz/module"
	"go.uber.org/zap"
)

// SimpleServiceTransHeadersWorkflow defines the interface for SimpleServiceTransHeaders workflow
type SimpleServiceTransHeadersWorkflow interface {
	Handle(
		ctx context.Context,
		reqHeaders zanzibar.Header,
		r *endpointsIDlEndpointsBazBaz.SimpleService_TransHeaders_Args,
	) (context.Context, *endpointsIDlEndpointsBazBaz.TransHeader, zanzibar.Header, error)
}

// NewSimpleServiceTransHeadersWorkflow creates a workflow
func NewSimpleServiceTransHeadersWorkflow(deps *module.Dependencies) SimpleServiceTransHeadersWorkflow {
	var whitelistedDynamicHeaders []string
	if deps.Default.Config.ContainsKey("clients.baz.alternates") {
		var alternateServiceDetail config.AlternateServiceDetail
		deps.Default.Config.MustGetStruct("clients.baz.alternates", &alternateServiceDetail)
		for _, routingConfig := range alternateServiceDetail.RoutingConfigs {
			whitelistedDynamicHeaders = append(whitelistedDynamicHeaders, textproto.CanonicalMIMEHeaderKey(routingConfig.HeaderName))
		}
	}

	return &simpleServiceTransHeadersWorkflow{
		Clients:                   deps.Client,
		Logger:                    deps.Default.Logger,
		whitelistedDynamicHeaders: whitelistedDynamicHeaders,
		defaultDeps:               deps.Default,
	}
}

// simpleServiceTransHeadersWorkflow calls thrift client Baz.TransHeaders
type simpleServiceTransHeadersWorkflow struct {
	Clients                   *module.ClientDependencies
	Logger                    *zap.Logger
	whitelistedDynamicHeaders []string
	defaultDeps               *zanzibar.DefaultDependencies
}

// Handle calls thrift client.
func (w simpleServiceTransHeadersWorkflow) Handle(
	ctx context.Context,
	reqHeaders zanzibar.Header,
	r *endpointsIDlEndpointsBazBaz.SimpleService_TransHeaders_Args,
) (context.Context, *endpointsIDlEndpointsBazBaz.TransHeader, zanzibar.Header, error) {
	clientRequest := convertToTransHeadersClientRequest(r)
	clientRequest = propagateHeadersTransHeadersClientRequests(clientRequest, reqHeaders)

	clientHeaders := map[string]string{}

	var ok bool
	var h string
	var k string

	k = textproto.CanonicalMIMEHeaderKey("x-uber-foo")
	h, ok = reqHeaders.Get(k)
	if ok {
		clientHeaders[k] = h
	}
	k = textproto.CanonicalMIMEHeaderKey("x-uber-bar")
	h, ok = reqHeaders.Get(k)
	if ok {
		clientHeaders[k] = h
	}

	h, ok = reqHeaders.Get("Token")
	if ok {
		clientHeaders["Token"] = h
	}
	h, ok = reqHeaders.Get("Uuid")
	if ok {
		clientHeaders["Uuid"] = h
	}
	h, ok = reqHeaders.Get("X-Deputy-Forwarded")
	if ok {
		clientHeaders["X-Deputy-Forwarded"] = h
	}
	for _, whitelistedHeader := range w.whitelistedDynamicHeaders {
		headerVal, ok := reqHeaders.Get(whitelistedHeader)
		if ok {
			clientHeaders[whitelistedHeader] = headerVal
		}
	}

	//when maxRetry is 0, timeout per client level is used & one attempt is made, and timoutPerAttempt is not used
	var timeoutAndRetryConfig = zanzibar.TimeoutAndRetryOptions{}

	//when endpoint level timeout information is available, override it with client level config
	if w.defaultDeps.Config.ContainsKey("endpoints.baz.transHeaders.timeoutPerAttempt") {
		scaleFactor := w.defaultDeps.Config.MustGetFloat("endpoints.baz.transHeaders.scaleFactor")
		maxRetry := int(w.defaultDeps.Config.MustGetInt("endpoints.baz.transHeaders.retryCount"))

		backOffTimeAcrossRetriesCfg := int(w.defaultDeps.Config.MustGetInt("endpoints.baz.transHeaders.backOffTimeAcrossRetries"))
		timeoutPerAttemptConf := int(w.defaultDeps.Config.MustGetInt("endpoints.baz.transHeaders.timeoutPerAttempt"))

		timeoutAndRetryConfig = zanzibar.BuildTimeoutAndRetryConfig(int(timeoutPerAttemptConf), backOffTimeAcrossRetriesCfg, maxRetry, scaleFactor)
	}

	ctx, clientRespBody, cliRespHeaders, err := w.Clients.Baz.TransHeaders(
		ctx, clientHeaders, clientRequest, &timeoutAndRetryConfig,
	)

	if err != nil {
		switch errValue := err.(type) {

		case *clientsIDlClientsBazBaz.AuthErr:
			serverErr := convertTransHeadersAuthErr(
				errValue,
			)

			return ctx, nil, nil, serverErr

		case *clientsIDlClientsBazBaz.OtherAuthErr:
			serverErr := convertTransHeadersOtherAuthErr(
				errValue,
			)

			return ctx, nil, nil, serverErr

		default:
			w.Logger.Warn("Client failure: could not make client request",
				zap.Error(errValue),
				zap.String("client", "Baz"),
			)

			return ctx, nil, nil, err

		}
	}

	// Filter and map response headers from client to server response.
	resHeaders := zanzibar.ServerHTTPHeader{}

	response := convertSimpleServiceTransHeadersClientResponse(clientRespBody)
	if val, ok := cliRespHeaders[zanzibar.ClientResponseDurationKey]; ok {
		resHeaders.Set(zanzibar.ClientResponseDurationKey, val)
	}

	resHeaders.Set(zanzibar.ClientTypeKey, "tchannel")
	return ctx, response, resHeaders, nil
}

func convertToTransHeadersClientRequest(in *endpointsIDlEndpointsBazBaz.SimpleService_TransHeaders_Args) *clientsIDlClientsBazBaz.SimpleService_TransHeaders_Args {
	out := &clientsIDlClientsBazBaz.SimpleService_TransHeaders_Args{}

	if in.Req != nil {
		out.Req = &clientsIDlClientsBazBase.TransHeaders{}
	} else {
		out.Req = nil
	}

	return out
}

func convertTransHeadersAuthErr(
	clientError *clientsIDlClientsBazBaz.AuthErr,
) *endpointsIDlEndpointsBazBaz.AuthErr {
	// TODO: Add error fields mapping here.
	serverError := &endpointsIDlEndpointsBazBaz.AuthErr{}
	return serverError
}
func convertTransHeadersOtherAuthErr(
	clientError *clientsIDlClientsBazBaz.OtherAuthErr,
) *endpointsIDlEndpointsBazBaz.OtherAuthErr {
	// TODO: Add error fields mapping here.
	serverError := &endpointsIDlEndpointsBazBaz.OtherAuthErr{}
	return serverError
}

func convertSimpleServiceTransHeadersClientResponse(in *clientsIDlClientsBazBase.TransHeaders) *endpointsIDlEndpointsBazBaz.TransHeader {
	out := &endpointsIDlEndpointsBazBaz.TransHeader{}

	return out
}

func propagateHeadersTransHeadersClientRequests(in *clientsIDlClientsBazBaz.SimpleService_TransHeaders_Args, headers zanzibar.Header) *clientsIDlClientsBazBaz.SimpleService_TransHeaders_Args {
	if in == nil {
		in = &clientsIDlClientsBazBaz.SimpleService_TransHeaders_Args{}
	}
	if key, ok := headers.Get("x-token"); ok {
		if in.Req == nil {
			in.Req = &clientsIDlClientsBazBase.TransHeaders{}
		}
		if in.Req.W1 == nil {
			in.Req.W1 = &clientsIDlClientsBazBase.Wrapped{}
		}
		if in.Req.W1.N1 == nil {
			in.Req.W1.N1 = &clientsIDlClientsBazBase.NestHeaders{}
		}
		in.Req.W1.N1.Token = &key

	}
	if key, ok := headers.Get("x-uuid"); ok {
		if in.Req == nil {
			in.Req = &clientsIDlClientsBazBase.TransHeaders{}
		}
		if in.Req.W1 == nil {
			in.Req.W1 = &clientsIDlClientsBazBase.Wrapped{}
		}
		if in.Req.W1.N1 == nil {
			in.Req.W1.N1 = &clientsIDlClientsBazBase.NestHeaders{}
		}
		in.Req.W1.N1.UUID = key

	}
	if key, ok := headers.Get("x-token"); ok {
		if in.Req == nil {
			in.Req = &clientsIDlClientsBazBase.TransHeaders{}
		}
		if in.Req.W1 == nil {
			in.Req.W1 = &clientsIDlClientsBazBase.Wrapped{}
		}
		if in.Req.W1.N2 == nil {
			in.Req.W1.N2 = &clientsIDlClientsBazBase.NestHeaders{}
		}
		in.Req.W1.N2.Token = &key

	}
	if key, ok := headers.Get("x-uuid"); ok {
		if in.Req == nil {
			in.Req = &clientsIDlClientsBazBase.TransHeaders{}
		}
		if in.Req.W1 == nil {
			in.Req.W1 = &clientsIDlClientsBazBase.Wrapped{}
		}
		if in.Req.W1.N2 == nil {
			in.Req.W1.N2 = &clientsIDlClientsBazBase.NestHeaders{}
		}
		in.Req.W1.N2.UUID = key

	}
	if key, ok := headers.Get("x-token"); ok {
		if in.Req == nil {
			in.Req = &clientsIDlClientsBazBase.TransHeaders{}
		}
		if in.Req.W2 == nil {
			in.Req.W2 = &clientsIDlClientsBazBase.Wrapped{}
		}
		if in.Req.W2.N1 == nil {
			in.Req.W2.N1 = &clientsIDlClientsBazBase.NestHeaders{}
		}
		in.Req.W2.N1.Token = &key

	}
	if key, ok := headers.Get("x-uuid"); ok {
		if in.Req == nil {
			in.Req = &clientsIDlClientsBazBase.TransHeaders{}
		}
		if in.Req.W2 == nil {
			in.Req.W2 = &clientsIDlClientsBazBase.Wrapped{}
		}
		if in.Req.W2.N1 == nil {
			in.Req.W2.N1 = &clientsIDlClientsBazBase.NestHeaders{}
		}
		in.Req.W2.N1.UUID = key

	}
	if key, ok := headers.Get("x-token"); ok {
		if in.Req == nil {
			in.Req = &clientsIDlClientsBazBase.TransHeaders{}
		}
		if in.Req.W2 == nil {
			in.Req.W2 = &clientsIDlClientsBazBase.Wrapped{}
		}
		if in.Req.W2.N2 == nil {
			in.Req.W2.N2 = &clientsIDlClientsBazBase.NestHeaders{}
		}
		in.Req.W2.N2.Token = &key

	}
	if key, ok := headers.Get("x-uuid"); ok {
		if in.Req == nil {
			in.Req = &clientsIDlClientsBazBase.TransHeaders{}
		}
		if in.Req.W2 == nil {
			in.Req.W2 = &clientsIDlClientsBazBase.Wrapped{}
		}
		if in.Req.W2.N2 == nil {
			in.Req.W2.N2 = &clientsIDlClientsBazBase.NestHeaders{}
		}
		in.Req.W2.N2.UUID = key

	}
	return in
}