kobotoolbox / kpi / 25687037878

81%

master: 76%

Build Type

push

github

Committed by web-flow

Commit Message

feat(metadata): ensure extra metadata fields are nested in asset settings DEV-2072  (#7027)

### 📣 Summary
Added extra project metadata fields to the asset settings under a
dedicated section to ensure a more organized and reliable data structure

### 💭 Notes
This backend update expects custom metadata fields to be passed from the
frontend under `settings.extra_metadata`. This avoids collisions when a
custom field has the same name as a core setting, such as `country`.

### 👀 Preview steps
To see the changes, test asset creation via the Django shell, as the
frontend isn't implemented yet.

1. ℹ️ have an account
2. Open the Django shell
3. Get your user and create new asset with extra metadata:
```
user = User.objects.get(username='your_username')
asset = Asset.objects.create(
    name='test survey',
    owner=user,
    asset_type='survey',
    settings={
        'description': 'test',
        'country': [{'label': 'Canada', 'value': 'ca'}],
        'extra_metadata': {
            'ProjectManager': 'Alex',
            'Department': 'Research',
            'country': 'USA'
        }
    }
)
```
4. Obtain the newly created asset's uid and check out the endpoint:
`/api/v2/assets/{asset_uid}`
5. 🟢 [on PR] Notice that the extra metadata is nicely nested under
settings. Should look something like:
```
"settings": {
    "sector": {},
    "country": [
      {
        "label": "Canada",
        "value": "ca"
      }
    ],
    "description": "test",
    "organization": "",
    "country_codes": [
      "ca"
    ],
    "extra_metadata": {
      "country": "USA",
      "Department": "Research",
      "ProjectManager": "Alex"
    }
  },
```
6. 🟢 notice that we have two of the same keys 'country' that are not
colliding
7. Test filtering:
`api/v2/assets/?q=settings__extra_metadata__icontains:Alex` and ensure
that the correct asset is returned
8. Also test that library items are created with the correct nested
`extra_metadata`

Coverage Stats

9131 of 12290 branches covered (74.3%)

14 of 16 new or added lines in 1 file covered. (87.5%)

491 existing lines in 25 files now uncovered.

30079 of 36725 relevant lines covered (81.9%)

5.75 hits per line