1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
|
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.
import json
import socket
from datetime import datetime, timedelta
import odoo
from odoo.tools.misc import mute_logger
from odoo.addons.mail.tests.common import mail_new_test_user
from odoo.addons.mail.tools.jwt import InvalidVapidError
from odoo.addons.sms.tests.common import SMSCommon
from odoo.addons.test_mail.data.test_mail_data import MAIL_TEMPLATE
from odoo.tests import tagged
from markupsafe import Markup
from unittest.mock import patch
from types import SimpleNamespace
@tagged('post_install', '-at_install', 'mail_push')
class TestWebPushNotification(SMSCommon):
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.user_email = cls.user_employee
cls.user_email.notification_type = 'email'
cls.user_inbox = mail_new_test_user(
cls.env, login='user_inbox', groups='base.group_user', name='User Inbox',
notification_type='inbox'
)
cls.record_simple = cls.env['mail.test.simple'].with_context(cls._test_context).create({
'name': 'Test',
'email_from': 'ignasse@example.com'
})
cls.record_simple.message_subscribe(partner_ids=[
cls.user_email.partner_id.id,
cls.user_inbox.partner_id.id,
])
# generate keys and devices
cls.vapid_public_key = cls.env['mail.push.device'].get_web_push_vapid_public_key()
cls.env['mail.push.device'].sudo().create([
{
'endpoint': f'https://test.odoo.com/webpush/user{(idx + 1)}',
'expiration_time': None,
'keys': json.dumps({
'p256dh': 'BGbhnoP_91U7oR59BaaSx0JnDv2oEooYnJRV2AbY5TBeKGCRCf0HcIJ9bOKchUCDH4cHYWo9SYDz3U-8vSxPL_A',
'auth': 'DJFdtAgZwrT6yYkUMgUqow'
}),
'partner_id': user.partner_id.id,
} for idx, user in enumerate(cls.user_email + cls.user_inbox)
])
def _trigger_cron_job(self):
self.env.ref('mail.ir_cron_web_push_notification').method_direct_trigger()
def _assert_notification_count_for_cron(self, number_of_notification):
notification_count = self.env['mail.push'].search_count([])
self.assertEqual(notification_count, number_of_notification)
@patch.object(odoo.addons.mail.models.mail_thread, 'push_to_end_point')
@mute_logger('odoo.tests')
def test_notify_by_push(self, push_to_end_point):
""" When posting a comment, notify both inbox and people outside of Odoo
aka email """
self.record_simple.with_user(self.user_admin).message_post(
body=Markup('<p>Hello</p>'),
message_type='comment',
partner_ids=(self.user_email + self.user_inbox).partner_id.ids,
subtype_xmlid='mail.mt_comment',
)
# not using cron, as max 1 push notif -> direct send
self._assert_notification_count_for_cron(0)
# two recipients, comment notifies both inbox and email people
self.assertEqual(push_to_end_point.call_count, 2)
@patch.object(odoo.addons.mail.models.mail_thread, 'push_to_end_point')
def test_notify_by_push_channel(self, push_to_end_point):
""" Test various use case with discuss.channel. Chat and group channels
sends push notifications, channel not. """
chat_channel, channel_channel, group_channel = self.env['discuss.channel'].with_user(self.user_email).create([
{
'channel_partner_ids': [
(4, self.user_email.partner_id.id),
(4, self.user_inbox.partner_id.id),
],
'channel_type': channel_type,
'name': f'{channel_type} Message',
} for channel_type in ['chat', 'channel', 'group']
])
for channel, has_notification in zip(
(chat_channel + channel_channel + group_channel),
(True, False, True)
):
with self.subTest(channel_type=channel.channel_type):
# Test Direct Message
channel.with_user(self.user_email).message_post(
body='Test Push',
message_type='comment',
subtype_xmlid='mail.mt_comment',
)
if has_notification:
push_to_end_point.assert_called_once()
payload_value = json.loads(push_to_end_point.call_args.kwargs['payload'])
if channel.channel_type == 'chat':
self.assertEqual(payload_value['title'], f'{self.user_email.name}')
else:
self.assertEqual(payload_value['title'], f'#{channel.name}')
self.assertEqual(
payload_value['options']['icon'],
f'/web/image/res.partner/{self.user_email.partner_id.id}/avatar_128'
)
self.assertEqual(payload_value['options']['body'], 'Test Push')
self.assertEqual(payload_value['options']['data']['res_id'], channel.id)
self.assertEqual(payload_value['options']['data']['model'], channel._name)
self.assertEqual(push_to_end_point.call_args.kwargs['device']['endpoint'], 'https://test.odoo.com/webpush/user2')
else:
push_to_end_point.assert_not_called()
push_to_end_point.reset_mock()
# Test Direct Message with channel muted -> should skip push notif
now = datetime.now()
self.env['discuss.channel.member'].search([
('partner_id', 'in', (self.user_email.partner_id + self.user_inbox.partner_id).ids),
('channel_id', 'in', (chat_channel + channel_channel + group_channel).ids),
]).write({
'mute_until_dt': now + timedelta(days=5)
})
chat_channel.with_user(self.user_email).message_post(
body='Test',
message_type='comment',
subtype_xmlid='mail.mt_comment',
)
push_to_end_point.assert_not_called()
push_to_end_point.reset_mock()
self.env["discuss.channel.member"].search([
("partner_id", "in", (self.user_email.partner_id + self.user_inbox.partner_id).ids),
("channel_id", "in", (chat_channel + channel_channel + group_channel).ids),
]).write({
"mute_until_dt": False,
})
# Test Channel Message
group_channel.with_user(self.user_email).message_post(
body='Test',
partner_ids=self.user_inbox.partner_id.ids,
message_type='comment',
subtype_xmlid='mail.mt_comment',
)
push_to_end_point.assert_called_once()
@patch.object(odoo.addons.mail.models.mail_thread, "push_to_end_point")
def test_notify_by_push_channel_with_channel_notifications_settings(self, push_to_end_point):
""" Test various use case with the channel notification settings."""
all_test_user = mail_new_test_user(
self.env,
login="all",
name="all",
email="all@example.com",
notification_type="inbox",
groups="base.group_user",
)
mentions_test_user = mail_new_test_user(
self.env,
login="mentions",
name="mentions",
email="mentions@example.com",
notification_type="inbox",
groups="base.group_user",
)
nothing_test_user = mail_new_test_user(
self.env,
login="nothing",
name="nothing",
email="nothing@example.com",
notification_type="inbox",
groups="base.group_user",
)
all_test_user.res_users_settings_ids.write({"channel_notifications": "all"})
nothing_test_user.res_users_settings_ids.write({"channel_notifications": "no_notif"})
# generate devices
self.env["mail.push.device"].sudo().create(
[
{
"endpoint": f"https://test.odoo.com/webpush/user{(idx + 20)}",
"expiration_time": None,
"keys": json.dumps(
{
"p256dh": "BGbhnoP_91U7oR59BaaSx0JnDv2oEooYnJRV2AbY5TBeKGCRCf0HcIJ9bOKchUCDH4cHYWo9SYDz3U-8vSxPL_A",
"auth": "DJFdtAgZwrT6yYkUMgUqow",
}
),
"partner_id": user.partner_id.id,
}
for idx, user in enumerate(all_test_user + mentions_test_user + nothing_test_user)
]
)
channel_channel = self.env["discuss.channel"].with_user(self.user_email).create(
[
{
"channel_partner_ids": [
(4, self.user_email.partner_id.id),
(4, all_test_user.partner_id.id),
(4, mentions_test_user.partner_id.id),
(4, nothing_test_user.partner_id.id),
],
"channel_type": "channel",
"name": "channel",
}
]
)
# normal messages in channel
channel_channel.with_user(self.user_email).message_post(
body="Test Push",
message_type="comment",
subtype_xmlid="mail.mt_comment",
)
push_to_end_point.assert_called_once()
# all_test_user should be notified
self.assertEqual(push_to_end_point.call_args.kwargs["device"]["endpoint"], "https://test.odoo.com/webpush/user20")
push_to_end_point.reset_mock()
# mention messages in channel
channel_channel.with_user(self.user_email).message_post(
body="Test Push @mentions",
message_type="comment",
partner_ids=(all_test_user + mentions_test_user + nothing_test_user).partner_id.ids,
subtype_xmlid="mail.mt_comment",
)
self.assertEqual(push_to_end_point.call_count, 2)
# all_test_user and mentions_test_user should be notified
self.assertEqual(push_to_end_point.call_args_list[0].kwargs["device"]["endpoint"], "https://test.odoo.com/webpush/user20")
self.assertEqual(push_to_end_point.call_args_list[1].kwargs["device"]["endpoint"], "https://test.odoo.com/webpush/user21")
push_to_end_point.reset_mock()
# muted channel
now = datetime.now()
self.env["discuss.channel.member"].search(
[
("partner_id", "in", (all_test_user.partner_id + mentions_test_user.partner_id + nothing_test_user.partner_id).ids),
]
).write(
{
"mute_until_dt": now + timedelta(days=5),
}
)
# normal messages in channel
channel_channel.with_user(self.user_email).message_post(
body="Test Push",
message_type="comment",
subtype_xmlid="mail.mt_comment",
)
push_to_end_point.assert_not_called()
# mention messages in channel
channel_channel.with_user(self.user_email).message_post(
body="Test Push",
message_type="comment",
subtype_xmlid="mail.mt_comment",
)
push_to_end_point.assert_not_called()
@patch.object(odoo.addons.mail.models.mail_thread, 'push_to_end_point')
@mute_logger('odoo.addons.mail.models.mail_thread')
def test_notify_by_push_mail_gateway(self, push_to_end_point):
test_record = self.env['mail.test.gateway'].with_context(self._test_context).create({
'name': 'Test',
'email_from': 'ignasse@example.com',
})
test_record.message_subscribe(partner_ids=[self.user_inbox.partner_id.id])
fake_email = self.env['mail.message'].create({
'model': 'mail.test.gateway',
'res_id': test_record.id,
'subject': 'Public Discussion',
'message_type': 'email',
'subtype_id': self.env.ref('mail.mt_comment').id,
'author_id': self.user_email.partner_id.id,
'message_id': '<123456-openerp-%s-mail.test.gateway@%s>' % (test_record.id, socket.gethostname()),
})
self.format_and_process(
MAIL_TEMPLATE, self.user_email.email_formatted,
self.user_inbox.email_formatted,
subject='Test Subject Reply By mail',
extra='In-Reply-To:\r\n\t%s\n' % fake_email.message_id,
)
self._assert_notification_count_for_cron(0)
push_to_end_point.assert_called_once()
payload_value = json.loads(push_to_end_point.call_args.kwargs['payload'])
self.assertIn(self.user_email.name, payload_value['title'])
self.assertIn(
'Please call me as soon as possible this afternoon!\n\n--\nSylvie',
payload_value['options']['body'],
'The body must contain the text send by mail'
)
@patch.object(odoo.addons.mail.models.mail_thread, 'push_to_end_point')
@mute_logger('odoo.tests')
def test_notify_by_push_message_notify(self, push_to_end_point):
""" In case of notification, only inbox users are notified """
for recipient, has_notification in [(self.user_email, False), (self.user_inbox, True)]:
with self.subTest(recipient=recipient):
self.record_simple.with_user(self.user_admin).message_notify(
body='Test Push Notif',
partner_ids=recipient.partner_id.ids,
record_name=self.record_simple.display_name,
subject='Test Push Notification',
)
# not using cron, as max 1 push notif -> direct send
self._assert_notification_count_for_cron(0)
if has_notification:
push_to_end_point.assert_called_once()
payload_value = json.loads(push_to_end_point.call_args.kwargs['payload'])
self.assertEqual(
payload_value['title'],
f'{self.user_admin.name}: {self.record_simple.display_name}'
)
self.assertEqual(
payload_value['options']['icon'],
f'/web/image/res.partner/{self.user_admin.partner_id.id}/avatar_128'
)
self.assertEqual(payload_value['options']['body'], 'Test Push Notif')
self.assertEqual(payload_value['options']['data']['res_id'], self.record_simple.id)
self.assertEqual(payload_value['options']['data']['model'], self.record_simple._name)
self.assertEqual(push_to_end_point.call_args.kwargs['device']['endpoint'], 'https://test.odoo.com/webpush/user2')
self.assertIn('vapid_private_key', push_to_end_point.call_args.kwargs)
self.assertIn('vapid_public_key', push_to_end_point.call_args.kwargs)
else:
push_to_end_point.assert_not_called()
push_to_end_point.reset_mock()
@patch.object(odoo.addons.mail.models.mail_thread, 'push_to_end_point')
def test_notify_by_push_tracking(self, push_to_end_point):
""" Test tracking message included in push notifications """
container_update_subtype = self.env.ref('test_mail.st_mail_test_ticket_container_upd')
ticket = self.env['mail.test.ticket'].with_user(self.user_email).create({
'name': 'Test',
})
ticket.message_subscribe(
partner_ids=[self.user_email.partner_id.id],
subtype_ids=[container_update_subtype.id],
)
container = self.env['mail.test.container'].create({'name': 'Container'})
ticket.write({
'name': 'Test2',
'email_from': 'noone@example.com',
'container_id': container.id,
})
self.flush_tracking()
self._assert_notification_count_for_cron(0)
push_to_end_point.assert_not_called()
container2 = self.env['mail.test.container'].create({'name': 'Container Two'})
ticket.message_subscribe(
partner_ids=[self.user_inbox.partner_id.id],
subtype_ids=[container_update_subtype.id],
)
ticket.write({
'name': 'Test3',
'email_from': 'noone@example.com',
'container_id': container2.id,
})
self.flush_tracking()
self._assert_notification_count_for_cron(0)
push_to_end_point.assert_called_once()
payload_value = json.loads(push_to_end_point.call_args.kwargs['payload'])
self.assertIn(
f'{container_update_subtype.description}\nContainer: {container.name} → {container2.name}',
payload_value['options']['body'],
'Tracking changes should be included in push notif payload'
)
@patch.object(odoo.addons.mail.models.mail_push, 'push_to_end_point')
def test_push_notifications_cron(self, push_to_end_point):
# Add 4 more devices to force sending via cron queue
for index in range(10, 14):
self.env['mail.push.device'].sudo().create([{
'endpoint': 'https://test.odoo.com/webpush/user%d' % index,
'expiration_time': None,
'keys': json.dumps({
'p256dh': 'BGbhnoP_91U7oR59BaaSx0JnDv2oEooYnJRV2AbY5TBeKGCRCf0HcIJ9bOKchUCDH4cHYWo9SYDz3U-8vSxPL_A',
'auth': 'DJFdtAgZwrT6yYkUMgUqow'
}),
'partner_id': self.user_inbox.partner_id.id,
}])
self.record_simple.with_user(self.user_email).message_notify(
partner_ids=self.user_inbox.partner_id.ids,
body='Test message send via Web Push',
subject='Test Activity',
record_name=self.record_simple._name,
)
self._assert_notification_count_for_cron(5)
# Force the execution of the cron
self._trigger_cron_job()
self.assertEqual(push_to_end_point.call_count, 5)
@patch.object(odoo.addons.mail.models.mail_thread.Session, 'post',
return_value=SimpleNamespace(**{'status_code': 404, 'text': 'Device Unreachable'}))
def test_push_notifications_error_device_unreachable(self, post):
with mute_logger('odoo.addons.mail.tools.web_push'):
self.record_simple.with_user(self.user_email).message_notify(
partner_ids=self.user_inbox.partner_id.ids,
body='Test message send via Web Push',
subject='Test Activity',
record_name=self.record_simple._name,
)
self._assert_notification_count_for_cron(0)
post.assert_called_once()
# Test that the unreachable device is deleted from the DB
notification_count = self.env['mail.push.device'].search_count([('endpoint', '=', 'https://test.odoo.com/webpush/user2')])
self.assertEqual(notification_count, 0)
@patch.object(odoo.addons.mail.models.mail_thread.Session, 'post',
return_value=SimpleNamespace(**{'status_code': 201, 'text': 'Ok'}))
def test_push_notifications_error_encryption_simple(self, post):
""" Test to see if all parameters sent to the endpoint are present.
This test doesn't test if the cryptographic values are correct. """
self.record_simple.with_user(self.user_email).message_notify(
partner_ids=self.user_inbox.partner_id.ids,
body='Test message send via Web Push',
subject='Test Activity',
record_name=self.record_simple._name,
)
self._assert_notification_count_for_cron(0)
post.assert_called_once()
self.assertEqual(post.call_args.args[0], 'https://test.odoo.com/webpush/user2')
self.assertIn('headers', post.call_args.kwargs)
self.assertIn('vapid', post.call_args.kwargs['headers']['Authorization'])
self.assertIn('t=', post.call_args.kwargs['headers']['Authorization'])
self.assertIn('k=', post.call_args.kwargs['headers']['Authorization'])
self.assertEqual('aes128gcm', post.call_args.kwargs['headers']['Content-Encoding'])
self.assertEqual('0', post.call_args.kwargs['headers']['TTL'])
self.assertIn('data', post.call_args.kwargs)
self.assertIn('timeout', post.call_args.kwargs)
def test_push_notification_regenerate_vapid_keys(self):
ir_params_sudo = self.env['ir.config_parameter'].sudo()
ir_params_sudo.search([('key', 'in', [
'mail.web_push_vapid_private_key',
'mail.web_push_vapid_public_key'
])]).unlink()
new_vapid_public_key = self.env['mail.push.device'].get_web_push_vapid_public_key()
self.assertNotEqual(self.vapid_public_key, new_vapid_public_key)
with self.assertRaises(InvalidVapidError):
self.env['mail.push.device'].register_devices(
endpoint='https://test.odoo.com/webpush/user1',
expiration_time=None,
keys=json.dumps({
'p256dh': 'BGbhnoP_91U7oR59BaaSx0JnDv2oEooYnJRV2AbY5TBeKGCRCf0HcIJ9bOKchUCDH4cHYWo9SYDz3U-8vSxPL_A',
'auth': 'DJFdtAgZwrT6yYkUMgUqow'
}),
partner_id=self.user_email.partner_id.id,
vapid_public_key=self.vapid_public_key,
)
|