kobotoolbox / kpi / 12869843423

81%

master: 76%

Build Type

push

github

Committed by web-flow

Commit Message

feat(projectHistoryLogs): log deleted submissions (#5423)

### 📣 Summary
Create logs when submissions are deleted.


### 📖 Description
Each deletion is logged individually even if it was done in bulk. Unlike
other actions, even failed deletions will be logged as long as the
process of deletion was started, since some of the submissions may have
been deleted before the failure. In this case, we prefer false positives
to missing logs.


### 💭 Notes
The more robust way to handle this would probably be to redo the
bulk-deletion process entirely such that each deletion is done as a
single transaction with deletion from mongo, deleting docs from storage,
creating a log. This would obviously take a lot more time and probably
would work better as a celery task than an API endpoint.. At this moment
we did not think it was worth it to rethink the whole process, and
instead settled on just logging every *attempt* to delete, even if that
attempt failed. This is in-keeping with our logging strategy so far,
which has focused on intent more than effect.

For single deletes, this just adds a listener on the post_delete signal
for Instances which attaches the necessary information to the request,
similar to how individual updates were handled.


### 👀 Preview steps
Feature/no-change template:
1. ℹ️ have 2 accounts and a project
2. Give user2 permission to add submissions to the project
3. Add at least 2 submissions as user1 and 2 as user 2
4. Enable anonymous submissions
5. Add at least 2 anonymous submissions 
6. Go to Project > Data and get the _ids of 1 submission each for user1,
user2, and anonymous
7. For each submission, in the terminal, run `curl -X DELETE -H
'Authorization: Token <your token>'
localhost/api/v2/assets/<asset_uid>/data/<submission _id>/ `
8. Go to `api/v2/assets/<asset_uid>/history`
9. 🟢 There should be a project history log with
`action="delete-submission"` and the usual metadata, along with
`"submission":{"submitted_by": <user1/user2/Anonymous... (continued)

Run Details

5830 of 9332 branches covered (62.47%)

19 of 19 new or added lines in 5 files covered. (100.0%)

3 existing lines in 1 file now uncovered.

22275 of 27675 relevant lines covered (80.49%)

0.8 hits per line