✨ feat(phone): Add Pydantic phone number validation to reduce SMS waste in input schemas #8115

pcrespov · 2025-07-16T09:30:12Z

What do these changes do?

✨ Add phone number validation

Add phone number validation using pydantic_extra_types.phone_numbers to prevent SMS waste. Note that this validation only happens in input schemas, namely the phone field in:

the account request form
the phone registration (on creation)
the phone registration (on profile)

⬆️ adds `phonenumber` library

Adds in models_library and propagates downstream from models_library requirements

♻️ Normalized error in `request_validation` to comply with `EnvelopedError`

Found this issue and decided to refactor it properly. Now, 422 validation errors display correct enveloped error model. For instance

{
 "error": {
  "message": "Invalid parameter/s 'label' in request query",
  "status": 422,
  "errors": [
   {
    "code": "missing",
    "message": "Field required",
    "resource": "/projects/9a164106-cf6a-459e-b486-2b21fb97d435",
    "field": "label"
   }
  ]
 }
}

Related issue/s

Follows up ✨ webserver api: add phone registration endpoints and expose user phone field in profile #8106 (needs to be merged first)
Complements first part of backend for ITISFoundation/private-issues#280

How to test

cd packages/models_library
make install-dev
pytest -vv tests/test_users.py

Dev-ops

None

codecov · 2025-07-16T09:31:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.20%. Comparing base (49fe1e2) to head (8bc1c1c).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8115      +/-   ##
==========================================
+ Coverage   87.67%   88.20%   +0.52%     
==========================================
  Files        1700     1890     +190     
  Lines       66037    72631    +6594     
  Branches      822     1277     +455     
==========================================
+ Hits        57900    64061    +6161     
- Misses       7920     8189     +269     
- Partials      217      381     +164

Flag	Coverage Δ
integrationtests	`64.25% <90.32%> (+<0.01%)`	⬆️
unittests	`86.82% <100.00%> (+0.66%)`	⬆️

Components	Coverage Δ
pkg_aws_library	`93.93% <ø> (ø)`
pkg_celery_library	`87.34% <ø> (ø)`
pkg_dask_task_models_library	`79.62% <ø> (ø)`
pkg_models_library	`93.15% <100.00%> (ø)`
pkg_notifications_library	`85.26% <ø> (ø)`
pkg_postgres_database	`88.22% <ø> (ø)`
pkg_service_integration	`70.17% <ø> (ø)`
pkg_service_library	`71.48% <100.00%> (∅)`
pkg_settings_library	`90.45% <ø> (ø)`
pkg_simcore_sdk	`85.10% <ø> (+0.05%)`	⬆️
agent	`93.81% <ø> (ø)`
api_server	`93.02% <ø> (ø)`
autoscaling	`95.88% <ø> (ø)`
catalog	`92.34% <ø> (ø)`
clusters_keeper	`99.13% <ø> (ø)`
dask_sidecar	`91.81% <ø> (-0.57%)`	⬇️
datcore_adapter	`97.94% <ø> (ø)`
director	`76.14% <ø> (-0.10%)`	⬇️
director_v2	`91.06% <ø> (+0.04%)`	⬆️
dynamic_scheduler	`96.27% <ø> (ø)`
dynamic_sidecar	`90.07% <ø> (ø)`
efs_guardian	`89.76% <ø> (ø)`
invitations	`91.44% <ø> (ø)`
payments	`92.60% <ø> (ø)`
resource_usage_tracker	`92.55% <ø> (+0.37%)`	⬆️
storage	`86.69% <ø> (+0.20%)`	⬆️
webclient	`∅ <ø> (∅)`
webserver	`88.53% <100.00%> (+6.78%)`	⬆️

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 49fe1e2...8bc1c1c. Read the comment docs.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

sanderegg

Thanks!
Nevertheless I more and more find that the way we install our packages is wrong. Why would for example the clusers-keeper care about phone numbers... and now all of these services need to install an additional library even though only one uses it. This blows up the container image sizes, and decreases security. nothing to do now though. that is just a thought.

GitHK

fancy!

giancarloromeo

👌

matusdrobuliak66

Thanks!

pcrespov · 2025-07-17T13:37:19Z

@mergify queue

mergify · 2025-07-17T13:37:27Z

…tion

pcrespov · 2025-07-18T09:58:49Z

@mergify queue

mergify · 2025-07-18T09:58:55Z

sonarqubecloud · 2025-07-18T14:41:41Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

pcrespov self-assigned this Jul 16, 2025

pcrespov added the a:models-library label Jul 16, 2025

pcrespov changed the title ~~WIP: Is280/validate phone numbers~~ ✨ feat(phone): Add Pydantic phone number validation to reduce SMS waste in input schemas Jul 16, 2025

pcrespov force-pushed the is280/validate-phone-numbers branch from f6154b0 to 53c8407 Compare July 16, 2025 11:05

pcrespov added this to the Engage milestone Jul 16, 2025

pcrespov marked this pull request as ready for review July 16, 2025 16:38

pcrespov requested review from GitHK, giancarloromeo, matusdrobuliak66 and sanderegg as code owners July 16, 2025 16:38

pcrespov requested review from bisgaard-itis and odeimaiz July 16, 2025 16:38

