[14.0] cooperator: Multi-company e-mail templates #73

carmenbianca · 2023-06-06T15:12:50Z

Internal task: https://gestion.coopiteasy.be/web#id=10674&action=475&active_id=470&model=project.task&view_type=form&menu_id=536

PR to have each company utilise unique mail templates to send cooperator-related e-mails. The use case is that each company can personalise their mail template to their own desires without affecting other companies.

cooperator/__init__.py

huguesdk · 2023-06-07T08:52:20Z

cooperator/models/company.py

+    cooperator_certificate_mail_template = fields.Many2one(
+        comodel_name="mail.template",
+        string="Certificate email template",
+        domain="[('model', '=', 'res.partner')]",


an actual domain or a string are allowed for this attribute. is there a particular reason to use the string version?

I copied this from stock ;) No particular reason.

In this commit, the confirmation e-mail template (chosen at random) is configured on the res.company model instead of fetched via its XMLID. In a future commit, all the other cooperator-related e-mail templates will be configured in the same way, using the common scaffolding from this commit. The commit introduces a bug/regression, which is that the confirmation e-mail won't actually be sent. This is a result of the new scaffolding. Before, this happened: 1. cooperator is marked installed. 2. The mail template data file gets sourced, creating the confirmation template's record. 3. The subscription request demo data file gets sourced, creating a subscription.request record. 4. While creating the record, an e-mail using the confirmation template gets sent. In the new logic, this happens: 1. cooperator is marked installed. 2. The mail template data file gets sourced, creating the confirmation template's record, but NOT setting it on company 1. 3. The subscription request demo data file gets sourced, creating a subscription.request record. 4. While creating the record, Odoo tries to send a mail of the template company_id.cooperator_confirmation_mail_template, but the field is empty. 5. Error, obviously, but we've commented out the erroneous code, so let's proceed. 6. As a post-init hook, a copy of the confirmation template gets set on all companies' cooperator_confirmation_mail_template field. We'll need to re-jig the logic to circumvent the error. A problem for future me. Or you, if you're reading this in the distant future. Hello. Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

…pany Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

…n company Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

…company Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

…bscription request creation This was rather bad design to start with, and caused a bug during the installation of this module (at which stage the mail templates were not yet correctly set on the companies). An additional state 'confirmed' is created. The use case is to immediately click on it after all the values are correct. Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

enricostano · 2023-06-09T18:58:48Z

cooperator/models/company.py

+        if copy:
+            result = template.copy()
+            # Set name to 'Company - Template' instead of 'Template (copy)'.
+            result.name = "{} - {}".format(self.name, template.name)


Shouldn't we also set company_id here to the template?
Maybe we need https://github.com/OCA/multi-company/blob/14.0/mail_template_multi_company/models/mail_template.py#L11 for that.
What do you think?

Yes, initially I did do that here, but the mail_template_multi_company module is not in a usable state as far as I can tell.

OCA/multi-company#483

what about removing the default value for company_id in this module? would it be too late in that the data would already be assigned to the 1st company?

This module = cooperator or mail_template_multi_company?

Because there's nothing in cooperator that we can change to fix the problem described in the linked issue.

i was referring to cooperator: redefining the mail.template.company_id field without a default value.

mail.template are not multi-company by default, there isn't a company_id in the model if mail_template_multi_company is not installed.
If we want to add a unique template for every company, we would need this module, but I understand that the scope of this PR is to add mail.template selection for coopertor regardless if they are multi-company or not.

I think if we want to fix this, the most 'correct' thing to do is to move this discussion to OCA/multi-company#483 and fix this upstream.

… from subscription request creation" This reverts commit bf5aa27. This would imply a functional change that is not wanted at the moment. Let's solve this in a different way.

…are created Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

huguesdk

great, thanks for this @carmenbianca. lgtm with just some code style comments.

cooperator/models/account_move.py

cooperator/models/company.py

huguesdk · 2023-06-12T09:53:25Z

cooperator/models/company.py

+        if copy:
+            result = template.copy()
+            # Set name to 'Company - Template' instead of 'Template (copy)'.
+            result.name = "{} - {}".format(self.name, template.name)


i was referring to cooperator: redefining the mail.template.company_id field without a default value.

cooperator/models/subscription_request.py

DaniilDigtyar · 2023-06-13T07:36:28Z

cooperator/models/company.py

