🎨 Send invoice attachment 🗃️ (#5688)

Author: matusdrobuliak66

packages/notifications-library/src/notifications_library/_email.py

@@ -4,7 +4,6 @@
 from contextlib import asynccontextmanager
 from email.headerregistry import Address
 from email.message import EmailMessage
-from pathlib import Path
 from typing import cast
 
 from aiosmtplib import SMTP
@@ -38,22 +37,27 @@ def compose_email(
     return msg
 
 
-def _guess_file_type(file_path: Path) -> tuple[str, str]:
-    assert file_path.is_file()
-    mimetype, _encoding = mimetypes.guess_type(file_path)
+def _guess_file_type(file_name: str) -> tuple[str, str]:
+    """
+    Guess the MIME type based on the file name extension.
+    """
+    mimetype, _encoding = mimetypes.guess_type(file_name)
     if mimetype:
         maintype, subtype = mimetype.split("/", maxsplit=1)
     else:
         maintype, subtype = "application", "octet-stream"
     return maintype, subtype
 
 
-def add_attachments(msg: EmailMessage, file_paths: list[Path]):
-    for attachment_path in file_paths:
-        maintype, subtype = _guess_file_type(attachment_path)
+def add_attachments(msg: EmailMessage, attachments: list[tuple[bytes, str]]):
+    for file_data, file_name in attachments:
+        # Use the filename to guess the file type
+        maintype, subtype = _guess_file_type(file_name)
+
+        # Add the attachment
         msg.add_attachment(
-            attachment_path.read_bytes(),
-            filename=attachment_path.name,
+            file_data,
+            filename=file_name,
             maintype=maintype,
             subtype=subtype,
         )

packages/notifications-library/src/notifications_library/payments.py

@@ -26,6 +26,7 @@ class PaymentData:
     price_dollars: str
     osparc_credits: str
     invoice_url: str
+    invoice_pdf_url: str
 
 
 async def notify_payment_completed(

packages/notifications-library/tests/conftest.py

@@ -154,4 +154,5 @@ def payment_data(successful_transaction: dict[str, Any]) -> PaymentData:
         price_dollars=successful_transaction["price_dollars"],
         osparc_credits=successful_transaction["osparc_credits"],
         invoice_url=successful_transaction["invoice_url"],
+        invoice_pdf_url=successful_transaction["invoice_pdf_url"],
     )

packages/notifications-library/tests/email/test_email_events.py

@@ -139,16 +139,17 @@ def event_extra_data(  # noqa: PLR0911
 
 
 @pytest.fixture
-def event_attachments(event_name: str, faker: Faker, tmp_path: Path) -> list[Path]:
-    paths = []
+def event_attachments(event_name: str, faker: Faker) -> list[tuple[bytes, str]]:
+    attachments = []
     match event_name:
         case "on_payed":
-            paths.append(tmp_path / "test-payed-invoice.pdf")
+            # Create a fake PDF-like byte content and its filename
+            file_name = "test-payed-invoice.pdf"
+            # Simulate generating PDF data.
+            fake_pdf_content = faker.text().encode("utf-8")
+            attachments.append((fake_pdf_content, file_name))
 
-    # fill with fake data
-    for p in paths:
-        p.write_text(faker.text())
-    return paths
+    return attachments
 
 
 @pytest.mark.parametrize(
@@ -173,7 +174,7 @@ async def test_email_event(
     product_name: ProductName,
     event_name: str,
     event_extra_data: dict[str, Any],
-    event_attachments: list[Path],
+    event_attachments: list[tuple[bytes, str]],
     tmp_path: Path,
 ):
     assert user_data.email == user_email

packages/postgres-database/src/simcore_postgres_database/migration/versions/95d0932aaa83_add_invoice_pdf_column.py

@@ -0,0 +1,30 @@
+"""add invoice pdf column
+
+Revision ID: 95d0932aaa83
+Revises: 4a0f4efe8c86
+Create Date: 2024-04-17 11:36:46.653089+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "95d0932aaa83"
+down_revision = "4a0f4efe8c86"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        "payments_transactions",
+        sa.Column("invoice_pdf_url", sa.String(), nullable=True),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("payments_transactions", "invoice_pdf_url")
+    # ### end Alembic commands ###

packages/postgres-database/src/simcore_postgres_database/models/payments_transactions.py

@@ -101,6 +101,12 @@ def is_acknowledged(self) -> bool:
         nullable=True,
         doc="Invoice ID of invoice of this transaction. Available when completed",
     ),
+    sa.Column(
+        "invoice_pdf_url",
+        sa.String,
+        nullable=True,
+        doc="Link to invoice PDF. Available when completed",
+    ),
     #
     # States
     #

packages/pytest-simcore/src/pytest_simcore/faker_payments_data.py

@@ -47,6 +47,11 @@ def invoice_url(faker: Faker) -> HttpUrl:
     return parse_obj_as(HttpUrl, faker.image_url())
 
 
+@pytest.fixture
+def invoice_pdf_url(faker: Faker) -> HttpUrl:
+    return parse_obj_as(HttpUrl, faker.image_url())
+
+
 @pytest.fixture
 def stripe_invoice_id(faker: Faker) -> StripeInvoiceID:
     return parse_obj_as(StripeInvoiceID, f"in_{faker.word()}")
@@ -60,6 +65,7 @@ def successful_transaction(
     user_id: UserID,
     product_name: ProductName,
     invoice_url: HttpUrl,
+    invoice_pdf_url: HttpUrl,
     stripe_invoice_id: StripeInvoiceID,
 ) -> dict[str, Any]:
 
@@ -77,5 +83,6 @@ def successful_transaction(
         wallet_id=wallet_id,
         comment=f"fake fixture in {__name__}.successful_transaction",
         invoice_url=invoice_url,
+        invoice_pdf_url=invoice_pdf_url,
         stripe_invoice_id=stripe_invoice_id,
     )

services/payments/src/simcore_service_payments/db/payments_transactions_repo.py

@@ -68,6 +68,7 @@ async def update_ack_payment_transaction(
         state_message: str | None,
         invoice_url: HttpUrl | None,
         stripe_invoice_id: StripeInvoiceID | None,
+        invoice_pdf_url: HttpUrl | None,
     ) -> PaymentsTransactionsDB:
         """
         - ACKs payment by updating state with SUCCESS, CANCEL, etc
@@ -115,6 +116,7 @@ async def update_ack_payment_transaction(
                     state=completion_state,
                     invoice_url=invoice_url,
                     stripe_invoice_id=stripe_invoice_id,
+                    invoice_pdf_url=invoice_pdf_url,
                     **optional,
                 )
                 .where(payments_transactions.c.payment_id == f"{payment_id}")

services/payments/src/simcore_service_payments/models/db.py

@@ -25,6 +25,7 @@
     "comment": "This is a test comment.",
     "invoice_url": None,
     "stripe_invoice_id": None,
+    "invoice_pdf_url": None,
     "initiated_at": "2023-09-27T10:00:00",
     "state": PaymentTransactionState.PENDING,
 }
@@ -41,6 +42,7 @@ class PaymentsTransactionsDB(BaseModel):
     comment: str | None
     invoice_url: HttpUrl | None
     stripe_invoice_id: StripeInvoiceID | None
+    invoice_pdf_url: HttpUrl | None
     initiated_at: datetime.datetime
     completed_at: datetime.datetime | None
     state: PaymentTransactionState
@@ -55,6 +57,8 @@ class Config:
                 {
                     **_EXAMPLE_AFTER_INIT,
                     "invoice_url": "https://my-fake-pdf-link.com",
+                    "stripe_invoice_id": "12345",
+                    "invoice_pdf_url": "https://my-fake-pdf-link.com",
                     "completed_at": "2023-09-27T10:00:10",
                     "state": "SUCCESS",
                     "state_message": "Payment completed successfully",

services/payments/src/simcore_service_payments/services/notifier.py

@@ -2,16 +2,14 @@
 import logging
 
 from fastapi import FastAPI
-from models_library.api_schemas_webserver.wallets import (
-    PaymentMethodTransaction,
-    PaymentTransaction,
-)
+from models_library.api_schemas_webserver.wallets import PaymentMethodTransaction
 from models_library.users import UserID
 from servicelib.fastapi.app_state import SingletonInAppStateMixin
 from servicelib.utils import fire_and_forget_task
 
 from ..core.settings import ApplicationSettings
 from ..db.payment_users_repo import PaymentsUsersRepo
+from ..models.db import PaymentsTransactionsDB
 from .notifier_abc import NotificationProvider
 from .notifier_email import EmailProvider
 from .notifier_ws import WebSocketProvider
@@ -37,7 +35,7 @@ def _run_in_background(self, coro, suffix):
     async def notify_payment_completed(
         self,
         user_id: UserID,
-        payment: PaymentTransaction,
+        payment: PaymentsTransactionsDB,
         *,
         exclude: set | None = None,
     ):