feat: add buttons support to wpp template message

backends/rapidpro/msg.go

@@ -1020,3 +1020,44 @@ func (m *DBMsg) OrderDetailsMessage() *courier.OrderDetailsMessage {
 
 	return nil
 }
+
+func (m *DBMsg) Buttons() []courier.ButtonComponent {
+	if m.Metadata_ == nil {
+		return nil
+	}
+
+	var metadata map[string]interface{}
+	err := json.Unmarshal(m.Metadata_, &metadata)
+	if err != nil {
+		return nil
+	}
+
+	if metadata == nil {
+		return nil
+	}
+
+	if buttonsData, ok := metadata["buttons"].([]interface{}); ok {
+		buttons := make([]courier.ButtonComponent, len(buttonsData))
+		for i, button := range buttonsData {
+			buttonMap := button.(map[string]interface{})
+			buttons[i] = courier.ButtonComponent{
+				SubType:    buttonMap["sub_type"].(string),
+				Parameters: []courier.ButtonParam{},
+			}
+
+			if buttonMap["parameters"] != nil {
+				parameters := buttonMap["parameters"].([]interface{})
+				for _, parameter := range parameters {
+					parameterMap := parameter.(map[string]interface{})
+					buttons[i].Parameters = append(buttons[i].Parameters, courier.ButtonParam{
+						Type: parameterMap["type"].(string),
+						Text: parameterMap["text"].(string),
+					})
+				}
+			}
+		}
+		return buttons
+	}
+
+	return nil
+}

handlers/facebookapp/facebookapp.go

@@ -1611,6 +1611,18 @@ func (h *handler) sendCloudAPIWhatsappMsg(ctx context.Context, msg courier.Msg)
 					payload.Template.Components = append(payload.Template.Components, button)
 				}
 
