chore(program_v2): split forms.graphql.response to {_limited,_full,_profile}

Author: japsu

backend/forms/graphql/meta.py

@@ -11,7 +11,7 @@
 from ..models.meta import FormsEventMeta, FormsProfileMeta
 from ..models.response import Response
 from ..models.survey import Survey
-from .response import ProfileResponseType
+from .response_profile import ProfileResponseType
 from .survey_full import FullSurveyType
 
 DEFAULT_LANGUAGE: str = settings.LANGUAGE_CODE

backend/forms/graphql/mutations/create_survey_response.py

@@ -6,7 +6,7 @@
 
 from ...models.response import Response
 from ...models.survey import Survey
-from ..response import ProfileResponseType
+from ..response_profile import ProfileResponseType
 
 
 class CreateSurveyResponseInput(graphene.InputObjectType):

backend/forms/graphql/mutations/update_response_dimensions.py

@@ -5,7 +5,7 @@
 from dimensions.utils.process_dimensions_form import process_dimensions_form
 
 from ...models.survey import Survey
-from ..response import FullResponseType
+from ..response_full import FullResponseType
 
 
 class UpdateResponseDimensionsInput(graphene.InputObjectType):

backend/forms/graphql/response_full.py

@@ -0,0 +1,37 @@
+import graphene
+
+from ..models.response import Response
+from .form import FormType
+from .response_dimension_value import ResponseDimensionValueType
+from .response_limited import LimitedResponseType
+
+
+class FullResponseType(LimitedResponseType):
+    @staticmethod
+    def resolve_form(parent: Response, info):
+        return parent.form
+
+    form = graphene.Field(graphene.NonNull(FormType))
+
+    @staticmethod
+    def resolve_dimensions(parent: Response, info, key_dimensions_only: bool = False):
+        qs = parent.dimensions.all()
+
+        if key_dimensions_only:
+            qs = qs.filter(dimension__is_key_dimension=True)
+
+        return qs
+
+    dimensions = graphene.List(
+        graphene.NonNull(ResponseDimensionValueType),
+        key_dimensions_only=graphene.Boolean(),
+    )
+
+    class Meta:
+        model = Response
+        fields = (
+            "id",
+            "form_data",
+            "created_at",
+            "sequence_number",
+        )

backend/forms/graphql/response.py backend/forms/graphql/response_limited.pybackend/forms/graphql/response.py renamed to backend/forms/graphql/response_limited.py

@@ -8,8 +8,6 @@
 from graphql_api.utils import resolve_local_datetime_field
 
 from ..models.response import Response
-from .form import FormType
-from .response_dimension_value import ResponseDimensionValueType
 
 
 class LimitedResponseType(DjangoObjectType):
@@ -104,102 +102,3 @@ class Meta:
             "created_at",
             "sequence_number",
         )
-
-
-class FullResponseType(LimitedResponseType):
-    @staticmethod
-    def resolve_form(parent: Response, info):
-        return parent.form
-
-    form = graphene.Field(graphene.NonNull(FormType))
-
-    @staticmethod
-    def resolve_dimensions(parent: Response, info, key_dimensions_only: bool = False):
-        qs = parent.dimensions.all()
-
-        if key_dimensions_only:
-            qs = qs.filter(dimension__is_key_dimension=True)
-
-        return qs
-
-    dimensions = graphene.List(
-        graphene.NonNull(ResponseDimensionValueType),
-        key_dimensions_only=graphene.Boolean(),
-    )
-
-    class Meta:
-        model = Response
-        fields = (
-            "id",
-            "form_data",
-            "created_at",
-            "sequence_number",
-        )
-
-
-class ProfileResponseType(LimitedResponseType):
-    @staticmethod
-    def resolve_form(parent: Response, info):
-        return parent.form
-
-    form = graphene.Field(graphene.NonNull(FormType))
-
-    @staticmethod
-    def resolve_dimensions(response: Response, info, key_dimensions_only: bool = False):
-        """
-        The respondent will only see values of dimensions that are designated as
-        being shown to the respondent.
-        """
-        qs = response.dimensions.filter(value__dimension__is_public=True)
-
-        if key_dimensions_only:
-            qs = qs.filter(value__dimension__is_key_dimension=True)
-
-        return qs
-
-    dimensions = graphene.List(
-        graphene.NonNull(ResponseDimensionValueType),
-        key_dimensions_only=graphene.Boolean(),
-    )
-
-    @staticmethod
-    def resolve_cached_dimensions(response: Response, info, key_dimensions_only: bool = False):
-        """
-        Returns the dimensions of the response as
-        a dict of dimension slug -> list of dimension value slugs. If the response
-        is not related to a survey, there will be no dimensions and an empty dict
-        will always be returned.
-
-        Using this field is more efficient than querying the dimensions field
-        on the response, as the dimensions are cached on the response object.
-
-        The respondent will only see values of dimensions that are designated as
-        being shown to the respondent.
-        """
-        cached_dimensions = response.cached_dimensions
-
-        included_dimensions = response.dimensions.filter(
-            value__dimension__slug__in=cached_dimensions.keys(),
-            value__dimension__is_shown_to_subject=True,
-        )
-
-        if key_dimensions_only:
-            included_dimensions = included_dimensions.filter(value__dimension__is_key_dimension=True)
-
-        included_dimension_slugs = response.dimensions.values_list("value__dimension__slug", flat=True)
-
-        return {k: v for k, v in cached_dimensions.items() if k in included_dimension_slugs}
-
-    cached_dimensions = graphene.Field(
-        GenericScalar,
-        description=normalize_whitespace(resolve_cached_dimensions.__doc__ or ""),
-        key_dimensions_only=graphene.Boolean(),
-    )
-
-    class Meta:
-        model = Response
-        fields = (
-            "id",
-            "form_data",
-            "created_at",
-        )

