Reintroduce query plan reuse during warmup

.changesets/fix_geal_fix_hashing_algorithm.md

@@ -0,0 +1,26 @@
+### Fix cache key hashing algorithm ([Issue #5160](https://github.com/apollographql/router/issues/5160))
+
+> [!IMPORTANT]
+> If you have enabled [Distributed query plan caching](https://www.apollographql.com/docs/router/configuration/distributed-caching/#distributed-query-plan-caching), this release changes the hashing algorithm used for the cache keys.  On account of this, you should anticipate additional cache regeneration cost when updating between these versions while the new hashing algorithm comes into service.
+
+The Router contains a schema aware query hashing algorithm, designed to return the same hash across schema updates if they do not affect the query. It was used mainly to avoid planning a lot of queries when warming up the query plan cache. It was deactivated due to a regression. This reintroduces this algorithm, with a serie of reliability and performance fixes, along with better observability.
+
+The hashing algorithm can be activated in configuration, if query plan cache warm up is already enabled:
+
+```yaml title="router.yaml"
+supergraph:
+  query_planning:
+    warmed_up_queries: 100
+    experimental_reuse_query_plans: true
+```
+
+There is a counter metric named `apollo.router.query.planning.warmup.reused` that can be used to track the hashing algorithm benefits:
+- if the `experimental_reuse_query_plans` option is false, the `query_plan_reuse_active` metric attribute will be false. Cache warm up will not reuse query plans according to the algorithm, but it will evaluate if some of them could have been reused and report that in the metric
+- if the `experimental_reuse_query_plans` option is true, then the `query_plan_reuse_active` metric attribute will be true
+
+Fixes included in this change:
+- strenghten the hashing algorithm to prevent collisions. In particular, the query string is always hashed in, making sure that different queries cannot get the same hash
+- remove inefficiencies in cache key generation
+- use prefixes for each part of the Redis cache key, so they become self describing
+
+By [@Geal](https://github.com/Geal) in https://github.com/apollographql/router/pull/5255

apollo-router/src/configuration/mod.rs

@@ -438,6 +438,21 @@ impl Configuration {
             type_conditioned_fetching: self.experimental_type_conditioned_fetching,
         }
     }
+
+    pub(crate) fn rust_query_planner_config(
+        &self,
+    ) -> apollo_federation::query_plan::query_planner::QueryPlannerConfig {
+        apollo_federation::query_plan::query_planner::QueryPlannerConfig {
+            reuse_query_fragments: self.supergraph.reuse_query_fragments.unwrap_or(true),
+            subgraph_graphql_validation: false,
+            generate_query_fragments: false,
+            incremental_delivery:
+                apollo_federation::query_plan::query_planner::QueryPlanIncrementalDeliveryConfig {
+                    enable_defer: self.supergraph.defer_support,
+                },
+            debug: Default::default(),
+        }
+    }
 }
 
 impl Default for Configuration {

apollo-router/src/plugins/progressive_override/snapshots/apollo_router__plugins__progressive_override__tests__non_overridden_field_yields_expected_query_plan.snap

@@ -19,7 +19,7 @@ expression: query_plan
           "inputRewrites": null,
           "outputRewrites": null,
           "contextRewrites": null,
-          "schemaAwareHash": "12dda6193654ae4fe6e38bc09d4f81cc73d0c9e098692096f72d2158eef4776f",
+          "schemaAwareHash": "9b44446744b4cdb1a063511c35cb78fa79c519ac43671b1b60096b0984a17244",
           "authorization": {
             "is_authenticated": false,
             "scopes": [],

apollo-router/src/plugins/progressive_override/snapshots/apollo_router__plugins__progressive_override__tests__overridden_field_yields_expected_query_plan.snap

@@ -24,7 +24,7 @@ expression: query_plan
               "inputRewrites": null,
               "outputRewrites": null,
               "contextRewrites": null,
-              "schemaAwareHash": "00ad582ea45fc1bce436b36b21512f3d2c47b74fdbdc61e4b349289722c9ecf2",
+              "schemaAwareHash": "d5ed8e0726a1b6f88dcd89ddf57620f3f878eecf169a01a921fa6f4efc2529f5",
               "authorization": {
                 "is_authenticated": false,
                 "scopes": [],
@@ -63,7 +63,7 @@ expression: query_plan
                 "inputRewrites": null,
                 "outputRewrites": null,
                 "contextRewrites": null,
-                "schemaAwareHash": "a8ebdc2151a2e5207882e43c6906c0c64167fd9a8e0c7c4becc47736a5105096",
+                "schemaAwareHash": "d9d748cdc6d6e7a1e85d2ad07a24e749b15ccfac02aefe28b8acf6e190796fd4",
                 "authorization": {
                   "is_authenticated": false,
                   "scopes": [],

apollo-router/src/plugins/snapshots/apollo_router__plugins__expose_query_plan__tests__it_expose_query_plan-2.snap

@@ -69,7 +69,7 @@ expression: "serde_json::to_value(response).unwrap()"
               "inputRewrites": null,
               "outputRewrites": null,
               "contextRewrites": null,
-              "schemaAwareHash": "7245d488e97c3b2ac9f5fa4dd4660940b94ad81af070013305b2c0f76337b2f9",
+              "schemaAwareHash": "527383ea0a0ef3ac37b096a8f1e5cfc0208a358ec45af6e41e5354459bf22768",
               "authorization": {
                 "is_authenticated": false,
                 "scopes": [],
@@ -109,7 +109,7 @@ expression: "serde_json::to_value(response).unwrap()"
                 "inputRewrites": null,
                 "outputRewrites": null,
                 "contextRewrites": null,
-                "schemaAwareHash": "6e0b4156706ea0cf924500cfdc99dd44b9f0ed07e2d3f888d4aff156e6a33238",
+                "schemaAwareHash": "a85be34ef80bc1f92f03839733e8488c87f76b7b7fec0dbab3aabb9022392d95",
                 "authorization": {
                   "is_authenticated": false,
                   "scopes": [],
@@ -156,7 +156,7 @@ expression: "serde_json::to_value(response).unwrap()"
                     "inputRewrites": null,
                     "outputRewrites": null,
                     "contextRewrites": null,
-                    "schemaAwareHash": "ff649f3d70241d5a8cd5f5d03ff4c41ecff72b0e4129a480207b05ac92318042",
+                    "schemaAwareHash": "534733f432a250d11d412d158534cde6409ab67e77a8d56b39d66a2508816d42",
                     "authorization": {
                       "is_authenticated": false,
                       "scopes": [],
@@ -200,7 +200,7 @@ expression: "serde_json::to_value(response).unwrap()"
                     "inputRewrites": null,
                     "outputRewrites": null,
                     "contextRewrites": null,
-                    "schemaAwareHash": "bf9f3beda78a7a565e47c862157bad4ec871d724d752218da1168455dddca074",
+                    "schemaAwareHash": "242d0b3a066d67c9e80151b6ddf8996964ebae0ef78757bb6ea6d1e1c6a61819",
                     "authorization": {
                       "is_authenticated": false,
                       "scopes": [],

apollo-router/src/plugins/snapshots/apollo_router__plugins__expose_query_plan__tests__it_expose_query_plan.snap

@@ -69,7 +69,7 @@ expression: "serde_json::to_value(response).unwrap()"
               "inputRewrites": null,
               "outputRewrites": null,
               "contextRewrites": null,
-              "schemaAwareHash": "7245d488e97c3b2ac9f5fa4dd4660940b94ad81af070013305b2c0f76337b2f9",
+              "schemaAwareHash": "527383ea0a0ef3ac37b096a8f1e5cfc0208a358ec45af6e41e5354459bf22768",
               "authorization": {
                 "is_authenticated": false,
                 "scopes": [],
@@ -109,7 +109,7 @@ expression: "serde_json::to_value(response).unwrap()"
                 "inputRewrites": null,
                 "outputRewrites": null,
                 "contextRewrites": null,
-                "schemaAwareHash": "6e0b4156706ea0cf924500cfdc99dd44b9f0ed07e2d3f888d4aff156e6a33238",
+                "schemaAwareHash": "a85be34ef80bc1f92f03839733e8488c87f76b7b7fec0dbab3aabb9022392d95",
                 "authorization": {
                   "is_authenticated": false,
                   "scopes": [],
@@ -156,7 +156,7 @@ expression: "serde_json::to_value(response).unwrap()"
                     "inputRewrites": null,
                     "outputRewrites": null,
                     "contextRewrites": null,
-                    "schemaAwareHash": "ff649f3d70241d5a8cd5f5d03ff4c41ecff72b0e4129a480207b05ac92318042",
+                    "schemaAwareHash": "534733f432a250d11d412d158534cde6409ab67e77a8d56b39d66a2508816d42",
                     "authorization": {
                       "is_authenticated": false,
                       "scopes": [],
@@ -200,7 +200,7 @@ expression: "serde_json::to_value(response).unwrap()"
                     "inputRewrites": null,
                     "outputRewrites": null,
                     "contextRewrites": null,
-                    "schemaAwareHash": "bf9f3beda78a7a565e47c862157bad4ec871d724d752218da1168455dddca074",
+                    "schemaAwareHash": "242d0b3a066d67c9e80151b6ddf8996964ebae0ef78757bb6ea6d1e1c6a61819",
                     "authorization": {
                       "is_authenticated": false,
                       "scopes": [],

apollo-router/src/query_planner/bridge_query_planner.rs

@@ -140,19 +140,7 @@ impl PlannerMode {
         schema: &Schema,
         configuration: &Configuration,
     ) -> Result<Arc<QueryPlanner>, ServiceBuildError> {
-        let config = apollo_federation::query_plan::query_planner::QueryPlannerConfig {
-            reuse_query_fragments: configuration
-                .supergraph
-                .reuse_query_fragments
-                .unwrap_or(true),
-            subgraph_graphql_validation: false,
-            generate_query_fragments: false,
-            incremental_delivery:
-                apollo_federation::query_plan::query_planner::QueryPlanIncrementalDeliveryConfig {
-                    enable_defer: configuration.supergraph.defer_support,
-                },
-            debug: Default::default(),
-        };
+        let config = configuration.rust_query_planner_config();
         Ok(Arc::new(QueryPlanner::new(
             schema.federation_supergraph(),
             config,