✨ Add Optional Contact Information Fields to get_profile Response (#8300)

Author: pcrespov

packages/models-library/src/models_library/api_schemas_webserver/users.py

@@ -62,6 +62,17 @@ class MyProfilePrivacyPatch(InputSchema):
     hide_email: bool | None = None
 
 
+class MyProfileAddressGet(OutputSchema):
+    """Details provided upon registration and used e.g. for invoicing"""
+
+    institution: str | None
+    address: str | None
+    city: str | None
+    state: Annotated[str | None, Field(description="State, province, canton, ...")]
+    postal_code: str | None
+    country: str | None
+
+
 class MyProfileRestGet(OutputSchemaWithoutCamelCase):
     id: UserID
     user_name: Annotated[
@@ -86,6 +97,7 @@ class MyProfileRestGet(OutputSchemaWithoutCamelCase):
 
     privacy: MyProfilePrivacyGet
     preferences: AggregatedPreferences
+    contact: MyProfileAddressGet | None = None
 
     @staticmethod
     def _update_json_schema_extra(schema: JsonDict) -> None:
@@ -105,6 +117,25 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
                             "hide_email": 1,
                         },
                     },
+                    {
+                        "id": 1,
+                        "login": "[email protected]",
+                        "userName": "minuser",
+                        "role": "USER",
+                        "preferences": {},
+                        "privacy": {
+                            "hide_username": False,
+                            "hide_fullname": False,
+                            "hide_email": False,
+                        },
+                        "provided": {
+                            "address": "123 Main St",
+                            "city": "Sampleville",
+                            "state": "CA",
+                            "postal_code": "12345",
+                            "country": "Wonderland",
+                        },
+                    },
                 ]
             }
         )
@@ -133,8 +164,9 @@ def from_domain_model(
         my_product_group: tuple[Group, AccessRightsDict] | None,
         my_preferences: AggregatedPreferences,
         my_support_group: Group | None,
+        profile_contact: MyProfileAddressGet | None = None,
     ) -> Self:
