As a Compliance officer, I can see differences between versions of SWRS reports

[matthieu-foucault]

Description:

As a Compliance officer, I can quickly see differences between version of SWRS reports within two XML files displayed side by side.

Given a report ID, we can retrieve the original XML report via the foreign keys located in the swrs_history.report table.
The XML string needs to be formatted (e.g. with https://www.npmjs.com/package/xml-formatter), its syntax highlighted (e.g. with https://prismjs.com/) prior to the diff being rendered (e.g. with https://github.com/praneshr/react-diff-viewer)

Miro board reference: CE Discovery Space

Acceptance Criteria:

In the GGIRCS app,

• two text boxes to input the report ID
• differences in XML text can be seen in red and green
• indicate where the file came from, date, name of file
• diffs can be collapsed (summarize changes toggle)
• When you type a report into the input box - if the number is a valid ID, there is a green checkmark displayed and the XML appears automatically below.
• If you type an invalid ID, helper text tells you it's incorrect.
• There can be an option to reverse the order of the two files if desired.

[Dianadec]

Are they looking for different things? Like differences in emissions? What are the specific differences? If not, a file comparison would work. We'd need to show them an example of what a diff looks like between two XML files (if they aren't familiar with the XML format it might not be the best solution).

[jaimiebutton]

User story to be validated

[Dianadec]

Q from July 27 meeting: What differences do we need to see between versions of reports?

[Dianadec]

MVP - could show ALL the differences, then they can scroll to look at the differences they actually need to see.

[rajpersram]

Raj to mockup what a diff might look like (drawing on tools such as https://www.npmjs.com/package/react-diff-viewer) with emphasis on keeping it very simple in regards to the time we have available.

[matthieu-foucault]

@dleard can you help @rajpersram with downloading and formatting XML files (and perhaps re-encoding them from UTF-16 to UTF-8) to see what a diff looks like.

Screenshots and/or a recording could be passed to the C&E team to show them what a diff would look like

[rajpersram]

Notes from Aug 12 meeting with John showing the File and Diff image shown below

• Flag not needed right now (but saw some potential usefulness. Low priority).
• Need a way to clear all files selected.
  • Possible to show what’s been selected after you move away?
• Would like a way to summarize changes in the color coded diffs instead of seeing the whole file.

[Dianadec]

Feedback about flags as a feature has been captured in the card #300

Suggestion to have a way to toggle to see changes vs. the whole picture has been captured in the card #301

[Dianadec]

@rajpersram once the design is complete, can it be added to this card?

[rajpersram]

Report ID entered into each field, which automatically shows the diff for each on the respective left and right side. Contents can be cleared by starting a new search. The 'Summarize Changes' toggle button would either show the full documents with highlighted changes, or show just the highlighted changes on their own. Only numerical report IDs will give results (error to show on input field otherwise: "Invalid entry. Input may only contain 5 digit number.").

[matthieu-foucault]

@rajpersram Now that the UX design work is done for this card, I'll move it back to the backlog

[matthieu-foucault]

@dleard @naomiaro @pbastia Hey team! Can you please add your planning poker estimates with ZenHub

[dleard]

The ggircs_app user/schema needs the swrs_history / swrs_extract schemas included (with select only privileges). Work is done here:
#309

[LindsayMacfarlane]

Awesome diff @dleard! Thank you for walking me through the feature and all the troubleshooting you had to do to make it work.

[LindsayMacfarlane]

Great job troubleshooting @dleard! Can't wait to get this in front of the Compliance Team.