🎨 2. Part: Invoice expiration fix (OPS ⚠️) (ITISFoundation#5537)

Author: matusdrobuliak66

.env-devel

@@ -99,6 +99,8 @@ PAYMENTS_HOST=payments
 PAYMENTS_LOGLEVEL=INFO
 PAYMENTS_PASSWORD=adminadmin
 PAYMENTS_PORT=8000
+PAYMENTS_STRIPE_URL=https://api.stripe.com
+PAYMENTS_STRIPE_API_SECRET='REPLACE_ME_with_api_secret'
 PAYMENTS_SWAGGER_API_DOC_ENABLED=1
 PAYMENTS_USERNAME=admin
 

api/specs/web-server/_wallets.py

@@ -105,6 +105,19 @@ async def list_all_payments(params: Annotated[PageQueryParameters, Depends()]):
     """Lists all user payments to his/her wallets (only the ones he/she created)"""
 
 
+@router.get(
+    "/wallets/{wallet_id}/payments/{payment_id}/invoice-link",
+    status_code=status.HTTP_302_FOUND,
+    responses={
+        status.HTTP_302_FOUND: {
+            "description": "redirection to invoice download link",
+        }
+    },
+)
+async def get_payment_invoice_link(wallet_id: WalletID, payment_id: PaymentID):
+    ...
+
+
 @router.post(
     "/wallets/{wallet_id}/payments/{payment_id}:cancel",
     response_description="Successfully cancelled",

services/docker-compose.yml

@@ -369,6 +369,8 @@ services:
       PAYMENTS_GATEWAY_URL: ${PAYMENTS_GATEWAY_URL}
       PAYMENTS_LOGLEVEL: ${PAYMENTS_LOGLEVEL}
       PAYMENTS_PASSWORD: ${PAYMENTS_PASSWORD}
+      PAYMENTS_STRIPE_URL: ${PAYMENTS_STRIPE_URL}
+      PAYMENTS_STRIPE_API_SECRET: ${PAYMENTS_STRIPE_API_SECRET}
       PAYMENTS_SWAGGER_API_DOC_ENABLED: ${PAYMENTS_SWAGGER_API_DOC_ENABLED}
       PAYMENTS_USERNAME: ${PAYMENTS_USERNAME}
       POSTGRES_DB: ${POSTGRES_DB}

services/payments/src/simcore_service_payments/api/rpc/_payments.py

@@ -15,13 +15,14 @@
 from models_library.products import ProductName, StripePriceID, StripeTaxRateID
 from models_library.users import UserID
 from models_library.wallets import WalletID
-from pydantic import EmailStr
+from pydantic import EmailStr, HttpUrl
 from servicelib.logging_utils import get_log_record_extra, log_context
 from servicelib.rabbitmq import RPCRouter
 
 from ...db.payments_transactions_repo import PaymentsTransactionsRepo
 from ...services import payments
 from ...services.payments_gateway import PaymentsGatewayApi
+from ...services.stripe import StripeApi
 
 _logger = logging.getLogger(__name__)
 
@@ -112,3 +113,20 @@ async def get_payments_page(
         limit=limit,
         offset=offset,
     )
+
+
+@router.expose(reraise_if_error_type=(PaymentsError, PaymentServiceUnavailableError))
+async def get_payment_invoice_url(
+    app: FastAPI,
+    *,
+    user_id: UserID,
+    wallet_id: WalletID,
+    payment_id: PaymentID,
+) -> HttpUrl:
+    return await payments.get_payment_invoice_url(
+        repo=PaymentsTransactionsRepo(db_engine=app.state.engine),
+        stripe_api=StripeApi.get_from_app_state(app),
+        user_id=user_id,
+        wallet_id=wallet_id,
+        payment_id=payment_id,
+    )

services/payments/src/simcore_service_payments/cli.py

@@ -87,6 +87,12 @@ def echo_dotenv(
                 ),
             ),
         ),
