Enable generate_query_fragments by default

.changesets/feat_lrlna_enable_generate_query_fragments_by_default.md

@@ -0,0 +1,26 @@
+### Compress subgraph operations by generating fragments
+
+The router now compresses operations sent to subgraphs by default by generating fragment
+definitions and using them in the operation.
+
+Initially, the router is using a very simple transformation that is implemented in both
+the JavaScript and Native query planners. We will improve the algorithm after the JavaScript
+planner is no longer supported.
+
+This replaces a previous experimental algorithm that was enabled by default.
+`experimental_reuse_query_fragments` attempted to intelligently reuse the fragment definitions
+from the original operation. Fragment generation is much faster, and in most cases produces
+better outputs too.
+
+If you are relying on the shape of fragments in your subgraph operations or tests, you can opt
+out of the new algorithm with the configuration below. Note we strongly recommend against
+relying on the shape of planned operations as new router features and optimizations may affect
+it, and we intend to remove `experimental_reuse_query_fragments` in a future release.
+
+```yaml
+supergraph:
+  generate_query_fragments: false
+  experimental_reuse_query_fragments: true
+```
+
+By [@lrlna](https://github.com/lrlna) in https://github.com/apollographql/router/pull/6013

apollo-router/src/axum_factory/snapshots/apollo_router__axum_factory__tests__defer_is_not_buffered.snap

@@ -20,7 +20,7 @@ expression: parts
     },
     "errors": [
       {
-        "message": "couldn't find mock for query {\"query\":\"query($representations: [_Any!]!) { _entities(representations: $representations) { ... on Product { reviews { __typename id product { __typename upc } } } } }\",\"variables\":{\"representations\":[{\"__typename\":\"Product\",\"upc\":\"1\"},{\"__typename\":\"Product\",\"upc\":\"2\"}]}}",
+        "message": "couldn't find mock for query {\"query\":\"query($representations: [_Any!]!) { _entities(representations: $representations) { ..._generated_onProduct1_0 } } fragment _generated_onProduct1_0 on Product { reviews { __typename id product { __typename upc } } }\",\"variables\":{\"representations\":[{\"__typename\":\"Product\",\"upc\":\"1\"},{\"__typename\":\"Product\",\"upc\":\"2\"}]}}",
         "path": [
           "topProducts",
           "@"

apollo-router/src/axum_factory/tests.rs

@@ -1847,7 +1847,7 @@ async fn http_compressed_service() -> impl Service<
                 "apollo.include_subgraph_errors": {
                     "all": true
                 }
-            }
+            },
         }))
         .unwrap()
         .supergraph_hook(move |service| {

apollo-router/src/configuration/mod.rs

@@ -681,7 +681,7 @@ pub(crate) struct Supergraph {
     pub(crate) reuse_query_fragments: Option<bool>,
 
     /// Enable QP generation of fragments for subgraph requests
-    /// Default: false
+    /// Default: true
     pub(crate) generate_query_fragments: bool,
 
     /// Set to false to disable defer support
@@ -701,6 +701,10 @@ pub(crate) struct Supergraph {
     pub(crate) experimental_log_on_broken_pipe: bool,
 }
 
+const fn default_generate_query_fragments() -> bool {
+    true
+}
+
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
 #[serde(rename_all = "snake_case", untagged)]
 pub(crate) enum AvailableParallelism {
@@ -753,7 +757,7 @@ impl Supergraph {
                     Some(false)
                 } else { reuse_query_fragments }
             ),
-            generate_query_fragments: generate_query_fragments.unwrap_or_default(),
+            generate_query_fragments: generate_query_fragments.unwrap_or_else(default_generate_query_fragments),
             early_cancel: early_cancel.unwrap_or_default(),
             experimental_log_on_broken_pipe: experimental_log_on_broken_pipe.unwrap_or_default(),
         }
@@ -790,7 +794,7 @@ impl Supergraph {
                     Some(false)
                 } else { reuse_query_fragments }
             ),
-            generate_query_fragments: generate_query_fragments.unwrap_or_default(),
+            generate_query_fragments: generate_query_fragments.unwrap_or_else(default_generate_query_fragments),
             early_cancel: early_cancel.unwrap_or_default(),
             experimental_log_on_broken_pipe: experimental_log_on_broken_pipe.unwrap_or_default(),
         }

apollo-router/src/configuration/snapshots/apollo_router__configuration__tests__schema_generation.snap

