Feature: Add campaign setting for default form

[kjohnson]

Resolves GIVE-1493

Description

This PR adds the Default Form setting in the Campaign Details Page, on the Settings tab.

Affects

• Adds CampaignDetailsData DTO class
• Updates response data to use DTO in CampaignRequestController

Visuals

Testing Instructions

Go to the Campaign Details Page
Go to the Settings tab
Select a default form
Publish the campaign
Check that the default form was updated on the Default Form widget

Pre-review Checklist

• Acceptance criteria satisfied and marked in related issue
• Relevant @unreleased tags included in DocBlocks
• Includes unit tests
• Reviewed by the designer (if follows a design)
• Self Review of code and UX completed

[glaubersilva]

@kjohnson I found a few problems while testing it and recorded a video to demonstrate that, here is the link: https://www.loom.com/share/f77ce3b6d30b4932ac81edb8d308972f?sid=48028945-a72f-469b-9eaa-1e67190af3e7

[glaubersilva]

There is any specific reason to use number instead of integer here?

[kjohnson]

My understanding is that reactHookForms is validating as a number. When I used integer it would throw an error. Likewise, the goal property of the schema uses number. The id property uses integer, but the id isn't being validated with reactHookForms.

[glaubersilva]

@kjohnson In this case, I think the best approach is to create a react-hook-form custom rule in the fronted to validate integer numbers because changing this parameter here to number will not reflect what exactly this endpoint accepts as a parameter. If someone using our API uses the OPTIONS to retrieve the parameters schema for this endpoint, they will see that the id can be a number which is wrong since it can only be an integer value. Also, if we decide to provide some documentation for our API using a plugin like the wp-api-swaggerui (or any other similar tool) the docs generated by it will display the wrong type for this parameter as well.

[glaubersilva]

I think we don't need this DTO since the campaign model will have the default form ID available when this PR is merged: #7616

[kjohnson]

Good point. I'm looking at #7616 now.

[glaubersilva]

We need a way to load this form list beyond the first page load because it can get inaccurate easily depending of how user add new forms to the campaign - check my attached video for more details.

[kjohnson]

Is a list of forms available for re-use from the Campaign Forms List Table?

[glaubersilva]

@kjohnson I don't know if our List Table component provides some way to access the list of available items through a JS object or something like that, but I think not, even because the list table can have pagination which makes me think again that this field to update the default form trough the settings tab is not a good idea because in situations where we have a massive amount of forms in a single campaign, populate this dropdown can become a problem.

[alaca]

Since we already have a registered campaign entity, we should use the useEntityRecord hook. As I see it, we should just update the CampaignDetailsData DTO to include the forms associated with the campaign.

[jonwaldstein]

Any reason to not use the useWatch hook instead? I typically use the hook for the performance benefits unless I need to watch many values at the root level:

From the docs about watch

This API will trigger re-render at the root of your app or form, consider using a callback or the useWatch api if you are experiencing performance issues.

[kjohnson]

That would probably work. I had copy/pasted from another part of the codebase, but I'll refactor and try it.

[alaca]

Hey Kyle, nice job man.
What would be really cool is that we use the useEntityRecord hook to get the campaign data, we don't have to localize scripts then. The defaultFormId should be a property of the campaign entity so we don't have to use the react-hook-forms watch function to get the form id because the entity will reflect that once it's updated.

[alaca]

Since we already have a registered campaign entity, we should use the useEntityRecord hook. As I see it, we should just update the CampaignDetailsData DTO to include the forms associated with the campaign.