As a CIF user, I want to see the differences between array-type fields, so that I know that I made the right modifications

pbastia commented 1 year ago

Description:

Additional funding sources and anticipated funding per fiscal year are handled as an array, which our current diff logic can't currently display. To Do: figure out how to handle that, and implement it. We don't have an ArrayField yet in CustomDiffFields so that may be the first step

Acceptance Criteria:

Given I am a CIF user When I create or edit a revision and add a field that uses an array-type display Then I can see the diff on the summary page (app/pages/cif/project-revision/[projectRevision]/edit.tsx)

Given I am a CIF user When I create or edit a revision and change a field that uses an array-type display Then I can see the diff on the summary page (app/pages/cif/project-revision/[projectRevision]/edit.tsx)

Given I am a CIF user When I create or edit a revision and delete a field that uses an array-type display Then I can see the diff on the summary page (app/pages/cif/project-revision/[projectRevision]/edit.tsx)

Given I am a CIF user When I view a revision Then I can see the revision's diff on the summary page (app/pages/cif/project-revision/[projectRevision]/view.tsx)

Development Checklist:

[ ] Investigate handling diffs of arrays
[ ] Implement solution for array-based diffs
[ ] Make sure that the diffs work for projects that already have additional funding sources when new ones are added (this feature should fix #1036)
[ ] Show the diffs
[ ] E2E Tests
[ ] Meets the DOD

Definition of Ready (Note: If any of these points are not applicable, mark N/A)

[x] User story is included
[x] User role and type are identified
[x] Acceptance criteria are included
[ ] Wireframes are included (if required)
[ ] Design / Solution is accepted by Product Owner
[ ] Dependencies are identified (technical, business, regulatory/policy)
[ ] Story has been estimated (under 13 pts)

·Definition of Done (Note: If any of these points are not applicable, mark N/A)

[ ] Acceptance criteria are tested by the CI pipeline
[ ] UI meets accessibility requirements
[ ] Configuration changes are documented, documentation and designs are updated
[ ] Passes code peer-review
[ ] Passes QA of Acceptance Criteria with verification in Dev and Test
[ ] Ticket is ready to be merged to main branch
[ ] Can be demoed in Sprint Review
[ ] Bugs or future work cards are identified and created
[ ] Reviewed and approved by Product Owner

Notes:

-

Sepehr-Sobhani commented 1 year ago

I think by tackling this card, we address this tech debt: https://app.zenhub.com/workspaces/climate-action-secretariat-60ca4121764d710011481ca2/issues/gh/bcgov/cas-cif/1536

BCerki commented 1 year ago

Hey team! Please add your planning poker estimate with Zenhub @dleard @gurjmatharu @JoshLarouche @mikevespi @pbastia @sam-warren @Sepehr-Sobhani @tmastrom

pbastia commented 1 year ago

Do we actually need item-by-item diff? Or should we show just both versions of the array

["funding 1","funding 2"] => ["funding 1","funding 3"]

This would be much simpler

mikevespi commented 1 year ago

I agree Pierre, I think showing old -> new makes sense and reduces the effort quite a bit

BCerki commented 1 year ago

Could try starting with JSON.stringify(newData, oldData, etc.) and use the existing string diff functions

bcgov / cas-cif