fix: rename "phone" courier channel to "sms" (#3680)

Co-authored-by: zepatrik <[email protected]>
ory · Jan 5, 2024 · eb8d1b9 · eb8d1b9
1 parent 699e5d5
commit eb8d1b9
Show file tree

Hide file tree

Showing 31 changed files with 321 additions and 127 deletions.
diff --git a/contrib/quickstart/kratos/phone-password/identity.schema.json b/contrib/quickstart/kratos/phone-password/identity.schema.json
@@ -19,7 +19,7 @@
               }
             },
             "verification": {
-              "via": "phone"
+              "via": "sms"
             }
           }
         }

diff --git a/contrib/quickstart/kratos/phone-password/kratos.yml b/contrib/quickstart/kratos/phone-password/kratos.yml
@@ -96,11 +96,12 @@ identity:
 
 courier:
   channels:
-    - id: phone
+    - id: sms
+      type: http
       request_config:
         url: https://api.twilio.com/2010-04-01/Accounts/AXXXXXXXXXXXXXX/Messages.json
         method: POST
-        body: base64://ZnVuY3Rpb24oY3R4KSB7CkJvZHk6IGN0eC5ib2R5LApUbzogY3R4LnRvLEZyb206IGN0eC5mcm9tCn0=
+        body: base64://ZnVuY3Rpb24oY3R4KSB7ClRvOiBjdHguUmVjaXBpZW50LApCb2R5OiBjdHguQm9keSwKfQ==
         headers:
           Content-Type: application/x-www-form-urlencoded
         auth:

