Handle resource url according to new standard

[Charl1996]

Technical Summary

With the merge of this PR it's necessary to update the resource URL to remove the resource name as it's not necessary to specify the resource name manually anymore (@esoergel can expound in more detail if necessary)

Feature flag

Although this change is technically global, only users with the SUPERSET_ANALYTICS feature flag will be directly impacted after this PR has been deployed.

Safety Assurance

Tested locally

Automated test coverage

No QA. Local testing if fine

Rollback instructions

• This PR can be reverted after deploy with no further considerations

Labels & Review

• Risk label is set correctly
• The set of people pinged as reviewers is appropriate for the level of risk of the change

[mkangia]

I tried to understand the impact of the linked PR on to this one, but could not really figure it out.

The resource name now comes before the version?
Or may be the question is,
What was the URL earlier and what is it now?

[esoergel]

I moved the resource_name out of this portion of the URL and up a level higher.

The conflict between my PR and Charl's meant that (?P<resource_name>%s) would've appeared in the URL twice.

>>> resolve('/a/esoergel/api/v0.5/analytics-roles/analytics-roles/')
ResolverMatch(func=tastypie.resources.wrapper, args=(), kwargs={'domain': 'esoergel', 'api_name': 'v0.5', 'resource_name': 'analytics-roles'},
 url_name=None, app_names=[], namespaces=[], route='^a/(?P<domain>[\\w\\.:-]+)/api/(?P<api_name>v0.5)/(?P<resource_name>analytics-roles)/(?P<r
esource_name>analytics-roles)/$', captured_kwargs={'resource_name': 'analytics-roles'})

[mkangia]

Thsnks @esoergel

Do users need to update any of the urls they might be using like we do here https://github.com/dimagi/commcare-analytics/blob/master/hq_superset/hq_url.py?

[esoergel]

Nope, all the existing URLs should continue to function as before. Though if you guys like, you could make this the first API only available at the new URL (assuming you can be confident that that's the only place referencing this API)

[Charl1996]

How about this?

[mkangia]

Solid, thank you @Charl1996 @esoergel

[esoergel]

Oh yeah thank you - I forgot to follow up with this PR. Can you make the resource also available at v1 by putting this at the bottom of urlpatterns in api/urls.py? Or even better yet, if no one is using it at v0.5 yet, you can drop it from there entirely now.

$ git diff
diff --git a/corehq/apps/api/urls.py b/corehq/apps/api/urls.py
index 829ccd2ff5c..0de13afb213 100644
--- a/corehq/apps/api/urls.py
+++ b/corehq/apps/api/urls.py
@@ -101,7 +101,6 @@ _OLD_API_LIST = (
         fixtures.v0_1.LookupTableResource,
         fixtures.v0_1.LookupTableItemResource,
         v0_5.NavigationEventAuditResource,
-        v0_5.CommCareAnalyticsUserResource,
     )),
     ((0, 6), (
         locations.v0_6.LocationResource,
@@ -182,6 +181,7 @@ urlpatterns = [
     fixtures.v0_1.LookupTableItemResource.get_urlpattern('v1'),
     fixtures.v0_6.LookupTableItemResource.get_urlpattern('v2'),
     v0_5.NavigationEventAuditResource.get_urlpattern('v1'),
+    v0_5.CommCareAnalyticsUserResource.get_urlpattern('v1'),
 ]

[esoergel]

Reverted #35315 here and made the URL available also in the v1 format

[mkangia]

FYI
This is now deployed on staging

[esoergel]

Oooh, very nice! Another thing you may consider if it makes resonates with you is to put the resource in the app containing the model it serves. So the users resources in the users app, the groups resource in the groups app, etc. We have a few that operate this way already, and I've been thinking about pushing us to that model eventually, though I certainly haven't established a consensus around it yet.

My thinking is that it's more in line with how Django apps are generally used - one app per "thing", with models, views, tests, forms, fixtures, migrations, etc all in that folder, so related code is close together. Though in this case I'm not certain there's a very natural home for CommCareAnalyticsUserResource - maybe users? Also fine to punt on that question