[IMP] web_editor,*: Refactoring the wysiwyg editor and 'html' field

_Task #1878502_

- The refactoring allows for the update of the _Summernote_ library.
- A new structure was created by transforming all the plugins in the library using the odoo inheritance system. Plugins are easier to implement with the `AbstractPlugin` to add Odoo behaviors.
- The cleanup allowed us to remove some of the code that was in `web_editor` but only used in `website` or in `mass_mailing`. Some parts are still in `web_editor` but will be moved at a later time.
- The refactoring also had to be done in order to create a set of unit tests. Each behavior can be tested, including the behaviors performed as a consequence of keyboard interactions (for instance: Enter, Tab...).
- From now on, the methods of the library (in this case _Summernote_) can no longer be called by other modules or files. Only the `wysiwyg` widgets can access it, to simplify the updating process. The `wysiwyg` object serves as an interface. A lot of tests are done, ensuring the consistency of outside behavior.
- Depending on the options the snippets will be loaded or not, the editor will be in an iframe or not... all of this is transparent from the outside.
- Regarding iframes, all controllers related to editing have been removed: the new API no longer needs them. This speeds up loading, eases testing and removes complexity for the same features.

**PUBLIC FEATURES**

There are several public methods on the `Wysiwyg` class:
- `Wysiwyg.prepare (WidgetParent)` which returns a deferred resolved when the library (xml, lazy, assets...) is loaded.
- `Wysiwyg.getRange (DOM)` returns the range (selection in the dom)
- `Wysiwyg.setRange (startNode, startOffset, endNode, endOffset)` which creates a range (selection in the dom)
- `Wysiwyg.setRangeFromNode (DOM, options)` that creates a range from an element (option available to select all, start or end)

A jQuery selector was added: `:o_editable`, which indicates whether the current element is editable. That is, if it is contained in a tag with the attribute `contentEditable = "true"` or in a tag with the class `o_editable`.
Several methods are also present:
- `focusIn`: makes a focus and places the cursor at the beginning of the element
- `focusInEnd`: makes a focus and places the cursor at the end of the element
- `selectContent`: makes a focus and selects the content

**HTML FIELD**

The HTML field can receive different options:
- `style-inline:` {boolean} transforms a class into an inline style when saving and vice versa when reading.
- `no-attachment`: {boolean} prevents the use of attachments (in media dialog)
- `cssEdit`: {xml_id} to use a template containing the css to loaded in an iframe when editing
- `cssReadonly`: {xml_id} to use a template containing the css to load into an iframe when viewing in readonly
- `snippets`: {xml_id} snippets template (can be used with or without `cssEdit`)
- `wrapper`: {template} qweb static template (containing a tag: `id = "wrapper"`) that will include the content during editing (removed on save)

**MASS MAILING**

A widget was created for `mass mailing`. There are now two fields: `body_html` and `body_arch`.
`body_arch` contains the code with the class without conversion into inline style, useful when editing and one with the inline style that is visible in readonly mode and sent by email.
Advantage: no spreading errors, able to update css/theme, able to do more changes when converting to inline style so that a maximum of mail clients have an impeccable rendering.

**REMAINING KNOW ISSUES**

These will be fixed in a subsequent commit.
- A few committed changes made during the development of this refactoring were lost in the process and should be reapplied.
- Some minor (mostly range) issues remain with Firefox.
--
I confirm I have signed the CLA and read the PR guidelines at www.odoo.com/submit-pr

closes odoo/odoo#29775

1 files changed, 0 insertions, 327 deletions

