⚡ Sync Order

Author: yelizariev

sync/README.rst

@@ -1,6 +1,6 @@
 .. image:: https://itpp.dev/images/infinity-readme.png
    :alt: Tested and maintained by IT Projects Labs
-   :target: https://itpp.dev
+   :target: https://odoomagic.com
 
 .. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :target: https://opensource.org/licenses/MIT

sync/__manifest__.py

@@ -7,13 +7,16 @@
     "name": "Sync 🪬 Studio",
     "summary": """Join the Amazing 😍 Community ⤵️""",
     "category": "VooDoo ✨ Magic",
-    "version": "16.0.11.0.1",
+    "version": "16.0.13.0.0",
     "application": True,
     "author": "Ivan Kropotkin",
     "support": "[email protected]",
     "website": "https://sync_studio.t.me/",
     "license": "Other OSI approved licence",  # MIT
-    "depends": ["base_automation", "mail", "queue_job"],
+    # The `partner_telegram` dependency is not directly needed,
+    # but it plays an important role in the **Sync 🪬 Studio** ecosystem
+    # and is added for the quick onboarding of new **Cyber ✨ Pirates**.
+    "depends": ["base_automation", "mail", "queue_job", "partner_telegram"],
     "external_dependencies": {"python": ["markdown", "pyyaml"], "bin": []},
     "data": [
         "security/sync_groups.xml",
@@ -25,6 +28,7 @@
         "views/sync_trigger_automation_views.xml",
         "views/sync_trigger_webhook_views.xml",
         "views/sync_trigger_button_views.xml",
+        "views/sync_order_views.xml",
         "views/sync_task_views.xml",
         "views/sync_link_views.xml",
         "views/sync_project_views.xml",
@@ -37,12 +41,6 @@
     },
     "demo": [
         "data/sync_project_unittest_demo.xml",
-        # Obsolete
-        # "data/sync_project_context_demo.xml",
-        # "data/sync_project_telegram_demo.xml",
-        # "data/sync_project_odoo2odoo_demo.xml",
-        # "data/sync_project_trello_github_demo.xml",
-        # "data/sync_project_context_demo.xml",
     ],
     "qweb": [],
     "post_load": None,

sync/doc/MAGIC.rst

@@ -69,6 +69,7 @@ Libs
 * ``MAGIC.timezone``
 * ``MAGIC.b64encode``
 * ``MAGIC.b64decode``
+* ``MAGIC.sha256``
 
 Tools
 =====
@@ -80,6 +81,8 @@ Tools
 * ``MAGIC.type2str``: get type of the given object
 * ``MAGIC.DEFAULT_SERVER_DATETIME_FORMAT``
 * ``MAGIC.AttrDict``: Extended dictionary that allows for attribute-style access
+* ``MAGIC.group_by_lang(partners, default_lang="en_US")``: yields `lang, partners` grouped by lang
+* ``MAGIC.gen2csv(generator)``: prepares csv as a string
 
 Exceptions
 ==========

sync/doc/changelog.rst

@@ -1,3 +1,14 @@
+`13.0.0`
+-------
+
+- **Fix:** Use `__sync.` for xmlid namespace to avoid data loss on module update.
+- **Fix:** Use task ID in xmlid namespace for the task triggers.
+- **Fix:** Keep job records (and their logs) on task deletion.
+- **New:** Add *Sync Order* — advanced manual trigger with blackjack, partners list, text input, etc.
+- **New:** Support `data.markdown` for custom documentation in the `DATA.🐫` tab.
+- **New:** Add `MAGIC.group_by_lang` to eval context.
+- **Improvement:** Add `DATA.*` to the library eval context.
+
 `11.0.1`
 -------
 

sync/models/__init__.py

@@ -11,6 +11,7 @@
 from . import sync_task
 from . import sync_job
 from . import sync_data
+from . import sync_order
 from . import ir_logging
 from . import ir_actions
 from . import ir_attachment

sync/models/base.py

@@ -19,7 +19,7 @@ def search_links(self, relation_name, refs=None):
             ._search_links_odoo(self, relation_name, refs)
         )
 
