More readable & detailed Changes page

[hayley-leblanc]

The current "Changes" page shows a JSON diff between two consecutive versions of a dataset, which is difficult to read and not particularly user-friendly. This PR provides a much more readable and detailed summary of each change on the "Changes" page. The JSON diff is still viewable for each change, but it is not automatically displayed. This PR also adds the ability to view the changes that were made in multiple consecutive revisions of a dataset (see image below).

• includes tests covering changes
• includes updated documentation
• includes user-visible changes
• includes API changes
• includes bugfix for possible backport

[hayley-leblanc]

A couple of new tests fail because in order to make the Changes page more useful, I removed the lines preventing activity about private datasets from being saved.

[amercader]

@hayley-leblanc Thanks for this, really exciting

@davidread you seem like the best placed to lead on the review of this

[davidread]

Great to see this! This really enhances the Changes page, making it much easier for users to view this info.

I've reviewed most of this and the templating/i18n in changes.py needs looking at the most. Once this is resolved I just want to look through the detail of changes.py to check any edge cases.

[hayley-leblanc]

All the tests pass now, except for one (test_remove_org), which I cannot for the life of me get to pass. I can't replicate the issue either; the same case works just fine in my instance of CKAN.

[smotornyuk]

I was able to reproduce fail locally and noticed that the one, that unsets dataset organization is failing. update_package_schema has ignore_missing as first validator for owner_org and corresponding action just assumes that you don't want to update the organisation looking at its new value. Something, like direct model change would work:

    @helpers.change_config(u'ckan.auth.create_unowned_dataset', True)
    def test_remove_org(self):
        changes = []
        old_org = Organization()
        original = Dataset(owner_org=old_org['id'])

        import ckan.model as model
        pkg = model.Package.get(original['id'])
        pkg.owner_org = None
        pkg.save()

        new = helpers.call_action(
            u'package_show', id=original['id'])

        check_metadata_changes(changes, original, new)

        eq(changes[0]['type'], u'org')
        eq(changes[0]['method'], u'remove')

but if there are no particular reason, why you put owner_org here, it would be easier to just test another field.

[davidread]

Many thanks @smotornyuk ! I've added that test fix and opened a fresh PR to merge this (because that is simpler than asking @hayley-leblanc to add it to this one): #4969

[davidread]

This is merged now 🎉 @hayley-leblanc many thanks for doing the hard work to meet all our CKAN standards - this is a really valuable contribution 👍

[amercader]

Thanks @hayley-leblanc! Really exciting to see such a valuable contribution. And thanks @davidread for a proactive and thorough review