fix: counted-usage with session-hour

Author: aaxelb

api/metrics/serializers.py

@@ -46,7 +46,7 @@ class PageviewInfoSerializer(ser.Serializer):
 
 
 class CountedAuthUsageSerializer(ser.Serializer):
-    item_guid = ser.CharField(max_length=255, required=False)
+    item_guid = ser.CharField(max_length=255, required=True)
     client_session_id = ser.CharField(max_length=255, required=False)
     provider_id = ser.CharField(max_length=255, required=False)
 
@@ -73,12 +73,16 @@ def create(self, validated_data):
             pageview_info = PageviewInfo(**pageview_info_data)
             pageview_info_es8 = PageviewInfoEs8(**pageview_info_data)
         OsfCountedUsageRecord.record(
-            item_osfid=validated_data.get('item_guid'),
-            client_session_id=validated_data['session_id'],
+            item_osfid=validated_data['item_guid'],
             action_labels=validated_data.get('action_labels'),
+            provider_id=validated_data.get('provider_id'),
             pageview_info=pageview_info_es8,
+            # used to create a COUNTER session-hour id, not stored:
+            client_session_id=validated_data.get('client_session_id'),
+            user_id=self.context.get('user_id'),
+            request_host=self.context.get('request_host'),
+            request_useragent=self.context.get('request_useragent'),
         )
-
         return CountedAuthUsage.record(
             platform_iri=website_settings.DOMAIN,
             provider_id=validated_data.get('provider_id'),

api/metrics/views.py

@@ -394,7 +394,14 @@ class CountedAuthUsageView(JSONAPIBaseView):
     serializer_class = CountedAuthUsageSerializer
 
     def post(self, request, *args, **kwargs):
-        serializer = self.serializer_class(data=request.data)
+        serializer = self.serializer_class(
+            data=request.data,
+            context={
+                'user_id': request.user._id if request.user.is_authenticated else None,
+                'request_host': request.get_host(),
+                'request_useragent': request.META.get('HTTP_USER_AGENT', ''),
+            },
+        )
         serializer.is_valid(raise_exception=True)
         session_id, user_is_authenticated = self._get_session_id(
             request,
@@ -404,6 +411,8 @@ def post(self, request, *args, **kwargs):
         return HttpResponse(status=201)
 
     def _get_session_id(self, request, client_session_id=None):
+        # NOTE: to remove after osfmetrics 6to8 migration -- logic moved to djelme
+
         # get a session id as described in the COUNTER code of practice:
         # https://cop5.projectcounter.org/en/5.0.2/07-processing/03-counting-unique-items.html
         # -- different from the "login session" tracked by `osf.models.Session` (which

api_tests/metrics/test_counted_usage.py

@@ -287,7 +287,7 @@ def test_preprint_file(self, app, mock_save, preprint, item_public):
             item_guid=preprint._id,
             action_labels=['view', 'web'],
         )
-        resp = app.post_json_api(COUNTED_USAGE_URL, payload)
+        resp = app.post_json_api(COUNTED_USAGE_URL, payload, headers={'User-Agent': 'blarg'})
         assert resp.status_code == 201
         assert_saved_with(
             mock_save,
@@ -306,7 +306,7 @@ def test_preprint_file(self, app, mock_save, preprint, item_public):
             item_guid=preprint.primary_file.get_guid(create=True)._id,
             action_labels=['view', 'web'],
         )
-        resp = app.post_json_api(COUNTED_USAGE_URL, payload)
+        resp = app.post_json_api(COUNTED_USAGE_URL, payload, headers={'User-Agent': 'blarg'})
         assert resp.status_code == 201
         assert_saved_with(
             mock_save,
@@ -325,7 +325,7 @@ def test_child_registration_file(self, app, mock_save, child_reg_file_guid, chil
             item_guid=child_reg_file_guid,
             action_labels=['view', 'web'],
         )
-        resp = app.post_json_api(COUNTED_USAGE_URL, payload)
+        resp = app.post_json_api(COUNTED_USAGE_URL, payload, headers={'User-Agent': 'blarg'})
         assert resp.status_code == 201
         assert_saved_with(
             mock_save,
@@ -348,7 +348,7 @@ def test_child_registration_file(self, app, mock_save, child_reg_file_guid, chil
             item_guid=child_reg._id,
             action_labels=['view', 'web'],
         )
-        resp = app.post_json_api(COUNTED_USAGE_URL, payload)
+        resp = app.post_json_api(COUNTED_USAGE_URL, payload, headers={'User-Agent': 'blarg'})
         assert resp.status_code == 201
         assert_saved_with(
             mock_save,
@@ -370,7 +370,7 @@ def test_child_registration_file(self, app, mock_save, child_reg_file_guid, chil
             item_guid=parent_reg._id,
             action_labels=['view', 'web'],
         )
-        resp = app.post_json_api(COUNTED_USAGE_URL, payload)
+        resp = app.post_json_api(COUNTED_USAGE_URL, payload, headers={'User-Agent': 'blarg'})
         assert resp.status_code == 201
         assert_saved_with(
             mock_save,