Add campaign custom data

[wmnnd]

Implements #103

Here is campaign data in action:

This PR does the following:

• Add new JsonField type for campaign.data and contact.data
• Adds data data field to campaigns
• Moves campaign settings to modal
• Moves update/send controllers to LiveView
• Adds preview button to WYSIWYG editor
• Removes toggle-wysiwyg button from Markdown campaigns (it’s been a bit buggy, so moving it to the settings modal discourages users from just going back and forth)

[wmnnd]

@panoramix360, @gbottari: I’d really appreciate it if you could give this PR a look and let me know what you think! :pray:

[wmnnd]

@panoramix360 Excellent! I’ve added some more details of what the PR changes in the PR description.

[wmnnd]

I think there are some bugs in the editor in this branch, but I’m already working on fixing those.

[panoramix360]

HI @wmnnd, I looked into your PR, sorry for the delay, the PR is very long hehe

Pretty nice feature! I think that will be good to have this on Keila! Congrats!

Some suggestions:

• Maybe it will be cool to add some reference sheet to make the user know about all the dynamic properties that he can add into the campaign email. Ex.: Contact first name, last name, etc
• It is not clear to me as user if I can use the custom fields from Campaign Data to fill the template.
• The refactoring to create a JsonField is pretty nice, it can be used in the future for other purposes.

I tested and found some minor bugs:

• I can scroll behind the preview when it is expanded.
• When I saved a campaign and edit again, I tried to open the preview and it was not showing.
• The preview is not reflecting the changes made on the WYSIWYG.
• I don't know if it was intended but when I inserted a incorrect JSON, the validation error was not really friendly.
• RememberUnsaved did not worked when editing the WYSIWYG field, I don't know if it's possible either hehe
• When I opened the Settings Dialog, I can type anything on Campaign Data field and close Settings clicking on the overlay background, if I open again the settings, the field will remain filled, maybe we can use the RememberUnsaved to solve this.
• When I opened the schedule Dialog and tried to send without filling any text fields, it was possible and did not show any validation error.

I noticed something strange too, I'll try to write the steps so you can reproduce:

• I created a campaign without having a Sender created.
• After creating the campaign and editing, I tried scheduling and it was informed that I needed a sender to send the campaign, so I think this behaviour is correct.
• Then I created a sender and opened the campaign
• When I clicked on the Settings, the sender was already selected for the campaign
• Then I clicked "Cancel"
• Tried to schedule again and received same error above
• I was only able to schedule when I opened settings and clicked on "Ok"

Maybe don't letting a campaign being created if the user has not configured any senders will be a better choice, I don't know.

Sorry for the extense reply haha

Tomorow, me and @gbottari will begin looking into the rate limiter issue.

But if you want I can help you tackle this issues above!

Let me know what you think :)

[gbottari]

Hi guys! I think @panoramix360 made some great points. I also think this PR is great because it will enable the personalization of newsletters.

I noticed that JsonField does not allow JSON arrays. But it's not clear to me why that is. I think it is a valid use case. Imagine one wishes to reference a contact recommended products, like ['apples', 'oranges', 'bananas'].

I also think it is worth limiting the maximum size of contact.data and campaign.data to prevent abuse (maybe adding a constraint).

[wmnnd]

Hey @panoramix360 and @gbottari, thanks for this very useful feedback!

• Very good point about the discoverability of the contact and campaign data. Do you have any suggestions for improving that? Maybe a first step would be an additional page in the docs and linking them in the app.
• Good catch with the dialog scrolling and empty sender!
• I think allowing JSON arrays would make things a bit more complicated, because then it’s no longer guaranteed that campaign.data is always an object. If users want to use an array, they could easily just do something like {"my_array": ["foo", "bar"]}
• My latest commits have now already fixed the broken preview. I’ve also added improved Markdown editing while I was at it :smile:

So here are the things that still need fixing as a takeaway from your comments:

• [ ] Make Liquid options more discoverable
• [ ] Disable scrolling background when preview is open
• [x] Correctly reflect empty sender selection in campaign settings
• [x] Add limit on contact and campaign data

[panoramix360]

I'm glad that you liked our feedback, if you need any more help with this PR, just let us know

We'll now focus our efforts in the send rate issue

[wmnnd]

I’m working on a new modal for adding Liquid tags, this should make things a bit easier! What do you think?

[panoramix360]

I think this is a great opportunity to show the user what the feature can do!

[wmnnd]

The Liquid dialog is now ready! Let me know what you think, I think this PR is ready to merge :partying_face:

[panoramix360]

I tested and now I think it's pretty nice, well done

It'll be a great addition to the project :)

[wmnnd]

@panoramix360 Thanks for testing it and all the feedback you’ve given, that’s been really helpful!