Home db cache (#833)

* Refactor auth tokens

* Initial implementation of cache

* Add supported feature for Bolt 5.8 and fix cache key for home database

* Enhance routing and connection pool interfaces to support home database caching and SSR configuration

* Fix for Stefan's category/classification issue in WithNotifications, some tidying, moved GQL Notifications out of preview

* Add test for WithNotifications to set multiple categories and classifications

* Refactor NotificationsConfig to handle null disabled categories and classifications

* Update tests to assert DisabledCategories is empty instead of null

* Cache key now working?

* Refactor authentication token handling and update tests for response handlers

* Get unit tests working

* pre cache refactor

* Refactor logging output format and introduce ConsoleTextWriter for enhanced console output

* testkit tests looking good

* Enhance BeginResponseHandler and RunResponseHandler to support default database flag

* Unit tests all fixed

* Review notes bugs fixed

* HomeDbCache cache purging

* Add support for Bolt protocol version 5.8

* fix failing tests

* maybe fix testkit?

* Add exception detail to aid in debugging testkit failures

* Fix failing testkit tests

* Implement IsDirectDriver property in connection provider and related classes

* LoadBalancer fix for mixed clusters

* Fix logic in "dance"

* fix testkit tests?

Author: RichardIrons-neo4j

Neo4j.Driver/.editorconfig

@@ -369,11 +369,11 @@ dotnet_naming_symbols.types_and_namespaces_symbols.applicable_kinds = namespace,
 dotnet_naming_symbols.type_parameters_symbols.applicable_accessibilities = *
 dotnet_naming_symbols.type_parameters_symbols.applicable_kinds = type_parameter
 dotnet_naming_symbols.unity_serialized_field_symbols.applicable_accessibilities = *
-dotnet_naming_symbols.unity_serialized_field_symbols.applicable_kinds = 
+dotnet_naming_symbols.unity_serialized_field_symbols.applicable_kinds =
 dotnet_naming_symbols.unity_serialized_field_symbols.resharper_applicable_kinds = unity_serialised_field
 dotnet_naming_symbols.unity_serialized_field_symbols.resharper_required_modifiers = instance
 dotnet_naming_symbols.unity_serialized_field_symbols_1.applicable_accessibilities = *
-dotnet_naming_symbols.unity_serialized_field_symbols_1.applicable_kinds = 
+dotnet_naming_symbols.unity_serialized_field_symbols_1.applicable_kinds =
 dotnet_naming_symbols.unity_serialized_field_symbols_1.resharper_applicable_kinds = unity_serialised_field
 dotnet_naming_symbols.unity_serialized_field_symbols_1.resharper_required_modifiers = instance
 dotnet_separate_import_directive_groups = false
@@ -663,8 +663,8 @@ resharper_line_break_before_requires_clause = do_not_change
 resharper_linkage_specification_braces = end_of_line
 resharper_linkage_specification_indentation = none
 resharper_local_function_body = block_body
-resharper_macro_block_begin = 
-resharper_macro_block_end = 
+resharper_macro_block_begin =
+resharper_macro_block_end =
 resharper_max_array_initializer_elements_on_line = 10000
 resharper_max_attribute_length_for_same_line = 38
 resharper_max_enum_members_on_line = 1
@@ -734,7 +734,7 @@ resharper_resx_attribute_indent = single_indent
 resharper_resx_blank_line_after_pi = true
 resharper_resx_indent_text = OneIndent
 resharper_resx_keep_user_linebreaks = true
-resharper_resx_linebreak_before_elements = 
+resharper_resx_linebreak_before_elements =
 resharper_resx_max_blank_lines_between_tags = 0
 resharper_resx_pi_attribute_style = do_not_touch
 resharper_resx_space_before_self_closing = false
@@ -963,7 +963,7 @@ resharper_xml_attribute_indent = align_by_first_attribute
 resharper_xml_blank_line_after_pi = true
 resharper_xml_indent_text = OneIndent
 resharper_xml_keep_user_linebreaks = true
-resharper_xml_linebreak_before_elements = 
+resharper_xml_linebreak_before_elements =
 resharper_xml_max_blank_lines_between_tags = 2
 resharper_xml_pi_attribute_style = do_not_touch
 resharper_xml_space_before_self_closing = true

Neo4j.Driver/Neo4j.Driver.Tests.BenchkitBackend/Abstractions/IWorkloadExecutor.cs

@@ -17,14 +17,10 @@
 
 namespace Neo4j.Driver.Tests.BenchkitBackend.Abstractions;
 
-/// <summary>
-/// Defines methods for executing a workload.
-/// </summary>
+/// <summary>Defines methods for executing a workload.</summary>
 public interface IWorkloadExecutor
 {
-    /// <summary>
-    /// Execute a workload.
-    /// </summary>
+    /// <summary>Execute a workload.</summary>
     /// <param name="workload">The workload to execute.</param>
     /// <returns>A task that completes when the workload has been executed.</returns>
     Task ExecuteWorkloadAsync(Workload workload);

Neo4j.Driver/Neo4j.Driver.Tests.BenchkitBackend/Abstractions/IWorkloadExecutorSelector.cs

@@ -1,12 +1,12 @@
 // Copyright (c) "Neo4j"
 // Neo4j Sweden AB [https://neo4j.com]
-//
+// 
 // Licensed under the Apache License, Version 2.0 (the "License").
 // You may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
-//
+// 
 //     http://www.apache.org/licenses/LICENSE-2.0
-//
+// 
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -17,14 +17,10 @@
 
 namespace Neo4j.Driver.Tests.BenchkitBackend.Abstractions;
 
-/// <summary>
-/// Methods for forwarding a workload to the correct executor.
-/// </summary>
+/// <summary>Methods for forwarding a workload to the correct executor.</summary>
 public interface IWorkloadExecutorSelector
 {
-    /// <summary>
-    /// Gets the correct executor for the workload.
-    /// </summary>
+    /// <summary>Gets the correct executor for the workload.</summary>
     /// <param name="workload">The workload to execute.</param>
     public IWorkloadExecutor GetExecutor(Workload workload);
 }

Neo4j.Driver/Neo4j.Driver.Tests.BenchkitBackend/Abstractions/IWorkloadStore.cs

@@ -1,12 +1,12 @@
 // Copyright (c) "Neo4j"
 // Neo4j Sweden AB [https://neo4j.com]
-//
+// 
 // Licensed under the Apache License, Version 2.0 (the "License").
 // You may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
-//
+// 
 //     http://www.apache.org/licenses/LICENSE-2.0
-//
+// 
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -17,41 +17,29 @@
 
 namespace Neo4j.Driver.Tests.BenchkitBackend.Abstractions;
 
-/// <summary>
-/// Represents a store for managing workloads.
-/// </summary>
+/// <summary>Represents a store for managing workloads.</summary>
 public interface IWorkloadStore
 {
-    /// <summary>
-    /// Creates a new workload in the store.
-    /// </summary>
+    /// <summary>Creates a new workload in the store.</summary>
     /// <param name="workload">The workload to create.</param>
     /// <returns>The ID of the created workload.</returns>
     string CreateWorkload(Workload workload);
 
-    /// <summary>
-    /// Retrieves a workload from the store.
-    /// </summary>
+    /// <summary>Retrieves a workload from the store.</summary>
     /// <param name="id">The ID of the workload to retrieve.</param>
     /// <returns>The retrieved workload.</returns>
     Workload GetWorkload(string id);
 
-    /// <summary>
-    /// Updates a workload in the store.
-    /// </summary>
+    /// <summary>Updates a workload in the store.</summary>
     /// <param name="id">The ID of the workload to update.</param>
     /// <param name="workload">The updated workload.</param>
     /// <returns>The updated workload.</returns>
     Workload UpdateWorkload(string id, Workload workload);
 
-    /// <summary>
-    /// Deletes a workload from the store.
-    /// </summary>
+    /// <summary>Deletes a workload from the store.</summary>
     /// <param name="id">The ID of the workload to delete.</param>
     void DeleteWorkload(string id);
 
-    /// <summary>
-    /// Retrieves the full list of workloads from the store.
-    /// </summary>
+    /// <summary>Retrieves the full list of workloads from the store.</summary>
     IDictionary<string, Workload> GetAllWorkloads();
 }

Neo4j.Driver/Neo4j.Driver.Tests.BenchkitBackend/Controllers/ReadyController.cs

@@ -1,12 +1,12 @@
 // Copyright (c) "Neo4j"
 // Neo4j Sweden AB [https://neo4j.com]
-//
+// 
 // Licensed under the Apache License, Version 2.0 (the "License").
 // You may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
-//
+// 
 //     http://www.apache.org/licenses/LICENSE-2.0
-//
+// 
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -19,9 +19,7 @@ namespace Neo4j.Driver.Tests.BenchkitBackend.Controllers;
 
 using ILogger = Microsoft.Extensions.Logging.ILogger;
 
-/// <summary>
-/// Check if the service is ready.
-/// </summary>
+/// <summary>Check if the service is ready.</summary>
 [ApiController]
 [Route("[controller]")]
 public class ReadyController(
@@ -30,12 +28,10 @@ public class ReadyController(
     : ControllerBase
 {
     // GET
-    /// <summary>
-    /// Check if the service is ready.
-    /// </summary>
+    /// <summary>Check if the service is ready.</summary>
     /// <remarks>
-    /// This endpoint can be used to check if the service is ready to receive requests. This obviously includes
-    /// the web server, but also whether the backend can successfully connect to the DBMS.
+    /// This endpoint can be used to check if the service is ready to receive requests. This obviously includes the
+    /// web server, but also whether the backend can successfully connect to the DBMS.
     /// </remarks>
     [HttpGet]
     [ProducesResponseType(StatusCodes.Status204NoContent)]

Neo4j.Driver/Neo4j.Driver.Tests.BenchkitBackend/Controllers/WorkloadController.cs

@@ -21,16 +21,14 @@ namespace Neo4j.Driver.Tests.BenchkitBackend.Controllers;
 
 using ILogger = Microsoft.Extensions.Logging.ILogger;
 
-/// <summary>
-/// Define and run workloads in the Neo4j driver.
-/// </summary>
+/// <summary>Define and run workloads in the Neo4j driver.</summary>
 [ApiController]
 [Route("[controller]")]
 public class WorkloadController(
-        IWorkloadStore workloadStore,
-        IWorkloadExecutorSelector workloadExecutorSelector,
-        ILogger logger,
-        LinkGenerator linkGenerator)
+    IWorkloadStore workloadStore,
+    IWorkloadExecutorSelector workloadExecutorSelector,
+    ILogger logger,
+    LinkGenerator linkGenerator)
     : ControllerBase
 {
     // GET
@@ -95,8 +93,7 @@ public async Task<ActionResult> ExecuteEphemeral([FromBody] Workload workload)
 
     // DELETE
     /// <summary>Deletes a driver workload.</summary>
-    /// <remarks>This endpoint deletes the workload from memory. Ongoing executions will not be
-    /// canceled or stopped.</remarks>
+    /// <remarks>This endpoint deletes the workload from memory. Ongoing executions will not be canceled or stopped.</remarks>
     [HttpDelete("{id}")]
     [ProducesResponseType(StatusCodes.Status204NoContent)]
     [ProducesResponseType(StatusCodes.Status404NotFound)]

Neo4j.Driver/Neo4j.Driver.Tests.BenchkitBackend/Implementations/ExecuteQueryWorkloadExecutor.cs

@@ -1,12 +1,12 @@
 // Copyright (c) "Neo4j"
 // Neo4j Sweden AB [https://neo4j.com]
-//
+// 
 // Licensed under the Apache License, Version 2.0 (the "License").
 // You may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
-//
+// 
 //     http://www.apache.org/licenses/LICENSE-2.0
-//
+// 
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -21,9 +21,9 @@ namespace Neo4j.Driver.Tests.BenchkitBackend.Implementations;
 using ILogger = Microsoft.Extensions.Logging.ILogger;
 
 internal class ExecuteQueryWorkloadExecutor(
-        IDriver driver,
-        IRecordConsumer recordConsumer,
-        ILogger logger)
+    IDriver driver,
+    IRecordConsumer recordConsumer,
+    ILogger logger)
     : IWorkloadExecutor
 {
     public async Task ExecuteWorkloadAsync(Workload workload)

Neo4j.Driver/Neo4j.Driver.Tests.BenchkitBackend/Implementations/ExecuteReadWriteWorkloadExecutor.cs

@@ -21,10 +21,10 @@ namespace Neo4j.Driver.Tests.BenchkitBackend.Implementations;
 using ILogger = Microsoft.Extensions.Logging.ILogger;
 
 internal class ExecuteReadWriteWorkloadExecutor(
-        IDriver driver,
-        IRecordConsumer recordConsumer,
-        IWorkloadSessionBuilder sessionBuilder,
-        ILogger logger)
+    IDriver driver,
+    IRecordConsumer recordConsumer,
+    IWorkloadSessionBuilder sessionBuilder,
+    ILogger logger)
     : IWorkloadExecutor
 {
     public async Task ExecuteWorkloadAsync(Workload workload)
@@ -145,7 +145,7 @@ await execute(
 
                 return 0;
             },
-            _ => { });
+            _ => {});
 
         logger.LogDebug("Workload completed");
     }

Neo4j.Driver/Neo4j.Driver.Tests.BenchkitBackend/Implementations/RecordConsumer.cs

@@ -1,12 +1,12 @@
 // Copyright (c) "Neo4j"
 // Neo4j Sweden AB [https://neo4j.com]
-//
+// 
 // Licensed under the Apache License, Version 2.0 (the "License").
 // You may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
-//
+// 
 //     http://www.apache.org/licenses/LICENSE-2.0
-//
+// 
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -20,7 +20,7 @@ namespace Neo4j.Driver.Tests.BenchkitBackend.Implementations;
 using ILogger = Microsoft.Extensions.Logging.ILogger;
 
 internal class RecordConsumer(
-        ILogger logger)
+    ILogger logger)
     : IRecordConsumer
 {
     public void ConsumeRecords(IEnumerable<IRecord> records)

Neo4j.Driver/Neo4j.Driver.Tests.BenchkitBackend/Implementations/SessionRunWorkloadExecutor.cs

@@ -1,12 +1,12 @@
 // Copyright (c) "Neo4j"
 // Neo4j Sweden AB [https://neo4j.com]
-//
+// 
 // Licensed under the Apache License, Version 2.0 (the "License").
 // You may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
-//
+// 
 //     http://www.apache.org/licenses/LICENSE-2.0
-//
+// 
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -21,10 +21,10 @@ namespace Neo4j.Driver.Tests.BenchkitBackend.Implementations;
 using ILogger = Microsoft.Extensions.Logging.ILogger;
 
 internal class SessionRunWorkloadExecutor(
-        IDriver driver,
-        IRecordConsumer recordConsumer,
-        IWorkloadSessionBuilder sessionBuilder,
-        ILogger logger)
+    IDriver driver,
+    IRecordConsumer recordConsumer,
+    IWorkloadSessionBuilder sessionBuilder,
+    ILogger logger)
     : IWorkloadExecutor
 {
     public async Task ExecuteWorkloadAsync(Workload workload)
@@ -47,17 +47,18 @@ private async Task ExecuteInParallelSessionsAsync(Workload workload)
         {
             var queryToRun = new Query(query.Text, query.Parameters);
             logger.LogDebug("Starting query {Query} in parallel session", queryToRun.Text);
-            tasks.Add(Task.Run(
-                async () =>
-                {
-                    // create a new session in parallel for each query
-                    await using var session = sessionBuilder.BuildSession(driver, workload);
-
-                    var resultCursor = await session.RunAsync(queryToRun);
-                    var records = await resultCursor.ToListAsync();
-                    logger.LogDebug("Received {RecordCount} records", records.Count);
-                    recordConsumer.ConsumeRecords(records);
-                }));
+            tasks.Add(
+                Task.Run(
+                    async () =>
+                    {
+                        // create a new session in parallel for each query
+                        await using var session = sessionBuilder.BuildSession(driver, workload);
+
+                        var resultCursor = await session.RunAsync(queryToRun);
+                        var records = await resultCursor.ToListAsync();
+                        logger.LogDebug("Received {RecordCount} records", records.Count);
+                        recordConsumer.ConsumeRecords(records);
+                    }));
         }
 
         logger.LogDebug("Waiting for {TaskCount} parallel tasks to complete", tasks.Count);