Use clearer names for restricted features

Author: sarayourfriend

api/api/constants/restricted_features.py

@@ -51,8 +51,8 @@ def choices(cls):
         return ((slug,) * 2 for slug in _RESTRICTED_FEATURES)
 
 
-PAGE_SIZE: RestrictedFeature[int] = RestrictedFeature(
-    "page_size",
+MAX_PAGE_SIZE: RestrictedFeature[int] = RestrictedFeature(
+    "max_page_size",
     anonymous=20,
     authenticated=50,
     # Max out privileged page size at the maximum authenticated
@@ -61,14 +61,14 @@ def choices(cls):
     privileged=240,
 )
 
-QUERY_DEPTH: RestrictedFeature[int] = RestrictedFeature(
-    "query_depth",
+MAX_RESULT_COUNT: RestrictedFeature[int] = RestrictedFeature(
+    "max_result_count",
     # 12 pages of 20 results
     # Both anon and authed are limited to the same depth
     # authed users can request bigger pages, but still only the same
     # overall number of results available
-    anonymous=12 * PAGE_SIZE.anonymous,
-    authenticated=12 * PAGE_SIZE.anonymous,
+    anonymous=12 * MAX_PAGE_SIZE.anonymous,
+    authenticated=12 * MAX_PAGE_SIZE.anonymous,
     # 20 pages of maxed out page sizes for privileged apps
-    privileged=20 * PAGE_SIZE.privileged,
+    privileged=20 * MAX_PAGE_SIZE.privileged,
 )

api/api/migrations/0064_throttledapplication_privileges.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.11 on 2024-05-23 01:41
+# Generated by Django 4.2.11 on 2024-05-29 01:23
 
 import django.contrib.postgres.fields
 from django.db import migrations, models
@@ -14,6 +14,6 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='throttledapplication',
             name='privileges',
-            field=django.contrib.postgres.fields.ArrayField(base_field=models.CharField(choices=[('page_size', 'page_size'), ('pagination_depth', 'pagination_depth')]), default=list, help_text='Privileges granted to applications upon approved request to Openverse maintainers.  Maintainers review requests for increased privileges on a per-case basis.  Distinct from ``rate_limit_model`` which only affects access rates rather than privileges.', size=None),
+            field=django.contrib.postgres.fields.ArrayField(base_field=models.CharField(choices=[('max_page_size', 'max_page_size'), ('max_result_count', 'max_result_count')]), default=list, help_text='Restricted features to which this application has been granted privileged access', size=None),
         ),
     ]

api/api/serializers/media_serializers.py

@@ -58,7 +58,7 @@ class PaginatedRequestSerializer(serializers.Serializer):
         label="page_size",
         help_text=f"Number of results to return per page. {_SUBJECT_TO_PAGINATION_LIMITS}",
         required=False,
-        default=restricted_features.PAGE_SIZE.anonymous,
+        default=restricted_features.MAX_PAGE_SIZE.anonymous,
         min_value=1,
     )
     page = serializers.IntegerField(
@@ -70,7 +70,7 @@ class PaginatedRequestSerializer(serializers.Serializer):
     )
 
     def validate_page_size(self, value):
-        level, max_value = restricted_features.PAGE_SIZE.request_level(
+        level, max_value = restricted_features.MAX_PAGE_SIZE.request_level(
             self.context.get("request")
         )
 
@@ -95,7 +95,7 @@ def validate_page_size(self, value):
         return value
 
     def clamp_result_count(self, real_result_count):
-        _, max_depth = restricted_features.QUERY_DEPTH.request_level(
+        _, max_depth = restricted_features.MAX_RESULT_COUNT.request_level(
             self.context.get("request")
         )
 
@@ -105,7 +105,7 @@ def clamp_result_count(self, real_result_count):
         return real_result_count
 
     def clamp_page_count(self, real_page_count):
-        _, max_depth = restricted_features.QUERY_DEPTH.request_level(
+        _, max_depth = restricted_features.MAX_RESULT_COUNT.request_level(
             self.context.get("request")
         )
 
@@ -122,21 +122,21 @@ def validate(self, data):
 
         # pagination depth is validated as a combination of page and page size,
         # and so cannot be validated in the individual field validation methods
-        level, max_depth = restricted_features.QUERY_DEPTH.request_level(
+        level, max_depth = restricted_features.MAX_RESULT_COUNT.request_level(
             self.context.get("request")
         )
 
-        requested_query_depth = data["page"] * data["page_size"]
+        requested_result_depth = data["page"] * data["page_size"]
 
-        query_depth_validator = MaxValueValidator(
+        result_depth_validator = MaxValueValidator(
             max_depth,
             message=serializers.IntegerField.default_error_messages["max_value"].format(
                 max_value=max_depth
             ),
         )
 
         try:
-            query_depth_validator(requested_query_depth)
+            result_depth_validator(requested_result_depth)
         except (ValidationError, DjangoValidationError) as e:
             if level == restricted_features.PRIVILEGED:
                 raise

api/test/integration/test_auth.py

@@ -300,12 +300,12 @@ def test_page_size_privileges(
         application = AccessToken.objects.get(token=token).application
 
         if level == restricted_features.PRIVILEGED:
-            application.privileges.append(restricted_features.PAGE_SIZE.slug)
+            application.privileges.append(restricted_features.MAX_PAGE_SIZE.slug)
 
         application.save()
         authorization = f"Bearer {token}"
 
-    limit = getattr(restricted_features.PAGE_SIZE, level)
+    limit = getattr(restricted_features.MAX_PAGE_SIZE, level)
 
     res = api_client.get(
         "/v1/images/",
@@ -346,14 +346,14 @@ def test_pagination_depth_privileges(
         application = AccessToken.objects.get(token=token).application
 
         if level == restricted_features.PRIVILEGED:
-            application.privileges.append(restricted_features.QUERY_DEPTH.slug)
+            application.privileges.append(restricted_features.MAX_RESULT_COUNT.slug)
 
         application.save()
         authorization = f"Bearer {token}"
 
-    depth_limit = getattr(restricted_features.QUERY_DEPTH, level)
+    depth_limit = getattr(restricted_features.MAX_RESULT_COUNT, level)
 
-    page_size_limit = restricted_features.PAGE_SIZE.anonymous
+    page_size_limit = restricted_features.MAX_PAGE_SIZE.anonymous
 
     last_page = int(depth_limit / page_size_limit)
 

api/test/integration/test_dead_link_filter.py

@@ -179,7 +179,7 @@ def test_page_consistency_removing_dead_links(search_without_dead_links):
     """Test that results in consecutive pages don't repeat when filtering dead links."""
 
     page_size = 5
-    total_pages = int(restricted_features.QUERY_DEPTH.anonymous / page_size)
+    total_pages = int(restricted_features.MAX_RESULT_COUNT.anonymous / page_size)
 
     page_results = []
     for page in range(1, total_pages + 1):