-
- Downloads
[REF] mail: JS mail refactoring
---------------------- Summary ---------------------- The purpose of this commit is to improve the JS code of the `mail` module. It applies the new coding guidelines and makes some changes on the design of some modules, such as the old ChatManager module. Here is a short summary of the changes that have been made: 1. New coding guidelines - snake_case to camelCase - prefix private attributes and methods with '_' - jsdoc on most methods - one class per module 2. Rename/Merge some classes - 'chat manager' becomes 'mail manager' (internal) and 'mail service' (external) - 'chat window manager' is now included in mail manager - 'thread' widget now named 'thread widget' 3. New model abstraction for mail objects: - modules 'mail.model.*' - modeling: 0..1 0..1 * * ThreadWindow <------> Thread <-------> Message / \ / \ Thread With Cache Document Thread / | \ / | \ Mailbox Channel Support Channel | | DM - Thread: the superclass of threads. - ThreadWindow: the window component of a thread. - Message: mail objects representing messages. - Thread With Cache: threads that can be used with search view (Discuss app compatible). - Document Thread: represents the thread part of a chatter. - Mailbox: represents what was previously called 'static' channel, e.g. 'Inbox'. - Channel: mail objects representing channels, including livechat. - DM: special kind of Channel for 1:1 communication in the backend. - Support Channel: special channel for im_support module. This new modeling approach let us easily add features on all threads, such as the possibility to put any thread in a small window. ---------------------- Known issues ---------------------- [Already Present in Master] 1. When the Discuss app is in the background with 'Inbox' as the selected Thread, when clicking on a document thread preview in the messaging menu of the systray, the rainbow man appears. 2. When a document with the chatter is in the background, when receiving an inbox notification from this document thread, the document thread is automatically marked as read, which removes the notification right away. 3. Sometimes, opening a DM window from the "blank" thread window does not work. 4. Reply-to feature on Inbox is not working: no message is sent in the document thread. 5. On the first login of admin user with demo data, the inbox counter is wrong (it displays 6, instead of 3). Explanation after investigation: > On page load, it fetches the correct number of Inbox messages (3), but the server notifies of 3 needaction messages right away, so it wrongly assumes these are new needaction messages. > Not possible for web client to detect that these messages should not increment the Inbox counter while keeping same API. 6. Notifications for new document thread messages only work when the user sets 'handle with Odoo' for the Notification Management in the preferences. > due to notifications on the longpoll bus for document thread messages that come from needaction notifications. > requires server-side changes to send notification on the longpoll bus to mentionned user. [New] 7. When receiving a message on a unjoined channel, thread window flickers ('open' > 'close' > 'open') Explanation after investigation: > JS logic: a) On auto-join, ask server to join the channel and get channel infos. b) The info tells the channel is not detached, but JS code makes decision to detach it, and tells server the channel is now detached. c) From (a), server notifies on longpoll bus the state of channel, which is not detached. The web client thinks that the window state of the channel has been changed somewhere else, and the channel is now closed. d) From (b), server notifies on longpoll bus the state of channel, which is detached. The web client opens the thread window of this channel. > The flicker didn't occur before refactoring because the web client was only updating the model of channel when it receives the longpoll notification. > Server behaviour on 1st longpoll notification is necessary for cross-tab synchronization for channel window state. > New design implies that model and view should be synchronized, hence the issue now. > Solution: remove server-side thread window synchronization and replace with client-side synchronization. ---------------------- Hacks ---------------------- The module `im_livechat` now uses mail objects that are compatible with Message and Window objects: Modeling for messages: AbstractMessage / \ / \ LivechatMessage Message - AbstractMessage: message compatible with the thread widget. - LivechatMessage: message used by im_livechat. - Message: message used with the mail manager. Modeling for thread windows: AbstractThreadWindow / \ / \ LivechatWindow ThreadWindow - AbstractThreadWindow: behaviour share between all types of thread windows. - LivechatWindow: window used by im_livechat. - ThreadWindow: window used with mail_manager. The reason for these hacks are twofold: 1. Use the thread widget in the frontend and livechat external lib bundles. 2. Do not have a dependency with the mail manager in the frontend and external lib bundles.
Showing
- addons/bus/static/src/js/services/bus_service.js 6 additions, 8 deletionsaddons/bus/static/src/js/services/bus_service.js
- addons/calendar/static/src/js/systray_activity_menu.js 3 additions, 3 deletionsaddons/calendar/static/src/js/systray_activity_menu.js
- addons/calendar/static/src/xml/base_calendar.xml 2 additions, 2 deletionsaddons/calendar/static/src/xml/base_calendar.xml
- addons/calendar/static/tests/systray_activity_menu_tests.js 10 additions, 10 deletionsaddons/calendar/static/tests/systray_activity_menu_tests.js
- addons/calendar/views/calendar_templates.xml 2 additions, 2 deletionsaddons/calendar/views/calendar_templates.xml
- addons/im_livechat/static/src/js/im_livechat.js 234 additions, 190 deletionsaddons/im_livechat/static/src/js/im_livechat.js
- addons/im_livechat/static/src/js/im_livechat_backend.js 13 additions, 8 deletionsaddons/im_livechat/static/src/js/im_livechat_backend.js
- addons/im_livechat/static/src/js/livechat_window.js 135 additions, 0 deletionsaddons/im_livechat/static/src/js/livechat_window.js
- addons/im_livechat/static/src/js/models/livechat_message.js 65 additions, 0 deletionsaddons/im_livechat/static/src/js/models/livechat_message.js
- addons/im_livechat/static/src/scss/im_livechat.scss 1 addition, 1 deletionaddons/im_livechat/static/src/scss/im_livechat.scss
- addons/im_livechat/static/src/scss/im_livechat_bootstrap.scss 2 additions, 2 deletions...ns/im_livechat/static/src/scss/im_livechat_bootstrap.scss
- addons/im_livechat/static/src/xml/im_livechat_backend.xml 8 additions, 8 deletionsaddons/im_livechat/static/src/xml/im_livechat_backend.xml
- addons/im_livechat/views/im_livechat_channel_templates.xml 10 additions, 3 deletionsaddons/im_livechat/views/im_livechat_channel_templates.xml
- addons/im_support/static/src/js/discuss.js 13 additions, 13 deletionsaddons/im_support/static/src/js/discuss.js
- addons/im_support/static/src/js/mail_manager.js 260 additions, 0 deletionsaddons/im_support/static/src/js/mail_manager.js
- addons/im_support/static/src/js/support_channel.js 233 additions, 0 deletionsaddons/im_support/static/src/js/support_channel.js
- addons/im_support/static/src/js/support_message.js 67 additions, 0 deletionsaddons/im_support/static/src/js/support_message.js
- addons/im_support/static/src/js/support_session.js 3 additions, 4 deletionsaddons/im_support/static/src/js/support_session.js
- addons/im_support/static/src/js/systray_messaging_menu.js 12 additions, 14 deletionsaddons/im_support/static/src/js/systray_messaging_menu.js
- addons/im_support/static/src/js/thread_window.js 67 additions, 0 deletionsaddons/im_support/static/src/js/thread_window.js
Loading
Please register or sign in to comment