kobotoolbox / kpi / 23748212298

82%

master: 76%

Build Type

push

github

Committed by web-flow

Commit Message

feat(api): add new endpoints for asset counts DEV-1817 (#6853)

### 📣 Summary
Add new endpoints for determining the count of draft, deployed, and
archived assets for a user, an organization, and a project view.


### 📖 Description
Adds three new endpoints:
`/api/v2/assets/counts`
`api/v2/organizations/{org_id}/assets/counts`
`api/v2/project-views/{pv_id}/assets/counts`
each returning the number of draft, deployed, and archived assets in the
relevant scope.


### 💭 Notes
This PR does mean we end up using `counts` as part of the url path for
both submission counts (in `/api/v2/assets/{asset_uid}/counts`) and
asset counts (in the new ` /api/v2/assets/counts`), but hopefully the
documentation makes it clear enough. The real issue is that the
submission counts should have been nested under the `data` for clarity,
but it's too late to change it without having to make a whole new API
version.

The aggregate query in the serializer turns out to be much faster than
running three smaller queries (as tested locally with ~6000 assets) and
doesn't actually cause any problems in the case of the anonymous user
even if it is wasted code/query.

SILLY PROBLEM: with lots of assets, this endpoint will crash if
--print-sql is turned on, or something else that is logging the sql
queries (eg the debug toolbar). This is because of the change in
`sqlparse` that raises errors if there are too many tokens. This is very
annoying, but solving it in a thread-safe way is worse, so we are
leaving it in.


### 👀 Preview steps

1. ℹ️ have an account that is the owner of an MMO with at least one
other admin
2. Using the shell, create 300 assets for the org owner (no deployments)
3. Navigate to `/api/v2/assets/counts`
4. 🟢 You should see `'draft_count': '300', 'deployed_count': 0,
'archived_count': 0`
5. Deploy one of the assets
6. Reload the endpoint
7. 🟢 You should see `'draft_count': '299', 'deployed_count': 1,
'archived_count': 0`
8. Deploy and then archive another asset
9. Reload ... (continued)

Coverage Stats

7782 of 11983 branches covered (64.94%)

30 of 57 new or added lines in 6 files covered. (52.63%)

6 existing lines in 3 files now uncovered.

29625 of 36040 relevant lines covered (82.2%)

5.8 hits per line