[10.0][ADD] website_form_builder: Exactly what the title says #402

yajo · 2017-12-15T16:14:13Z

This is WIP until tours pass, but you can start playing with it!

pedrobaeza · 2017-12-15T19:53:44Z

@lasley I think you will love this

lasley · 2017-12-15T19:54:11Z

Oh snap!

pedrobaeza · 2017-12-15T19:57:28Z

website_form_builder/README.rst

+  sense in this module's context, or a correct implementation would be adding
+  not much value while adding lots of complexity:
+
+  * ``id``


What about create_date, write_date, create_uid, write_uid? They should be forbidden also I think.

pedrobaeza · 2017-12-15T19:58:27Z

website_form_builder/README.rst

+  installation to get a better UX when a user has already sent a form and
+  cannot resend it.
+
+* To edit any ``<label>`` text, you need to click twice. Review the problem


Only in Firefox?

Chrome worked without patch out of the box. Besides, this bug affects EE website_form_editor, just try in the enterprise runbot.

lasley

Freaking awesome @yajo. Haven't played with it functionally yet, but excellent code. A few minor things inline

lasley · 2017-12-15T19:56:22Z

website_form_builder/README.rst

+   fields. When you create a new website form, all its model fields are
+   automatically whitelisted for the sake of improving the UX. If you want to
+   have higher control, come back here after creating the form and blacklist
+   any fields you want.


Hmmm this is opposite of the operation of the existing website_form, which is a whitelist. More thoughts probably after reading the code, this is mainly a reminder for me to update with more thoughts. If I don't, remind me to update with more thoughts!

I prefer this approach for not having to manually add each of the fields we wish to add or supply glue modules for each possible model.

(moved inline)

Hmmm but modules that are naive of forms, which inherit a model that is be exposed by a form, typically expect that the data is coming from an authenticated source. An example is prescription or doctor verification. This data can now be submitted by users that are not authenticated.

Models are opt-in, fields are opt-out

In the example I was mentioning, the validation field is on the partner. I see a lot of potential uses for opting the partner in, which would opt in those fields too.

I'm actually kind of confused though. This black list is circumventing the pre-existing whitelist of website_form? Why is the whitelist also being used in the demo data?

Well, the point here is that, in an awesomely rare exception, website_form is completely undocumented (🤣). I tried to reuse the existing engine as much as possible, and it actually makes sense. Let me explain what it does:

ir.model has some fields to whitelist the model to be used in website forms.

ir.model.fields has a website_form_blacklisted boolean that defaults to True, so all model fields are blacklisted by default.

When a model is not whiltelisted, the controller aborts. No models are whitelisted by default in website_form addon.

When a field is blacklisted, but the model is whitelisted, the field is considered extra data (like a custom field that does not exist).

The formbuilder_whitelist method is a public method only available to website designers, which means that those users should be able to decide which fields they want to make writeable. The most UX-friendly way of expressing such desire is when you add a field to a website form, so when you save the form, any model fields found there are whitelisted automatically.

Core addons use such method to enable specific models, so when you install those addons you automatically get a website-form-enabled model ready to use out of the box.

I use such method in demo data to mimic the behavior of such addons and have some data to run the tour (which is ❌ right now).

The main purpose of website_form is to allow unauthenticated users to create records that they should have no access to, such as creating a crm.lead. The way to verify that the form came from a trusted source we have the CSRF token, provided out of the box. If we want to use the engine to provide a more granular authentication system, such as allowing only portal users to submit to certain models, then I think that belongs to another addon, independent of this one (it would extend the website_form engine, no matter if to use it with EE builder or this one).

lasley · 2017-12-15T19:57:57Z

website_form_builder/README.rst

+  sense in this module's context, or a correct implementation would be adding
+  not much value while adding lots of complexity:
+
+  * ``id``


IMO we should prevent all the magic fields

That happens automatically, I was just trying to avoid having to fill the docs gap from website_form, but I think I'll have to do it after all 😆