diff --git a/courier/http_channel.go b/courier/http_channel.go
@@ -61,12 +61,12 @@ func (c *httpChannel) Dispatch(ctx context.Context, msg Message) (err error) {
 
 	builder, err := request.NewBuilder(ctx, c.requestConfig, c.d)
 	if err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 
 	tmpl, err := newTemplate(c.d, msg)
 	if err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 
 	td := httpDataModel{
@@ -80,12 +80,12 @@ func (c *httpChannel) Dispatch(ctx context.Context, msg Message) (err error) {
 
 	req, err := builder.BuildRequest(ctx, td)
 	if err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 
 	res, err := c.d.HTTPClient(ctx).Do(req)
 	if err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 
 	if res.StatusCode >= 200 && res.StatusCode < 300 {
@@ -109,7 +109,7 @@ func (c *httpChannel) Dispatch(ctx context.Context, msg Message) (err error) {
 		WithField("message_subject", msg.Subject).
 		WithError(err).
 		Error("sending mail via HTTP failed.")
-	return err
+	return errors.WithStack(err)
 }
 
 func newTemplate(d template.Dependencies, msg Message) (Template, error) {

diff --git a/driver/config/config.go b/driver/config/config.go
@@ -1112,7 +1112,7 @@ func (p *Config) CourierTemplatesVerificationCodeValid(ctx context.Context) *Cou
 }
 
 func (p *Config) CourierSMSTemplatesVerificationCodeValid(ctx context.Context) *CourierSMSTemplate {
-	return p.CourierSMSTemplatesHelper(ctx, ViperKeyCourierTemplatesVerificationCodeValidEmail)
+	return p.CourierSMSTemplatesHelper(ctx, ViperKeyCourierTemplatesVerificationCodeValidSMS)
 }
 
 func (p *Config) CourierTemplatesLoginCodeValid(ctx context.Context) *CourierEmailTemplate {

diff --git a/embedx/config.schema.json b/embedx/config.schema.json
@@ -1999,7 +1999,13 @@
                 "title": "Channel id",
                 "description": "The channel id. Corresponds to the .via property of the identity schema for recovery, verification, etc. Currently only phone is supported.",
                 "maxLength": 32,
-                "enum": ["phone"]
+                "enum": ["sms"]
+              },
+              "type": {
+                "type": "string",
+                "title": "Channel type",
+                "description": "The channel type. Currently only http is supported.",
+                "enum": ["http"]
               },
               "request_config": {
                 "$ref": "#/definitions/httpRequestConfig"

diff --git a/embedx/embedx_test.go b/embedx/embedx_test.go
@@ -5,15 +5,19 @@ package embedx
 
 import (
 	"context"
+	"embed"
+	"io/fs"
+	"strings"
 	"testing"
 
+	"github.com/stretchr/testify/require"
+
 	"github.com/stretchr/testify/assert"
 
 	"github.com/ory/jsonschema/v3"
 )
 
 func TestAddSchemaResources(t *testing.T) {
-
 	for _, tc := range []struct {
 		description       string
 		dependencies      []SchemaType
@@ -65,7 +69,38 @@ func TestAddSchemaResources(t *testing.T) {
 					assert.NoError(t, err)
 				}
 			}
-
 		})
 	}
 }
+
+//go:embed testdata/identity_meta.*
+var identityMetaTestCases embed.FS
+
+func TestIdentityMetaSchema(t *testing.T) {
+	c := jsonschema.NewCompiler()
+	err := AddSchemaResources(c, IdentityMeta, IdentityExtension)
+	require.NoError(t, err)
+
+	schema, err := c.Compile(context.Background(), IdentityMeta.GetSchemaID())
+	require.NoError(t, err)
+
+	require.NoError(t, fs.WalkDir(identityMetaTestCases, ".", func(path string, d fs.DirEntry, err error) error {
+		if d.IsDir() {
+			return nil
+		}
+
+		t.Run("case="+path, func(t *testing.T) {
+			f, err := identityMetaTestCases.Open(path)
+			require.NoError(t, err)
+
+			err = schema.Validate(f)
+			if strings.HasSuffix(path, "invalid.schema.json") {
+				assert.Error(t, err)
+			} else {
+				assert.NoError(t, err)
+			}
+		})
+
+		return nil
+	}))
+}
diff --git a/embedx/identity_extension.schema.json b/embedx/identity_extension.schema.json
@@ -60,7 +60,7 @@
               "properties": {
                 "via": {
                   "type": "string",
-                  "enum": ["email", "phone"]
+                  "enum": ["email", "sms"]
                 }
               }
             },

diff --git a/embedx/identity_meta.schema.json b/embedx/identity_meta.schema.json
@@ -10,9 +10,7 @@
       "properties": {
         "properties": {
           "type": "object",
-          "required": [
-            "traits"
-          ],
+          "required": ["traits"],
           "properties": {
             "traits": {
               "type": "object",
@@ -27,6 +25,32 @@
                   "patternProperties": {
                     ".*": {
                       "type": "object",
+                      "if": {
+                        "properties": {
+                          "ory.sh/kratos": {
+                            "type": "object",
+                            "properties": {
+                              "verification": {}
+                            },
+                            "required": ["verification"]
+                          }
+                        },
+                        "required": ["ory.sh/kratos"]
+                      },
+                      "then": {
+                        "properties": {
+                          "format": {
+                            "enum": [
+                              "email",
+                              "tel",
+                              "date",
+                              "time",
+                              "date-time",
+                              "no-validate"
+                            ]
+                          }
+                        }
+                      },
                       "allOf": [
                         {
                           "$ref": "ory://identity-extension"
@@ -40,9 +64,7 @@
           }
         }
       },
-      "required": [
-        "properties"
-      ]
+      "required": ["properties"]
     }
   ]
 }
diff --git a/embedx/testdata/identity_meta.no_traits.invalid.schema.json b/embedx/testdata/identity_meta.no_traits.invalid.schema.json
@@ -0,0 +1 @@
+{}
diff --git a/embedx/testdata/identity_meta.simple.valid.schema.json b/embedx/testdata/identity_meta.simple.valid.schema.json
@@ -0,0 +1,23 @@
+{
+  "properties": {
+    "traits": {
+      "type": "object",
+      "properties": {
+        "email": {
+          "type": "string",
+          "format": "email",
+          "ory.sh/kratos": {
+            "credentials": {
+              "password": {
+                "identifier": true
+              }
+            },
+            "verification": {
+              "via": "email"
+            }
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/embedx/testdata/identity_meta.verification_format.invalid.schema.json b/embedx/testdata/identity_meta.verification_format.invalid.schema.json
@@ -0,0 +1,23 @@
+{
+  "properties": {
+    "traits": {
+      "type": "object",
+      "properties": {
+        "email": {
+          "type": "string",
+          "format": "unknown",
+          "ory.sh/kratos": {
+            "credentials": {
+              "password": {
+                "identifier": true
+              }
+            },
+            "verification": {
+              "via": "email"
+            }
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/identity/address.go b/identity/address.go
@@ -5,5 +5,4 @@ package identity
 
 const (
 	AddressTypeEmail = "email"
-	AddressTypePhone = "phone"
 )
diff --git a/identity/credentials.go b/identity/credentials.go
@@ -146,15 +146,6 @@ func ParseCredentialsType(in string) (CredentialsType, bool) {
 	return "", false
 }
 
-// swagger:ignore
-type CredentialsIdentifierAddressType string
-
-const (
-	CredentialsIdentifierAddressTypeEmail CredentialsIdentifierAddressType = AddressTypeEmail
-	CredentialsIdentifierAddressTypePhone CredentialsIdentifierAddressType = AddressTypePhone
-	CredentialsIdentifierAddressTypeNone  CredentialsIdentifierAddressType = "none"
-)
-
 // Credentials represents a specific credential type
 //
 // swagger:model identityCredentials

diff --git a/identity/credentials_code.go b/identity/credentials_code.go
@@ -11,7 +11,6 @@ type CodeAddressType string
 
 const (
 	CodeAddressTypeEmail CodeAddressType = AddressTypeEmail
-	CodeAddressTypePhone CodeAddressType = AddressTypePhone
 )
 
 // CredentialsCode represents a one time login/registration code

diff --git a/identity/extension_credentials.go b/identity/extension_credentials.go
@@ -26,7 +26,7 @@ func NewSchemaExtensionCredentials(i *Identity) *SchemaExtensionCredentials {
 	return &SchemaExtensionCredentials{i: i}
 }
 
-func (r *SchemaExtensionCredentials) setIdentifier(ct CredentialsType, value interface{}, addressType CredentialsIdentifierAddressType) {
+func (r *SchemaExtensionCredentials) setIdentifier(ct CredentialsType, value interface{}) {
 	cred, ok := r.i.GetCredentials(ct)
 	if !ok {
 		cred = &Credentials{
@@ -49,11 +49,11 @@ func (r *SchemaExtensionCredentials) Run(ctx jsonschema.ValidationContext, s sch
 	defer r.l.Unlock()
 
 	if s.Credentials.Password.Identifier {
-		r.setIdentifier(CredentialsTypePassword, value, CredentialsIdentifierAddressTypeNone)
+		r.setIdentifier(CredentialsTypePassword, value)
 	}
 
 	if s.Credentials.WebAuthn.Identifier {
-		r.setIdentifier(CredentialsTypeWebAuthn, value, CredentialsIdentifierAddressTypeNone)
+		r.setIdentifier(CredentialsTypeWebAuthn, value)
 	}
 
 	if s.Credentials.Code.Identifier {
@@ -63,7 +63,7 @@ func (r *SchemaExtensionCredentials) Run(ctx jsonschema.ValidationContext, s sch
 				return ctx.Error("format", "%q is not a valid %q", value, s.Credentials.Code.Via)
 			}
 
-			r.setIdentifier(CredentialsTypeCodeAuth, value, CredentialsIdentifierAddressTypeEmail)
+			r.setIdentifier(CredentialsTypeCodeAuth, value)
 		// case f.AddCase(AddressTypePhone):
 		// 	if !jsonschema.Formats["tel"](value) {
 		// 		return ctx.Error("format", "%q is not a valid %q", value, s.Credentials.Code.Via)
-Original file line number
+Diff line change
@@ Expand Up / @@ -19,7 +19,7 @@ @@
                   }
                 },
                 "verification": {
-                  "via": "phone"
+                  "via": "sms"
                 }
               }
             }
@@ Expand Down @@