diff options
| author | Sébastien Theys <seb@odoo.com> | 2020-06-15 18:12:21 +0000 |
|---|---|---|
| committer | Sébastien Theys <seb@odoo.com> | 2020-06-15 18:12:21 +0000 |
| commit | 3fea5b2136627c1d7e83b2a5e111952fe3eb10a1 (patch) | |
| tree | 5eefad07972a87ce4689b83260f981bc87aadad4 /addons/mail/static/src/model/model_core.js | |
| parent | 0a82848606151ef60eb6523e9c4c161171f214e7 (diff) | |
[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>
Diffstat (limited to 'addons/mail/static/src/model/model_core.js')
| -rw-r--r-- | addons/mail/static/src/model/model_core.js | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/addons/mail/static/src/model/model_core.js b/addons/mail/static/src/model/model_core.js new file mode 100644 index 00000000000..0198e47ee7d --- /dev/null +++ b/addons/mail/static/src/model/model_core.js @@ -0,0 +1,125 @@ +odoo.define('mail/static/src/model/model_core.js', function (require) { +'use strict'; + +/** + * Module that contains registry for adding new models or patching models. + * Useful for model manager in order to generate model classes. + * + * This code is not in model manager because other JS modules should populate + * a registry, and it's difficult to ensure availability of the model manager + * when these JS modules are deployed. + */ + +const registry = {}; + +//------------------------------------------------------------------------------ +// Private +//------------------------------------------------------------------------------ + +/** + * @private + * @param {string} modelName + * @returns {Object} + */ +function _getEntryFromModelName(modelName) { + if (!registry[modelName]) { + registry[modelName] = { + dependencies: [], + factory: undefined, + name: modelName, + patches: [], + }; + } + return registry[modelName]; +} + +/** + * @private + * @param {string} modelName + * @param {string} patchName + * @param {Object} patch + * @param {Object} [param3={}] + * @param {string} [param3.type='instance'] 'instance', 'class' or 'field' + */ +function _registerPatchModel(modelName, patchName, patch, { type = 'instance' } = {}) { + const entry = _getEntryFromModelName(modelName); + Object.assign(entry, { + patches: (entry.patches || []).concat([{ + name: patchName, + patch, + type, + }]), + }); +} + +//------------------------------------------------------------------------------ +// Public +//------------------------------------------------------------------------------ + +/** + * Register a patch for static methods in model. + * + * @param {string} modelName + * @param {string} patchName + * @param {Object} patch + */ +function registerClassPatchModel(modelName, patchName, patch) { + _registerPatchModel(modelName, patchName, patch, { type: 'class' }); +} + +/** + * Register a patch for fields in model. + * + * @param {string} modelName + * @param {string} patchName + * @param {Object} patch + */ +function registerFieldPatchModel(modelName, patchName, patch) { + _registerPatchModel(modelName, patchName, patch, { type: 'field' }); +} + +/** + * Register a patch for instance methods in model. + * + * @param {string} modelName + * @param {string} patchName + * @param {Object} patch + */ +function registerInstancePatchModel(modelName, patchName, patch) { + _registerPatchModel(modelName, patchName, patch, { type: 'instance' }); +} + +/** + * @param {string} name + * @param {function} factory + * @param {string[]} [dependencies=[]] + */ +function registerNewModel(name, factory, dependencies = []) { + const entry = _getEntryFromModelName(name); + let entryDependencies = [...dependencies]; + if (name !== 'mail.model') { + entryDependencies = [...new Set(entryDependencies.concat(['mail.model']))]; + } + if (entry.factory) { + throw new Error(`Model "${name}" has already been registered!`); + } + Object.assign(entry, { + dependencies: entryDependencies, + factory, + name, + }); +} + +//------------------------------------------------------------------------------ +// Export +//------------------------------------------------------------------------------ + +return { + registerClassPatchModel, + registerFieldPatchModel, + registerInstancePatchModel, + registerNewModel, + registry, +}; + +}); |