lasley · 2017-12-15T20:00:52Z

website_form_builder/static/src/js/snippets.js

+        "/website_form_builder/static/src/xml/snippets.xml"
+    );
+
+    var _fields_asked = {},


IMO we should use JS naming conventions & camelCase the vars/methods

I know those common JS conventions, but in Odoo it seems they decided to match the python ones. Just give a glance at https://www.odoo.com/documentation/11.0/reference/javascript.html and you'll see. So, I prefer to stick with those.

lasley · 2017-12-15T20:06:46Z

website_form_builder/static/src/js/snippets.js

+         */
+        add_model_field: function (info) {
+            var relational_data = [],
+                template = _.str.sprintf(


TIL _.str

lasley · 2017-12-15T20:07:14Z

website_form_builder/static/src/js/snippets.js

+            var domain = [], context = base.get_context();
+            // Domain might contain un-evaluable literals
+            try {
+                domain = new data.CompoundDomain(field.domain || []).eval()


Missing ; * 3 other instances below

lasley · 2017-12-15T20:08:50Z

website_form_builder/static/src/js/widgets.js

+                this.field_html = $(field).html();
+                options = $.extend({}, {
+                    title: _t("Set field's default value"),
+                    size: "small",


trailing comma no bueno in JS

I'd say it's safe to use it nowadays. 🤔 See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Trailing_commas#Browser_compatibility

pedrobaeza · 2017-12-15T20:30:22Z

website_form_builder/README.rst

+#. Search for the model you want to manage website form access for.
+#. When you find it, it will have a *Website Forms* section where you can:
+
+   * Allow the model to get forms, by checking *Allowed to use in forms*.


We need to provide a built-in list of allowed models without depending on the corresponding modules (crm.lead if present, hr.recruitment if present...). We can use a similar approach to the one used in website_multi_theme.

As I just mentioned above in #402 (comment), addons that depend on website_form already provide those, so not needed IMO.

yajo · 2017-12-18T10:25:35Z

I think all your concerns are solved now, let me focus on the tour. However functional reviews can start already 😊

yajo · 2017-12-18T13:31:27Z

Ok, it went ✔️ locally, let's see in Travis. The tour is not as exhaustive as I'd wish, but it's a good start IMHO.

tarteo

@yajo Very useful module!

I followed the steps provided by the readme using model project and task but I got stuck when I tried to whitelist a field. The error I got was: "Properties of base fields cannot be altered in this manner! Please modify them through Python code, preferably through a custom addon!".

It also would be nice to be able to edit "Blacklisted in web forms" from the Model form. Now it's only available through the Field form (Settings -> Technical -> Database Structure -> Fields).

yajo · 2018-01-10T10:43:18Z

AFAIK the setting is available in the model form too:

I followed the steps provided by the readme using model project and task but I got stuck when I tried to whitelist a field. The error I got was: "Properties of base fields cannot be altered in this manner! Please modify them through Python code, preferably through a custom addon!".

Could you provide the steps please?

tarteo · 2018-01-10T11:34:27Z

@yajo

Activate developer mode
Go to Technical -> Database Structure -> Models
Check "Allowed to use in forms"
Click a field in the Fields tab
A modal form opens with the field form
"Blacklisted in web forms" is not there
Go to Technical -> Database Structure -> Fields
Search for Project
Click the name field
"Blacklisted in web forms" is there
Uncheck "Blacklisted in web forms"
Click Save
A message shows: "Properties of base fields cannot be altered in this manner! Please modify them through Python code, preferably through a custom addon!"

yajo · 2018-01-11T13:14:39Z

It seems you can't alter fields properties through UI unless it's a manually-created model. I'm not sure I want to change that... Should I then just change the docs?

tarteo · 2018-01-11T14:21:14Z

@yajo haha, that would be funny! So the module will only work for manual created models through the UI. That's np, it's still a very useful module. Maybe you can add a disclaimer to the readme.

yajo · 2018-01-16T13:12:40Z

Docs fixed

tarteo

👍

yajo · 2018-01-19T09:15:26Z

Setting as WIP again to fix the hidden fields UI

yajo · 2018-01-19T10:53:49Z

Done. Now, instead of having the previously ugly and unusable UI for hidden data, now the user can simply set the field as hidden and use it as usual. Since hidden fields are expected to have a value, when hiding a field without it, the user will be asked for it automatically.

Please @rafaelbn review

rafaelbn · 2018-01-22T13:30:35Z

Hi @yajo 👍

Please try the form I've created in http://3315250-402-88cc0c.runbot1.odoo-community.org/#scrollTop=0

Form says "An error has occured, the form has not been sent."

-----------------------------27635325922190
Content-Disposition: form-data; name="name"

Mismo asunto para todos
-----------------------------27635325922190
Content-Disposition: form-data; name="campaign_id"

2
-----------------------------27635325922190
Content-Disposition: form-data; name="partner_name"

Bodeguita
-----------------------------27635325922190
Content-Disposition: form-data; name="email_from"

a@a
-----------------------------27635325922190
Content-Disposition: form-data; name="phone"

+34 123 456 7891
-----------------------------27635325922190
Content-Disposition: form-data; name="mobile"

+34666888444
-----------------------------27635325922190
Content-Disposition: form-data; name="street"

street
-----------------------------27635325922190
Content-Disposition: form-data; name="state_id"

28
-----------------------------27635325922190
Content-Disposition: form-data; name="zip"

28045
-----------------------------27635325922190
Content-Disposition: form-data; name="description"

Notas largas
-----------------------------27635325922190
Content-Disposition: form-data; name="tag_ids"

6,7
-----------------------------27635325922190
Content-Disposition: form-data; name="Custom Date field"

01/30/2018
-----------------------------27635325922190
Content-Disposition: form-data; name="Custom Short text field"

Corto
-----------------------------27635325922190
Content-Disposition: form-data; name="Custom Long text field"

Largo
-----------------------------27635325922190
Content-Disposition: form-data; name="Custom Yes or not field"

Custom Yes or not field
-----------------------------27635325922190
Content-Disposition: form-data; name="Custom File upload field[0]"; filename="2018-01-22_14-13-36.png"
Content-Type: image/png

�PNG
�

Answer says: false

yajo · 2018-01-22T13:59:51Z

I added the possibility to add multiple model fields at once, but I didn't have time yet to check that bug @rafaelbn

rafaelbn · 2018-01-25T00:18:26Z

Thanks @yajo ! after reviewing the BUG it is 👍 in my side!

yajo · 2018-01-26T11:11:28Z

I can reproduce the bug if I try to add a file upload field when the model has no mail.thread features. I'm not sure if that's a bug or how to fix that, honestly, but I will add a note in known issues for now.

yajo · 2018-01-26T11:13:51Z

Done now @rafaelbn

rafaelbn · 2018-01-26T12:08:33Z

@yajo stil fails in model crm.lead (for ex.) basic one 😄

yajo · 2018-01-29T08:28:29Z

Could you please try in the empty database? It seems to be conflicting with some other addon, maybe one that validates input or something like that. Your very same form works for me locally.

rafaelbn · 2018-02-02T00:47:01Z

That's right @yajo I tested in production in customer and it works. 👍 😄

rafaelbn

Great one!

yajo · 2018-02-05T10:02:08Z

Big milestone today! 🚀 🎉 😊

* [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says * fixup! [ADD] website_form_builder: Exactly what the title says

yajo added the work in progress label Dec 15, 2017

yajo self-assigned this Dec 15, 2017

yajo added this to the 10.0 milestone Dec 15, 2017

[ADD] website_form_builder: Exactly what the title says

b913b12

yajo force-pushed the 10.0-website_form_builder branch from 178c7a3 to b913b12 Compare December 15, 2017 16:17

pedrobaeza changed the title ~~[ADD] website_form_builder: Exactly what the title says~~ [10.0][ADD] website_form_builder: Exactly what the title says Dec 15, 2017

pedrobaeza reviewed Dec 15, 2017

View reviewed changes

lasley approved these changes Dec 15, 2017

View reviewed changes

pedrobaeza reviewed Dec 15, 2017

View reviewed changes

fixup! [ADD] website_form_builder: Exactly what the title says

4a7f2da

yajo added the needs review label Dec 18, 2017

yajo added 2 commits December 18, 2017 12:33

fixup! [ADD] website_form_builder: Exactly what the title says

fe05d64

fixup! [ADD] website_form_builder: Exactly what the title says

87bc239

yajo removed the work in progress label Dec 18, 2017

fixup! [ADD] website_form_builder: Exactly what the title says

1a5b5d3

tarteo requested changes Jan 9, 2018

View reviewed changes

fixup! [ADD] website_form_builder: Exactly what the title says

15825b7

yajo force-pushed the 10.0-website_form_builder branch from c993b4e to 15825b7 Compare January 16, 2018 13:12

yajo requested a review from rafaelbn January 16, 2018 13:14

tarteo approved these changes Jan 16, 2018

View reviewed changes

yajo mentioned this pull request Jan 18, 2018

[REF] javascript-lint: Usability boost OCA/pylint-odoo#185

Merged

yajo added work in progress and removed needs review labels Jan 19, 2018

fixup! [ADD] website_form_builder: Exactly what the title says

5d511a4

yajo added needs review and removed work in progress labels Jan 19, 2018

yajo added 2 commits January 19, 2018 10:52

fixup! [ADD] website_form_builder: Exactly what the title says

da88faa

fixup! [ADD] website_form_builder: Exactly what the title says

88cc0cd

fixup! [ADD] website_form_builder: Exactly what the title says

bbe2903

yajo added the work in progress label Jan 22, 2018

pedrobaeza removed the work in progress label Jan 26, 2018

fixup! [ADD] website_form_builder: Exactly what the title says

d868642

rafaelbn approved these changes Feb 2, 2018

View reviewed changes

rafaelbn merged commit 94c9f12 into OCA:10.0 Feb 2, 2018

pedrobaeza deleted the 10.0-website_form_builder branch February 2, 2018 08:55

[10.0][ADD] website_form_builder: Exactly what the title says #402

[10.0][ADD] website_form_builder: Exactly what the title says #402

Conversation

yajo commented Dec 15, 2017 • edited Loading

pedrobaeza commented Dec 15, 2017

lasley commented Dec 15, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yajo Dec 18, 2017 • edited Loading

Choose a reason for hiding this comment

lasley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lasley Dec 15, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yajo commented Dec 18, 2017

yajo commented Dec 18, 2017 • edited Loading

tarteo left a comment

Choose a reason for hiding this comment

yajo commented Jan 10, 2018

tarteo commented Jan 10, 2018

yajo commented Jan 11, 2018 • edited Loading

tarteo commented Jan 11, 2018

yajo commented Jan 16, 2018

tarteo left a comment

Choose a reason for hiding this comment

yajo commented Jan 19, 2018

yajo commented Jan 19, 2018

rafaelbn commented Jan 22, 2018 • edited Loading

yajo commented Jan 22, 2018

rafaelbn commented Jan 25, 2018

yajo commented Jan 26, 2018 • edited Loading

yajo commented Jan 26, 2018

rafaelbn commented Jan 26, 2018

yajo commented Jan 29, 2018

rafaelbn commented Feb 2, 2018

rafaelbn left a comment

Choose a reason for hiding this comment

yajo commented Feb 5, 2018

yajo commented Dec 15, 2017 •

edited

Loading

yajo Dec 18, 2017 •

edited

Loading

lasley Dec 15, 2017 •

edited

Loading

yajo commented Dec 18, 2017 •

edited

Loading

yajo commented Jan 11, 2018 •

edited

Loading

rafaelbn commented Jan 22, 2018 •

edited

Loading

yajo commented Jan 26, 2018 •

edited

Loading