Add GRAPH_GRAPHQL_DISABLE_CHILD_SORTING (false by default)

Author: kamilkisiela

docs/environment-variables.md

@@ -126,6 +126,9 @@ those.
 - `GRAPH_GRAPHQL_DISABLE_BOOL_FILTERS`: disables the ability to use AND/OR
   filters. This is useful if we want to disable filters because of
   performance reasons.
+- `GRAPH_GRAPHQL_DISABLE_CHILD_SORTING`: disables the ability to use child-based
+  sorting. This is useful if we want to disable child-based sorting because of
+  performance reasons.
 - `GRAPH_GRAPHQL_TRACE_TOKEN`: the token to use to enable query tracing for
   a GraphQL request. If this is set, requests that have a header
   `X-GraphTraceQuery` set to this value will include a trace of the SQL

graph/src/env/graphql.rs

@@ -87,6 +87,9 @@ pub struct EnvVarsGraphQl {
     /// Set by the flag `GRAPH_GRAPHQL_DISABLE_BOOL_FILTERS`. Off by default.
     /// Disables AND/OR filters
     pub disable_bool_filters: bool,
+    /// Set by the flag `GRAPH_GRAPHQL_DISABLE_CHILD_SORTING`. Off by default.
+    /// Disables child-based sorting
+    pub disable_child_sorting: bool,
     /// Set by `GRAPH_GRAPHQL_TRACE_TOKEN`, the token to use to enable query
     /// tracing for a GraphQL request. If this is set, requests that have a
     /// header `X-GraphTraceQuery` set to this value will include a trace of
@@ -137,6 +140,7 @@ impl From<InnerGraphQl> for EnvVarsGraphQl {
             error_result_size: x.error_result_size.0 .0,
             max_operations_per_connection: x.max_operations_per_connection,
             disable_bool_filters: x.disable_bool_filters.0,
+            disable_child_sorting: x.disable_child_sorting.0,
             query_trace_token: x.query_trace_token,
         }
     }
@@ -185,6 +189,8 @@ pub struct InnerGraphQl {
     max_operations_per_connection: usize,
     #[envconfig(from = "GRAPH_GRAPHQL_DISABLE_BOOL_FILTERS", default = "false")]
     pub disable_bool_filters: EnvVarBoolean,
+    #[envconfig(from = "GRAPH_GRAPHQL_DISABLE_CHILD_SORTING", default = "false")]
+    pub disable_child_sorting: EnvVarBoolean,
     #[envconfig(from = "GRAPH_GRAPHQL_TRACE_TOKEN", default = "")]
     query_trace_token: String,
 }

graphql/src/schema/api.rs

@@ -216,7 +216,10 @@ fn field_enum_values_from_child_entity(
         }
     }
 
-    let type_name = resolve_supported_type_name(&field.field_type);
+    let type_name = match ENV_VARS.graphql.disable_child_sorting {
+        true => None,
+        false => resolve_supported_type_name(&field.field_type),
+    };
 
     Ok(match type_name {
         Some(name) => {

graphql/src/store/query.rs

@@ -62,48 +62,64 @@ pub(crate) fn build_query<'a>(
         (Some((attr, value_type, None)), OrderDirection::Descending) => {
             EntityOrder::Descending(attr, value_type)
         }
-        (Some((attr, _, Some(child))), OrderDirection::Ascending) => match child {
-            OrderByChild::Object(child) => EntityOrder::ChildAscending(EntityOrderByChild::Object(
-                EntityOrderByChildInfo {
-                    sort_by_attribute: attr,
-                    join_attribute: child.join_attribute,
-                    derived: child.derived,
-                },
-                child.entity_type,
-            )),
-            OrderByChild::Interface(child) => {
-                EntityOrder::ChildAscending(EntityOrderByChild::Interface(
-                    EntityOrderByChildInfo {
-                        sort_by_attribute: attr,
-                        join_attribute: child.join_attribute,
-                        derived: child.derived,
-                    },
-                    child.entity_types,
-                ))
+        (Some((attr, _, Some(child))), OrderDirection::Ascending) => {
+            if ENV_VARS.graphql.disable_child_sorting {
+                return Err(QueryExecutionError::NotSupported(
+                    "Sorting by child attributes is not supported".to_string(),
+                ));
             }
-        },
-        (Some((attr, _, Some(child))), OrderDirection::Descending) => match child {
-            OrderByChild::Object(child) => {
-                EntityOrder::ChildDescending(EntityOrderByChild::Object(
-                    EntityOrderByChildInfo {
-                        sort_by_attribute: attr,
-                        join_attribute: child.join_attribute,
-                        derived: child.derived,
-                    },
-                    child.entity_type,
-                ))
+            match child {
+                OrderByChild::Object(child) => {
+                    EntityOrder::ChildAscending(EntityOrderByChild::Object(
+                        EntityOrderByChildInfo {
+                            sort_by_attribute: attr,
+                            join_attribute: child.join_attribute,
+                            derived: child.derived,
+                        },
+                        child.entity_type,
+                    ))
+                }
+                OrderByChild::Interface(child) => {
+                    EntityOrder::ChildAscending(EntityOrderByChild::Interface(
+                        EntityOrderByChildInfo {
+                            sort_by_attribute: attr,
+                            join_attribute: child.join_attribute,
+                            derived: child.derived,
+                        },
+                        child.entity_types,
+                    ))
+                }
+            }
+        }
+        (Some((attr, _, Some(child))), OrderDirection::Descending) => {
+            if ENV_VARS.graphql.disable_child_sorting {
+                return Err(QueryExecutionError::NotSupported(
+                    "Sorting by child attributes is not supported".to_string(),
+                ));
             }
-            OrderByChild::Interface(child) => {
-                EntityOrder::ChildDescending(EntityOrderByChild::Interface(
-                    EntityOrderByChildInfo {
-                        sort_by_attribute: attr,
-                        join_attribute: child.join_attribute,
-                        derived: child.derived,
-                    },
-                    child.entity_types,
-                ))
+            match child {
+                OrderByChild::Object(child) => {
+                    EntityOrder::ChildDescending(EntityOrderByChild::Object(
+                        EntityOrderByChildInfo {
+                            sort_by_attribute: attr,
+                            join_attribute: child.join_attribute,
+                            derived: child.derived,
+                        },
+                        child.entity_type,
+                    ))
+                }
+                OrderByChild::Interface(child) => {
+                    EntityOrder::ChildDescending(EntityOrderByChild::Interface(
+                        EntityOrderByChildInfo {
+                            sort_by_attribute: attr,
+                            join_attribute: child.join_attribute,
+                            derived: child.derived,
+                        },
+                        child.entity_types,
+                    ))
+                }
             }
-        },
+        }
         (None, _) => EntityOrder::Default,
     };
     query = query.order(order);