Add noop number for Twilio

Author: esimonov

model/server_settings.go

@@ -10,7 +10,6 @@ import (
 )
 
 const (
-	defaultEtcdKey            = "identifo"
 	IdentifoConfigPathEnvName = "IDENTIFO_CONFIG"
 )
 
@@ -290,12 +289,13 @@ const (
 
 type TwilioServiceSettings struct {
 	// Twilio related config.
-	AccountSid string `yaml:"accountSid" json:"account_sid"`
-	AuthToken  string `yaml:"authToken" json:"auth_token"`
-	ServiceSid string `yaml:"serviceSid" json:"service_sid"`
-	SendFrom   string `yaml:"sendFrom" json:"send_from"`
-	Region     string `yaml:"region" json:"region"`
-	Edge       string `yaml:"edge" json:"edge"`
+	AccountSid         string   `yaml:"accountSid" json:"account_sid"`
+	AuthToken          string   `yaml:"authToken" json:"auth_token"`
+	ServiceSid         string   `yaml:"serviceSid" json:"service_sid"`
+	SendFrom           string   `yaml:"sendFrom" json:"send_from"`
+	Region             string   `yaml:"region" json:"region"`
+	Edge               string   `yaml:"edge" json:"edge"`
+	NoopNumbersRegexps []string `yaml:"noopNumbersRegexps" json:"noopNumbersRegexps"`
 }
 
 type NexmoServiceSettings struct {

model/server_settings_validation.go

@@ -8,11 +8,9 @@ import (
 )
 
 const (
-	identifoLoginWebAppBucket    = "IDENTIFO_LOGIN_APP_BUCKET"
-	identifoJWTKeysBucketEnvName = "IDENTIFO_JWT_KEYS_BUCKET"
+	identifoLoginWebAppBucket = "IDENTIFO_LOGIN_APP_BUCKET"
 	// RouteMobileRegionUAE is a regional UAE RouteMobileR platform.
-	RouteMobileRegionUAE        = "uae"
-	identifoConfigBucketEnvName = "IDENTIFO_CONFIG_BUCKET"
+	RouteMobileRegionUAE = "uae"
 )
 
 // Validate makes sure that all crucial fields are set.

services/sms/twilio/twilio.go

@@ -2,7 +2,9 @@ package twilio
 
 import (
 	"errors"
+	"fmt"
 	"log/slog"
+	"regexp"
 
 	"github.com/madappgang/identifo/v2/model"
 	"github.com/twilio/twilio-go"
@@ -15,6 +17,7 @@ type SMSService struct {
 	messagingServiceSid string
 	sendFrom            string
 	client              *twilio.RestClient
+	noopNumbersRegexps  []*regexp.Regexp
 }
 
 // NewSMSService creates, inits and returns Twilio-backed SMS service.
@@ -30,14 +33,25 @@ func NewSMSService(
 			Username: settings.AccountSid,
 			Password: settings.AuthToken,
 		}),
+		noopNumbersRegexps: make([]*regexp.Regexp, len(settings.NoopNumbersRegexps)),
 	}
+
 	if len(settings.Region) > 0 {
 		t.client.Region = settings.Region
 	}
 	if len(settings.Edge) > 0 {
 		t.client.Edge = settings.Edge
 	}
 
+	for i, r := range settings.NoopNumbersRegexps {
+		complied, err := regexp.Compile(r)
+		if err != nil {
+			return nil, fmt.Errorf("compiling noop phone number regexp %q: %s", r, err)
+		}
+
+		t.noopNumbersRegexps[i] = complied
+	}
+
 	return t, nil
 }
 
@@ -46,6 +60,16 @@ func (ss *SMSService) SendSMS(recipient, message string) error {
 	if ss.client == nil {
 		return errors.New("twilio SMS service is not configured")
 	}
+
+	for _, r := range ss.noopNumbersRegexps {
+		if r.MatchString(recipient) {
+			ss.logger.Info("Will not attempt sending SMS for a no-op number",
+				"phoneNumber", recipient, "regexp", r.String())
+
+			return nil
+		}
+	}
+
 	params := &twilioApi.CreateMessageParams{}
 	params.SetTo(recipient)
 	params.SetBody(message)

services/sms/twilio/twilio_test.go

@@ -0,0 +1,26 @@
+package twilio_test
+
+import (
+	"testing"
+
+	"github.com/madappgang/identifo/v2/logging"
+	"github.com/madappgang/identifo/v2/model"
+	"github.com/madappgang/identifo/v2/services/sms/twilio"
+	"github.com/stretchr/testify/require"
+)
+
+func TestSensSMS_WhenNoopNumber_ReturnsNil(t *testing.T) {
+	logger := logging.NewLogger("json", "info")
+
+	settings := model.TwilioServiceSettings{
+		AccountSid:         "testAccountSid",
+		ServiceSid:         "testServiceSid",
+		NoopNumbersRegexps: []string{"\\+123456.*"},
+	}
+
+	sut, err := twilio.NewSMSService(logger, settings)
+	require.NoError(t, err)
+
+	err = sut.SendSMS("+123456789", "test message")
+	require.NoError(t, err)
+}