+				if len(msg.Buttons()) > 0 {
+					for i, button := range msg.Buttons() {
+						buttonComponent := &wacComponent{Type: "button", SubType: button.SubType, Index: &i}
+
+						for _, parameter := range button.Parameters {
+							buttonComponent.Params = append(buttonComponent.Params, &wacParam{Type: parameter.Type, Text: parameter.Text})
+						}
+
+						payload.Template.Components = append(payload.Template.Components, buttonComponent)
+					}
+				}
+
 			} else {
 				if i < (len(msgParts) + len(msg.Attachments()) - 1) {
 					if strings.Contains(msgParts[i-len(msg.Attachments())], "https://") || strings.Contains(msgParts[i-len(msg.Attachments())], "http://") {

handlers/facebookapp/facebookapp_test.go

@@ -883,6 +883,14 @@ var SendTestCasesWAC = []ChannelSendTestCase{
 		ResponseBody: `{ "messages": [{"id": "157b5e14568e8"}] }`, ResponseStatus: 200,
 		RequestBody: `{"messaging_product":"whatsapp","recipient_type":"individual","to":"250788123123","type":"template","template":{"name":"revive_issue","language":{"policy":"deterministic","code":"en"},"components":[{"type":"body","parameters":[{"type":"text","text":"Chef"},{"type":"text","text":"tomorrow"}]},{"type":"button","sub_type":"order_details","index":0,"parameters":[{"type":"action","action":{"order_details":{"reference_id":"220788123125","type":"digital-goods","payment_type":"br","payment_settings":[{"type":"payment_link","payment_link":{"uri":"https://foo.bar"}},{"type":"pix_dynamic_code","pix_dynamic_code":{"code":"pix-code","merchant_name":"merchant name","key":"pix-key","key_type":"EMAIL"}}],"currency":"BRL","total_amount":{"value":18200,"offset":100},"order":{"status":"pending","catalog_id":"c4t4l0g-1D","items":[{"retailer_id":"789236789","name":"item 1","quantity":2,"amount":{"value":200,"offset":100}},{"retailer_id":"59016733","name":"item 2","quantity":9,"amount":{"value":4000,"offset":100},"sale_amount":{"value":2000,"offset":100}}],"subtotal":{"value":36400,"offset":100},"tax":{"value":500,"offset":100,"description":"tax description"},"shipping":{"value":900,"offset":100,"description":"shipping description"},"discount":{"value":1000,"offset":100,"description":"discount description","discount_program_name":"discount program name"}}}}}]}]}}`,
 		SendPrep:    setSendURL},
+	{Label: "Message Template - Buttons",
+		Text:   "templated message",
+		URN:    "whatsapp:250788123123",
+		Status: "W", ExternalID: "157b5e14568e8",
+		Metadata:     json.RawMessage(`{ "templating": { "template": { "name": "revive_issue", "uuid": "171f8a4d-f725-46d7-85a6-11aceff0bfe3" }, "language": "eng", "variables": ["Chef", "tomorrow"]},"buttons":[{"sub_type":"url","parameters":[{"type":"text","text":"first param"}]}]}`),
+		ResponseBody: `{ "messages": [{"id": "157b5e14568e8"}] }`, ResponseStatus: 200,
+		RequestBody: `{"messaging_product":"whatsapp","recipient_type":"individual","to":"250788123123","type":"template","template":{"name":"revive_issue","language":{"policy":"deterministic","code":"en"},"components":[{"type":"body","parameters":[{"type":"text","text":"Chef"},{"type":"text","text":"tomorrow"}]},{"type":"button","sub_type":"url","index":0,"parameters":[{"type":"text","text":"first param"}]}]}}`,
+		SendPrep:    setSendURL},
 	{Label: "Mesage without text and with quick replies and attachments should not be sent",
 		Text: "", URN: "whatsapp:250788123123",
 		QuickReplies: []string{"Yes", "No"},

handlers/test.go

@@ -316,7 +316,7 @@ func RunChannelSendTestCases(t *testing.T, channel courier.Channel, handler cour
 			}
 
 			if (len(testCase.Responses)) != 0 {
-				require.Equal(mockRRCount, len(testCase.Responses), "Probably MockRequest or MockResponse from testcase is not equal that processed in handler", testCase.Responses)
+				require.Equal(len(testCase.Responses), mockRRCount, "Probably MockRequest or MockResponse from testcase is not equal that processed in handler", testCase.Responses)
 			}
 
 			if testCase.Headers != nil {

msg.go

@@ -135,6 +135,17 @@ type Msg interface {
 	CTAMessage() *CTAMessage
 	FlowMessage() *FlowMessage
 	OrderDetailsMessage() *OrderDetailsMessage
+	Buttons() []ButtonComponent
+}
+
+type ButtonComponent struct {
+	SubType    string        `json:"sub_type"`
+	Parameters []ButtonParam `json:"parameters"`
+}
+
+type ButtonParam struct {
+	Type string `json:"type"`
+	Text string `json:"text"`
 }
 
 type ListMessage struct {

test.go

@@ -946,6 +946,47 @@ func (m *mockMsg) OrderDetailsMessage() *OrderDetailsMessage {
 	return nil
 }
 
+func (m *mockMsg) Buttons() []ButtonComponent {
+	if m.metadata == nil {
+		return nil
+	}
+
+	var metadata map[string]interface{}
+	err := json.Unmarshal(m.metadata, &metadata)
+	if err != nil {
+		return nil
+	}
+
+	if metadata == nil {
+		return nil
+	}
+
+	if buttonsData, ok := metadata["buttons"].([]interface{}); ok {
+		buttons := make([]ButtonComponent, len(buttonsData))
+		for i, button := range buttonsData {
+			buttonMap := button.(map[string]interface{})
+			buttons[i] = ButtonComponent{
+				SubType:    buttonMap["sub_type"].(string),
+				Parameters: []ButtonParam{},
+			}
+
+			if buttonMap["parameters"] != nil {
+				parameters := buttonMap["parameters"].([]interface{})
+				for _, parameter := range parameters {
+					parameterMap := parameter.(map[string]interface{})
+					buttons[i].Parameters = append(buttons[i].Parameters, ButtonParam{
+						Type: parameterMap["type"].(string),
+						Text: parameterMap["text"].(string),
+					})
+				}
+			}
+		}
+		return buttons
+	}
+
+	return nil
+}
+
 //-----------------------------------------------------------------------------
 // Mock status implementation
 //-----------------------------------------------------------------------------