Add phone normalizer

pkg/admin/graphql/user_mutation.go

@@ -261,7 +261,8 @@ var _ = registerMutationField(
 			gqlCtx := GQLContext(p.Context)
 
 			var channel apimodel.AuthenticatorOOBChannel
-			if err := phone.EnsureE164(target); err == nil {
+			phoneNumberParser := &phone.LegalAndValidParser{}
+			if err := phoneNumberParser.CheckE164(target); err == nil {
 				channel = apimodel.AuthenticatorOOBChannelSMS
 			} else {
 				channel = apimodel.AuthenticatorOOBChannelEmail

pkg/auth/webapp/authflow.go

@@ -36,8 +36,9 @@ func GetMostAppropriateIdentification(f *authflow.FlowResponse, loginID string,
 
 	// Else, guess the type
 
+	phoneNumberParser := &phone.LegalAndValidParser{}
 	lookLikeAPhoneNumber := func(loginID string) bool {
-		err := phone.EnsureE164(loginID)
+		err := phoneNumberParser.CheckE164(loginID)
 		if err == nil {
 			return true
 		}

pkg/lib/authn/identity/loginid/normalizer.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/authgear/authgear-server/pkg/api/model"
 	"github.com/authgear/authgear-server/pkg/lib/config"
+	"github.com/authgear/authgear-server/pkg/util/phone"
 )
 
 type Normalizer interface {
@@ -31,6 +32,8 @@ func (f *NormalizerFactory) NormalizerWithLoginIDType(loginIDKeyType model.Login
 		return &UsernameNormalizer{
 			Config: f.Config.Types.Username,
 		}
+	case model.LoginIDKeyTypePhone:
+		return &PhoneNumberNormalizer{}
 	}
 
 	return &NullNormalizer{}
@@ -111,6 +114,23 @@ func (n *UsernameNormalizer) ComputeUniqueKey(normalizeLoginID string) (string,
 	return normalizeLoginID, nil
 }
 
+type PhoneNumberNormalizer struct {
+}
+
+func (n *PhoneNumberNormalizer) Normalize(loginID string) (string, error) {
+	phoneNumberParser := &phone.LegalParser{}
+	e164, err := phoneNumberParser.ParseInputPhoneNumber(loginID)
+	if err != nil {
+		return "", err
+	}
+
+	return e164, nil
+}
+
+func (n *PhoneNumberNormalizer) ComputeUniqueKey(normalizeLoginID string) (string, error) {
+	return normalizeLoginID, nil
+}
+
 type NullNormalizer struct{}
 
 func (n *NullNormalizer) Normalize(loginID string) (string, error) {

pkg/lib/authn/identity/loginid/normalizer_test.go

@@ -164,4 +164,26 @@ func TestNormalizers(t *testing.T) {
 			}
 		})
 	})
+
+	Convey("PhoneNumberNormalizer", t, func() {
+		Convey("normalize to e164", func() {
+			cases := []Case{
+				{"+85298887766", "+85298887766"},
+				{
+					"+852-98887766",
+					"+85298887766",
+				},
+				{
+					"+852-98-88-77-66",
+					"+85298887766",
+				},
+			}
+
+			n := &PhoneNumberNormalizer{}
+
+			for _, c := range cases {
+				f(c, n)
+			}
+		})
+	})
 }

pkg/lib/authn/stdattrs/normalizer.go

@@ -51,12 +51,15 @@ func (n *Normalizer) normalizeEmail(t T) error {
 	return nil
 }
 
-func normalizePhoneNumber(t T) error {
+func (n *Normalizer) normalizePhoneNumber(t T) error {
 	if phoneNumber, ok := t[PhoneNumber].(string); ok && phoneNumber != "" {
-		err := phone.EnsureE164(phoneNumber)
+		phoneNumberParser := &phone.LegalParser{}
+		phoneNumber, err := phoneNumberParser.ParseInputPhoneNumber(phoneNumber)
 		if err != nil {
 			return err
 		}
+
+		t[PhoneNumber] = phoneNumber
 	} else {
 		delete(t, PhoneNumber)
 	}
@@ -133,7 +136,7 @@ func (n *Normalizer) Normalize(t T) error {
 		return err
 	}
 
-	err = normalizePhoneNumber(t)
+	err = n.normalizePhoneNumber(t)
 	if err != nil {
 		return err
 	}

pkg/lib/elasticsearch/model.go

@@ -75,10 +75,12 @@ func RawToSource(raw *model.ElasticsearchUserRaw) *model.ElasticsearchUserSource
 		emailDomain = append(emailDomain, domain)
 	}
 
+	phoneNumberParser := &phone.LegalAndValidParser{}
+
 	var phoneNumberCountryCode []string
 	var phoneNumberNationalNumber []string
 	for _, phoneNumber := range raw.PhoneNumber {
-		nationalNumber, callingCode, err := phone.ParseE164ToCallingCodeAndNumber(phoneNumber)
+		nationalNumber, callingCode, err := phoneNumberParser.SplitE164(phoneNumber)
 		if err == nil {
 			phoneNumberCountryCode = append(phoneNumberCountryCode, callingCode)
 			phoneNumberNationalNumber = append(phoneNumberNationalNumber, nationalNumber)

pkg/lib/usage/count_collector.go

@@ -300,7 +300,9 @@ func (c *CountCollector) querySMSCount(appID string, rangeFrom *time.Time, range
 			}
 
 			e164 := payload.Recipient
-			isNorthAmericaNumber, err := phoneutil.IsNorthAmericaNumber(e164)
+
+			phoneNumberParser := &phoneutil.LegalAndValidParser{}
+			isNorthAmericaNumber, err := phoneNumberParser.IsNorthAmericaNumber(e164)
 			if err != nil {
 				return nil, fmt.Errorf("usage: failed to parse sms recipient %w", err)
 			}
@@ -345,7 +347,8 @@ func (c *CountCollector) queryWhatsappCount(appID string, rangeFrom *time.Time,
 
 			e164 := payload.Recipient
 
-			isNorthAmericaNumber, err := phoneutil.IsNorthAmericaNumber(e164)
+			phoneNumberParser := &phoneutil.LegalAndValidParser{}
+			isNorthAmericaNumber, err := phoneNumberParser.IsNorthAmericaNumber(e164)
 			if err != nil {
 				return nil, fmt.Errorf("usage: failed to parse whatsapp recipient %w", err)
 			}

pkg/util/phone/deps.go

@@ -0,0 +1,8 @@
+package phone
+
+import "github.com/google/wire"
+
+var DependencySet = wire.NewSet(
+	wire.Struct(new(LegalParser), "*"),
+	wire.Struct(new(LegalAndValidParser), "*"),
+)

pkg/util/phone/legal_and_valid_parser.go

@@ -0,0 +1,73 @@
+package phone
+
+import (
+	"regexp"
+	"strconv"
+
+	"github.com/nyaruka/phonenumbers"
+)
+
+// Other places except Login ID normalizer uses LegalAndValidParser.
+// What is Legal and Valid? phonenumbers.Parse does not return err, and phonenumbers.IsValidNumber returns true.
+type LegalAndValidParser struct{}
+
+func (p *LegalAndValidParser) ParseInputPhoneNumber(phone string) (e164 string, err error) {
+	isNumericString, _ := regexp.Match(`^\+[0-9\ \-]*$`, []byte(phone))
+	if !isNumericString {
+		err = ErrNotInE164Format
+		return
+	}
+	num, err := phonenumbers.Parse(phone, "")
+	if err != nil {
+		return
+	}
+	isPhoneValid := phonenumbers.IsValidNumber(num)
+	if !isPhoneValid {
+		err = ErrPhoneNumberInvalid
+		return
+	}
+	e164 = phonenumbers.Format(num, phonenumbers.E164)
+	return
+}
+
+func (p *LegalAndValidParser) ParseCountryCallingCodeAndNationalNumber(nationalNumber string, countryCallingCode string) (e164 string, err error) {
+	rawInput := combineCallingCodeWithNumber(nationalNumber, countryCallingCode)
+	e164, err = p.ParseInputPhoneNumber(rawInput)
+	return
+
+}
+
+func (p *LegalAndValidParser) SplitE164(e164 string) (nationalNumber string, countryCallingCode string, err error) {
+	err = p.CheckE164(e164)
+	if err != nil {
+		return
+	}
+
+	num, err := phonenumbers.Parse(e164, "")
+	if err != nil {
+		return
+	}
+	countryCallingCode = strconv.Itoa(int(num.GetCountryCode()))
+	nationalNumber = phonenumbers.GetNationalSignificantNumber(num)
+	return
+}
+
+func (p *LegalAndValidParser) CheckE164(phone string) error {
+	formatted, err := p.ParseInputPhoneNumber(phone)
+	if err != nil {
+		return err
+	}
+	if formatted != phone {
+		return ErrNotInE164Format
+	}
+	return nil
+}
+
+func (p *LegalAndValidParser) IsNorthAmericaNumber(e164 string) (bool, error) {
+	_, callingCode, err := p.SplitE164(e164)
+	if err != nil {
+		return false, err
+	}
+
+	return callingCode == "1", nil
+}

pkg/util/phone/legal_and_valid_parser_test.go

@@ -0,0 +1,137 @@
+package phone
+
+import (
+	"testing"
+
+	. "github.com/smartystreets/goconvey/convey"
+)
+
+func TestLegalAndValidParser(t *testing.T) {
+	parser := &LegalAndValidParser{}
+	Convey("Phone", t, func() {
+		Convey("checkE164", func() {
+			good := "+85223456789"
+			So(parser.CheckE164(good), ShouldBeNil)
+
+			bad := " +85223456789 "
+			So(parser.CheckE164(bad), ShouldBeError, "not in E.164 format")
+
+			withLetter := "+85222a"
+			So(parser.CheckE164(withLetter), ShouldBeError, "not in E.164 format")
+
+			invalid := "+85212345678"
+			So(parser.CheckE164(invalid), ShouldBeError, "invalid phone number")
+
+			tooShort := "+85222"
+			So(parser.CheckE164(tooShort), ShouldBeError, "invalid phone number")
+
+			nonsense := "a"
+			So(parser.CheckE164(nonsense), ShouldNotBeNil)
+		})
+
+		Convey("ParseCountryCallingCodeAndNationalNumber", func() {
+			Convey("valid cases", func() {
+				check := func(nationalNumber, callingCode, e164 string) {
+					actual, err := parser.ParseCountryCallingCodeAndNationalNumber(nationalNumber, callingCode)
+					if e164 == "" {
+						So(err, ShouldNotBeNil)
+					} else {
+						So(actual, ShouldEqual, e164)
+					}
+				}
+				// calling code can have optional + sign
+				check("98887766", "+852", "+85298887766")
+				check("98887766", "852", "+85298887766")
+
+				// national number can have spaces in between
+				check("9888 7766", "852", "+85298887766")
+				check(" 9888 7766 ", "852", "+85298887766")
+
+				// national number can have hyphens in between
+				check("9888-7766", "852", "+85298887766")
+				check(" 9888-7766 ", "852", "+85298887766")
+				check("98-88-77-66", "852", "+85298887766")
+				check("9-8-8-8-7-7-6-6", "852", "+85298887766")
+				check("9 - 8 - 8 - 8 - 7 - 7 - 6 - 6 ", "852", "+85298887766")
+
+				// calling code can have leading or trailing spaces
+				check("98887766", " +852 ", "+85298887766")
+				check("98887766", " 852 ", "+85298887766")
+
+				// calling code can have spaces or hyphens in between
+				check("98887766", "8 52", "+85298887766")
+				check("98887766", "8-52", "+85298887766")
+				check("98887766", " 8-5-2- ", "+85298887766")
+			})
+
+			Convey("should not accept non-numeric character(s)", func() {
+				_, err := parser.ParseCountryCallingCodeAndNationalNumber("asdf", "+852")
+				So(err, ShouldBeError, "not in E.164 format")
+			})
+
+			Convey("invalid, (+852) phone number does not begin with 1", func() {
+				_, err := parser.ParseCountryCallingCodeAndNationalNumber("12345678", "+852")
+				So(err, ShouldBeError, "invalid phone number")
+			})
+
+			Convey("invalid, (+852) phone number is 8 digit long", func() {
+				_, err := parser.ParseCountryCallingCodeAndNationalNumber("6234567", "+852")
+				So(err, ShouldBeError, "invalid phone number")
+			})
+		})
+
+		Convey("SplitE164", func() {
+			Convey("valid cases", func() {
+				check := func(e164, nationalNumber, callingCode string) {
+					actualNationalNumber, actualCallingCode, err := parser.SplitE164(e164)
+					So(actualNationalNumber, ShouldEqual, nationalNumber)
+					So(actualCallingCode, ShouldEqual, callingCode)
+					So(err, ShouldBeNil)
+				}
+
+				check("+61401123456", "401123456", "61")
+				check("+85298887766", "98887766", "852")
+			})
+
+			Convey("invalid, not in E.164 format", func() {
+				check := func(input string) {
+					_, _, err := parser.SplitE164(input)
+					So(err, ShouldBeError, "not in E.164 format")
+				}
+
+				check("unknown")
+				check("85298887766")
+			})
+
+			Convey("invalid, invalid phone number", func() {
+				check := func(input string) {
+					_, _, err := parser.SplitE164(input)
+					So(err, ShouldBeError, "invalid phone number")
+				}
+
+				check("+85212345678")
+				check("+852123456")
+			})
+		})
+
+		Convey("IsNorthAmericaNumber", func() {
+			check := func(e164 string, expected bool, errStr string) {
+				actual, err := parser.IsNorthAmericaNumber(e164)
+				if errStr == "" {
+					So(expected, ShouldEqual, actual)
+					So(err, ShouldBeNil)
+				} else {
+					So(err, ShouldBeError, errStr)
+				}
+			}
+
+			check("+12015550123", true, "")
+			check("+18195555555", true, "")
+			check("+61401123456", false, "")
+			check("+85298887766", false, "")
+			check("+85212345678", false, "invalid phone number")
+			check("+85223456789 ", false, "not in E.164 format")
+			check("", false, "not in E.164 format")
+		})
+	})
+}