kobotoolbox / kpi / 29028964036

81%

master: 76%

Build Type

push

github

Committed by web-flow

Commit Message

fix(supplement): add UUID query fallback to supplement view DEV-2320 (#7222)

### 📣 Summary
Use the fallback query in the supplement view to avoid throwing a 404
error for submissions that didn't get the rootUuid backfilled in mongo.

### 📖 Description
In `kpi/views/v2/data.py`, the method `DataViewSet.supplement` I
replaced the strict `meta/rootUuid` MongoDB query with the method
`_get_submission_by_id_or_root_uuid` that searches both `meta/rootUuid`
and `meta/instanceID` as a fallback. Also added logic to safely inject
the matched uuid into `submission['meta/rootUuid']` if it was missing.

### 👀 Preview steps
Hard to preview, but you could manually remove the `meta/rootUuid` from
a mongodb instance record and then request the supplement endpoint to
test the fallback:

1. Have a deployed asset and submit a record to it.

2. Execute in shell_plus the following snippet to manually strip the
`meta/rootUuid` from MongoDB for that submission:

```
   from django.conf import settings
   
   asset = Asset.objects.get(uid='ASSET_UID')
   submission = list(asset.deployment.get_submissions(asset.owner))[0]
   instance_id = submission['_uuid']
   mongo_id = submission['_id']

   settings.MONGO_DB.instances.update_one(
       {'_id': mongo_id}, 
       {'$unset': {'meta/rootUuid': ""}}
   )
   
   print(f"Use this Instance ID for the URL: {instance_id}")
```
3. Request the supplement endpoint using the instanceID printed above.
You can do this via curl, or by navigating in the browser to:
`https://kf.local.kbtdev.org/api/v2/assets/{YOUR_ASSET_UID}/data/{INSTANCE_ID}/supplement/`.

5. Before this PR the endpoint would return a 404 Not Found because it
strictly queried meta/rootUuid. After this PR it will return a 200 OK
because it successfully falls back to matching the provided UUID against
`meta/instanceID`

---------

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

Coverage Stats

6192 of 12480 branches covered (49.62%)

1 of 37 new or added lines in 2 files covered. (2.7%)

1666 existing lines in 66 files now uncovered.

22692 of 37059 relevant lines covered (61.23%)

1.93 hits per line