Test Post Performances with an email ping
'), partner_ids=self.customer.ids, @@ -741,33 +749,136 @@ class TestMailAPIPerformance(BaseMailPerformance): @tagged('mail_performance', 'post_install', '-at_install') class TestMailComplexPerformance(BaseMailPerformance): - def setUp(self): - super(TestMailComplexPerformance, self).setUp() - self.user_portal = self.env['res.users'].with_context(self._test_context).create({ + @classmethod + def setUpClass(cls): + super().setUpClass() + + cls.user_portal = cls.env['res.users'].with_context(cls._test_context).create({ 'name': 'Olivia Portal', 'login': 'port', 'email': 'p.p@example.com', 'signature': '--\nOlivia', 'notification_type': 'email', - 'groups_id': [(6, 0, [self.env.ref('base.group_portal').id])], + 'groups_id': [(6, 0, [cls.env.ref('base.group_portal').id])], }) - self.container = self.env['mail.test.container'].with_context(mail_create_nosubscribe=True).create({ - 'name': 'Test Container', - 'customer_id': self.customer.id, - 'alias_name': 'test-alias', - }) - Partners = self.env['res.partner'].with_context(self._test_context) - self.partners = self.env['res.partner'] - for x in range(0, 10): - self.partners |= Partners.create({'name': 'Test %s' % x, 'email': 'test%s@example.com' % x}) - self.container.message_subscribe(self.partners.ids, subtype_ids=[ - self.env.ref('mail.mt_comment').id, - self.env.ref('test_mail.st_mail_test_container_child_full').id + cls.containers = cls.env['mail.test.container'].with_context(mail_create_nosubscribe=True).create([ + { + 'alias_name': 'test-alias', + 'customer_id': cls.customers[0].id, + 'name': 'Test Container', + }, { + 'alias_name': 'test-alias-2', + 'customer_id': cls.customers[1].id, + 'name': 'Test Container 2', + }, + ]) + Partners = cls.env['res.partner'].with_context(cls._test_context) + cls.partners = Partners.create([ + { + 'name': f'Test {idx}', + 'email': f'test{idx}@example.com', + } + for idx in range(10) + ]) + cls.containers.message_subscribe(cls.partners.ids, subtype_ids=[ + cls.env.ref('mail.mt_comment').id, + cls.env.ref('test_mail.st_mail_test_container_child_full').id + ]) + cls.container = cls.containers[0] + + name_field = cls.env['ir.model.fields']._get(cls.container._name, 'name') + customer_id_field = cls.env['ir.model.fields']._get(cls.container._name, 'customer_id') + comment_subtype_id = cls.env['ir.model.data']._xmlid_to_res_id('mail.mt_comment') + + cls.messages_all = cls.env['mail.message'].sudo().create([ + { + 'attachment_ids': [ + (0, 0, { + 'datas': 'data', + 'name': f'Test file {att_idx}', + 'res_id': record.id, + 'res_model': record._name, + }) + for att_idx in range(2) + ], + 'author_id': cls.partners[msg_idx].id, + 'body': f'Test {msg_idx}
', + 'email_from': cls.partners[msg_idx].email_formatted, + 'link_preview_ids': [ + (0, 0, { + 'source_url': 'https://www.odoo.com', + }), (0, 0, { + 'source_url': 'https://www.example.com', + }), + ], + 'message_type': 'comment', + 'model': record._name, + 'notification_ids': [ + (0, 0, { + 'is_read': False, + 'notification_type': 'inbox', + 'res_partner_id': cls.partners[(record_idx * 5) + (msg_idx * 2)].id, + }), + (0, 0, { + 'is_read': True, + 'notification_type': 'email', + 'notification_status': 'sent', + 'res_partner_id': cls.partners[(record_idx * 5) + (msg_idx * 2) + 1].id, + }), + (0, 0, { + 'is_read': True, + 'notification_type': 'email', + 'notification_status': 'exception', + 'res_partner_id': cls.partners[(record_idx * 5) + (msg_idx * 2) + 2].id, + }), + ], + 'partner_ids': [ + (4, cls.partners[(record_idx * 5) + msg_idx].id), + (4, cls.partners[(record_idx * 5) + msg_idx + 1].id), + ], + 'reaction_ids': [ + (0, 0, { + 'content': '\U0001F4E7', + 'partner_id': cls.partners[(record_idx * 5)].id + }), (0, 0, { + 'content': '\U0001F4E8', + 'partner_id': cls.partners[(record_idx * 5) + 1].id + }), + ], + 'res_id': record.id, + 'starred_partner_ids': [ + (4, cls.partners[(record_idx * 5) + msg_idx].id), + (4, cls.partners[(record_idx * 5) + (msg_idx * 2) + 1].id), + ], + 'subject': f'Test Container {msg_idx}', + 'subtype_id': comment_subtype_id, + 'tracking_value_ids': [ + (0, 0, { + 'field': name_field.id, + 'field_desc': 'Name', + 'new_value_char': 'new 0', + 'old_value_char': 'old 0', + }), + (0, 0, { + 'field': customer_id_field.id, + 'field_desc': 'Customer', + 'new_value_char': 'new 1', + 'new_value_integer': cls.partners[(record_idx * 5)].id, + 'old_value_char': 'old 1', + 'old_value_integer': cls.partners[(record_idx * 5) + 1].id, + }), + ] + } + for msg_idx in range(2) + for record_idx, record in enumerate(cls.containers) ]) # `test_complex_mail_mail_send` - self.env.flush_all() + cls.env.flush_all() + + def test_assert_initial_values(self): + self.assertEqual(len(self.messages_all), 2*2) @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') @users('admin', 'employee') @@ -793,7 +904,7 @@ class TestMailComplexPerformance(BaseMailPerformance): 'mail_message_id': message.id, 'recipient_ids': [(4, pid) for pid in self.partners.ids], }) - with self.assertQueryCount(admin=9, employee=9): + with self.assertQueryCount(admin=7, employee=7): self.env['mail.mail'].sudo().browse(mail.ids).send() @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') @@ -832,7 +943,7 @@ class TestMailComplexPerformance(BaseMailPerformance): unlinked_mails |= set(records.ids) unlinked_mails = set() - with self.assertQueryCount(admin=32, employee=32), \ + with self.assertQueryCount(admin=30, employee=30), \ patch.object(type(self.env['mail.mail']), 'unlink', _patched_unlink): self.env['mail.mail'].sudo().browse(mails.ids).send() @@ -852,7 +963,7 @@ class TestMailComplexPerformance(BaseMailPerformance): record = self.container.with_user(self.env.user) # about 20 (19?) queries per additional customer group - with self.assertQueryCount(admin=56, employee=55): + with self.assertQueryCount(admin=55, employee=54): record.message_post( body=Markup('Test Post Performances
'), message_type='comment', @@ -870,7 +981,7 @@ class TestMailComplexPerformance(BaseMailPerformance): template = self.env.ref('test_mail.mail_test_container_tpl') # about 20 (19 ?) queries per additional customer group - with self.assertQueryCount(admin=63, employee=62): + with self.assertQueryCount(admin=62, employee=61): record.message_post_with_source( template, message_type='comment', @@ -960,7 +1071,7 @@ class TestMailComplexPerformance(BaseMailPerformance): }) rec1 = rec.with_context(active_test=False) # to see inactive records self.assertEqual(rec1.message_partner_ids, self.partners | self.env.user.partner_id) - with self.assertQueryCount(admin=39, employee=39): + with self.assertQueryCount(admin=38, employee=38): rec.write({'user_id': self.user_portal.id}) self.assertEqual(rec1.message_partner_ids, self.partners | self.env.user.partner_id | self.user_portal.partner_id) # write tracking message @@ -980,7 +1091,7 @@ class TestMailComplexPerformance(BaseMailPerformance): customer_id = self.customer.id user_id = self.user_portal.id - with self.assertQueryCount(admin=94, employee=94): + with self.assertQueryCount(admin=92, employee=92): rec = self.env['mail.test.ticket'].create({ 'name': 'Test', 'container_id': container_id, @@ -1009,7 +1120,7 @@ class TestMailComplexPerformance(BaseMailPerformance): rec1 = rec.with_context(active_test=False) # to see inactive records self.assertEqual(rec1.message_partner_ids, self.user_portal.partner_id | self.env.user.partner_id) self.assertEqual(len(rec1.message_ids), 1) - with self.assertQueryCount(admin=59, employee=59): + with self.assertQueryCount(admin=58, employee=58): rec.write({ 'name': 'Test2', 'container_id': self.container.id, @@ -1046,7 +1157,7 @@ class TestMailComplexPerformance(BaseMailPerformance): rec1 = rec.with_context(active_test=False) # to see inactive records self.assertEqual(rec1.message_partner_ids, self.user_portal.partner_id | self.env.user.partner_id) - with self.assertQueryCount(admin=65, employee=65): + with self.assertQueryCount(admin=64, employee=64): rec.write({ 'name': 'Test2', 'container_id': container_id, @@ -1079,7 +1190,7 @@ class TestMailComplexPerformance(BaseMailPerformance): rec1 = rec.with_context(active_test=False) # to see inactive records self.assertEqual(rec1.message_partner_ids, self.partners | self.env.user.partner_id | self.user_portal.partner_id) - with self.assertQueryCount(admin=33, employee=33): + with self.assertQueryCount(admin=32, employee=32): rec.write({ 'name': 'Test2', 'customer_id': customer_id, @@ -1100,115 +1211,42 @@ class TestMailComplexPerformance(BaseMailPerformance): @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') @users('employee') @warmup - def test_message_format(self): + def test_message_format_multi(self): """Test performance of `_message_format` and of `message_format` with multiple messages with multiple attachments, different authors, various notifications, and different tracking values. + Those messages might not make sense functionally but they are crafted to cover as much of the code as possible in regard to number of queries. + + Setup : + * 2 records (self.containers -> 2 mail.test.container record, with + a different customer_id each) + * 2 messages / record + * 2 attachments / message + * 3 notifications / message + * 2 tracking values / message """ - name_field = self.env['ir.model.fields']._get(self.container._name, 'name') - customer_id_field = self.env['ir.model.fields']._get(self.container._name, 'customer_id') + messages_all = self.messages_all.with_env(self.env) - messages = self.env['mail.message'].sudo().create([{ - 'subject': 'Test 0', - 'body': 'Test 0
', - 'author_id': self.partners[0].id, - 'email_from': self.partners[0].email, - 'model': 'mail.test.container', - 'res_id': self.container.id, - 'subtype_id': self.env['ir.model.data']._xmlid_to_res_id('mail.mt_comment'), - 'attachment_ids': [ - (0, 0, { - 'name': 'test file 0 - %d' % j, - 'datas': 'data', - }) for j in range(2) - ], - 'notification_ids': [ - (0, 0, { - 'res_partner_id': self.partners[3].id, - 'notification_type': 'inbox', - }), - (0, 0, { - 'res_partner_id': self.partners[4].id, - 'notification_type': 'email', - 'notification_status': 'exception', - }), - (0, 0, { - 'res_partner_id': self.partners[6].id, - 'notification_type': 'email', - 'notification_status': 'exception', - }), - ], - 'tracking_value_ids': [ - (0, 0, { - 'field': name_field.id, - 'field_desc': 'Name', - 'old_value_char': 'old 0', - 'new_value_char': 'new 0', - }), - (0, 0, { - 'field': customer_id_field.id, - 'field_desc': 'Customer', - 'old_value_integer': self.partners[7].id, - 'new_value_integer': self.partners[8].id, - }), - ] - }, { - 'subject': 'Test 1', - 'body': 'Test 1
', - 'author_id': self.partners[1].id, - 'email_from': self.partners[1].email, - 'model': 'mail.test.container', - 'res_id': self.container.id, - 'subtype_id': self.env['ir.model.data']._xmlid_to_res_id('mail.mt_note'), - 'attachment_ids': [ - (0, 0, { - 'name': 'test file 1 - %d' % j, - 'datas': 'data', - }) for j in range(2) - ], - 'notification_ids': [ - (0, 0, { - 'res_partner_id': self.partners[5].id, - 'notification_type': 'inbox', - }), - (0, 0, { - 'res_partner_id': self.partners[6].id, - 'notification_type': 'email', - 'notification_status': 'exception', - }), - ], - 'tracking_value_ids': [ - (0, 0, { - 'field': name_field.id, - 'field_desc': 'Name', - 'old_value_char': 'old 1', - 'new_value_char': 'new 1', - }), - (0, 0, { - 'field': customer_id_field.id, - 'field_desc': 'Customer', - 'old_value_integer': self.partners[7].id, - 'new_value_integer': self.partners[8].id, - }), - ] - }]) + with self.assertQueryCount(employee=24): # test_mail: 24 + res = messages_all.message_format() - with self.assertQueryCount(employee=7): - res = messages.message_format() - self.assertEqual(len(res), 2) - for message in res: - self.assertEqual(len(message['attachment_ids']), 2) + self.assertEqual(len(res), 2*2) + for message in res: + self.assertEqual(len(message['attachment_ids']), 2) - self.env.flush_all() - self.env.invalidate_all() + @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') + @users('employee') + @warmup + def test_message_format_single(self): + message = self.messages_all[0].with_env(self.env) - with self.assertQueryCount(employee=18): - res = messages.message_format() - self.assertEqual(len(res), 2) - for message in res: - self.assertEqual(len(message['attachment_ids']), 2) + with self.assertQueryCount(employee=21): # test_mail: 21 + res = message.message_format() + + self.assertEqual(len(res), 1) + self.assertEqual(len(res[0]['attachment_ids']), 2) @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') @users('employee') @@ -1309,7 +1347,7 @@ class TestMailHeavyPerformancePost(BaseMailPerformance): attachments = self.env['ir.attachment'].with_user(self.env.user).create(self.test_attachments_vals) # enable_logging = self.cr._enable_logging() if self.warm else nullcontext() # with self.assertQueryCount(employee=63), enable_logging: - with self.assertQueryCount(employee=62): + with self.assertQueryCount(employee=60): record_container.with_context({}).message_post( body=Markup('Test body
Test Content
'), @@ -95,3 +104,216 @@ class TestMailPerformance(BaseMailPerformance): new_message.notified_partner_ids, self.user_emp_email.partner_id + self.user_admin.partner_id + self.customers + self.user_portal.partner_id ) + + +@tagged('mail_performance', 'post_install', '-at_install') +class TestPortalFormatPerformance(FullBaseMailPerformance): + """Test performance of `portal_message_format` with multiple messages + with multiple attachments, with ratings. + + Those messages might not make sense functionally but they are crafted to + cover as much of the code as possible in regard to number of queries. + + Setup : + * 5 records (self.containers -> 5 mail.test.rating records, with + a different customer_id each) + * 2 messages / record + * 2 attachments / message + """ + + @classmethod + def setUpClass(cls): + super().setUpClass() + + # rating-enabled test records + cls.record_ratings = cls.env['mail.test.rating'].create([ + { + 'customer_id': cls.customers[idx].id, + 'name': f'TestRating_{idx}', + 'user_id': cls.test_users[idx].id, + + } + for idx in range(5) + ]) + + # messages and ratings + user_id_field = cls.env['ir.model.fields']._get(cls.record_ratings._name, 'user_id') + comment_subtype_id = cls.env['ir.model.data']._xmlid_to_res_id('mail.mt_comment') + cls.messages_all = cls.env['mail.message'].sudo().create([ + { + 'attachment_ids': [ + (0, 0, { + 'datas': 'data', + 'name': f'Test file {att_idx}', + 'res_id': record.id, + 'res_model': record._name, + }) + for att_idx in range(2) + ], + 'author_id': record.customer_id.id, + 'body': f'Test {msg_idx}
', + 'date': datetime(2023, 5, 15, 10, 30, 5), + 'email_from': record.customer_id.email_formatted, + 'link_preview_ids': [ + (0, 0, { + 'source_url': 'https://www.odoo.com', + }), (0, 0, { + 'source_url': 'https://www.example.com', + }), + ], + 'notification_ids': [ + (0, 0, { + 'is_read': False, + 'notification_type': 'inbox', + 'res_partner_id': cls.customers[(msg_idx * 2)].id, + }), + (0, 0, { + 'is_read': True, + 'notification_type': 'email', + 'notification_status': 'sent', + 'res_partner_id': cls.customers[(msg_idx * 2) + 1].id, + }), + ], + 'message_type': 'comment', + 'model': record._name, + 'partner_ids': [ + (4, cls.customers[(msg_idx * 2)].id), + (4, cls.customers[record_idx].id), + ], + 'reaction_ids': [ + (0, 0, { + 'content': 'https://www.odoo.com', + 'partner_id': cls.customers[(msg_idx * 2) + 1].id + }), (0, 0, { + 'content': 'https://www.example.com', + 'partner_id': cls.customers[record_idx].id + }), + ], + 'res_id': record.id, + 'subject': f'Test Rating {msg_idx}', + 'subtype_id': comment_subtype_id, + 'starred_partner_ids': [ + (4, cls.customers[(msg_idx * 2)].id), + (4, cls.customers[(msg_idx * 2) + 1].id), + ], + 'tracking_value_ids': [ + (0, 0, { + 'field': user_id_field.id, + 'field_desc': 'Responsible', + 'new_value_char': 'new 1', + 'new_value_integer': record.user_id.id, + 'old_value_char': 'old 1', + 'old_value_integer': cls.user_admin.id, + }), + ] + } + for msg_idx in range(2) + for record_idx, record in enumerate(cls.record_ratings) + ]) + + cls.messages_records = [cls.env[message.model].browse(message.res_id) for message in cls.messages_all] + # ratings values related to rating-enabled records + cls.ratings_all = cls.env['rating.rating'].sudo().create([ + { + 'consumed': True, + 'message_id': message.id, + 'partner_id': record.customer_id.id, + 'publisher_comment': 'Comment', + 'publisher_id': cls.user_admin.partner_id.id, + 'publisher_datetime': datetime(2023, 5, 15, 10, 30, 5) - timedelta(days=2), + 'rated_partner_id': record.user_id.partner_id.id, + 'rating': 4, + 'res_id': message.res_id, + 'res_model_id': cls.env['ir.model']._get_id(message.model), + } + for rating_idx in range(2) + for message, record in zip(cls.messages_all, cls.messages_records) + ]) + + def test_assert_initial_values(self): + self.assertEqual(len(self.messages_all), 5 * 2) + self.assertEqual(len(self.ratings_all), len(self.messages_all) * 2) + + @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') + @users('employee') + @warmup + def test_portal_message_format_norating(self): + messages_all = self.messages_all.with_user(self.env.user) + + with self.assertQueryCount(employee=31): + # res = messages_all.portal_message_format(options=None) + res = messages_all.portal_message_format(options={'rating_include': False}) + + comment_subtype = self.env.ref('mail.mt_comment') + self.assertEqual(len(res), len(messages_all)) + for format_res, message, record in zip(res, messages_all, self.messages_records): + self.assertEqual(len(format_res['attachment_ids']), 2) + self.assertEqual( + format_res['attachment_ids'], + [ + { + 'access_token': message.attachment_ids[0].access_token, + 'checksum': message.attachment_ids[0].checksum, + 'filename': 'Test file 1', + 'id': message.attachment_ids[0].id, + 'mimetype': 'application/octet-stream', + 'name': 'Test file 1', + 'res_id': record.id, + 'res_model': record._name, + }, { + 'access_token': message.attachment_ids[1].access_token, + 'checksum': message.attachment_ids[1].checksum, + 'filename': 'Test file 0', + 'id': message.attachment_ids[1].id, + 'mimetype': 'application/octet-stream', + 'name': 'Test file 0', + 'res_id': record.id, + 'res_model': record._name, + } + ] + ) + self.assertEqual(format_res['author_id'], (record.customer_id.id, record.customer_id.display_name)) + self.assertEqual(format_res['author_avatar_url'], f'/web/image/mail.message/{message.id}/author_avatar/50x50') + self.assertEqual(format_res['date'], datetime(2023, 5, 15, 10, 30, 5)) + self.assertEqual(format_res['published_date_str'], 'May 15, 2023, 10:30:05 AM') + self.assertEqual(format_res['id'], message.id) + self.assertFalse(format_res['is_internal']) + self.assertFalse(format_res['is_message_subtype_note']) + self.assertEqual(format_res['subtype_id'], (comment_subtype.id, comment_subtype.name)) + # should not be in, not asked + self.assertNotIn('rating', format_res) + self.assertNotIn('rating_stats', format_res) + self.assertNotIn('rating_value', format_res) + + @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') + @users('employee') + @warmup + def test_portal_message_format_rating(self): + messages_all = self.messages_all.with_user(self.env.user) + + with self.assertQueryCount(employee=45): + res = messages_all.portal_message_format(options={'rating_include': True}) + + self.assertEqual(len(res), len(messages_all)) + for format_res, _message, _record in zip(res, messages_all, self.messages_records): + self.assertEqual(format_res['rating']['publisher_avatar'], f'/web/image/res.partner/{self.partner_admin.id}/avatar_128/50x50') + self.assertEqual(format_res['rating']['publisher_comment'], 'Comment') + self.assertEqual(format_res['rating']['publisher_id'], self.partner_admin.id) + self.assertEqual(format_res['rating']['publisher_datetime'], 'May 13, 2023, 10:30:05 AM') + self.assertEqual(format_res['rating']['publisher_name'], self.partner_admin.display_name) + self.assertDictEqual( + format_res['rating_stats'], + {'avg': 4.0, 'total': 4, 'percent': {1: 0.0, 2: 0.0, 3: 0.0, 4: 100.0, 5: 0.0}} + ) + self.assertEqual(format_res['rating_value'], 4) + + @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') + @users('employee') + @warmup + def test_portal_message_format_monorecord(self): + message = self.messages_all[0].with_user(self.env.user) + + with self.assertQueryCount(employee=18): + res = message.portal_message_format(options={'rating_include': True}) + + self.assertEqual(len(res), 1) diff --git a/addons/test_mail_sms/tests/test_sms_performance.py b/addons/test_mail_sms/tests/test_sms_performance.py index f1e7f9e21a6..585b22ee616 100644 --- a/addons/test_mail_sms/tests/test_sms_performance.py +++ b/addons/test_mail_sms/tests/test_sms_performance.py @@ -35,7 +35,7 @@ class TestSMSPerformance(BaseMailPerformance, sms_common.SMSCase): def test_message_sms_record_1_partner(self): record = self.test_record.with_user(self.env.user) pids = self.customer.ids - with self.mockSMSGateway(sms_allow_unlink=True), self.assertQueryCount(employee=26): + with self.mockSMSGateway(sms_allow_unlink=True), self.assertQueryCount(employee=25): messages = record._message_sms( body='Performance Test', partner_ids=pids, @@ -50,7 +50,7 @@ class TestSMSPerformance(BaseMailPerformance, sms_common.SMSCase): def test_message_sms_record_10_partners(self): record = self.test_record.with_user(self.env.user) pids = self.partners.ids - with self.mockSMSGateway(sms_allow_unlink=True), self.assertQueryCount(employee=26): + with self.mockSMSGateway(sms_allow_unlink=True), self.assertQueryCount(employee=25): messages = record._message_sms( body='Performance Test', partner_ids=pids, @@ -64,7 +64,7 @@ class TestSMSPerformance(BaseMailPerformance, sms_common.SMSCase): @warmup def test_message_sms_record_default(self): record = self.test_record.with_user(self.env.user) - with self.mockSMSGateway(sms_allow_unlink=True), self.assertQueryCount(employee=28): + with self.mockSMSGateway(sms_allow_unlink=True), self.assertQueryCount(employee=27): messages = record._message_sms( body='Performance Test', )