[14.0][IMP] edi_oca: Add new model edi.configuration #1035

thienvh332 · 2024-09-06T03:20:46Z

Specs

In edi_oca

Add generic edi.configuration model with these characteristics:

Fields

active
code
  uniq identifier, normalized
description: describe what the conf is for
backend_id
type_id

model: model the conf applies to

partner_ids: Apply the conf on specific partners (Leave blank to apply all partners)

trigger: Selection field to make easier and more explicit the use of the conf for a specific event (eg: on_post_account_move, on_so_confirm, etc)
    default option: empty

snippet_before_do: validate the state, used to collect records todo
    can be used to do anything before the action that triggered it
  
    eval ctx:
        trigger = create/write/$name_of_the_event
        conf = current conf

    the snippet can return:
        todo = True/False
        snippet_do_vars = {}  # set of variables to pass over to the next snippet
        event_only
        tracked_fields
        edi_action
        .. in fact, any other variable that might be needed

snippet_do: used to do something specific here

    receives: operation, edi_action, vals, old_vals

This model can then be used by conf consumers.
Other methods:

edi_exec_snippet_before_do(self, record):
  exec before snippet, self=conf

edi_exec_snippet_do(self, record):
  exec snippet, self=conf

edi_get_conf(self, trigger, model_name=None, partners=None, backend=None):
  filter current recordset based on conditions

Backend / Exc. record

In `edi.backend._check_output_exchange_sync` move the loop on new_records to a new method `exchange_generate_send` whereas if the file has to be generated
2 jobs are chained (generate + send) if only send is needed, delay only one job.

Then add edi.exchange.record.action_exchange_generate_send and use that method from backend.
Consumer mixin

Specific fields for configuration (eg: edi_purchase_conf_ids) will be added by glue modules on res.partner.

Default conf

add generic conf for send_via_email

code: send_via_email
trigger: on_email_send
snippet: `record._edi_send_via_email()

add generic conf for send_via_edi

code: send_via_edi
trigger: none
snippet: `record._edi_send_via_edi(conf.type_id)

NOTE: sending emails is not really bound to edi
but in real life it's handy to have a default way to send EDI docs via email.
You could even generate an exchange record to keep track of that
but the choice will be up to the implementers.
The key is that w/ this features they can do whatever they want.

Views

add a specific menu item in edi settings to see all confs
make them searchable by model, active/inactive, partner, exc type, trigger

On edi_purchase_oca

add conf trigger on_button_confirm_purchase_order

add res.partner.edi_purchase_conf_ids
domain model=purchase.order, default_model=purchase.order, default_res_id=active_id

(document this approach in edi_oca readme section for edi.conf)

add generic conf for send_via_email_rfq