-    def _create_or_update_by_xmlid(self, vals, code, namespace="XXX", module="sync"):
+    def _create_or_update_by_xmlid(self, vals, code, namespace="XXX", module="__sync"):
         """
         Create or update a record by a dynamically generated XML ID.
         Warning! The field `noupdate` is ignored, i.e. existing records are always updated.

sync/models/sync_job.py

@@ -31,7 +31,7 @@ class SyncJob(models.Model):
     trigger_webhook_id = fields.Many2one("sync.trigger.webhook", readonly=True)
     trigger_button_id = fields.Many2one("sync.trigger.button", readonly=True)
     task_id = fields.Many2one(
-        "sync.task", compute="_compute_sync_task_id", store=True, ondelete="cascade"
+        "sync.task", compute="_compute_sync_task_id", store=True, ondelete="set null"
     )
     project_id = fields.Many2one(
         "sync.project", related="task_id.project_id", readonly=True

sync/models/sync_order.py

@@ -0,0 +1,55 @@
+# Copyright 2024 Ivan Yelizariev <https://twitter.com/yelizariev>
+from odoo import api, fields, models
+
+
+class SyncOrder(models.Model):
+    _name = "sync.order"
+    _description = "Sync Order"
+    _inherit = ["mail.thread", "mail.activity.mixin"]
+    _order = "id desc"
+
+    name = fields.Char("Title")
+    body = fields.Text("Order")
+    sync_project_id = fields.Many2one("sync.project", related="sync_task_id.project_id")
+    sync_task_id = fields.Many2one(
+        "sync.task",
+        ondelete="cascade",
+        required=True,
+    )
+    description = fields.Html(related="sync_task_id.sync_order_description")
+    record_id = fields.Reference(
+        string="Record",
+        selection="_selection_record_id",
+        help="Optional extra information to perform this task",
+    )
+
+    partner_ids = fields.Many2many("res.partner", string="Partners")
+    state = fields.Selection(
+        [
+            ("draft", "Draft"),
+            ("open", "In Progress"),
+            ("done", "Done"),
+            ("cancel", "Canceled"),
+        ],
+        default="draft",
+    )
+
+    @api.model
+    def _selection_record_id(self):
+        mm = self.sync_task_id.sync_order_model_id
+        if not mm:
+            return []
+        return [(mm.model, mm.name)]
+
+    def action_done(self):
+        self.write({"state": "done"})
+
+    def action_confirm(self):
+        self.write({"state": "open"})
+
+    def action_cancel(self):
+        self.write({"state": "cancel"})
+
+    def action_refresh(self):
+        # Magic
+        pass

sync/models/sync_project.py

@@ -4,9 +4,14 @@
 # License MIT (https://opensource.org/licenses/MIT).
 
 import base64
+import csv
+import io
 import logging
 import os
 from datetime import datetime
+from hashlib import sha256
+from itertools import groupby
+from operator import itemgetter
 
 import urllib3
 from pytz import timezone
@@ -94,6 +99,8 @@ class SyncProject(models.Model):
 
     task_ids = fields.One2many("sync.task", "project_id", copy=True)
     task_count = fields.Integer(compute="_compute_task_count")
+    task_description = fields.Html(readonly=True)
+
     trigger_cron_count = fields.Integer(
         compute="_compute_triggers", help="Enabled Crons"
     )
@@ -103,13 +110,18 @@ class SyncProject(models.Model):
     trigger_webhook_count = fields.Integer(
         compute="_compute_triggers", help="Enabled Webhooks"
     )
+    sync_order_ids = fields.One2many(
+        "sync.order", "sync_project_id", string="Sync Orders", copy=True
+    )
+    sync_order_count = fields.Integer(compute="_compute_sync_order_count")
     job_ids = fields.One2many("sync.job", "project_id")
     job_count = fields.Integer(compute="_compute_job_count")
     log_ids = fields.One2many("ir.logging", "sync_project_id")
     log_count = fields.Integer(compute="_compute_log_count")
     link_ids = fields.One2many("sync.link", "project_id")
     link_count = fields.Integer(compute="_compute_link_count")
     data_ids = fields.One2many("sync.data", "project_id")
+    data_description = fields.Html(readonly=True)
 
     def copy(self, default=None):
         default = dict(default or {})
@@ -129,6 +141,11 @@ def _compute_task_count(self):
         for r in self:
             r.task_count = len(r.with_context(active_test=False).task_ids)
 
+    @api.depends("sync_order_ids")
+    def _compute_sync_order_count(self):
+        for r in self:
+            r.sync_order_count = len(r.sync_order_ids)
+
     @api.depends("job_ids")
     def _compute_job_count(self):
         for r in self:
@@ -259,6 +276,43 @@ def record2image(record, fname="image_1920"):
                 )
             )
 
+        def group_by_lang(partners, default_lang="en_US"):
+            """
+            Yield groups of partners grouped by their language.
+
+            :param partners: recordset of res.partner
+            :return: generator yielding tuples of (lang, partners)
+            """
+            if not partners:
+                return
+
+            # Sort the partners by 'lang' to ensure groupby works correctly
+            partners = partners.sorted(key=lambda p: p.lang)
+
+            # Group the partners by 'lang'
+            for lang, group in groupby(partners, key=itemgetter("lang")):
+                partner_group = partners.browse([partner.id for partner in group])
+                yield lang or default_lang, partner_group
+
+        def gen2csv(generator):
+            # Prepare a StringIO buffer to hold the CSV data
+            output = io.StringIO()
+
+            # Create a CSV writer with quoting enabled
+            writer = csv.writer(output, quoting=csv.QUOTE_ALL)
+
+            # Write rows from the generator
+            for row in generator:
+                writer.writerow(row)
+
+            # Get the CSV content
+            csv_content = output.getvalue()
+
+            # Close the StringIO buffer
+            output.close()
+
+            return csv_content
+
         context = dict(self.env.context, log_function=log, sync_project_id=self.id)
         env = self.env(context=context)
         link_functions = env["sync.link"]._get_eval_context()
@@ -294,8 +348,11 @@ def record2image(record, fname="image_1920"):
                 "timezone": timezone,
                 "b64encode": base64.b64encode,
                 "b64decode": base64.b64decode,
+                "sha256": sha256,
                 "type2str": type2str,
                 "record2image": record2image,
+                "gen2csv": gen2csv,
+                "group_by_lang": group_by_lang,
                 "DEFAULT_SERVER_DATETIME_FORMAT": DEFAULT_SERVER_DATETIME_FORMAT,
                 "AttrDict": AttrDict,
             },
@@ -467,11 +524,16 @@ def magic_upgrade(self):
         )
 
         # [Documentation]
-        vals["description"] = (
-            compile_markdown_to_html(gist_files.get("README.md"))
-            if gist_files.get("README.md")
-            else "<h1>Please add README.md file to place some documentation here</h1>"
-        )
+        for field_name, file_name in (
+            ("description", "README.md"),
+            ("task_description", "tasks.markdown"),
+            ("data_description", "datas.markdown"),
+        ):
+            vals[field_name] = (
+                compile_markdown_to_html(gist_files.get(file_name))
+                if gist_files.get(file_name)
+                else f"<h1>Please add {file_name} file to place some documentation here</h1>"
+            )
 
         # [PARAMS] and [SECRETS]
         for model, field_name, file_name in (
@@ -512,7 +574,7 @@ def magic_upgrade(self):
         for file_info in gist_content["files"].values():
             # e.g. "data.emoji.csv"
             file_name = file_info["filename"]
-            if not file_name.startswith("data."):
+            if not (file_name.startswith("data.") and file_name != "data.markdown"):
                 continue
             raw_url = file_info["raw_url"]
             response = http.request("GET", raw_url)
@@ -574,6 +636,20 @@ def magic_upgrade(self):
                 else None,
                 "project_id": self.id,
             }
+            # Sync Order Model
+            if meta.get("SYNC_ORDER_MODEL"):
+                model = self._get_model(meta.get("SYNC_ORDER_MODEL"))
+                task_vals["sync_order_model_id"] = model.id
+
+            # Parse docs
+            sync_order_description = gist_files.get(
+                file_name[: -len(".py")] + ".markdown"
+            )
+            if sync_order_description:
+                task_vals["sync_order_description"] = compile_markdown_to_html(
+                    sync_order_description
+                )
+
             task = self.env["sync.task"]._create_or_update_by_xmlid(
                 task_vals, task_technical_name, namespace=self.id
             )
@@ -585,7 +661,7 @@ def create_trigger(model, data):
                     trigger_name=data["name"],
                 )
                 return self.env[model]._create_or_update_by_xmlid(
-                    vals, data["name"], namespace=self.id
+                    vals, data["name"], namespace=f"p{self.id}t{task.id}"
                 )
 
             # Create/Update triggers
@@ -596,20 +672,37 @@ def create_trigger(model, data):
                 create_trigger("sync.trigger.webhook", data)
 
             for data in meta.get("DB_TRIGGERS", []):
-                model_id = self.env["ir.model"]._get(data["model"]).id
-                if not model_id:
-                    raise ValidationError(
-                        _(
-                            "Model %s is not available. Check if you need to install an extra module first."
+                model = self._get_model(data["model"])
+                if data.get("trigger_fields"):
+                    trigger_field_ids = []
+                    for f in data.pop("trigger_fields").split(","):
+                        ff = self.env["ir.model.fields"]._get(model.model, f)
+                        trigger_field_ids.append(ff.id)
+                    data["trigger_field_ids"] = [(6, 0, trigger_field_ids)]
+
+                for field_name in ("filter_pre_domain", "filter_domain"):
+                    if data.get(field_name):
+                        data[field_name] = data[field_name].replace(
+                            "{TASK_ID}", str(task.id)
                         )
-                        % data["model"]
-                    )
+
                 create_trigger(
-                    "sync.trigger.automation", dict(data, model_id=model_id, model=None)
+                    "sync.trigger.automation", dict(data, model_id=model.id, model=None)
                 )
 
         self.update(vals)
 
+    def _get_model(self, model_name):
+        model = self.env["ir.model"]._get(model_name)
+        if not model:
+            raise ValidationError(
+                _(
+                    "Model %s is not available. Check if you need to install an extra module first."
+                )
+                % model_name
+            )
+        return model
+
 
 class SyncProjectParamMixin(models.AbstractModel):