+    cooperator_certificate_mail_template = fields.Many2one(
+        comodel_name="mail.template",
+        string="Certificate email template",
+        domain="[('model', '=', 'res.partner')]",


Maybe we can assign by default the mail template of cooperator, so we don't need to select it every time we create a new company.
Also, if is not assigned, it gets the cooperator template? Should be this field required?

Agree with @DaniilDigtyar.
Also: perhaps the domain should add the ('is_cooperator_template', '=', True) element (in addition to the correspondant model one)

I see now that is assigned when creating the company.

I'm not entirely sure what the proposal is. This is the philosophy of the current state of the PR:

There exists a template (in truth, several, but let's simplify to 1) defined in the XML data. Let's call this the global template. This template is not itself used anywhere. Instead, when a company is created, a copy of the global template is created and set on the field in res.company.

The upside of this approach is that none of the non-global templates interfere with each other. The downside is that you get the following slight UX problem: When creating a company, you leave the mail template field empty. After clicking on 'save', the copy is created and the field is populated. If you now erase the contents of that field, nothing will stop you, and you will break the cooperator module.

I have bypassed one of the UX problems by making the mail template field invisible until after clicking on 'save'. This means the user won't be confused by an empty field suddenly being populated, or feeling like they have to populate these fields during creation when in fact they needn't.

The other problem I am not certain how to work around. The field can't be mandatory, because it's empty during creation. Similar problem in re adding a constraint. Maybe you could do an onchange or write that throws an error; I'm not sure.

Your proposal, as I understand it, is to use the global by default on companies, either by making it the default value of the field, or by making it a fallback value in a helper getter method (both are fine; I'd probably prefer the former over the latter, but it's just about the same). This fixes the UX problems (although we may need to add a help text that 'empty' is a valid value for the template field), but does change the philosophy: where previously all templates were always separate, they are now identical-unless-declared-otherwise.

I'm fine with that change in philosophy, but it has the downside that a user at one company may change the template without realising that this affects all other companies.

@DaniilDigtyar @XavierBonetViura Let me know which approach you prefer.

No, you are right and this is correct implementation. It was a misunderstanding about how it was working because we didn't understand the assignation of the relations after the creation of the company record.

This philosophy of your implementation is the one that we need in Som Comunitats projects, because we need to have different mail.templates for all companies, even if there are little variation between them.

But maybe for a more global need of cooperator, it will make sense to use the global mail template as the default for all the companies and not copy them on every creation, because this will cause an extensive list of same mail.template shared between all the companies (because there isn't a company_id by default)

Creating systematically a .copy() of each email_template and assign those new templates to every new company that we create is an aproach that have some issues:

We want to have the possibility to have it, ... but sure that not all companies will need to have it (personalized templates). Perhaps only FEW companies will want to have it.

Caution with the templates Translation effort. I we build new templates for absolutelly each new company we will need to proceed to translate it per each company. I can be crazy to maintain.

If we proceed to do CHANGES into the 'cooperator' templates by code (adding globally new fuctionallity),.... those improvements will not apply at all at any company because we have ALL the templates personalized.

Perhaps it will be better to have another aproach:

have the new fields available at res_company to select personalized templates,... but allow to have it EMPTY (by default).

If those fields are EMPLY, the code will use the 'corporate' (cooperator) base templates.

If a company need to PERSONALYZE A TEMPLATE, allow a button at mail_template model to do a COPY of any of the coopetaror templates,... and assign company_id field to those new copied templates.

filally at the res_company fields that point to those persolalyzed email_templates, force the domain in order to ONLY show to be selected the templates that match the field company_id (and that are cooperator ones)

@XavierBonetViura I have implemented the above proposal, where empty = default. Thank you for that proposal.

I have not presently implemented a 'copy' button. Let's come back to that later, maybe.

cooperator/models/company.py

… otherwise specified This is a big revert of previous commits. Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

… company

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

DaniilDigtyar

LGTM

enricostano

👏

XavierBonetViura

Looks Good to me

carmenbianca force-pushed the 14.0-cooperator-mail-multi-company branch from ba2fc00 to 9157219 Compare June 7, 2023 08:48

huguesdk reviewed Jun 7, 2023

View reviewed changes

carmenbianca changed the title ~~[14.0][IMP] cooperator: Scaffolding for multi-company e-mail templates~~ [14.0] cooperator: Multi-company e-mail templates Jun 7, 2023

carmenbianca force-pushed the 14.0-cooperator-mail-multi-company branch 2 times, most recently from 7e74c42 to 0168ce7 Compare June 8, 2023 09:08

carmenbianca marked this pull request as ready for review June 8, 2023 09:09

carmenbianca force-pushed the 14.0-cooperator-mail-multi-company branch from 0168ce7 to 4331eca Compare June 9, 2023 08:55

carmenbianca added 11 commits June 9, 2023 11:24

[IMP] cooperator: Set cooperator_capital_release_mail_template on com…

1fa6208

…pany Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

[IMP] cooperator: Set cooperator_waiting_list_mail_template on company

35f27cf

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

[IMP] cooperator: Set cooperator_confirmation_company_mail_template o…

043d643

…n company Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

[IMP] cooperator: Set cooperator_certificate_mail_template on company

8df99ef

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

[IMP] cooperator: Set cooperator_certifice_increase_mail_template on …

579b744

…company Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

[IMP] cooperator: Set cooperator_share_transfer_mail_template on company

0c81316

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

[IMP] cooperator: Set cooperator_share_update_mail_template on company

97bc40b

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

[IMP] cooperator: Migration script to populate company fields

3a7279e

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

[FIX] cooperator: Make template fields invisible during company creation

8b38774

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

carmenbianca force-pushed the 14.0-cooperator-mail-multi-company branch from 4331eca to 8b38774 Compare June 9, 2023 09:24

carmenbianca requested a review from huguesdk June 9, 2023 09:24

enricostano reviewed Jun 9, 2023

View reviewed changes

carmenbianca added 4 commits June 12, 2023 11:37

Revert "[REF] cooperator: Send confirmation e-mail as a separate step…

528df97

… from subscription request creation" This reverts commit bf5aa27. This would imply a functional change that is not wanted at the moment. Let's solve this in a different way.

[FIX] cooperator: Correctly set templates on company after templates …

5812383

…are created Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

[FIX] cooperator: override → overwrite

07efcf3

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

[FIX] cooperator: Fix English letter closing

dbfff89

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

carmenbianca force-pushed the 14.0-cooperator-mail-multi-company branch from 314ca85 to dbfff89 Compare June 12, 2023 13:26

carmenbianca mentioned this pull request Jun 12, 2023

cooperator: Confirmation e-mail is sent too soon #76

Open

huguesdk approved these changes Jun 12, 2023

View reviewed changes

DaniilDigtyar reviewed Jun 13, 2023

View reviewed changes

cooperator/models/company.py Outdated Show resolved Hide resolved

huguesdk reviewed Jun 13, 2023

View reviewed changes

cooperator/models/company.py Outdated Show resolved Hide resolved

carmenbianca added 3 commits June 13, 2023 16:52

[REF] cooperator: Change philosophy; use default mail template unless…

788fb91

… otherwise specified This is a big revert of previous commits. Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

fixup! [IMP] cooperator: Set cooperator_share_update_mail_template on…

5fa59b3

… company

[IMP] cooperator: Make domains stricter

765aec3

Signed-off-by: Carmen Bianca BAKKER <carmen@coopiteasy.be>

DaniilDigtyar approved these changes Jun 22, 2023

View reviewed changes

enricostano approved these changes Jun 22, 2023

View reviewed changes

XavierBonetViura approved these changes Jun 22, 2023

View reviewed changes

[IMP] cooperator: Add newsfragment

12024fb

huguesdk mentioned this pull request Jul 14, 2023

[14.0][IMP] make cooperator multi-company compatible #83

Merged

OCA-git-bot merged commit 5cd3192 into OCA:14.0 Jul 25, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[14.0] cooperator: Multi-company e-mail templates #73

[14.0] cooperator: Multi-company e-mail templates #73

carmenbianca commented Jun 6, 2023 •

edited

huguesdk Jun 7, 2023

carmenbianca Jun 7, 2023

enricostano Jun 9, 2023

carmenbianca Jun 10, 2023

huguesdk Jun 12, 2023

carmenbianca Jun 12, 2023

huguesdk Jun 12, 2023

DaniilDigtyar Jun 13, 2023

carmenbianca Jun 13, 2023

huguesdk left a comment

huguesdk Jun 12, 2023

DaniilDigtyar Jun 13, 2023

XavierBonetViura Jun 13, 2023

DaniilDigtyar Jun 13, 2023

carmenbianca Jun 13, 2023

DaniilDigtyar Jun 13, 2023

DaniilDigtyar Jun 13, 2023

XavierBonetViura Jun 13, 2023 •

edited

carmenbianca Jun 13, 2023

DaniilDigtyar left a comment

enricostano left a comment

XavierBonetViura left a comment

[14.0] cooperator: Multi-company e-mail templates #73

[14.0] cooperator: Multi-company e-mail templates #73

Conversation

carmenbianca commented Jun 6, 2023 • edited

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

huguesdk left a 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

XavierBonetViura Jun 13, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaniilDigtyar left a comment

Choose a reason for hiding this comment

enricostano left a comment

Choose a reason for hiding this comment

XavierBonetViura left a comment

Choose a reason for hiding this comment

carmenbianca commented Jun 6, 2023 •

edited

XavierBonetViura Jun 13, 2023 •

edited