+        PAYMENTS_STRIPE_URL=os.environ.get(
+            "PAYMENTS_STRIPE_URL", "https://api.stripe.com"
+        ),
+        PAYMENTS_STRIPE_API_SECRET=os.environ.get(
+            "PAYMENTS_STRIPE_API_SECRET", "replace-with-api-secret"
+        ),
     )
 
     print_as_envfile(

services/payments/src/simcore_service_payments/core/application.py

@@ -3,8 +3,6 @@
 from servicelib.fastapi.prometheus_instrumentation import (
     setup_prometheus_instrumentation,
 )
-from simcore_service_payments.services.notifier import setup_notifier
-from simcore_service_payments.services.socketio import setup_socketio
 
 from .._meta import (
     API_VERSION,
@@ -17,10 +15,13 @@
 from ..api.rest.routes import setup_rest_api
 from ..api.rpc.routes import setup_rpc_api_routes
 from ..services.auto_recharge_listener import setup_auto_recharge_listener
+from ..services.notifier import setup_notifier
 from ..services.payments_gateway import setup_payments_gateway
 from ..services.postgres import setup_postgres
 from ..services.rabbitmq import setup_rabbitmq
 from ..services.resource_usage_tracker import setup_resource_usage_tracker
+from ..services.socketio import setup_socketio
+from ..services.stripe import setup_stripe
 from .settings import ApplicationSettings
 
 
@@ -57,6 +58,9 @@ def create_app(settings: ApplicationSettings | None = None) -> FastAPI:
     # APIs w/ RUT
     setup_resource_usage_tracker(app)
 
+    # APIs w/ Stripe
+    setup_stripe(app)
+
     # Listening to Rabbitmq
     setup_auto_recharge_listener(app)
     setup_socketio(app)

services/payments/src/simcore_service_payments/core/errors.py

@@ -19,3 +19,12 @@ class PaymentsGatewayError(_BaseAppError):
 
 class PaymentsGatewayNotReadyError(PaymentsGatewayError):
     msg_template = "Payments-Gateway is unresponsive: {checks}"
+
+
+#
+# stripe  errors
+#
+
+
+class StripeRuntimeError(_BaseAppError):
+    msg_template = "Stripe unexpected error"

services/payments/src/simcore_service_payments/core/settings.py

@@ -110,6 +110,13 @@ class ApplicationSettings(_BaseApplicationSettings):
         auto_default_from_env=True, description="settings for postgres service"
     )
 
+    PAYMENTS_STRIPE_URL: HttpUrl = Field(
+        ..., description="Base url to the payment Stripe"
+    )
+    PAYMENTS_STRIPE_API_SECRET: SecretStr = Field(
+        ..., description="Credentials for Stripe api"
+    )
+
     PAYMENTS_SWAGGER_API_DOC_ENABLED: bool = Field(
         default=True, description="If true, it displays swagger doc at /doc"
     )

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

@@ -0,0 +1,5 @@
+from pydantic import BaseModel, HttpUrl
+
+
+class InvoiceData(BaseModel):
+    hosted_invoice_url: HttpUrl

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

@@ -25,7 +25,7 @@
 from models_library.products import ProductName, StripePriceID, StripeTaxRateID
 from models_library.users import UserID
 from models_library.wallets import WalletID
-from pydantic import EmailStr, PositiveInt
+from pydantic import EmailStr, HttpUrl, PositiveInt
 from servicelib.logging_utils import log_context
 from simcore_postgres_database.models.payments_transactions import (
     PaymentTransactionState,
@@ -46,7 +46,9 @@
     StripeTaxExempt,
 )
 from ..models.schemas.acknowledgements import AckPayment, AckPaymentWithPaymentMethod
+from ..models.stripe import InvoiceData
 from ..services.resource_usage_tracker import ResourceUsageTrackerApi
+from ..services.stripe import StripeApi
 from .notifier import NotifierService
 from .notifier_ws import WebSocketProvider
 from .payments_gateway import PaymentsGatewayApi
@@ -313,3 +315,24 @@ async def get_payments_page(
     )
 
     return total_number_of_items, [to_payments_api_model(t) for t in page]
+
+
+async def get_payment_invoice_url(
+    repo: PaymentsTransactionsRepo,
+    stripe_api: StripeApi,
+    *,
+    user_id: UserID,
+    wallet_id: WalletID,
+    payment_id: PaymentID,
+) -> HttpUrl:
+    """Get invoice data from Stripe. As invoice url expires after some time, Stripe always generates a new
+    invoice url with 10 day validity."""
+
+    payment: PaymentsTransactionsDB | None = await repo.get_payment_transaction(
+        payment_id=payment_id, user_id=user_id, wallet_id=wallet_id
+    )
+    if payment is None or payment.stripe_invoice_id is None:
+        raise PaymentNotFoundError(payment_id=payment_id)
+    invoice_data: InvoiceData = await stripe_api.get_invoice(payment.stripe_invoice_id)
+
+    return invoice_data.hosted_invoice_url