feat: Ensure "Go to review" is always displayed for forms #10314

Siyasanga · 2025-08-26T23:29:22Z

Addresses: #10132

Country-config PR: opencrvs/opencrvs-countryconfig#959

Description

Clearly describe what has been changed. Include relevant context or background.
Explain how the issue was fixed (if applicable) and the root cause.

Link this pull request to the GitHub issue (and optionally name the branch ocrvs-<issue #>)

Checklist

I have linked the correct Github issue under "Development"
I have tested the changes locally, and written appropriate tests
I have tested beyond the happy path (e.g. edge cases, failure paths)
I have updated the changelog with this change (if applicable)
I have updated the GitHub issue status accordingly

Note

Always display a "Go to review" button across event forms by default, replacing "Back to review" and updating i18n, navigation, components, and tests accordingly.

Frontend
- Form navigation:
  - Default showReviewButton to true in v2-events/features/events/components/Pages.tsx; remove conditional showReviewButton passing from DECLARE/REGISTER/VALIDATE/REQUEST_CORRECTION pages; explicitly set showReviewButton=false for PRINT_CERTIFICATE.
  - Rename button label from "Back to review" → "Go to review" in FormWizard, VerificationWizard, and all usages; update button ids/keys.
- i18n:
  - Add messages.goToReviewButton in i18n/messages/views/register.ts; adjust references throughout.
- Review/Summary:
  - Update correction summary top action to "Go to review" and navigation; adjust ReviewSection to persist (writeDeclaration) before navigating from review edits.
- Stories/Tests:
  - Replace interactions expecting "Back to review" with "Go to review" across multiple Storybook tests.
Docs
- Add CHANGELOG entry: always display a "Go to review" button on every form page.

^{Written by Cursor Bugbot for commit 0507adf. This will update automatically on new commits. Configure here.}

Zangetsu101 · 2025-08-28T07:04:16Z

packages/client/src/v2-events/features/events/components/FormWizard.tsx

              {continueButtonText}
            </Button>
-
-            {showReviewButton && (


Is the showReviewButton being used for something else? If not can we remove it then?

Zangetsu101 · 2025-08-28T07:04:41Z

packages/client/src/v2-events/features/events/components/FormWizard.tsx

    description: 'Back button text',
    id: 'v2.buttons.back'
  },
  backToReview: {


Suggested change

backToReview: {

goToReview: {

Zangetsu101 · 2025-08-28T07:05:11Z

packages/client/src/views/RegisterForm/RegisterForm.tsx

                                )}
                              </Button>
                            ),
-                            declaration.review && (


Do we want the same change in v1 too?

Thanks @Zangetsu101, what do you mean by v1? I thought this is v1

Sorry let me rephrase that, do we need the change in v1? Or just having it in v2 is enough?

Thanks @Zangetsu101 I'm not sure about this detail, @euanmillar can you weigh in please. My thinking was that I needed to do it for both v1 and v2 to keep things consistent but since Residence Registration is a v2 event I think it makes sense to to only make the change on v2 side

github-actions · 2025-10-03T00:21:14Z

This PR has been marked with label stale Since it has been inactive for 20 days. It will automatically be closed in 10 days if no further activity occurs.

Zangetsu101 · 2025-10-08T09:40:08Z

packages/client/src/v2-events/features/events/actions/correct/request/Onboarding/Onboarding.tsx

        formPages={formPages}
        pageId={currentPageId}
        setFormData={(data) => setAnnotation(data)}
-        showReviewButton={false}


Do we want to show the review button during the initial correction form too? There are two forms during the correction flow, one that collects details regarding the correction and the other is the usual declaration form where we make the corrections. This is the first one so let's make sure we are consciously removing it

Zangetsu101 · 2025-10-08T09:42:10Z

packages/client/src/v2-events/features/events/actions/print-certificate/Pages.tsx

        })}
        pageId={currentPageId}
        setFormData={(data) => setAnnotation(data)}
-        showReviewButton={searchParams.from === 'review'}


similarly for this one, during print certificate action we do not even have a review page so wouldn't make sense to show the button

Zangetsu101 · 2025-10-08T17:13:08Z

packages/client/src/views/RegisterForm/review/ReviewSection.tsx

+    const { draft, pageRoute, writeDeclaration } = this.props
    const declaration = draft
    declaration.review = true
+    writeDeclaration(declaration)


is this intended?

Yes it is, otherwise the tests fail for some reason the in-memory storage was not working well in testing environment since we re-routing

That's a bit weird as we aren't really making any changes on the v1 side 🤔

rikukissa · 2025-10-30T13:22:58Z

@Siyasanga is this still relevant? Can we close this

Siyasanga · 2025-10-31T08:08:44Z

