dapr
/
components-contrib
mirror of https://github.com/dapr/components-contrib.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

bindings.twilio.sms: Properly handle JSON-formatted req.Data 

Fixes #2422

Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com>
This commit is contained in:
ItalyPaleAle 2023-01-10 17:16:28 +00:00
parent 15394572dd
commit c33be7f858
2 changed files with 100 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
bindings/twilio/sms/sms.go
View File

@ -15,8 +15,10 @@ package sms
import (
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strings"
@ -24,6 +26,7 @@ import (
"github.com/dapr/components-contrib/bindings"
"github.com/dapr/kit/logger"
"github.com/spf13/cast"
)
const (
@ -105,14 +108,29 @@ func (t *SMS) Invoke(ctx context.Context, req *bindings.InvokeRequest) (*binding
toNumberValue = toNumberFromRequest
}
var (
bodyObj any
body string
)
err := json.Unmarshal(req.Data, &bodyObj)
if err != nil {
// If req.Data can't be un-marshalled, keep body as-is
body = string(req.Data)
} else {
// Try casting to string
body, err = cast.ToStringE(bodyObj)
if err != nil {
body = string(req.Data)
}
}
v := url.Values{}
v.Set("To", toNumberValue)
v.Set("From", t.metadata.fromNumber)
v.Set("Body", string(req.Data))
vDr := *strings.NewReader(v.Encode())
v.Set("Body", body)
twilioURL := fmt.Sprintf("%s%s/Messages.json", twilioURLBase, t.metadata.accountSid)
httpReq, err := http.NewRequestWithContext(ctx, http.MethodPost, twilioURL, &vDr)
twilioURL := twilioURLBase + t.metadata.accountSid + "/Messages.json"
httpReq, err := http.NewRequestWithContext(ctx, http.MethodPost, twilioURL, strings.NewReader(v.Encode()))
if err != nil {
return nil, err
}
@ -124,9 +142,13 @@ func (t *SMS) Invoke(ctx context.Context, req *bindings.InvokeRequest) (*binding
if err != nil {
return nil, err
}
defer resp.Body.Close()
defer func() {
// Drain the body before closing
_, _ = io.ReadAll(resp.Body)
resp.Body.Close()
}()
if !(resp.StatusCode >= 200 && resp.StatusCode < 300) {
return nil, fmt.Errorf("error from Twilio: %s", resp.Status)
return nil, fmt.Errorf("error from Twilio (%d): %s", resp.StatusCode, resp.Status)
}
return nil, nil

80
bindings/twilio/sms/sms_test.go
View File

@ -18,11 +18,13 @@ import (
"errors"
"io"
"net/http"
"net/url"
"strings"
"sync/atomic"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/dapr/components-contrib/bindings"
"github.com/dapr/kit/logger"
@ -58,8 +60,10 @@ func TestInit(t *testing.T) {
func TestParseDuration(t *testing.T) {
m := bindings.Metadata{}
m.Properties = map[string]string{
"toNumber": "toNumber", "fromNumber": "fromNumber",
"accountSid": "accountSid", "authToken": "authToken", "timeout": "badtimeout",
"toNumber": "toNumber",
"fromNumber": "fromNumber",
"accountSid": "accountSid",
"authToken": "authToken", "timeout": "badtimeout",
}
tw := NewSMS(logger.NewLogger("test"))
err := tw.Init(m)
@ -72,15 +76,17 @@ func TestWriteShouldSucceed(t *testing.T) {
}
m := bindings.Metadata{}
m.Properties = map[string]string{
"toNumber": "toNumber", "fromNumber": "fromNumber",
"accountSid": "accountSid", "authToken": "authToken",
"toNumber": "toNumber",
"fromNumber": "fromNumber",
"accountSid": "accountSid",
"authToken": "authToken",
}
tw := NewSMS(logger.NewLogger("test")).(*SMS)
tw.httpClient = &http.Client{
Transport: httpTransport,
}
err := tw.Init(m)
assert.Nil(t, err)
assert.NoError(t, err)
t.Run("Should succeed with expected url and headers", func(t *testing.T) {
httpTransport.reset()
@ -91,7 +97,7 @@ func TestWriteShouldSucceed(t *testing.T) {
},
})
assert.Nil(t, err)
assert.NoError(t, err)
assert.Equal(t, int32(1), httpTransport.requestCount)
assert.Equal(t, "https://api.twilio.com/2010-04-01/Accounts/accountSid/Messages.json", httpTransport.request.URL.String())
assert.NotNil(t, httpTransport.request)
@ -110,14 +116,15 @@ func TestWriteShouldFail(t *testing.T) {
m := bindings.Metadata{}
m.Properties = map[string]string{
"fromNumber": "fromNumber",
"accountSid": "accountSid", "authToken": "authToken",
"accountSid": "accountSid",
"authToken": "authToken",
}
tw := NewSMS(logger.NewLogger("test")).(*SMS)
tw.httpClient = &http.Client{
Transport: httpTransport,
}
err := tw.Init(m)
assert.Nil(t, err)
assert.NoError(t, err)
t.Run("Missing 'to' should fail", func(t *testing.T) {
httpTransport.reset()
@ -157,3 +164,60 @@ func TestWriteShouldFail(t *testing.T) {
assert.NotNil(t, err)
})
}
func TestMessageBody(t *testing.T) {
httpTransport := &mockTransport{
response: &http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(strings.NewReader(""))},
}
m := bindings.Metadata{}
m.Properties = map[string]string{
"toNumber": "toNumber",
"fromNumber": "fromNumber",
"accountSid": "accountSid",
"authToken": "authToken",
}
tw := NewSMS(logger.NewLogger("test")).(*SMS)
tw.httpClient = &http.Client{
Transport: httpTransport,
}
err := tw.Init(m)
require.NoError(t, err)
tester := func(reqData []byte, expectBody string) func(t *testing.T) {
return func(t *testing.T) {
httpTransport.reset()
_, err := tw.Invoke(context.Background(), &bindings.InvokeRequest{
Data: reqData,
Metadata: map[string]string{
toNumber: "toNumber",
},
})
require.NoError(t, err)
assert.Equal(t, int32(1), httpTransport.requestCount)
assert.Equal(t, "https://api.twilio.com/2010-04-01/Accounts/accountSid/Messages.json", httpTransport.request.URL.String())
assert.NotNil(t, httpTransport.request)
body, err := io.ReadAll(httpTransport.request.Body)
require.NoError(t, err)
q, err := url.ParseQuery(string(body))
require.NoError(t, err)
found := q.Get("Body")
assert.Equal(t, expectBody, found)
}
}
t.Run("Data is not JSON-encoded", func(t *testing.T) {
t.Run("Message body is string", tester([]byte("hello world"), "hello world"))
t.Run("Message body is int", tester([]byte("42"), "42"))
t.Run("Message body is empty", tester([]byte(""), ""))
})
t.Run("Data is JSON-encoded", func(t *testing.T) {
t.Run("Message body is string", tester([]byte(`"hello world"`), "hello world"))
t.Run("Message body is int", tester([]byte("42"), "42"))
t.Run("Message body is bool", tester([]byte("true"), "true"))
t.Run("Message body is empty", tester([]byte(""), ""))
})
}