Allow editing finalized forms saved before October 1st 2023 UTC #5670

grzesiek2010 · 2023-07-11T20:40:37Z

What has been done to verify that this works as intended?

I've added automated tests and tested the changes manually.

Why is this the best possible solution? Were any other approaches considered?

There is nothing important to discuss here.

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Generally opening forms for edit/view only is at risk. To test the case described in the issue you need to change dates manually in the app (after October 1st 2023) but please also make sure here is no regression in other related cases.

Do we need any specific form for testing your changes? If so, please attach one.

No.

Does this change require updates to documentation? If so, please file an issue here and include the link below.

No.

Before submitting this PR, please make sure you have:

run ./gradlew checkAll and confirmed all checks still pass OR confirm CircleCI build passes and run ./gradlew connectedDebugAndroidTest locally.
verified that any code or assets from external sources are properly credited in comments and/or in the about file.
verified that any new UI elements use theme colors. UI Components Style guidelines

grzesiek2010 · 2023-07-11T22:07:45Z

One thing we haven't discussed is the snackbar. If we finalize a form it contains the view action but the form can be edited. I think we should update it too right? @lognaturel @alyblenkin

alyblenkin · 2023-07-11T22:30:06Z

@grzesiek2010 - good point! I'm tempted to leave it as view instead of changing it to edit so they don't expect that to be the new behaviour. I know that's confusing because they can edit it, but this is only a temporary solution to help folks transition to the new workflow.

seadowg · 2023-07-12T08:56:19Z

...androidTest/java/org/odk/collect/android/feature/formentry/BackgroundAudioRecordingTest.java

@@ -181,6 +182,9 @@ public void viewForm_doesNotRecordAudio() {
                .startBlankForm("One Question")
                .fillOutAndFinalize(new FormEntryPage.QuestionAndAnswer("what is your age", "17"))
                .clickSendFinalizedForm(1)
+                .clickSelectAll()


Why is the form being sent here?

Because only if the form can't be edited recording should not be started again. Now if we just finalize, the forms are editable.

Ah right. I guess this is linked to the below discussion then. Feels like it'd be good to lock in one version for the behaviour in tests.

seadowg · 2023-07-12T08:57:47Z

..._app/src/androidTest/java/org/odk/collect/android/feature/formentry/FormSavedSnackbarTest.kt

-            .assertTextDoesNotExist(R.string.jump_to_beginning)
-            .assertTextDoesNotExist(R.string.jump_to_end)
-            .assertText(R.string.exit)
+            .assertText(R.string.jump_to_beginning)


This test (and the modified one in SendFinalizedFormTest will start failing after October 1st right?

Maybe we should flag this feature out in instrumentation tests or lock the clock to specific time (probably via Dagger and then passing it down through InstancesRepositoryProvider).

I was thinking about this but:

I wanted to quickly bring a fix for the issue.

I think it's better to have tests for the current state even if it's weird and then in October we can fix it instead of mocking the clock and having tests that verify what we expect to have in the future.

Ok I don't have strong feelings about it so I added separate tests fo the grace period and after.

Oh I like that even more!

seadowg · 2023-07-12T14:08:00Z

@grzesiek2010 looks like there's an "optimise imports" needed.

srujner · 2023-07-13T12:16:20Z

Tested with Success

Verified on device with Android 12,13

Verified cases:

Acceptance Criteria from Can't edit a form finalized in a previous version of Collect #5669 has been met;
Regression check on Editing/viewing form;
Editing forms saved before October 1st 2023;
Viewing forms saved after October 1st 2023;
Don't keep activities enabled/disabled;
Minimize the app, rotate the screen.

grzesiek2010 changed the base branch from master to v2023.2.x July 11, 2023 20:45

grzesiek2010 changed the base branch from v2023.2.x to master July 11, 2023 20:45

Added tests

998c081

grzesiek2010 force-pushed the COLLECT-5669 branch from 278420c to 5745057 Compare July 11, 2023 20:47

grzesiek2010 changed the base branch from master to v2023.2.x July 11, 2023 20:47

grzesiek2010 force-pushed the COLLECT-5669 branch from 5745057 to 7b3dba5 Compare July 11, 2023 21:15

Allow editing finalized forms saved before October 1st 2023 UTC

8dd615a

grzesiek2010 force-pushed the COLLECT-5669 branch from 7b3dba5 to 8dd615a Compare July 11, 2023 21:34

Fixed tests

efaa138

grzesiek2010 marked this pull request as ready for review July 12, 2023 08:14

grzesiek2010 requested a review from seadowg July 12, 2023 08:14

seadowg requested changes Jul 12, 2023

View reviewed changes

grzesiek2010 requested a review from seadowg July 12, 2023 13:32

grzesiek2010 force-pushed the COLLECT-5669 branch from 3859767 to e823eed Compare July 12, 2023 13:46

seadowg approved these changes Jul 12, 2023

View reviewed changes

seadowg added needs testing high priority Should be looked at before other PRs/issues labels Jul 12, 2023

Added separate tests for the grace period

970d32a

grzesiek2010 force-pushed the COLLECT-5669 branch from e823eed to 970d32a Compare July 12, 2023 15:03

srujner added behavior verified and removed needs testing labels Jul 13, 2023

grzesiek2010 merged commit c9f5ace into getodk:v2023.2.x Jul 13, 2023

seadowg mentioned this pull request Jul 13, 2023

Can't edit a form finalized in a previous version of Collect #5669

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow editing finalized forms saved before October 1st 2023 UTC #5670

Allow editing finalized forms saved before October 1st 2023 UTC #5670

grzesiek2010 commented Jul 11, 2023 •

edited

Loading

grzesiek2010 commented Jul 11, 2023

alyblenkin commented Jul 11, 2023

seadowg Jul 12, 2023

grzesiek2010 Jul 12, 2023

seadowg Jul 12, 2023 •

edited

Loading

seadowg Jul 12, 2023

grzesiek2010 Jul 12, 2023

grzesiek2010 Jul 12, 2023

seadowg Jul 12, 2023

seadowg commented Jul 12, 2023

srujner commented Jul 13, 2023

Allow editing finalized forms saved before October 1st 2023 UTC #5670

Allow editing finalized forms saved before October 1st 2023 UTC #5670

Conversation

grzesiek2010 commented Jul 11, 2023 • edited Loading

What has been done to verify that this works as intended?

Why is this the best possible solution? Were any other approaches considered?

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Do we need any specific form for testing your changes? If so, please attach one.

Does this change require updates to documentation? If so, please file an issue here and include the link below.

Before submitting this PR, please make sure you have:

grzesiek2010 commented Jul 11, 2023

alyblenkin commented Jul 11, 2023

seadowg Jul 12, 2023

Choose a reason for hiding this comment

grzesiek2010 Jul 12, 2023

Choose a reason for hiding this comment

seadowg Jul 12, 2023 • edited Loading

Choose a reason for hiding this comment

seadowg Jul 12, 2023

Choose a reason for hiding this comment

grzesiek2010 Jul 12, 2023

Choose a reason for hiding this comment

grzesiek2010 Jul 12, 2023

Choose a reason for hiding this comment

seadowg Jul 12, 2023

Choose a reason for hiding this comment

seadowg commented Jul 12, 2023

srujner commented Jul 13, 2023

grzesiek2010 commented Jul 11, 2023 •

edited

Loading

seadowg Jul 12, 2023 •

edited

Loading