[IMP] util: Announce Release Notes after a migration

The goal is to warn users that have just upgraded and get them curious
about the new features.

closes #149

Taskid: 3950689
Signed-off-by: Christophe Simonis (chs) <[email protected]>

Author: arbaes

src/mail/0.0.0/pre-report-migration.py

@@ -27,6 +27,7 @@ class MailMessage(models.Model):
 
     @model_cr
     def _register_hook(self):
+        util.announce_release_note(self.env.cr)
         if len(util.migration_reports):
             util.announce_migration_report(self.env.cr)
         return super(MailMessage, self)._register_hook()

src/util/release-note.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<t t-name="mail.release_note">
+  <span>Hello,</span>
+  <span>Your database has successfully been upgraded to the latest version 🥳.</span>
+  <br/>
+  <t t-if="odoo_showcase_video_id">
+    <br/>
+    <a t-attf-href="https://www.youtube.com/watch?v={{ odoo_showcase_video_id }}" target="_blank">
+      <b>Meet Odoo <t t-esc="major_version"/>.<t t-esc="minor_version"/> now !</b>
+      <div class="card shadow-sm yt-container" style="max-height: 360px; max-width: 640px">
+          <img t-attf-src="https://img.youtube.com/vi/{{ odoo_showcase_video_id }}/maxresdefault.jpg"/>
+      </div>
+    </a>
+  </t>
+  <br/>
+  <p t-if="int(minor_version) == 0">Want to know more? Check out the full <a t-attf-href="https://www.odoo.com/odoo-{{ major_version }}-release-notes">release note</a>.</p>
+  <p t-elif="int(minor_version) >= 0">Want to know more? Check out the full <a t-attf-href="https://www.odoo.com/odoo-{{ major_version }}-{{ minor_version }}-release-notes">release note</a>.</p>
+  <p t-else=""></p>
+</t>

src/util/report-migration.xml

@@ -1,6 +1,11 @@
 <?xml version="1.0"?>
 <t t-name="mail.report_migration">
-  <h2> Upgrade report: <t t-esc="major_version" /> </h2>
+  <h2> Congratulations, you have just upgraded to Odoo <t t-esc="version" /> </h2>
+  <p> Here are changes that may impact day to day flows in this new version. </p>
+  <p t-if="int(minor_version) == 0">Want to know more? Check out the full functional <a t-attf-href="https://www.odoo.com/odoo-{{ major_version }}-release-notes">release note</a>.</p>
+  <p t-elif="int(minor_version) >= 0">Want to know more? Check out the full fonctional <a t-attf-href="https://www.odoo.com/odoo-{{ major_version }}-{{ minor_version }}-release-notes">release note</a>.</p>
+  <p t-else=""></p>
+  <br/>
   <t t-foreach="messages" t-as="category">
     <h3><t t-esc="category"/></h3>
     <ul>

src/util/report.py

@@ -66,6 +66,14 @@ def html_escape(text):
 migration_reports = {}
 _logger = logging.getLogger(__name__)
 
+ODOO_SHOWCASE_VIDEOS = {
+    "18.0": "gbE3azm_Io0",
+    "saas~17.4": "8F4-uDwom8A",
+    "saas~17.2": "ivjgo_2-wkE",
+    "17.0": "qxb74CMR748",
+    "16.0": "RVFZL3D9plg",
+}
+
 
 def add_to_migration_reports(message, category="Other", format="text"):
     assert format in {"text", "html", "md", "rst"}
@@ -82,6 +90,25 @@ def add_to_migration_reports(message, category="Other", format="text"):
     migration_reports.setdefault(category, []).append((message, raw))
 
 
+def announce_release_note(cr):
+    filepath = os.path.join(os.path.dirname(__file__), "release-note.xml")
+    with open(filepath, "rb") as fp:
+        contents = fp.read()
+        report = lxml.etree.fromstring(contents)
+    e = env(cr)
+    major_version, minor_version = re.findall(r"\d+", release.major_version)
+    values = {
+        "version": release.major_version,
+        "major_version": major_version,
+        "minor_version": minor_version,
+        "odoo_showcase_video_id": ODOO_SHOWCASE_VIDEOS.get(release.major_version, ""),
+    }
+    _logger.info("Rendering release note for version %s", release.version)
+    render = e["ir.qweb"].render if hasattr(e["ir.qweb"], "render") else e["ir.qweb"]._render
+    message = render(report, values=values)
+    _announce_to_db(cr, message, to_admin_only=False)
+
+
 def announce_migration_report(cr):
     filepath = os.path.join(os.path.dirname(__file__), "report-migration.xml")
     with open(filepath, "rb") as fp:
@@ -90,27 +117,35 @@ def announce_migration_report(cr):
             contents = contents.replace(b"t-raw", b"t-out")
         report = lxml.etree.fromstring(contents)
     e = env(cr)
+    major_version, minor_version = re.findall(r"\d+", release.major_version)
     values = {
         "action_view_id": e.ref("base.action_ui_view").id,
-        "major_version": release.major_version,
+        "version": release.major_version,
+        "major_version": major_version,
+        "minor_version": minor_version,
         "messages": migration_reports,
         "get_anchor_link_to_record": get_anchor_link_to_record,
     }
     _logger.info(migration_reports)
     render = e["ir.qweb"].render if hasattr(e["ir.qweb"], "render") else e["ir.qweb"]._render
     message = render(report, values=values)
+    _announce_to_db(cr, message)
+    # To avoid posting multiple time the same messages in case this method is called multiple times.
+    migration_reports.clear()
+
+
+def _announce_to_db(cr, message, to_admin_only=True):
+    """Send a rendered message to the database via mail channel."""
     if not isinstance(message, basestring):
         message = message.decode("utf-8")
     if message.strip():
         message = message.replace("{", "{{").replace("}", "}}")
         kw = {}
         # If possible, post the migration report message to administrators only.
-        admin_channel = get_admin_channel(cr)
-        if admin_channel:
-            kw["recipient"] = admin_channel
+        recipient = get_admin_channel(cr) if to_admin_only else None
+        if recipient:
+            kw["recipient"] = recipient
         announce(cr, release.major_version, message, format="html", header=None, footer=None, **kw)
-    # To avoid posting multiple time the same messages in case this method is called multiple times.
-    migration_reports.clear()
 
 
 def rst2html(rst):