@Siyasanga is this still relevant? Can we close this

@rikukissa yes it is still relevant since the Household members list still accepts up to 30 members so for big households we'll still need a way to jump to the review screen

It was blocked by the unrelated failing checks. I will update the PR to see if they still fail

#10132

- Not persisting was causing errors within the tests for packages/client/src/views/RegisterForm/DeclarationForm.test.tsx ` renders preview page test - Also add back the translations for v1 to still work #10132

#10132

We don't need to show the "Go to review" button on metadata form like certificate collector's form and correction request forms. #10132

rikukissa · 2025-11-13T07:22:54Z

@Siyasanga which release should this go to?

github-actions · 2025-12-08T00:25:18Z

This PR has been marked with label stale Since it has been inactive for 20 days. It will automatically be closed in 10 days if no further activity occurs.

Siyasanga self-assigned this Aug 26, 2025

Siyasanga force-pushed the ocrvs-10132 branch from 78a24c7 to 4840466 Compare August 26, 2025 23:40

Siyasanga mentioned this pull request Aug 26, 2025

feat: Ensure "Go to review" is always displayed for forms opencrvs/opencrvs-countryconfig#959

Closed

5 tasks

euanmillar added the 💅 Waiting For Review label Aug 27, 2025

Siyasanga force-pushed the ocrvs-10132 branch from 4840466 to 4f4cc6e Compare August 27, 2025 12:53

Zangetsu101 requested changes Aug 28, 2025

View reviewed changes

Zangetsu101 changed the title ~~feat: Ensure "Go to review" is always desplayed for forms~~ feat: Ensure "Go to review" is always displayed for forms Aug 28, 2025

Siyasanga force-pushed the ocrvs-10132 branch from 583724a to dd8001d Compare August 29, 2025 08:09

Siyasanga requested a review from Zangetsu101 August 29, 2025 08:10

github-actions bot added the Stale The pr is inactive label Oct 3, 2025

Siyasanga force-pushed the ocrvs-10132 branch from dd8001d to e978d7f Compare October 3, 2025 14:07

Siyasanga removed the Stale The pr is inactive label Oct 3, 2025

Siyasanga force-pushed the ocrvs-10132 branch 4 times, most recently from f2e2b31 to b24039a Compare October 8, 2025 08:29

Zangetsu101 reviewed Oct 8, 2025

View reviewed changes

Zangetsu101 approved these changes Oct 8, 2025

View reviewed changes

Siyasanga enabled auto-merge (squash) October 8, 2025 19:46

Siyasanga disabled auto-merge October 8, 2025 19:51

Siyasanga added ✅ Ready for merging and removed 💅 Waiting For Review labels Oct 8, 2025

Siyasanga added 5 commits November 5, 2025 10:06

Always show back-to-review btn

38fefc5

#10132

Rn backToReview -> goToReview

4a2a3e2

#10132

Ensure "Go to review" is always desplayed for forms

b8ee3c9

#10132

Record PR changes to CHANGELOG.MD

b5ca50d

#10132

Remove the showReviewButton prop frm FormWizard

136ce05

#10132

Siyasanga added 5 commits November 5, 2025 10:09

Remove the unsused showReviewButton

44a6d61

#10132

Ensure we persit draft after edit btn clicked

8f3893f

- Not persisting was causing errors within the tests for packages/client/src/views/RegisterForm/DeclarationForm.test.tsx ` renders preview page test - Also add back the translations for v1 to still work #10132

Update chromatic test to use "Go to review"

55684f8

#10132

Update chromatic test to use "Go to review"

cc7c836

#10132

Conditionally show "Go to review" page meta forms

5ad3386

We don't need to show the "Go to review" button on metadata form like certificate collector's form and correction request forms. #10132

Siyasanga force-pushed the ocrvs-10132 branch from 2a4b652 to 5ad3386 Compare November 5, 2025 08:12

This was referenced Nov 5, 2025

Residence Registration #10286

Open

Always display a "Go to review" button on every page of any form #10132

Open

Merge branch 'develop' into ocrvs-10132

0507adf

Siyasanga added this to the IET Triage milestone Nov 17, 2025

github-actions bot added the Stale The pr is inactive label Dec 8, 2025

feat: Ensure "Go to review" is always displayed for forms #10314

Are you sure you want to change the base?

feat: Ensure "Go to review" is always displayed for forms #10314

Conversation

Siyasanga commented Aug 26, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rikukissa commented Oct 30, 2025

Uh oh!

Siyasanga commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rikukissa commented Nov 13, 2025

Uh oh!

github-actions bot commented Dec 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Siyasanga commented Aug 26, 2025 •

edited by cursor bot

Loading

Siyasanga commented Oct 31, 2025 •

edited

Loading