controller: add content type option to send in the headers when invoking a function - Githubissues

openfaas / connector-sdk

SDK for connecting events to functions

MIT License

54 stars 25 forks source link

controller: add content type option to send in the headers when invoking a function #59

Closed cpanato closed 3 years ago

cpanato commented 3 years ago

Description

add content-type option to send in the headers when invoking a function

Motivation and Context

[x] I have raised an issue to propose this change (required) - https://github.com/openfaas/connector-sdk/issues/58
[ ] My issue has received approval from the maintainers or lead with the design/approved label

How Has This Been Tested?

To test this you will need to do:

create a kind cluster: kind create cluster
deploy openfaas with arkade: arkade install openfaas --gateways 1 --load-balancer false
deploy a simple function that read and log the content-type header, like:

package function

import (
    "fmt"
    "log"
    "os"
)

// Handle a serverless request
func Handle(req []byte) string {
        log.Printf("Content Type: %s", os.Getenv("Http_Content_Type"))
    return fmt.Sprintf("Hello! your Content-Type is: %s", os.Getenv("Http_Content_Type"))
}

and in the stack.yaml definition add the annotation

annotations:
   topic: "vm.powered.on"

Use the sample connector code from https://github.com/openfaas/connector-sdk/tree/master/cmd/tester
Run it and will see the Content-type is empty
use that changes in this PR and update the tester code to add ContentType: "application/json", the following line in the &types.ControllerConfig (https://github.com/openfaas/connector-sdk/blob/master/cmd/tester/main.go#L30-L36)

    config := &types.ControllerConfig{
        RebuildInterval:         time.Millisecond * 1000,
        GatewayURL:              "http://127.0.0.1:8080",
        PrintResponse:           true,
        PrintResponseBody:       true,
        AsyncFunctionInvocation: false,
        ContentType:             "application/json",
    }

run it again and you will see the content-type being set

2021/06/12 17:21:19 Invoking on topic vm.powered.on - http://127.0.0.1:8080
2021/06/12 17:21:19 connector-sdk got result: [200] vm.powered.on => test.openfaas-fn (46) bytes
[200] vm.powered.on => test.openfaas-fn
Hello! your Content-Type is: application/json

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[x] I've read the CONTRIBUTION guide
[x] I have signed-off my commits with git commit -s
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

Fixes: https://github.com/openfaas/connector-sdk/issues/58