Bump marshmallow to 4.x.x

The only breaking change which seems to affect us is that, when using
the `@validates` decorator, decorated methods now receive `data_key` as
a keyword argument.

So we need to update our method signatures to match.

See: https://marshmallow.readthedocs.io/en/stable/upgrading.html#validates-accepts-multiple-field-names

Author: quis

app/schemas.py

@@ -115,19 +115,19 @@ class Meta(BaseSchema.Meta):
         )
 
     @validates("name")
-    def validate_name(self, value):
+    def validate_name(self, value, data_key):
         if not value:
             raise ValidationError("Invalid name")
 
     @validates("email_address")
-    def validate_email_address(self, value):
+    def validate_email_address(self, value, data_key):
         try:
             validate_email_address(value)
         except InvalidEmailError as e:
             raise ValidationError(str(e)) from e
 
     @validates("mobile_number")
-    def validate_mobile_number(self, value):
+    def validate_mobile_number(self, value, data_key):
         try:
             if value is not None:
                 number = PhoneNumber(value)
@@ -155,19 +155,19 @@ class Meta(BaseSchema.Meta):
         )
 
     @validates("name")
-    def validate_name(self, value):
+    def validate_name(self, value, data_key):
         if not value:
             raise ValidationError("Invalid name")
 
     @validates("email_address")
-    def validate_email_address(self, value):
+    def validate_email_address(self, value, data_key):
         try:
             validate_email_address(value)
         except InvalidEmailError as e:
             raise ValidationError(str(e)) from e
 
     @validates("mobile_number")
-    def validate_mobile_number(self, value):
+    def validate_mobile_number(self, value, data_key):
         try:
             if value is not None:
                 number = PhoneNumber(value)
@@ -176,7 +176,7 @@ def validate_mobile_number(self, value):
             raise ValidationError(f"Invalid phone number: {error.get_legacy_v2_api_error_message()}") from error
 
     @validates("platform_admin")
-    def validate_platform_admin(self, value):
+    def validate_platform_admin(self, value, data_key):
         if value is not False:
             raise ValidationError(f"Cannot set platform_admin to {value}")
 
@@ -292,7 +292,7 @@ class Meta(BaseSchema.Meta):
         )
 
     @validates("permissions")
-    def validate_permissions(self, value):
+    def validate_permissions(self, value, data_key):
         permissions = [v.permission for v in value]
         for p in permissions:
             if p not in app.constants.SERVICE_PERMISSION_TYPES:
@@ -513,7 +513,7 @@ def get_template_type(self, job):
         return job.template.template_type
 
     @validates("scheduled_for")
-    def validate_scheduled_for(self, value):
+    def validate_scheduled_for(self, value, data_key):
         if value < datetime.utcnow():
             raise ValidationError("Date cannot be in the past")
 
@@ -542,7 +542,7 @@ class SmsNotificationSchema(NotificationSchema):
     to = fields.Str(required=True)
 
     @validates("to")
-    def validate_to(self, value):
+    def validate_to(self, value, data_key):
         try:
             number = PhoneNumber(value)
             number.validate(allow_international_number=True)
@@ -608,7 +608,7 @@ class Meta(BaseSchema.Meta):
         model = models.InvitedUser
 
     @validates("email_address")
-    def validate_to(self, value):
+    def validate_to(self, value, data_key):
         try:
             validate_email_address(value)
         except InvalidEmailError as e:
@@ -628,7 +628,7 @@ def __init__(self, partial_email=False):
         self.partial_email = partial_email
 
     @validates("email")
-    def validate_email(self, value):
+    def validate_email(self, value, data_key):
         if self.partial_email:
             return
         try:
@@ -675,11 +675,11 @@ def convert_schema_object_to_field(self, in_data, **kwargs):
         return in_data
 
     @validates("page")
-    def validate_page(self, value):
+    def validate_page(self, value, data_key):
         _validate_positive_number(value)
 
     @validates("page_size")
-    def validate_page_size(self, value):
+    def validate_page_size(self, value, data_key):
         _validate_positive_number(value)
 
 

requirements.in

@@ -5,15 +5,15 @@ celery[sqs]==5.6.0
 # Pin kombu to merge of PR #2342 (SQS fair queue / MessageGroupId support) until kombu 5.7 is released
 kombu @ git+https://github.com/celery/kombu.git@860e40a6c904c4d8551577d9f4e8c00f03b6e06c
 Flask-Bcrypt~=1.0
-flask-marshmallow~=1.3
+flask-marshmallow~=1.4
 Flask-Migrate==3.1.0
 flask-sqlalchemy==3.1.1
 click-datetime~=0.2
 gunicorn[eventlet]~=25.1
 eventlet~=0.40.4
 jsonschema[format]==4.23.0
-marshmallow-sqlalchemy~=1.0
-marshmallow~=3.21
+marshmallow-sqlalchemy~=1.4
+marshmallow~=4.2
 psycopg2-binary==2.9.10
 PyJWT==2.10.1
 SQLAlchemy==2.0.41

requirements.txt

@@ -139,7 +139,7 @@ markupsafe==3.0.3
     #   mako
     #   sentry-sdk
     #   werkzeug
-marshmallow==3.26.2
+marshmallow==4.2.2
     # via
     #   -r requirements.in
     #   flask-marshmallow
@@ -158,7 +158,6 @@ packaging==26.0
     # via
     #   gunicorn
     #   kombu
-    #   marshmallow
 phonenumbers==9.0.25
     # via notifications-utils
 prometheus-client==0.24.1

requirements_for_test.txt

@@ -205,7 +205,7 @@ markupsafe==3.0.3
     #   jinja2
     #   mako
     #   werkzeug
-marshmallow==3.26.2
+marshmallow==4.2.2
     # via
     #   -r requirements.txt
     #   flask-marshmallow
@@ -235,7 +235,6 @@ packaging==26.0
     #   -r requirements.txt
     #   gunicorn
     #   kombu
-    #   marshmallow
     #   pytest
 pathspec==1.0.4
     # via mypy