code: send_via_email_rfq
snippet: `record._edi_send_via_email(ir_action=record.action_rfq_send())

Example of specific listener implementation:

class EDIConfigPurchaseListener(Component):
    _name = "edi.config.consumer.listener.purchase.order"
    _inherit = "base.event.listener"

def on_button_confirm_purchase_order(self, record):
    trigger = "on_button_confirm_purchase_order"
    confs = record.edi_purchase_conf_ids.edi_get_conf(trigger)
    for conf in confs:
        conf.edi_exec_snippet_do(record)

OCA-git-bot · 2024-09-06T04:46:06Z

Hi @etobella, @simahawk,
some modules you are maintaining are being modified, check this out!

etobella · 2024-09-06T05:19:49Z

More information would be awesome in order to understand why you did this.

simahawk · 2024-09-06T05:47:37Z

@etobella this origins from our discussion on OCA/edi-framework#39
@thienvh332 I'm adding the specs I gave you in the description feel free to adapt / add more things.
IMO we should split the purchase part when ready (let's say before switching from draft to real PR to ease the final review of both parts).

simahawk · 2024-09-06T05:50:50Z

@thienvh332 as it's draft, do you want us to wait for a review?

nilshamerlinck · 2024-09-06T06:37:53Z

hi @simahawk

yes, please wait before reviewing, we need to finalize the internal review on our side
now that you confirmed you want this in v14, we'll complete it asap

thienvh332 · 2024-09-18T11:14:55Z

Hello @simahawk ,
This PR is ready for review. Could you please take a look at it?

simahawk · 2024-10-09T13:47:43Z

can you drop the pypdf fix? 15a994e

simahawk · 2024-10-09T13:51:00Z

edi_oca/models/edi_exchange_consumer_mixin.py

+    ):
+        # Default action if not provided
+        if ir_action is None:
+            # `action_send_email` is just an action name I created


I don't get what's the need for this ... there's no action_send_email anywhere.

simahawk · 2024-10-09T13:53:24Z

edi_oca/models/edi_configuration.py

+    code = fields.Char(required=True, copy=False, index=True, unique=True)
+    description = fields.Char(help="Describe what the conf is for")
+    backend_id = fields.Many2one(string="Backend", comodel_name="edi.backend")
+    type_id = fields.Many2one(


type should be mandatory

simahawk · 2024-10-09T13:55:42Z

edi_oca/models/edi_configuration.py

+        help="Model the conf applies to. Leave blank to apply for all models",
+    )
+    model_name = fields.Char(related="model.model", store=True)
+    partner_ids = fields.Many2many(


There's no need for a partner_ids field. The conf should be stored on the partner on a specific field per app or module (eg: edi_purchase_conf_ids).
The goal is to have clarity on UI on what confs are used for.
In fact, it's not in the specs.

simahawk · 2024-10-09T13:59:29Z

edi_oca/models/edi_configuration.py

+    def default_get(self, fields):
+        vals = super().default_get(fields)
+        model = self.env.context.get("default_model_name", False)
+        partners = self.env.context.get("default_partner_ids", False)


I'd choose which model field you want to be the master. If the model name is only used for searches, we don't need this.
Partners as well, can be trashed here.

simahawk · 2024-10-09T14:00:11Z

edi_oca/models/edi_configuration.py

@@ -0,0 +1,222 @@
+# Copyright 2024 Camptocamp SA


This comes from the auto-type stuff, can you keep the authorship here?

The license must be LGPL

simahawk · 2024-10-09T14:22:38Z

edi_oca/components/base_listener_config.py

+from odoo.addons.component.core import Component
+
+
+class EDIBackendListenerComponentConfig(Component):


this listener is useless IMO. See below.

simahawk · 2024-10-09T14:27:51Z

edi_oca/models/edi_configuration_mixin.py

+_logger = logging.getLogger(__name__)
+
+
+class EDIConfigurationMixin(models.AbstractModel):


I don't understand why we need this mixin. Is not in the specs... :/
Looks like a not required copy/past from *_auto module.

I think there's a big misunderstanding on WHO is supposed to trigger the specific action.
I wanted to simplify what I've done on *_auto module getting rid of all this automation and leave the control to the specific module and to the configuration that you can define.

Concept:

the trigger is given by the specific module -> on_button_confirm_purchase_order must be an event triggered by the module edi_purchase_oca when button_confirm is called (which is already the case!)

the condition to skip or exec a conf is defined on the conf itself -> that's why I described 2 methods (before_do and do)

simahawk · 2024-10-09T14:28:51Z

edi_oca/tests/fake_models.py

@@ -7,10 +7,11 @@

 class EdiExchangeConsumerTest(models.Model):
    _name = "edi.exchange.consumer.test"
-    _inherit = ["edi.exchange.consumer.mixin"]
+    _inherit = ["edi.exchange.consumer.mixin", "edi.configuration.mixin"]


you can rollback this

simahawk · 2024-10-09T14:29:54Z

edi_oca/tests/fake_models.py

    _description = "Model used only for test"

    name = fields.Char()
+    partner_id = fields.Many2one("res.partner")


why a partner_id? If there's no partner on the model we should not run anything or even break the init of the model if you are assigning configurations to a model w/o partners

simahawk · 2024-10-09T14:30:39Z

edi_purchase_oca/components/listener_purchase_order.py

+    def on_button_confirm_purchase_order(self, record):
+        trigger = "on_button_confirm_purchase_order"
+        for rec in record:
+            confs = self.env["edi.configuration"].edi_get_conf(


you are not using edi_purchase_conf_ids

thienvh332 force-pushed the 14.0-imp-edi_oca branch 6 times, most recently from 0a7f624 to 92b7973 Compare September 18, 2024 08:56

thienvh332 added 2 commits September 18, 2024 17:08

[ADD] edi_oca: Add new model edi.configuration

0a923bb

[UPD] edi_purchase_oca: Update for edi configuration

a65062e

thienvh332 force-pushed the 14.0-imp-edi_oca branch from 92b7973 to 89cc982 Compare September 18, 2024 10:09

[FIX] pdf_helper: fix issue pypdf 5.0 dropped support for python<=3.7

15a994e

thienvh332 force-pushed the 14.0-imp-edi_oca branch from 89cc982 to 15a994e Compare September 18, 2024 10:55

thienvh332 marked this pull request as ready for review September 18, 2024 11:11

simahawk requested changes Oct 9, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[14.0][IMP] edi_oca: Add new model edi.configuration #1035

[14.0][IMP] edi_oca: Add new model edi.configuration #1035

thienvh332 commented Sep 6, 2024 •

edited

Loading

OCA-git-bot commented Sep 6, 2024

etobella commented Sep 6, 2024

simahawk commented Sep 6, 2024 •

edited

Loading

simahawk commented Sep 6, 2024

nilshamerlinck commented Sep 6, 2024

thienvh332 commented Sep 18, 2024

simahawk commented Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

		from odoo.addons.component.core import Component


		class EDIBackendListenerComponentConfig(Component):

		_logger = logging.getLogger(__name__)


		class EDIConfigurationMixin(models.AbstractModel):

[14.0][IMP] edi_oca: Add new model edi.configuration #1035

Are you sure you want to change the base?

[14.0][IMP] edi_oca: Add new model edi.configuration #1035

Conversation

thienvh332 commented Sep 6, 2024 • edited Loading

Specs

OCA-git-bot commented Sep 6, 2024

etobella commented Sep 6, 2024

simahawk commented Sep 6, 2024 • edited Loading

simahawk commented Sep 6, 2024

nilshamerlinck commented Sep 6, 2024

thienvh332 commented Sep 18, 2024

simahawk commented Oct 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thienvh332 commented Sep 6, 2024 •

edited

Loading

simahawk commented Sep 6, 2024 •

edited

Loading