Add server side previews to the application workflow

[wes-otf]

Description

Closes #3545.

This creates the option to require a user to preview their form before submitting it. The requirement is set on a per fund/lab basis, and is a required checkbox when the lab/fund is configured in Wagtail admin global Django configuration option. The preview first saves the application as a draft, then presents the user with a preview of their application. Upon viewing, the user can either edit or submit as seen in the flow diagram below.

Sloppy Flow Diagram:

Screenshots:

Test Steps

Testing preview on initial apply

• Navigate to https://test-apply.hypha.app/
• Ensure you're logged in
• Select Apply on any fund in the list
• Populate some fields (ideally the ones that allow for text formatting)
• Confirm Preview and submit appears at the bottom of the application
• Select the Preview and submit button
• Confirm a preview with the application's rendered fields now appears, with Submit and Edit buttons at the bottom.
• Confirm selecting Submit successfully submits the submission (can be verified by using the navigation bar to go to Submissions > All submissions.

Testing preview on edit

• Navigate to https://test-apply.hypha.app/
• Ensure you're logged in
• Select Apply on any fund in the list
• Populate some fields (ideally the ones that allow for text formatting)
• Select the Save Draft button at the bottom of the page
• When redirected to the page statingYour application is saved as a draft., select the Continue editing button.
• Make changes to the application
• Confirm the Preview and submit button is present at the bottom of the page.
• Select the Preview and submit button
• Confirm a preview with the updated application's rendered fields now appears, with Submit and Edit buttons at the bottom.
• Confirm selecting Submit successfully submits the submission (can be verified by using the navigation bar to go to Submissions > All submissions.

[theskumar]

Do we really need a configuration option. I would suggest keeping it as default for all the rounds/labs.

One less configuration to care about.

[frjo]

This look like a nice implementation!

I would also prefer no option to make it more simple.

We can ask the other implementors and if some have really strong opinopn on it we might add a global env var to turn the previews off.

I can not see an organisation that wants previews for some fund/lab but not all.

[wes-otf]

Thanks @frjo @theskumar, this was great feedback! After chatting today in the maintainers meeting it seems like the path forward is global configurations for the previews rather than per-fund/lab as OTS brought up that some organizations might not want this feature. Will have those changes up soon!

[frjo]

This works really well in my testing. One small comment around the new env setting.

There is also an issue for sites that set:

FORCE_LOGIN_FOR_APPLICATION = False

The applicant fill in the submission form as anonymous (not logged in) and click "Preview and submit". They then have the option to click "Submit for review" or "Edit". Both will take them to the login screen without any explanations.

An account is created for them and the e-mail is sent out but we do not communicate this fact to them in Hypha.

If you set:

REQUIRE_PREVIEW = False

You still have the same issue if the applicant click the optional "Preview" button.

How should we handle this?

A simple way would be to make preview only work for logged in users.

[wes-otf]

@frjo thanks for testing! This is definitely an oversight from me, I'll go back to the drawing board for this one.

A simple way would be to make preview only work for logged in users.

I think this would also negate FORCE_LOGIN_FOR_APPLICATION = False if previewing was a piece of the submission process right? If you clicked "Preview and submit" and were forced to login to preview

[frjo]

@wes-otf I think the best solution is to only activate previewing for logged in users (regardless if REQUIRE_PREVIEW is set to true or false).

We then document that FORCE_LOGIN_FOR_APPLICATION = False will disable previewing of submissions for non logged in users.

What do you think?

[wes-otf]

@frjo Yeah I think that is the only answer that really makes sense. All the options I can think of would either be a major overhaul or a potential security vulnerability

[wes-otf]

This should be all set now!

[wes-otf]

@frjo I just created two labels for user testing vs dev testing. Let me know if you think that makes sense moving forward