kobotoolbox / kpi / 29435767219

81%

master: 76%

Build Type

push

github

Committed by web-flow

Commit Message

fix(assets): do not create version on all changes DEV-2432 (#7242)

### 📣 Summary
Only add entries to form history when the form content or name changes.


### 💭 Notes
Previously, the decision to not create a new version of an asset on save
was left to the caller. We now know we only want to create new versions
when either the asset content or the asset name has changed from the
previous version, so the responsibility of determining whether a version
has changed is moved to the `.save()` logic.

This does mean that every save requires one more query to get the latest
version. We could in theory keep the `create_version` flag to allow
callers to short-circuit this but we run the risk of missing content or
name changes if something in `.save()` changes the content in ways the
caller does not expect. This is not unlikely given how much additional
processing the `save()` method does. Ultimately if we want to make sure
we capture every content or name change, the responsibility needs to be
on the asset.

As noted in the comment, we don't use `asset.latest_version` because
that loads the whole version object, including the `version_content`
dictionary, which can be very large. Since we only need the name and the
hash, that's all we load.

In places where we previously called save with create_version = False,
adds a unit test to make sure we're still not creating new versions.


### 👀 Preview steps

1. ℹ️ have an account and a project with at least 2 submissions
2. Navigate to the data table and sort by _id
3. Navigate to the `Form` tab and `Show full history`
4. 🔴 [on main] notice there is a new Form change entry
5. 🟢 [on PR] no new entry

Coverage Stats

9274 of 12618 branches covered (73.5%)

18 of 19 new or added lines in 6 files covered. (94.74%)

11 existing lines in 2 files now uncovered.

30258 of 37175 relevant lines covered (81.39%)

5.52 hits per line