backend/forms/graphql/response_profile.py

@@ -0,0 +1,77 @@
+import graphene
+from graphene.types.generic import GenericScalar
+
+from core.utils.text_utils import normalize_whitespace
+
+from ..models.response import Response
+from .form import FormType
+from .response_dimension_value import ResponseDimensionValueType
+from .response_limited import LimitedResponseType
+
+
+class ProfileResponseType(LimitedResponseType):
+    @staticmethod
+    def resolve_form(parent: Response, info):
+        return parent.form
+
+    form = graphene.Field(graphene.NonNull(FormType))
+
+    @staticmethod
+    def resolve_dimensions(response: Response, info, key_dimensions_only: bool = False):
+        """
+        The respondent will only see values of dimensions that are designated as
+        being shown to the respondent.
+        """
+        qs = response.dimensions.filter(value__dimension__is_public=True)
+
+        if key_dimensions_only:
+            qs = qs.filter(value__dimension__is_key_dimension=True)
+
+        return qs
+
+    dimensions = graphene.List(
+        graphene.NonNull(ResponseDimensionValueType),
+        key_dimensions_only=graphene.Boolean(),
+    )
+
+    @staticmethod
+    def resolve_cached_dimensions(response: Response, info, key_dimensions_only: bool = False):
+        """
+        Returns the dimensions of the response as
+        a dict of dimension slug -> list of dimension value slugs. If the response
+        is not related to a survey, there will be no dimensions and an empty dict
+        will always be returned.
+
+        Using this field is more efficient than querying the dimensions field
+        on the response, as the dimensions are cached on the response object.
+
+        The respondent will only see values of dimensions that are designated as
+        being shown to the respondent.
+        """
+        cached_dimensions = response.cached_dimensions
+
+        included_dimensions = response.dimensions.filter(
+            value__dimension__slug__in=cached_dimensions.keys(),
+            value__dimension__is_shown_to_subject=True,
+        )
+
+        if key_dimensions_only:
+            included_dimensions = included_dimensions.filter(value__dimension__is_key_dimension=True)
+
+        included_dimension_slugs = response.dimensions.values_list("value__dimension__slug", flat=True)
+
+        return {k: v for k, v in cached_dimensions.items() if k in included_dimension_slugs}
+
+    cached_dimensions = graphene.Field(
+        GenericScalar,
+        description=normalize_whitespace(resolve_cached_dimensions.__doc__ or ""),
+        key_dimensions_only=graphene.Boolean(),
+    )
+
+    class Meta:
+        model = Response
+        fields = (
+            "id",
+            "form_data",
+            "created_at",
+        )

backend/forms/graphql/survey_full.py

@@ -14,7 +14,8 @@
 from ..models.survey import Survey
 from ..utils.summarize_responses import summarize_responses
 from .form import FormType
-from .response import FullResponseType, LimitedResponseType
+from .response_full import FullResponseType
+from .response_limited import LimitedResponseType
 from .survey_limited import LimitedSurveyType
 
 DEFAULT_LANGUAGE: str = settings.LANGUAGE_CODE

backend/program_v2/graphql/meta.py

@@ -10,7 +10,7 @@
 from core.utils.text_utils import normalize_whitespace
 from dimensions.graphql.dimension import FullDimensionType
 from dimensions.graphql.dimension_filter_input import DimensionFilterInput
-from forms.graphql.response import FullResponseType
+from forms.graphql.response_full import FullResponseType
 from forms.models.response import Response
 from graphql_api.language import DEFAULT_LANGUAGE