[REF] mail, *: refactor messaging with OWL

This commit is a significant rewriting of client-side discuss, chatter,
chat window, and messaging menu using OWL. The behavior should be broadly
the same, with some slight functional changes here and there.

From a technical standpoint, the code of messaging is mainly organized in 2
main groups of modules:

- models, which are logical entities that depict the client-side state of
  messaging as a whole.
- components, which are in charge of displaying information from models.

This refactoring also introduces new JS guidelines regarding folder structure
(/static) and naming rules for JS modules.

Community PR: https://github.com/odoo/odoo/pull/39023
Enterprise PR: https://github.com/odoo/enterprise/pull/6249

Task-1914207

This PR is a collaborative work by Alexandre, Julien, Sébastien and Xavier,
with the precious help of Lucas to speed it up towards the end.

closes odoo/odoo#39023

Related: odoo/enterprise#6249
Signed-off-by: Alexandre Kühn (aku) <aku@odoo.com>
Co-authored-by: Alexandre Kühn <aku@odoo.com>
Co-authored-by: Julien Giannone <jgi@odoo.com>
Co-authored-by: Lucas Perais <lpe@odoo.com>
Co-authored-by: Sébastien Theys <seb@odoo.com>
Co-authored-by: Xavier Dubuc <xdu@odoo.com>

1 files changed, 0 insertions, 260 deletions

