[IMP] fastapi_log_mail: Adapt to log collection

SirPyTech · SirPyTech · commit 7674bd7e31ed · 2025-08-04T11:58:49.000+02:00
diff --git a/fastapi_log_mail/README.rst b/fastapi_log_mail/README.rst
@@ -1,6 +1,6 @@
-===========
-Fastapi Log
-===========
+========================
+FastAPI Log notification
+========================
 
 .. 
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -28,8 +28,8 @@ Fastapi Log
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-This module allows to send an email when an exception occurs in an
-endpoint.
+This module allows to create an activity when an exception is logged in
+a fastapi endpoint.
 
 **Table of contents**
 
@@ -39,8 +39,7 @@ endpoint.
 Configuration
 =============
 
-In any endpoint that has logging enabled, insert an email template in
-"Error E-mail Template".
+Configure a fastapi endpoint as explained in ``api_log_mail``.
 
 Bug Tracker
 ===========
diff --git a/fastapi_log_mail/__init__.py b/fastapi_log_mail/__init__.py
@@ -1 +0,0 @@
-from . import models
diff --git a/fastapi_log_mail/__manifest__.py b/fastapi_log_mail/__manifest__.py
@@ -2,19 +2,19 @@
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 
 {
-    "name": "Fastapi Log",
-    "version": "16.0.1.0.0",
+    "name": "FastAPI Log notification",
+    "version": "16.0.1.1.0",
     "license": "AGPL-3",
     "author": "PyTech, Odoo Community Association (OCA)",
     "maintainers": [
         "SirPyTech",
     ],
     "website": "https://github.com/OCA/rest-framework",
-    "summary": "Email exceptions of Endpoints.",
+    "summary": "Notify logged exceptions.",
     "category": "Tools",
     "depends": [
         "fastapi_log",
-        "mail",
+        "api_log_mail",
     ],
     "data": [
         "views/fastapi_endpoint_views.xml",
diff --git a/fastapi_log_mail/migrations/16.0.1.1.0/post-migration.py b/fastapi_log_mail/migrations/16.0.1.1.0/post-migration.py
@@ -0,0 +1,32 @@
+# Copyright 2025 Simone Rubino - PyTech
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from openupgradelib import openupgrade
+
+
+@openupgrade.migrate()
+def migrate(env, version):
+    template_id_column = openupgrade.get_legacy_name(
+        "fastapi_log_mail_template_id",
+    )
+    openupgrade.logged_query(
+        env.cr,
+        """
+        UPDATE fastapi_endpoint SET
+        api_log_mail_exception_template_id=%(template_id_column)s
+        WHERE %(template_id_column)s IS NOT NULL
+        """
+        % {
+            "template_id_column": template_id_column,
+        },
+    )
+    openupgrade.logged_query(
+        env.cr,
+        """
+        ALTER TABLE fastapi_endpoint
+        DROP COLUMN %(template_id_column)s
+        """
+        % {
+            "template_id_column": template_id_column,
+        },
+    )
diff --git a/fastapi_log_mail/migrations/16.0.1.1.0/pre-migration.py b/fastapi_log_mail/migrations/16.0.1.1.0/pre-migration.py
@@ -0,0 +1,20 @@
+# Copyright 2025 Simone Rubino - PyTech
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from openupgradelib import openupgrade
+
+
+@openupgrade.migrate()
+def migrate(env, version):
+    openupgrade.copy_columns(
+        env.cr,
+        {
+            "fastapi_endpoint": [
+                (
+                    "fastapi_log_mail_template_id",
+                    None,
+                    None,
+                ),
+            ],
+        },
+    )
diff --git a/fastapi_log_mail/models/__init__.py b/fastapi_log_mail/models/__init__.py
diff --git a/fastapi_log_mail/models/api_log.py b/fastapi_log_mail/models/api_log.py
diff --git a/fastapi_log_mail/models/fastapi_endpoint.py b/fastapi_log_mail/models/fastapi_endpoint.py
diff --git a/fastapi_log_mail/readme/CONFIGURE.md b/fastapi_log_mail/readme/CONFIGURE.md
@@ -1 +1 @@
-In any endpoint that has logging enabled, insert an email template in "Error E-mail Template".
+Configure a fastapi endpoint as explained in `api_log_mail`.
diff --git a/fastapi_log_mail/readme/DESCRIPTION.md b/fastapi_log_mail/readme/DESCRIPTION.md
@@ -1 +1 @@
-This module allows to send an email when an exception occurs in an endpoint.
+This module allows to create an activity when an exception is logged in a fastapi endpoint.
diff --git a/fastapi_log_mail/static/description/index.html b/fastapi_log_mail/static/description/index.html
@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
-<title>Fastapi Log</title>
+<title>FastAPI Log notification</title>
 <style type="text/css">
 
 /*
@@ -360,8 +360,8 @@
 </style>
 </head>
 <body>
-<div class="document" id="fastapi-log">
-<h1 class="title">Fastapi Log</h1>
+<div class="document" id="fastapi-log-notification">
+<h1 class="title">FastAPI Log notification</h1>
 
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
@@ -370,8 +370,8 @@ <h1 class="title">Fastapi Log</h1>
 !! source digest: sha256:ef0c0bceb8ae27bcfebaebc22e2fb4747475f2a2c60dd2d410bc40b6efee9b6a
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/rest-framework/tree/16.0/fastapi_log_mail"><img alt="OCA/rest-framework" src="https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/rest-framework-16-0/rest-framework-16-0-fastapi_log_mail"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
-<p>This module allows to send an email when an exception occurs in an
-endpoint.</p>
+<p>This module allows to create an activity when an exception is logged in
+a fastapi endpoint.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -387,8 +387,7 @@ <h1 class="title">Fastapi Log</h1>
 </div>
 <div class="section" id="configuration">
 <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
-<p>In any endpoint that has logging enabled, insert an email template in
-“Error E-mail Template”.</p>
+<p>Configure a fastapi endpoint as explained in <tt class="docutils literal">api_log_mail</tt>.</p>
 </div>
 <div class="section" id="bug-tracker">
 <h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
diff --git a/fastapi_log_mail/tests/test_fastapi_log_mail.py b/fastapi_log_mail/tests/test_fastapi_log_mail.py
@@ -1,24 +1,32 @@
 # Copyright 2025 Akretion (http://www.akretion.com).
 # @author Florian Mounier <florian.mounier@akretion.com>
+# Copyright 2025 Simone Rubino - PyTech
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
 import os
 import unittest
 
-from odoo.addons.api_log.tests.common import CommonAPILog
 from odoo.addons.fastapi.schemas import DemoExceptionType
+from odoo.addons.fastapi_log.tests.common import Common
 from odoo.addons.mail.tests.common import MailCase
 
+from fastapi import status
+
 
-@unittest.skipIf(os.getenv("SKIP_HTTP_CASE"), "FastAPIEncryptedErrorsCase skipped")
-class FastAPIEncryptedErrorsCase(CommonAPILog, MailCase):
+@unittest.skipIf(os.getenv("SKIP_HTTP_CASE"), "TestFastapiLogMail skipped")
+class TestFastapiLogMail(Common, MailCase):
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
-        cls.fastapi_demo_app = cls.env.ref("fastapi.fastapi_endpoint_demo")
-
-        cls.fastapi_demo_app._handle_registry_sync()
-        cls.fastapi_demo_app.log_requests = True
-        cls.fastapi_demo_app.fastapi_log_mail_template_id = cls.env[
+        cls.fastapi_demo_app.api_log_mail_exception_activity_type_id = cls.env[
+            "mail.activity.type"
+        ].create(
+            {
+                "name": "Test exception activity type",
+                "res_model": "api.log",
+            }
+        )
+        cls.fastapi_demo_app.api_log_mail_exception_template_id = cls.env[
             "mail.template"
         ].create(
             {
@@ -27,16 +35,42 @@ def setUpClass(cls):
             }
         )
 
+    def test_endpoint_exception_create_activity(self):
+        """If an endpoint has an activity type,
+        when an exception occurs an activity of the configured type is created.
+        """
+        # Arrange
+        app = self.fastapi_demo_app
+        activity_type = app.api_log_mail_exception_activity_type_id
+        route = (
+            "/fastapi_demo/test/demo/exception?"
+            f"exception_type={DemoExceptionType.user_error.value}"
+            "&error_message=An error happened"
+        )
+        # pre-condition
+        self.assertTrue(activity_type)
+
+        # Act
+        with self.log_capturer() as capturer:
+            response = self.url_open(route, timeout=200)
+
+        # Assert
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+        log = capturer.records
+        self.assertEqual(len(log), 1)
+        self.assertTrue(log.activity_ids)
+
     def test_endpoint_exception_send_email(self):
         """If an endpoint has an email template,
         when an exception occurs an email is sent using the configured template.
         """
         # Arrange
-        mail_template = self.fastapi_demo_app.fastapi_log_mail_template_id
+        app = self.fastapi_demo_app
+        mail_template = app.api_log_mail_exception_template_id
         route = (
-            "/fastapi_demo/demo/exception?"
+            "/fastapi_demo/test/demo/exception?"
             f"exception_type={DemoExceptionType.user_error.value}"
-            "&error_message=User Error"
+            "&error_message=An error happened"
         )
         # pre-condition
         self.assertTrue(mail_template)
diff --git a/fastapi_log_mail/views/fastapi_endpoint_views.xml b/fastapi_log_mail/views/fastapi_endpoint_views.xml
@@ -5,12 +5,22 @@
 -->
 <odoo>
     <record id="fastapi_endpoint_form_view" model="ir.ui.view">
+        <field name="name">Add log mail fields to endpoint form view</field>
         <field name="model">fastapi.endpoint</field>
         <field name="inherit_id" ref="fastapi_log.fastapi_endpoint_form_view" />
         <field name="arch" type="xml">
             <field name="log_requests" position="after">
                 <field
-                    name="fastapi_log_mail_template_id"
+                    name="api_log_mail_exception_activity_type_id"
+                    groups="api_log.group_api_log"
+                    attrs="{
+                        'invisible': [
+                            ('log_requests', '=', False),
+                        ],
+                    }"
+                />
+                <field
+                    name="api_log_mail_exception_template_id"
                     groups="api_log.group_api_log"
                     attrs="{
                         'invisible': [

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-In any endpoint that has logging enabled, insert an email template in "Error E-mail Template".`
	`1`	+Configure a fastapi endpoint as explained in `api_log_mail`.
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-This module allows to send an email when an exception occurs in an endpoint.`
	`1`	`+This module allows to create an activity when an exception is logged in a fastapi endpoint.`