-        data = remap_keys(
+        profile_data = remap_keys(
             my_profile.model_dump(
                 include={
                     "id",
@@ -152,11 +184,12 @@ def from_domain_model(
             rename={"email": "login"},
         )
         return cls(
-            **data,
+            **profile_data,
             groups=MyGroupsGet.from_domain_model(
                 my_groups_by_type, my_product_group, my_support_group
             ),
             preferences=my_preferences,
+            contact=profile_contact,
         )
 
 

packages/models-library/src/models_library/users.py

@@ -71,8 +71,11 @@ class UserBillingDetails(BaseModel):
     institution: str | None
     address: str | None
     city: str | None
-    state: str | None = Field(description="State, province, canton, ...")
-    country: str  # Required for taxes
+    state: Annotated[str | None, Field(description="State, province, canton, ...")]
+    country: Annotated[
+        str,
+        Field(description="Billing country (with standardize name) required for taxes"),
+    ]
     postal_code: str | None
     phone: str | None
 

packages/postgres-database/src/simcore_postgres_database/utils_users.py

@@ -318,8 +318,17 @@ async def is_email_used(
             return bool(pre_registered)
 
     async def get_billing_details(
-        self, connection: AsyncConnection | None = None, *, user_id: int
+        self,
+        connection: AsyncConnection | None = None,
+        *,
+        product_name: str,
+        user_id: int,
     ) -> Any | None:
+        """Returns billing details for the specified user and product.
+
+        - If the user is registered without a product, returns details for that registration.
+        - Returns None if no billing details are found.
+        """
         async with pass_or_acquire_connection(self._engine, connection) as conn:
             result = await conn.execute(
                 sa.select(
@@ -339,7 +348,13 @@ async def get_billing_details(
                         users.c.id == users_pre_registration_details.c.user_id,
                     )
                 )
-                .where(users.c.id == user_id)
+                .where(
+                    (users.c.id == user_id)
+                    & (
+                        (users_pre_registration_details.c.product_name == product_name)
+                        | (users_pre_registration_details.c.product_name.is_(None))
+                    )
+                )
                 .order_by(users_pre_registration_details.c.created.desc())
                 .limit(1)
                 # NOTE: might want to copy billing details to users table??

packages/postgres-database/tests/test_users_details.py

@@ -288,6 +288,7 @@ async def test_create_and_link_user_from_pre_registration(
 async def test_get_billing_details_from_pre_registration(
     asyncpg_engine: AsyncEngine,
     pre_registered_user: tuple[str, dict[str, Any]],
+    product: dict[str, Any],
 ):
     """Test that billing details can be retrieved from pre-registration data."""
     pre_email, fake_pre_registration_data = pre_registered_user
@@ -309,7 +310,9 @@ async def test_get_billing_details_from_pre_registration(
         )
 
     # Get billing details
-    invoice_data = await repo.get_billing_details(user_id=new_user.id)
+    invoice_data = await repo.get_billing_details(
+        user_id=new_user.id, product_name=product["name"]
+    )
     assert invoice_data is not None
 
     # Test UserAddress model conversion

services/web/server/VERSION

@@ -1 +1 @@
-0.76.0
+0.77.0

services/web/server/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.76.0
+current_version = 0.77.0
 commit = True
 message = services/webserver api version: {current_version} → {new_version}
 tag = False

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.1.0
 info:
   title: simcore-service-webserver
   description: Main service with an interface (http-API & websockets) to the web front-end
-  version: 0.76.0
+  version: 0.77.0
 servers:
 - url: ''
   description: webserver
@@ -13717,6 +13717,49 @@ components:
       required:
       - phone
       title: MyPhoneRegister
+    MyProfileAddressGet:
+      properties:
+        institution:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Institution
+        address:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Address
+        city:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: City
+        state:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: State
+          description: State, province, canton, ...
+        postalCode:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Postalcode
+        country:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Country
+      type: object
+      required:
+      - institution
+      - address
+      - city
+      - state
+      - postalCode
+      - country
+      title: MyProfileAddressGet
+      description: Details provided upon registration and used e.g. for invoicing
     MyProfilePrivacyGet:
       properties:
         hideUsername:
@@ -13822,6 +13865,10 @@ components:
             $ref: '#/components/schemas/Preference'
           type: object
           title: Preferences
+        contact:
+          anyOf:
+          - $ref: '#/components/schemas/MyProfileAddressGet'
+          - type: 'null'
       type: object
       required:
       - id

services/web/server/src/simcore_service_webserver/payments/_onetime_api.py

@@ -298,7 +298,7 @@ async def init_creation_of_wallet_payment(
     # user info
     user = await users_service.get_user_display_and_id_names(app, user_id=user_id)
     user_invoice_address = await users_service.get_user_invoice_address(
-        app, user_id=user_id
+        app, user_id=user_id, product_name=product_name
     )
 
     # stripe info
@@ -393,7 +393,7 @@ async def pay_with_payment_method(
     # user info
     user_info = await users_service.get_user_display_and_id_names(app, user_id=user_id)
     user_invoice_address = await users_service.get_user_invoice_address(
-        app, user_id=user_id
+        app, user_id=user_id, product_name=product_name
     )
 
     settings: PaymentsSettings = get_plugin_settings(app)

services/web/server/src/simcore_service_webserver/payments/_rpc_invoice.py

@@ -31,7 +31,9 @@ async def get_invoice_data(
         app, product_name=product_name
     )
     user_invoice_address: UserInvoiceAddress = (
-        await users_service.get_user_invoice_address(app, user_id=user_id)
+        await users_service.get_user_invoice_address(
+            app, product_name=product_name, user_id=user_id
+        )
     )
     user_info = await users_service.get_user_display_and_id_names(app, user_id=user_id)