Participate anonymous mode - online and offline - Githubissues

OpenClinica / enketo-oc

OpenClinica's fork of the Enketo web forms monorepo

Apache License 2.0

0 stars 1 forks source link

Participate anonymous mode - online and offline #156

Open MartijnR opened 4 years ago

MartijnR commented 4 years ago

fieldsubmissions
queryparams
authentication (would be nice, but may not be absolutely required)

MartijnR commented 4 years ago

Inventory of tasks:

[x] no longer use iframe - figure out how - MAY BE OKAY FOR PARTICIPATE - iframe support not needed
[x] fieldsubmission logic: split up saved record into individual fieldsubmissions for all leaf nodes (including empty ones, I think), or compare with default instance and only for fields that were changed (but that's a lot more work) - OKAY, TRY SUBMITTING ONLY CHANGED VALUES - Just full record
[ ] get queryparameters to work offline, in particular ecid, -pid, jini- - pid and JINI not needed, NOT SURE ABOUT ECID - we don't think ecid is needed for these since they will always be new forms
[x] view for /survey/collect/participant/offline - YES
[x] parent_window_origin (probably not, as serving in iframe may not be feasible) no iframe involved

NOT part of scope:

offline-capable equivalent of /survey/view,
idem for /survey/view/pdf,
idem for /survey/preview,
idem for /survey/preview/participant,
idem for /instance/edit and instance/edit/c,
idem for /instance/edit/participant
idem for /instance/edit/rfc and /instance/edit/rfc/c
idem for /instance/view
idem for /instance/view/pdf
idem for /instance/note and /instance/note/c
idem for /instance/headless/rfc
no return_url functionality
defaults[] (API param) functionality
view for /survey/collect/offline - NOT NEEDED INITIALLY

MartijnR commented 4 years ago

~24 hours without iframe

http://localhost:8005/fs/participant/x/#d8fdeecf11ec44a518a2e529ab660b4a

MartijnR commented 4 years ago

[ ] what should button say: Submit?
[x] should save-as-draft be enabled? - Yes
[x] API endpoint
[x] record storage

pbowen-oc commented 4 years ago

@MartijnR - We need to think a little more about the exact expected behavior and when the queue should be populated and submitted.

pbowen-oc commented 4 years ago

We want to enabled online Anonymous mode as well. I think that aligns closely with this offline ticket. Online Anonymous mode would also be only for the new Participant record view and would have Submit button that would trigger the entire queue of items to be submitted (as field submissions).

How much additional work is needed on your end to enable online Anonymous mode (separate from the 24 hours above for offline Anonymous mode)?

MartijnR commented 4 years ago

/survey/collect/participant/offline -> /survey/collect/participant/anonymous/offline
/survey/collect/participant/anonymous

online: probably multi-submission, tbc

pbowen-oc commented 4 years ago

This has been de-prioritized for now.

MartijnR commented 4 years ago

If this ever becomes relevant again, IE11 won't be possible to support with offline-capable forms as Chrome is removing support for applicationCache in version 82, so we are switching to a different technology: https://github.com/enketo/enketo/issues/1204

MartijnR commented 3 years ago

[ ] ~~check into supporting OAUTH2~~

pbowen-oc commented 3 years ago

We want to support this in a true anonymous, non-authenticated model and also in a model that requires authentication to submit data and load the form.

We think full record submission (not field submission would make more sense after all).

MartijnR commented 3 years ago

[x] provide estimate for this

MartijnR commented 3 years ago

Estimate: 10 hrs

MartijnR commented 3 years ago

The remaining part of this issue:

[x] find old branch -> feature/offline-participate-253 -> feature/offline-participate-253-II
[x] add API endpoint for empty form offline participant view
add fieldsubmission logic that keeps submitting queues as done in current offline-capable views, but splits up the record into multiple fieldsubmissions (still think this is better done on OC side though from complete XML record)
[x] enable save-as-draft again

MartijnR commented 3 years ago

http://localhost:8005/fs/participant/x/d8fdeecf11ec44a518a2e529ab660b4a (no hash!)

MartijnR commented 3 years ago

some complications, I hadn't considered so far:

uploading binary files, e.g. drawings
keeping track of the result of all fieldsubmissions for a record. What to do if some fail? What if the user closes the browser and tries again another day? The only pragmatic way (for both) is probably to resubmit all values of the whole record again (including the ones that were successful).

This makes me wonder again, if it wouldn't be better to split up the whole XML record on the OC side.

pbowen-oc commented 3 years ago

@MartijnR - If a submission fails, could it be added back into the queue or would this require more complex development?

MartijnR commented 3 years ago

It will be more complex, because we also have to deal with the other use case, where a user tries again next day in which case I think it's not really feasible to only try the failed fields.

MartijnR commented 3 years ago

Right now, I haven't spent any time on actually splitting a record into fieldsubmissions. So it wouldn't be a waste to go back to the idea of doing this on the OC side. We could do this to a new /submission-xx endpoint on the OC side. I could write pseudo code for the splitting of a record. I don't remember what the argument for not doing this was @pbowen-oc

Work so far on creating the record UI with the OC customizations in the fieldsubmission views would still be relevant.

MartijnR commented 3 years ago

[x] new submission endpoint
[x] when record is marked as final, run checks - In Participate, there are no queries, just a Close button, so it should be similar to what is used now for Participate (strict required and constraint, and relevantErrors to be resolved. - http://localhost:8005/fs/participant/x/77291353cc70be078ba826a61452206b?ecid=a
[x] button should say Close (and Save Draft)
[x] Save Draft on every page and Close on last page only - http://localhost:8005/fs/participant/x/f992be996b8eb0342fbab92d589d8b81?ecid=a
[x] Last page button styling messed up due to addition of Save Draft
[x] look into whether customizations made to webform-controller.js can be undone - PREVIEW and VIEW still use this webform-controller, so we may still need to maintain a few customizations. I think it is best to wait until the next merge from enketo/enketo-express (2.8.1 or 2.9.0?). - Seems easiest to cut-and-paste the latest enketo-webform-controller in and then bring back the required customizations by discarding changed lines.
[x] Clear Storage button is broken

MartijnR commented 2 years ago

Changes:

/submission

Any submissions sent to this OC endpoint from special OC webform URLs are now always fieldsubmissions

/ submission-full

Any submissions sent to this OC endpoint from special OC webform URLs are now always full submissions that are expected to be spit up on the OC side,

MartijnR commented 2 years ago

[x] fix broken tests - it looks like offline capability is disabled somewhere in the tests

MartijnR commented 2 years ago

[x] change offline-capable endpoint to POST /survey/collect/anonymous/offline/participant?
[x] add POST /survey/collect/anonymous/participant
[x] check submission URLs with all 3 participate views
[x] check that online-only anonymous is single-submission - redirects
[x] fix issue with external data in offline-capable form - http://localhost:8005/an/participant/x/34b97f124e1d839a5bcccc2b54c27e79?ecid=1
[x] fix indexedDb error upon load in offline-capable form - http://localhost:8005/an/participant/x/34b97f124e1d839a5bcccc2b54c27e79?ecid=1

MartijnR commented 2 years ago

@pbowen-oc should the new online-only participant anonymous view direct back to OC after each submission or is the user allowed to keep submitting new records without going back to the OC interface?

pbowen-oc commented 2 years ago

@MartijnR - The user in that case would not be an authenticated OC user. I think we would just want to show them a success message after the submission was successful.

I would prefer if they had to manually go back to the URL in order to submit again in order to prevent confusion about whether they had already submitted. In the vast majority of cases for online mode, we would expect only one submission per person for the form.

MartijnR commented 2 years ago

Done in master. ~~See the two anonymous endpoints here: https://github.com/OpenClinica/enketo-express-oc/blob/master/tutorials/oc-api.md#post-surveycollectanonymousparticipant~~

I do not know if this can be easily merged into an old branch. It touched quite a parts of the code which makes me afraid.

MartijnR commented 2 years ago

[x] replace /anonymous/ with /full/ (and /an/ with /full/)
[x] check that POST /instance/edit/participant is fieldsubmission only, and correct API Docs

MartijnR commented 2 years ago

Ready for testing. See updated API Docs https://github.com/OpenClinica/enketo-express-oc/blob/master/tutorials/oc-api.md#post-surveycollectfullparticipant