@@ -6604,8 +6604,8 @@ expression: "&schema"
           "type": "boolean"
         },
         "generate_query_fragments": {
-          "default": false,
-          "description": "Enable QP generation of fragments for subgraph requests Default: false",
+          "default": true,
+          "description": "Enable QP generation of fragments for subgraph requests Default: true",
           "type": "boolean"
         },
         "introspection": {

apollo-router/src/plugin/test/mock/canned.rs

@@ -52,7 +52,7 @@ pub(crate) fn reviews_subgraph() -> MockSubgraph {
     let review_mocks = vec![
         (
             json! {{
-                    "query": "query TopProducts__reviews__1($representations:[_Any!]!){_entities(representations:$representations){...on Product{reviews{id product{__typename upc}author{__typename id}}}}}",
+                    "query": "query TopProducts__reviews__1($representations:[_Any!]!){_entities(representations:$representations){..._generated_onProduct1_0}}fragment _generated_onProduct1_0 on Product{reviews{id product{__typename upc}author{__typename id}}}",
                     "operationName": "TopProducts__reviews__1",
                     "variables": {
                         "representations":[

apollo-router/src/plugins/authorization/tests.rs

@@ -22,7 +22,7 @@ async fn authenticated_request() {
     let subgraphs = MockedSubgraphs([
     ("user", MockSubgraph::builder().with_json(
             serde_json::json!{{
-                "query": "query($representations:[_Any!]!){_entities(representations:$representations){...on User{name phone}}}",
+                "query": "query($representations:[_Any!]!){_entities(representations:$representations){..._generated_onUser2_0}}fragment _generated_onUser2_0 on User{name phone}",
                 "variables": {
                     "representations": [
                         { "__typename": "User", "id":0 }

apollo-router/src/plugins/cache/tests.rs

@@ -160,7 +160,7 @@ async fn insert() {
         ).with_header(CACHE_CONTROL, HeaderValue::from_static("public")).build()),
         ("orga", MockSubgraph::builder().with_json(
             serde_json::json!{{
-                "query": "query($representations:[_Any!]!){_entities(representations:$representations){...on Organization{creatorUser{__typename id}}}}",
+                "query": "query($representations:[_Any!]!){_entities(representations:$representations){..._generated_onOrganization1_0}}fragment _generated_onOrganization1_0 on Organization{creatorUser{__typename id}}",
             "variables": {
                 "representations": [
                     {
@@ -274,7 +274,7 @@ async fn no_cache_control() {
         ).build()),
         ("orga", MockSubgraph::builder().with_json(
             serde_json::json!{{
-                "query": "query($representations:[_Any!]!){_entities(representations:$representations){...on Organization{creatorUser{__typename id}}}}",
+                "query": "query($representations:[_Any!]!){_entities(representations:$representations){..._generated_onOrganization1_0}}fragment _generated_onOrganization1_0 on Organization{creatorUser{__typename id}}",
             "variables": {
                 "representations": [
                     {
@@ -365,7 +365,7 @@ async fn private() {
             .build()),
         ("orga", MockSubgraph::builder().with_json(
             serde_json::json!{{
-                "query": "query($representations:[_Any!]!){_entities(representations:$representations){...on Organization{creatorUser{__typename id}}}}",
+                "query": "query($representations:[_Any!]!){_entities(representations:$representations){..._generated_onOrganization1_0}}fragment _generated_onOrganization1_0 on Organization{creatorUser{__typename id}}",
             "variables": {
                 "representations": [
                     {

apollo-router/src/plugins/expose_query_plan.rs

@@ -218,6 +218,10 @@ mod tests {
             build_mock_supergraph(serde_json::json! {{
                 "plugins": {
                     "experimental.expose_query_plan": true
+                },
+                "supergraph": {
+                    // TODO(@goto-bus-stop): need to update the mocks and remove this, #6013
+                    "generate_query_fragments": false,
                 }
             }})
             .await,
@@ -231,6 +235,10 @@ mod tests {
             build_mock_supergraph(serde_json::json! {{
                 "plugins": {
                     "experimental.expose_query_plan": true
+                },
+                "supergraph": {
+                    // TODO(@goto-bus-stop): need to update the mocks and remove this, #6013
+                    "generate_query_fragments": false,
                 }
             }})
             .await,
@@ -245,6 +253,10 @@ mod tests {
         let supergraph = build_mock_supergraph(serde_json::json! {{
             "plugins": {
                 "experimental.expose_query_plan": false
+            },
+            "supergraph": {
+                // TODO(@goto-bus-stop): need to update the mocks and remove this, #6013
+                "generate_query_fragments": false,
             }
         }})
         .await;

apollo-router/src/plugins/include_subgraph_errors.rs

@@ -191,13 +191,19 @@ mod test {
 
         let product_service = MockSubgraph::new(product_mocks).with_extensions(extensions);
 
+        let mut configuration = Configuration::default();
+        // TODO(@goto-bus-stop): need to update the mocks and remove this, #6013
+        configuration.supergraph.generate_query_fragments = false;
+        let configuration = Arc::new(configuration);
+
         let schema =
             include_str!("../../../apollo-router-benchmarks/benches/fixtures/supergraph.graphql");
-        let schema = Schema::parse(schema, &Default::default()).unwrap();
+        let schema = Schema::parse(schema, &configuration).unwrap();
+
         let planner = BridgeQueryPlannerPool::new(
             Vec::new(),
             schema.into(),
-            Default::default(),
+            Arc::clone(&configuration),
             NonZeroUsize::new(1).unwrap(),
         )
         .await
@@ -207,15 +213,9 @@ mod test {
 
         let builder = PluggableSupergraphServiceBuilder::new(planner);
 
-        let mut plugins = create_plugins(
-            &Configuration::default(),
-            &schema,
-            subgraph_schemas,
-            None,
-            None,
-        )
-        .await
-        .unwrap();
+        let mut plugins = create_plugins(&configuration, &schema, subgraph_schemas, None, None)
+            .await
+            .unwrap();
 
         plugins.insert("apollo.include_subgraph_errors".to_string(), plugin);
 
@@ -228,10 +228,10 @@ mod test {
         let supergraph_creator = builder.build().await.expect("should build");
 
         RouterCreator::new(
-            QueryAnalysisLayer::new(supergraph_creator.schema(), Default::default()).await,
-            Arc::new(PersistedQueryLayer::new(&Default::default()).await.unwrap()),
+            QueryAnalysisLayer::new(supergraph_creator.schema(), Arc::clone(&configuration)).await,
+            Arc::new(PersistedQueryLayer::new(&configuration).await.unwrap()),
             Arc::new(supergraph_creator),
-            Arc::new(Configuration::default()),
+            configuration,
         )
         .await
         .unwrap()

apollo-router/src/plugins/traffic_shaping/mod.rs

@@ -578,6 +578,9 @@ mod test {
             r#"
         traffic_shaping:
             deduplicate_variables: true
+        supergraph:
+            # TODO(@goto-bus-stop): need to update the mocks and remove this, #6013
+            generate_query_fragments: false
         "#,
         )
         .unwrap();

apollo-router/src/query_planner/tests.rs

@@ -821,7 +821,13 @@ async fn alias_renaming() {
         ].into_iter().collect());
 
     let service = TestHarness::builder()
-        .configuration_json(serde_json::json!({"include_subgraph_errors": { "all": true } }))
+        .configuration_json(serde_json::json!({
+            "include_subgraph_errors": { "all": true },
+            "supergraph": {
+                // TODO(@goto-bus-stop): need to update the mocks and remove this, #6013
+                "generate_query_fragments": false,
+            }
+        }))
         .unwrap()
         .schema(schema)
         .extra_plugin(subgraphs)
@@ -1264,7 +1270,13 @@ async fn missing_typename_and_fragments_in_requires2() {
         ].into_iter().collect());
 
     let service = TestHarness::builder()
-        .configuration_json(serde_json::json!({"include_subgraph_errors": { "all": true } }))
+        .configuration_json(serde_json::json!({
+            "include_subgraph_errors": { "all": true },
+            "supergraph": {
+                // TODO(@goto-bus-stop): need to update the mocks and remove this, #6013
+                "generate_query_fragments": false,
+            }
+        }))
         .unwrap()
         .schema(schema)
         .extra_plugin(subgraphs)
@@ -1551,7 +1563,13 @@ async fn typename_propagation() {
     );
 
     let service = TestHarness::builder()
-        .configuration_json(serde_json::json!({"include_subgraph_errors": { "all": true } }))
+        .configuration_json(serde_json::json!({
+            "include_subgraph_errors": { "all": true },
+            "supergraph": {
+                // TODO(@goto-bus-stop): need to update the mocks and remove this, #6013
+                "generate_query_fragments": false,
+            }
+        }))
         .unwrap()
         .schema(TYPENAME_PROPAGATION_SCHEMA)
         .extra_plugin(subgraphs)
@@ -1648,7 +1666,13 @@ async fn typename_propagation2() {
     );
 
     let service = TestHarness::builder()
-        .configuration_json(serde_json::json!({"include_subgraph_errors": { "all": true } }))
+        .configuration_json(serde_json::json!({
+            "include_subgraph_errors": { "all": true },
+            "supergraph": {
+                // TODO(@goto-bus-stop): need to update the mocks and remove this, #6013
+                "generate_query_fragments": false,
+            }
+        }))
         .unwrap()
         .schema(TYPENAME_PROPAGATION_SCHEMA)
         .extra_plugin(subgraphs)
@@ -1746,7 +1770,13 @@ async fn typename_propagation3() {
     );
 
     let service = TestHarness::builder()
-        .configuration_json(serde_json::json!({"include_subgraph_errors": { "all": true } }))
+        .configuration_json(serde_json::json!({
+            "include_subgraph_errors": { "all": true },
+            "supergraph": {
+                // TODO(@goto-bus-stop): need to update the mocks and remove this, #6013
+                "generate_query_fragments": false,
+            }
+        }))
         .unwrap()
         .schema(TYPENAME_PROPAGATION_SCHEMA)
         .extra_plugin(subgraphs)

apollo-router/src/services/router/snapshots/apollo_router__services__router__tests__escaped_quotes_in_string_literal.snap

@@ -41,7 +41,7 @@ expression: "(graphql_response, &subgraph_query_log)"
         (
             "reviews",
             Some(
-                "query TopProducts__reviews__1($representations:[_Any!]!){_entities(representations:$representations){...on Product{reviewsForAuthor(authorID:\"\\\"1\\\"\"){body}}}}",
+                "query TopProducts__reviews__1($representations:[_Any!]!){_entities(representations:$representations){..._generated_onProduct1_0}}fragment _generated_onProduct1_0 on Product{reviewsForAuthor(authorID:\"\\\"1\\\"\"){body}}",
             ),
         ),
     ],