diff --git a/addons/web_editor/static/tests/web_editor_tests.js b/addons/web_editor/static/tests/web_editor_tests.js
deleted file mode 100644
index 1995add777d..00000000000
--- a/addons/web_editor/static/tests/web_editor_tests.js
+++ /dev/null
@@ -1,327 +0,0 @@
-odoo.define('web_editor.web_editor_tests', function (require) {
-"use strict";
-
-var FormView = require('web.FormView');
-var testUtils = require('web.test_utils');
-var core = require('web.core');
-var web_editor = require('web_editor.editor');
-
-var _t = core._t;
-
-QUnit.module('web_editor', {
-    beforeEach: function() {
-        this.data = {
-            'mass.mailing': {
-                fields: {
-                    display_name: { string: "Displayed name", type: "char" },
-                    body: {string: "Message Body", type: "html"},
-                },
-                records: [{
-                    id: 1,
-                    display_name: "first record",
-                    body: "<div class='field_body'>yep</div>",
-                }],
-                onchanges: {},
-            },
-        };
-    }
-});
-
-QUnit.test('field html widget', function (assert) {
-    var done = assert.async();
-    assert.expect(3);
-
-    var form = testUtils.createView({
-        View: FormView,
-        model: 'mass.mailing',
-        data: this.data,
-        arch: '<form string="Partners">' +
-                '<field name="body" widget="html" style="height: 100px"/>' +
-            '</form>',
-        res_id: 1,
-    });
-
-    assert.strictEqual(form.$('.field_body').text(), 'yep',
-        "should have rendered a div with correct content in readonly");
-    assert.hasAttrValue(form.$('div[name=body]'), 'style', 'height: 100px',
-        "should have applied the style correctly");
-
-    testUtils.form.clickEdit(form);
-
-    assert.strictEqual(form.$('.note-editable').html(), '<div class="field_body">yep</div>',
-            "should have rendered the field correctly in edit");
-
-    // summernote invokes handlers after a setTimeout, so we must wait as well
-    // before destroying the widget (otherwise we'll have a crash later on)
-    setTimeout(function () {
-        form.destroy();
-        done();
-    }, 0);
-});
-
-QUnit.test('field html widget (with options inline-style)', function (assert) {
-    var done = assert.async();
-    assert.expect(3);
-
-    var form = testUtils.createView({
-        View: FormView,
-        model: 'mass.mailing',
-        data: this.data,
-        arch: '<form string="Partners">' +
-                '<field name="body" widget="html" style="height: 100px" options="{\'style-inline\': true}"/>' +
-            '</form>',
-        res_id: 1,
-    });
-
-    assert.containsOnce(form, 'iframe',
-        "should have rendered an iframe without crashing in readonly");
-    assert.hasAttrValue(form.$('div[name=body]'), 'style', 'height: 100px',
-        "should have applied the style correctly");
-
-    testUtils.form.clickEdit(form);
-
-    assert.strictEqual(form.$('.note-editable').html(), '<div class="field_body">yep</div>',
-            "should have rendered the field correctly in edit");
-
-    // summernote invokes handlers after a setTimeout, so we must wait as well
-    // before destroying the widget (otherwise we'll have a crash later on)
-    setTimeout(function () {
-        form.destroy();
-        done();
-    }, 0);
-});
-
-QUnit.test('field html translatable', function (assert) {
-    assert.expect(3);
-
-    var multiLang = _t.database.multi_lang;
-    _t.database.multi_lang = true;
-
-    this.data['mass.mailing'].fields.body.translate = true;
-
-    var form = testUtils.createView({
-        View: FormView,
-        model: 'mass.mailing',
-        data: this.data,
-        arch: '<form string="Partners">' +
-                '<field name="body" widget="html"/>' +
-            '</form>',
-        res_id: 1,
-        mockRPC: function (route, args) {
-            if (route === '/web/dataset/call_button' && args.method === 'translate_fields') {
-                assert.deepEqual(args.args, ['mass.mailing',1,'body',{}], "should call 'call_button' route");
-                return $.when();
-            }
-            return this._super.apply(this, arguments);
-        },
-    });
-
-    assert.containsNone(form, '.oe_form_field_html_text .o_field_translate',
-        "should not have a translate button in readonly mode");
-
-    testUtils.form.clickEdit(form);
-    var $button = form.$('.oe_form_field_html_text .o_field_translate');
-    assert.strictEqual($button.length, 1, "should have a translate button");
-    testUtils.dom.click($button);
-
-    form.destroy();
-    _t.database.multi_lang = multiLang;
-});
-
-QUnit.test('field html_frame widget', function (assert) {
-    assert.expect(6);
-
-    var form = testUtils.createView({
-        View: FormView,
-        model: 'mass.mailing',
-        data: this.data,
-        arch: '<form string="Partners">' +
-                '<field name="body" widget="html_frame" options="{\'editor_url\': \'/logo\'}"/>' +
-            '</form>',
-        res_id: 1,
-        session: {user_context: {lang: "en_us"}},
-        mockRPC: function (route) {
-            if (_.str.startsWith(route, '/logo')) {
-                // those tests will be executed twice, once in readonly and once in edit
-                assert.ok(route.search('model=mass.mailing') > 0,
-                    "the route should specify the correct model");
-                assert.ok(route.search('res_id=1') > 0,
-                    "the route should specify the correct id");
-                return $.when();
-            }
-            return this._super.apply(this, arguments);
-        },
-    });
-
-    assert.containsOnce(form, 'iframe', "should have rendered an iframe without crashing");
-
-    testUtils.form.clickEdit(form);
-
-    assert.containsOnce(form, 'iframe', "should have rendered an iframe without crashing");
-
-    form.destroy();
-});
-
-QUnit.test('field htmlsimple does not crash when commitChanges is called in mode=readonly', function (assert) {
-    assert.expect(1);
-
-    var form = testUtils.createView({
-        View: FormView,
-        model: 'mass.mailing',
-        data: this.data,
-        arch: '<form string="Partners">' +
-                '<header>' +
-                    '<button name="some_method" class="s" string="Do it" type="object"/>' +
-                '</header>' +
-                '<sheet>' +
-                    '<field name="body"/>' +
-                '</sheet>' +
-            '</form>',
-        res_id: 1,
-        intercepts: {
-            execute_action: function () {
-                assert.step('execute_action');
-            }
-        },
-    });
-
-    testUtils.dom.click(form.$('button:contains(Do it)'));
-    form.destroy();
-});
-
-QUnit.test('html_frame does not crash when saving in readonly', function (assert) {
-    // The 'Save' action may be triggered even in readonly (e.g. when clicking
-    // on a button in the form view)
-    assert.expect(2);
-
-    var form = testUtils.createView({
-        View: FormView,
-        model: 'mass.mailing',
-        data: this.data,
-        arch: '<form string="Partners">' +
-                '<sheet>' +
-                    '<field name="body" widget="html_frame" options="{\'editor_url\': \'/logo\'}"/>' +
-                '</sheet>' +
-            '</form>',
-        res_id: 1,
-        mockRPC: function (route, args) {
-            if (args.method) {
-                assert.step(args.method);
-            }
-            if (_.str.startsWith(route, '/logo')) {
-                // manually call the callback to simulate that the iframe has
-                // been loaded (note: just the content, not the editor)
-                window.odoo[$.deparam(route).callback + '_content'].call();
-                return $.when();
-            }
-            return this._super.apply(this, arguments);
-        },
-    });
-
-    form.saveRecord(); // before the fix done in this commit, it crashed here
-
-    assert.verifySteps(['read']);
-
-    form.destroy();
-});
-
-QUnit.test('html_frame does not crash when saving in edit mode (editor not loaded)', function (assert) {
-    // The 'Save' action may be triggered when saving in edit mode very fast
-    // so that the editor may be not loaded, even though the content is!
-    assert.expect(2);
-
-    var form = testUtils.createView({
-        View: FormView,
-        model: 'mass.mailing',
-        data: this.data,
-        arch: '<form string="Partners">' +
-                '<sheet>' +
-                    '<field name="display_name"/>' +
-                    '<field name="body" widget="html_frame" options="{\'editor_url\': \'/logo\'}"/>' +
-                '</sheet>' +
-            '</form>',
-        res_id: 1,
-        mockRPC: function (route, args) {
-            if (args.method) {
-                assert.step(args.method);
-            }
-            if (_.str.startsWith(route, '/logo')) {
-                // manually call the callback to simulate that the iframe has
-                // been partially loaded (just the content, not the editor)
-                window.odoo[$.deparam(route).callback + '_content']();
-                return $.when();
-            }
-            return this._super.apply(this, arguments);
-        },
-    });
-
-    testUtils.form.clickEdit(form);
-    testUtils.fields.editInput(form.$('input.o_input.o_field_char'), 'trululu');
-    testUtils.form.clickSave(form); // crash without editor fully loaded
-
-    assert.verifySteps(['read']);
-
-    form.destroy();
-});
-
-QUnit.test('html_frame saving in edit mode (editor and content fully loaded)', function (assert) {
-    var done = assert.async();
-    assert.expect(4);
-
-    var editorBar = new web_editor.Class();
-    var loadDeferred = $.Deferred();
-    var writeDeferred = $.Deferred();
-
-    var form = testUtils.createView({
-        View: FormView,
-        model: 'mass.mailing',
-        data: this.data,
-        arch: '<form string="Partners">' +
-                '<sheet>' +
-                    '<field name="display_name"/>' +
-                    '<field name="body" widget="html_frame" options="{\'editor_url\': \'/logo\'}"/>' +
-                '</sheet>' +
-            '</form>',
-        res_id: 1,
-        mockRPC: function (route, args) {
-            if (args.method) {
-                assert.step(args.method);
-                if (args.method === 'write') {
-                    writeDeferred.resolve();
-                }
-            }
-            if (_.str.startsWith(route, '/logo')) {
-                // manually call the callback to simulate that the iframe has
-                // been fully loaded (content + editor)
-                var callback = $.deparam(route).callback;
-                return loadDeferred.then(function () {
-                    var contentCallback = window.odoo[callback + '_content'];
-                    var editorCallback = window.odoo[callback + '_editor'];
-                    if (editorCallback && contentCallback) {
-                        contentCallback();
-                        editorCallback(editorBar);
-                    }
-                });
-            }
-            return this._super.apply(this, arguments);
-        },
-    });
-
-    testUtils.form.clickEdit(form);
-    testUtils.fields.editInput(form.$('input.o_input.o_field_char'), 'trululu');
-    testUtils.form.clickSave(form);
-
-    loadDeferred.resolve(); // simulate late loading of html frame
-
-    assert.strictEqual(form.$('.o_field_char').val(), 'trululu',
-        "should have saved the char field text");
-
-    writeDeferred.then( function () { // html_frame is async with write
-        assert.verifySteps(['read', 'write']);
-        form.destroy();
-        done();
-    });
-
-});
-
-});