Bundle diff improvements

[mahalakshme]

1.

As is:

Currently on click of Review button, we are taken to a page where we need to upload old Metadata file on the left and the new one on the right.

To be:

• On click of Review button, it should directly show the list of files and the current org status is the old, and the uploaded to be considered new. Again user should not be in need to upload 2 files

2.

As is:

Currently say when the newly upload bundle has only one subject type - Individual and the current org has 2 subject types say, Individual and Household, it shows Household in red - gives a sense as if it is going to be removed

To be:

Comparison should happen and display only for entries in the uploaded bundle, since any extra entries in the current org(report cards or concepts) are going to be untouched.

3.

As is:

When say for a subject type only 'Program Eligibility Check Rule' is changed and name remains the same, we dont show the name of the entity

To be:

Show the name(if exists for an entity/applicable for a entity type) in black if there is no change, else it is difficult for the implementor to check uuids of everything

4.

As is:

Even when same bundle uploaded as both old and new, some files with diffs show up.

To be:

Only files with changes should get displayed in the dropdown.

Inputs:

• comparison between 2 envs - bundle should not be kept around - get rid of download bundle
• comment when uploading
• AI - description
• force review

[petmongrels]

Usability

• Comparing two zips brings friction to the user experience. One should be able to compare the zip with the metadata of the to-be-uploaded-into organisation without downloading the zip for that as well.
• We should be able to give feedback on which files have diff, so that the user can choose and check in them only. If there are file level differences we can show in three parts. PresentIn1AbsentIn2, PresentIn2AbsentIn1, Diff.
• Show diff in three parts when showing files. Present in 1 not present in 2. Present in 2 not present in 2, and present in both but different.

[mahalakshme]

@petmongrels

• I realised we dont need exactly a diff checker. Hence had added the 2nd point in the card. ie. PresentIn1AbsentIn2 - we dont care - since in bundle upload, say when a subject type not present, but in the org it is there, we don't remove it. With implementors unzipping and modifying the bundle, I feel it is safer to retain it this way.
• I felt the green and red itself gives a clear picture of PresentIn2AbsentIn1(this will be shown completely in green), Diff(here the org value would be in red and marked as oldValue and zip value will be in green marked as newValue). Let me know if you feel otherwise, we can discuss over a call.

[petmongrels]

• We will have to phrase it correctly perhaps. We can say these entries will be created, nothing will happen to these records already present, these records will be modified
• The colour I didn't recognise :-) thats why

[mahalakshme]

@petmongrels yeah agreed

[mahalakshme]

@petmongrels Also in addition to colour difference we can show +/- like in git based on the complexity involved.

[petmongrels]

To be consistent with the idea that bundles are meant to be mainly an on the wire artifact not a storage artifact. On the wire implying that it is like an request/response than source code or data. We should perhaps call this organisation diff than bundle diff.
We should retain download bundle and upload for more technical user type of usage.