pcrespov enabled auto-merge (squash) July 16, 2025 16:41

pcrespov disabled auto-merge July 16, 2025 16:41

odeimaiz approved these changes Jul 17, 2025

View reviewed changes

sanderegg approved these changes Jul 17, 2025

View reviewed changes

GitHK approved these changes Jul 17, 2025

View reviewed changes

giancarloromeo approved these changes Jul 17, 2025

View reviewed changes

matusdrobuliak66 approved these changes Jul 17, 2025

View reviewed changes

pcrespov force-pushed the is280/validate-phone-numbers branch 2 times, most recently from 19bcf78 to f2a1c8f Compare July 17, 2025 11:59

pcrespov added the a:webserver webserver's codebase. Assigning the area is particularly useful for bugs label Jul 17, 2025

pcrespov enabled auto-merge (squash) July 17, 2025 13:37

pcrespov added the 🤖-automerge marks PR as ready to be merged for Mergify label Jul 17, 2025

pcrespov added 3 commits July 17, 2025 16:39

adds phone numbers in models library

5614d4e

testing formatting

6ed148b

downstream dependency

67e6870

pcrespov added 13 commits July 17, 2025 16:39

fixing phone fixture

5ad0a7b

enhance phone number validation to enforce E.164 format and update tests

25da7bb

refactor request_product_account to improve error handling and valida…

073782c

…tion

update message

e942776

services/webserver api version: 0.72.0 → 0.73.0

9489de7

moved logic to webserver

ea4855f

phonumbers only in webserver

f1270b6

moving to models

9cee9aa

fixes import

83457eb

duplicates

66e59ce

fixing phone

9e88807

fixes pylint

f3d4d43

f=tests

da58d27

pcrespov force-pushed the is280/validate-phone-numbers branch from fe78048 to da58d27 Compare July 17, 2025 14:39

pcrespov added 6 commits July 17, 2025 22:08

fixes tixture

7a3cae1

Merge branch 'master' into is280/validate-phone-numbers

9b56b19

fixes import

92580ab

fixes

20ae11e

Merge branch 'master' into is280/validate-phone-numbers

f882ba8

fixes phones

448f37a

pcrespov added 2 commits July 18, 2025 16:40

oas

d0cfbb8

services/webserver api version: 0.73.0 → 0.73.1

8bc1c1c

pcrespov disabled auto-merge July 18, 2025 14:40

pcrespov merged commit 28dd617 into ITISFoundation:master Jul 18, 2025
89 of 95 checks passed

pcrespov deleted the is280/validate-phone-numbers branch July 18, 2025 14:55

YuryHrytsuk mentioned this pull request Jul 29, 2025

🚀 Pre-release master -> staging_Engage8 #8138

Closed

18 tasks

matusdrobuliak66 mentioned this pull request Aug 5, 2025

🚀 Release v1.84.0 #7947

Closed

88 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

✨ feat(phone): Add Pydantic phone number validation to reduce SMS waste in input schemas #8115

✨ feat(phone): Add Pydantic phone number validation to reduce SMS waste in input schemas #8115

Uh oh!

pcrespov commented Jul 16, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jul 16, 2025 •

edited

Loading

Uh oh!

sanderegg left a comment

Uh oh!

GitHK left a comment

Uh oh!

giancarloromeo left a comment

Uh oh!

matusdrobuliak66 left a comment

Uh oh!

pcrespov commented Jul 17, 2025

Uh oh!

mergify bot commented Jul 17, 2025 •

edited

Loading

Uh oh!

pcrespov commented Jul 18, 2025

Uh oh!

mergify bot commented Jul 18, 2025 •

edited

Loading

Uh oh!

sonarqubecloud bot commented Jul 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

✨ feat(phone): Add Pydantic phone number validation to reduce SMS waste in input schemas #8115

✨ feat(phone): Add Pydantic phone number validation to reduce SMS waste in input schemas #8115

Uh oh!

Conversation

pcrespov commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What do these changes do?

✨ Add phone number validation

⬆️ adds phonenumber library

♻️ Normalized error in request_validation to comply with EnvelopedError

Related issue/s

How to test

Dev-ops

Uh oh!

codecov bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sanderegg left a comment

Choose a reason for hiding this comment

Uh oh!

GitHK left a comment

Choose a reason for hiding this comment

Uh oh!

giancarloromeo left a comment

Choose a reason for hiding this comment

Uh oh!

matusdrobuliak66 left a comment

Choose a reason for hiding this comment

Uh oh!

pcrespov commented Jul 17, 2025

Uh oh!

mergify bot commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🟠 Waiting for conditions to match

Uh oh!

pcrespov commented Jul 18, 2025

Uh oh!

mergify bot commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🟠 Waiting for conditions to match

Uh oh!

sonarqubecloud bot commented Jul 18, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

pcrespov commented Jul 16, 2025 •

edited

Loading

⬆️ adds `phonenumber` library

♻️ Normalized error in `request_validation` to comply with `EnvelopedError`

codecov bot commented Jul 16, 2025 •

edited

Loading

mergify bot commented Jul 17, 2025 •

edited

Loading

mergify bot commented Jul 18, 2025 •

edited

Loading