diff --git a/addons/mail/static/src/js/services/mail_document_thread_manager.js b/addons/mail/static/src/js/services/mail_document_thread_manager.js
deleted file mode 100644
index 652567baf14..00000000000
--- a/addons/mail/static/src/js/services/mail_document_thread_manager.js
+++ /dev/null
@@ -1,260 +0,0 @@
-odoo.define('mail.Manager.DocumentThread', function (require) {
-"use strict";
-
-var MailManager = require('mail.Manager');
-var DocumentThread = require('mail.model.DocumentThread');
-
-var session = require('web.session');
-
-/**
- * Document Thread Manager
- *
- * This part of the mail manager extends the core functionnalities of mail
- * manager with document threads, in addition to enable cross tab
- * synchronization of document thread windows, through the local storage.
- *
- * Note that it assumes that the Mail Window Manager is loaded
- */
-MailManager.include({
-    DOCUMENT_THREAD_MESSAGE_KEY: 'mail.document_threads_last_message',
-    DOCUMENT_THREAD_STATE_KEY: 'mail.document_threads_state',
-
-    start: function () {
-        this._super.apply(this, arguments);
-        this._documentThreadWindowStates = {};
-        this._tabId = this.call('bus_service', 'getTabId');
-        // retrieve the open DocumentThreads from the localStorage
-        var localStorageLength = this.call('local_storage', 'length');
-        for (var i = 0; i < localStorageLength; i++) {
-            var key = this.call('local_storage', 'key', i);
-            if (key.indexOf(this.DOCUMENT_THREAD_STATE_KEY) === 0) {
-                // key format: DOCUMENT_THREAD_STATE_KEY + '/' + threadId
-                var documentThreadId = key.substring(this.DOCUMENT_THREAD_STATE_KEY.length+1);
-                this._documentThreadWindowStates[documentThreadId] =
-                    this.call('local_storage', 'getItem', key);
-            }
-        }
-        this._mailBus.on('messaging_ready', this, this._updateDocumentThreadWindows.bind(this, this._documentThreadWindowStates));
-        // listen to localStorage changes to synchronize DocumentThread's
-        // windows between tabs
-        this.call('local_storage', 'onStorage', this, this._onStorage);
-    },
-
-    //--------------------------------------------------------------------------
-    // Public
-    //--------------------------------------------------------------------------
-
-    /**
-     * For new posted message of current user in a document thread: store it in
-     * the localStorage to make it appear on the other tabs.
-     *
-     * Note: 'addMessage' modifies the message in place (by setting the channel_id,
-     * so we must store the message in the localStorage *before* calling
-     * 'addMessage')
-     *
-     * @override
-     * @param {Object} data
-     * @param {integer} data.id server ID of the message
-     * @param {Object} [options]
-     * @param {boolean} [options.postedFromDocumentThread=false]
-     */
-    addMessage: function (data, options) {
-        var message = this.getMessage(data.id);
-        if (
-            !message &&
-            options &&
-            options.postedFromDocumentThread
-        ) {
-            var key = this.DOCUMENT_THREAD_MESSAGE_KEY;
-            this.call('local_storage', 'setItem', key, {
-                messageData: data,
-                tabId: this._tabId,
-            });
-        }
-        return this._super.apply(this, arguments);
-    },
-    /**
-     * Returns a document thread corresponding to the given model and resID.
-     *
-     * @param  {string} model of the document thread, if it exists
-     * @return {integer} resID of the document thread, if it exists
-     */
-    getDocumentThread: function (model, resID) {
-        return this.getThread(model + '_' + resID);
-    },
-    /**
-     * Add a new document thread, or get if it exists already.
-     *
-     * Also, if a name is provided for the document thread, it overwrites the
-     * previous one.
-     *
-     * @param {Object} params
-     * @param {interger[]} [params.message_ids] the list of message ids linked
-     *   to the document (if not given, they will be fetched before fetching the
-     *   messages)
-     * @param {string} [params.name] if provided, overwrites the name of the
-     *   existing document thread
-     * @param {integer} params.resID
-     * @param {string} params.resModel
-     * @return {mail.model.DocumentThread}
-     */
-    getOrAddDocumentThread: function (params) {
-        var thread = this.getDocumentThread(params.resModel, params.resID);
-        if (!thread) {
-            thread = new DocumentThread({
-                parent: this,
-                data: {
-                    messageIDs: params.messageIDs,
-                    name: params.name,
-                    resID: params.resID,
-                    resModel: params.resModel,
-                },
-            });
-            this._threads.push(thread);
-        } else {
-            if ('messageIDs' in params) {
-                thread.setMessageIDs(params.messageIDs);
-            }
-            if ('name' in params && params.name) {
-                // document thread may have a change of name
-                thread.setName(params.name);
-            }
-        }
-        return thread;
-    },
-    /**
-     * Open the document thread form if discuss is open
-     *
-     * @override
-     * @param {integer|string} threadID
-     */
-    openThread: function (threadID) {
-        var thread = this.getThread(threadID);
-        if (
-            thread &&
-            thread.getType() === 'document_thread' &&
-            this._isDiscussOpen()
-        ) {
-            var resModel = thread.getDocumentModel();
-            var resID = thread.getDocumentID();
-            this._redirectToDocument(resModel, resID);
-        } else {
-            this._super.apply(this, arguments);
-        }
-    },
-    /**
-     * Updates the state of a given document thread (stored in localStorage).
-     * Garbage collects windows previously marked as 'closed' (assuming that the
-     * info has already been processed by the other tabs).
-     *
-     * @param {string} threadID ID of a document thread
-     * @param {Object} state
-     * @param {string} state.name name of the document thread
-     * @param {string} state.windowState ('closed', 'folded' or 'open')
-     */
-    updateDocumentThreadState: function (threadID, state) {
-        this._documentThreadWindowStates[threadID] = state;
-        this.call('local_storage', 'setItem', this.DOCUMENT_THREAD_STATE_KEY + '/' + threadID, {
-            state: state,
-            tabId: this._tabId,
-        });
-    },
-
-    //--------------------------------------------------------------------------
-    // Private
-    //--------------------------------------------------------------------------
-
-    /**
-     * For new messages, postprocess document thread linked to this message.
-     * If there is no such document thread, create it and register its ID to
-     * the message's thread IDs.
-     *
-     * @override
-     * @private
-     * @param {mail.model.Message} message
-     */
-    _addNewMessagePostprocessThread: function (message) {
-        var resModel = message.getDocumentModel();
-        var resID = message.getDocumentID();
-        if (resModel && resModel !== 'mail.channel' && resID) {
-            this.getOrAddDocumentThread({
-                name: message.getDocumentName(),
-                resID: resID,
-                resModel: resModel,
-            });
-        }
-        return this._super.apply(this, arguments);
-    },
-    /**
-     * Updates the thread windows related to document threads.
-     *
-     * @param {Object} documentThreadStates - keys are strings 'resModel_resID',
-     *   and values are the state of the corresponding document thread ('open'
-     *   or 'folded')
-     */
-    _updateDocumentThreadWindows: function (documentThreadStates) {
-        var self = this;
-        _.each(documentThreadStates, function (state, key) {
-            var info = key.split('_');
-            var documentThread = self.getOrAddDocumentThread({
-                name: state.name,
-                resID: parseInt(info[1]),
-                resModel: info[0],
-            });
-            if (state.windowState === 'closed') {
-                documentThread.close({
-                    skipCrossTabSync: true,
-                });
-            } else {
-                documentThread.fold(state.windowState === 'folded', {
-                    skipCrossTabSync: true,
-                });
-                self.openThreadWindow(documentThread.getID(), {
-                    keepFoldState: true,
-                    skipCrossTabSync: true,
-                });
-            }
-        });
-    },
-
-    //--------------------------------------------------------------------------
-    // Handlers
-    //--------------------------------------------------------------------------
-
-    /**
-     * Called each time a localStorage key is updated.
-     *
-     * @private
-     * @param {StorageEvent} ev
-     */
-    _onStorage: function (ev) {
-        var value;
-        try {
-            value = JSON.parse(ev.newValue);
-        } catch (err) {
-            return;
-        }
-        if (ev.key.indexOf(this.DOCUMENT_THREAD_STATE_KEY) === 0) {
-            if (value.tabId === this._tabId) {
-                return;
-            }
-            // key format: DOCUMENT_THREAD_STATE_KEY + '/' + threadId
-            var documentThreadId = ev.key.substring(this.DOCUMENT_THREAD_STATE_KEY.length+1);
-            var param = {};
-            param[documentThreadId] = value.state;
-            this._updateDocumentThreadWindows(param);
-        } else if (ev.key === this.DOCUMENT_THREAD_MESSAGE_KEY) {
-            if (value.tabId === this._tabId) {
-                return;
-            }
-            if (value.messageData) {
-                this.addMessage(value.messageData);
-            }
-        }
-    },
-
-});
-
-return MailManager;
-
-});