# -*- coding: utf-8 -*- # Part of Odoo. See LICENSE file for full copyright and licensing details. import lxml from datetime import datetime from odoo import http from odoo.addons.test_mail_full.tests.common import TestMailFullCommon from odoo.addons.test_mail_sms.tests.common import TestSMSRecipients from odoo.tests import tagged from odoo.tests.common import users, warmup from odoo.tools import mute_logger class TestRatingCommon(TestMailFullCommon, TestSMSRecipients): @classmethod def setUpClass(cls): super(TestRatingCommon, cls).setUpClass() cls.record_rating = cls.env['mail.test.rating'].create({ 'customer_id': cls.partner_1.id, 'name': 'Test Rating', 'user_id': cls.user_admin.id, }) cls.record_rating_thread = cls.env['mail.test.rating.thread'].create({ 'customer_id': cls.partner_1.id, 'name': 'Test rating without rating mixin', 'user_id': cls.user_admin.id, }) @tagged('rating') class TestRatingFlow(TestRatingCommon): def test_initial_values(self): for record_rating in [self.record_rating, self.record_rating_thread]: record_rating = record_rating.with_env(self.env) self.assertFalse(record_rating.rating_ids) self.assertEqual(record_rating.message_partner_ids, self.partner_admin) self.assertEqual(len(record_rating.message_ids), 1) @users('employee') @mute_logger('odoo.addons.mail.models.mail_mail') def test_rating_prepare(self): for record_rating, desc in ((self.record_rating, 'With rating mixin'), (self.record_rating_thread, 'Without rating mixin')): with self.subTest(desc): record_rating = record_rating.with_env(self.env) # prepare rating token access_token = record_rating._rating_get_access_token() # check rating creation rating = record_rating.rating_ids self.assertEqual(rating.access_token, access_token) self.assertFalse(rating.consumed) self.assertFalse(rating.is_internal) self.assertEqual(rating.partner_id, self.partner_1) self.assertEqual(rating.rated_partner_id, self.user_admin.partner_id) self.assertFalse(rating.rating) @users('employee') @mute_logger('odoo.addons.mail.models.mail_mail') def test_rating_rating_apply(self): for record_rating, expected_subtype, is_rating_mixin_test in ( (self.record_rating_thread, self.env.ref('mail.mt_comment'), False), (self.record_rating, self.env.ref('test_mail_full.mt_mail_test_rating_rating_done'), True), ): with self.subTest('With rating mixin' if is_rating_mixin_test else 'Without rating mixin'): record_rating = record_rating.with_env(self.env) record_messages = record_rating.message_ids # prepare rating token access_token = record_rating._rating_get_access_token() # simulate an email click: notification should be delayed with self.mock_mail_gateway(mail_unlink_sent=False), self.mock_mail_app(): record_rating.rating_apply(5, token=access_token, feedback='Top Feedback', notify_delay_send=True) message = record_rating.message_ids[0] rating = record_rating.rating_ids # check posted message self.assertEqual(record_rating.message_ids, record_messages + message) self.assertIn('Top Feedback', message.body) self.assertIn('/rating/static/src/img/rating_5.png', message.body) self.assertEqual(message.author_id, self.partner_1) self.assertEqual(message.rating_ids, rating) self.assertFalse(message.notified_partner_ids) self.assertEqual(message.subtype_id, expected_subtype) # check rating update self.assertTrue(rating.consumed) self.assertEqual(rating.feedback, 'Top Feedback') self.assertEqual(rating.message_id, message) self.assertEqual(rating.rating, 5) if is_rating_mixin_test: self.assertEqual(record_rating.rating_last_value, 5) # give a feedback: send notifications (notify_delay_send set to False) with self.mock_mail_gateway(mail_unlink_sent=False), self.mock_mail_app(): record_rating.rating_apply(1, token=access_token, feedback='Bad Feedback') # check posted message: message is updated update_message = record_rating.message_ids[0] self.assertEqual(update_message, message, 'Should update first message') self.assertEqual(record_rating.message_ids, record_messages + update_message) self.assertIn('Bad Feedback', update_message.body) self.assertIn('/rating/static/src/img/rating_1.png', update_message.body) self.assertEqual(update_message.author_id, self.partner_1) self.assertEqual(update_message.rating_ids, rating) self.assertEqual(update_message.notified_partner_ids, self.partner_admin) self.assertEqual(update_message.subtype_id, expected_subtype) # check rating update new_rating = record_rating.rating_ids self.assertEqual(new_rating, rating, 'Should update first rating') self.assertTrue(new_rating.consumed) self.assertEqual(new_rating.feedback, 'Bad Feedback') self.assertEqual(new_rating.message_id, update_message) self.assertEqual(new_rating.rating, 1) if is_rating_mixin_test: self.assertEqual(record_rating.rating_last_value, 1) @tagged('rating') class TestRatingMixin(TestRatingCommon): @users('employee') @warmup def test_rating_values(self): record_rating = self.record_rating.with_env(self.env) # prepare rating token access_0 = record_rating._rating_get_access_token() last_rating = record_rating.rating_apply(3, token=access_0, feedback="This record is meh but it's cheap.") # Make sure to update the write_date which is used to retrieve the last rating last_rating.write_date = datetime(2022, 1, 1, 14, 00) access_1 = record_rating._rating_get_access_token() last_rating = record_rating.rating_apply(1, token=access_1, feedback="This record sucks so much. I want to speak to the manager !") last_rating.write_date = datetime(2022, 2, 1, 14, 00) access_2 = record_rating._rating_get_access_token() last_rating = record_rating.rating_apply(5, token=access_2, feedback="This is the best record ever ! I wish I read the documentation before complaining !") last_rating.write_date = datetime(2022, 3, 1, 14, 00) record_rating.rating_ids.flush_model(['write_date']) self.assertEqual(record_rating.rating_last_value, 5, "The last rating is kept.") self.assertEqual(record_rating.rating_avg, 3, "The average should be equal to 3") @tagged('rating', 'mail_performance', 'post_install', '-at_install') class TestRatingPerformance(TestRatingCommon): @classmethod def setUpClass(cls): super().setUpClass() cls.RECORD_COUNT = 100 cls.partners = cls.env['res.partner'].sudo().create([ {'name': 'Jean-Luc %s' % (idx), 'email': 'jean-luc-%s@opoo.com' % (idx)} for idx in range(cls.RECORD_COUNT)]) def apply_ratings(self, rate): for record in self.record_ratings: access_token = record._rating_get_access_token() record.rating_apply(rate, token=access_token) self.flush_tracking() def create_ratings(self, model): self.record_ratings = self.env[model].create([{ 'customer_id': self.partners[idx].id, 'name': 'Test Rating', 'user_id': self.user_admin.id, } for idx in range(self.RECORD_COUNT)]) self.flush_tracking() @users('employee') @warmup def test_rating_last_value_perfs(self): with self.assertQueryCount(employee=1612): self.create_ratings('mail.test.rating.thread') with self.assertQueryCount(employee=2002): self.apply_ratings(1) with self.assertQueryCount(employee=1801): self.apply_ratings(5) @users('employee') @warmup def test_rating_last_value_perfs_with_rating_mixin(self): with self.assertQueryCount(employee=1715): self.create_ratings('mail.test.rating') with self.assertQueryCount(employee=2304): self.apply_ratings(1) with self.assertQueryCount(employee=2203): self.apply_ratings(5) with self.assertQueryCount(employee=1): self.record_ratings._compute_rating_last_value() vals = (val == 5 for val in self.record_ratings.mapped('rating_last_value')) self.assertTrue(all(vals), "The last rating is kept.") @tagged("rating", "rating_portal") class TestRatingRoutes(TestRatingCommon): @classmethod def setUpClass(cls): super().setUpClass() cls._create_portal_user() def test_open_rating_route(self): for record_rating, is_rating_mixin_test in ((self.record_rating_thread, False), (self.record_rating, True)): with self.subTest('With rating mixin' if is_rating_mixin_test else 'Without rating mixin'): """ 16.0 + expected behavior 1) Clicking on the smiley image triggers the /rate// route should not update the rating of the record but simply redirect to the feedback form 2) Customer interacts with webpage and submits FORM. Triggers /rate//submit_feedback route. Should update the rating of the record with the data in the POST request """ self.authenticate(None, None) # set up session for public user access_token = record_rating._rating_get_access_token() # First round of clicking the URL and then submitting FORM data response_click_one = self.url_open(f"/rate/{access_token}/5") response_click_one.raise_for_status() # there should be a form to post to validate the feedback and avoid one-click anyway forms = lxml.html.fromstring(response_click_one.content).xpath('//form') matching_rate_form = next((form for form in forms if form.get("action", "").startswith("/rate")), None) self.assertEqual(matching_rate_form.get('method'), 'post') self.assertEqual(matching_rate_form.get('action', ''), f'/rate/{access_token}/submit_feedback') # rating should not change, i.e. default values rating = record_rating.rating_ids self.assertFalse(rating.consumed) self.assertEqual(rating.rating, 0) self.assertFalse(rating.feedback) if is_rating_mixin_test: self.assertEqual(record_rating.rating_last_value, 0) response_submit_one = self.url_open( f"/rate/{access_token}/submit_feedback", data={ "rate": 5, "csrf_token": http.Request.csrf_token(self), "feedback": "good", } ) response_submit_one.raise_for_status() rating_post_submit_one = record_rating.rating_ids self.assertTrue(rating_post_submit_one.consumed) self.assertEqual(rating_post_submit_one.rating, 5) self.assertEqual(rating_post_submit_one.feedback, "good") if is_rating_mixin_test: self.assertEqual(record_rating.rating_last_value, 5) # Second round of clicking the URL and then submitting FORM data response_click_two = self.url_open(f"/rate/{access_token}/1") response_click_two.raise_for_status() if is_rating_mixin_test: self.assertEqual(record_rating.rating_last_value, 5) # should not be updated to 1 # check returned form forms = lxml.html.fromstring(response_click_two.content).xpath('//form') matching_rate_form = next((form for form in forms if form.get("action", "").startswith("/rate")), None) self.assertEqual(matching_rate_form.get('method'), 'post') self.assertEqual(matching_rate_form.get('action', ''), f'/rate/{access_token}/submit_feedback') response_submit_two = self.url_open( f"/rate/{access_token}/submit_feedback", data={ "rate": 1, "csrf_token": http.Request.csrf_token(self), "feedback": "bad job" } ) response_submit_two.raise_for_status() rating_post_submit_second = record_rating.rating_ids self.assertTrue(rating_post_submit_second.consumed) self.assertEqual(rating_post_submit_second.rating, 1) self.assertEqual(rating_post_submit_second.feedback, "bad job") if is_rating_mixin_test: self.assertEqual(record_rating.rating_last_value, 1) def test_portal_user_can_post_message_with_rating(self): """Test portal user can post a message with a rating on a thread with _mail_post_access as read. In this case, sudo() is not necessary for message_post itself, but it is necessary for adding the rating. This tests covers the rating part is properly allowed.""" record_rating = self.env["mail.test.rating.thread.read"].create( { "customer_id": self.partner_1.id, "name": "Test read access post + rating", "user_id": self.user_admin.id, } ) # from model message = record_rating.with_user(self.user_portal).message_post( body="Not bad", message_type="comment", rating_value=3, subtype_xmlid="mail.mt_comment", ) rating = message.sudo().rating_id self.assertEqual(rating.rating, 3, "rating was properly set") # stealing attempt from another user message2 = record_rating.message_post( body="Attempt to steal rating with another user", message_type="comment", rating_id=rating.id, subtype_xmlid="mail.mt_comment", ) self.assertEqual(message.sudo().rating_id, rating, "rating was not removed from m1") self.assertFalse(message2.rating_id, "rating was not added to m2") # from controller self.authenticate("portal_test", "portal_test") res = self.make_jsonrpc_request( "/mail/message/post", { "post_data": { "body": "Good service", "message_type": "comment", "rating_value": 5, "subtype_xmlid": "mail.mt_comment", }, "thread_id": record_rating.id, "thread_model": "mail.test.rating.thread.read", }, ) self.assertEqual(len(res["rating.rating"]), 1) self.assertEqual(res["rating.rating"][0]["rating"], 5)