Add retrier to repository requests. (#99)

* Initialize server in tests.

* Use the new api for getting the server in tests.

* Fallback to action call if the token cannot be parsed in GetCurrentUser.

* Add Retrier feature to default restcaller.

* Remove internal flag from Server property setter in IRepository.

* Add logging service in the client feature registration method.

* Add more explanation to retry exception handling.

src/SenseNet.Client.IntegrationTests/Initializer.cs

@@ -1,23 +1,54 @@
-namespace SenseNet.Client.IntegrationTests;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using SenseNet.Extensions.DependencyInjection;
+
+namespace SenseNet.Client.IntegrationTests;
 
 [TestClass]
 public class Initializer
 {
     [AssemblyInitialize]
     public static void InitializeAllTests(TestContext context)
     {
-        InitializeServer();
+        InitializeServer(context);
     }
 
-    public static void InitializeServer()
+    public static void InitializeServer(TestContext? context = null)
     {
+        var server = new ServerContext
+        {
+            Url = "https://localhost:44362"
+        };
+
+        if (context != null)
+        {
+            // workaround for authenticating using the configured client id and secret
+            var config = new ConfigurationBuilder()
+                .SetBasePath(context.DeploymentDirectory)
+                .AddJsonFile("appsettings.json", optional: true)
+                .AddUserSecrets<Initializer>()
+                .Build();
+
+            // create a service collection and register the sensenet client
+            var services = new ServiceCollection()
+                .AddSenseNetClient()
+                .ConfigureSenseNetRepository(repositoryOptions =>
+                {
+                    config.GetSection("sensenet:repository").Bind(repositoryOptions);
+                })
+                .BuildServiceProvider();
+
+            // get the repository amd extract the server context
+            var repositories = services.GetRequiredService<IRepositoryCollection>();
+            var repository = repositories.GetRepositoryAsync(CancellationToken.None).GetAwaiter().GetResult();
+
+            server = repository.Server;
+        }
+
         ClientContext.Current.RemoveAllServers();
         ClientContext.Current.AddServers(new[]
         {
-            new ServerContext
-            {
-                Url = "https://localhost:44362"
-            }
+            server
         });
 
         // for testing purposes

src/SenseNet.Client.IntegrationTests/Legacy/ActionTests.cs

@@ -59,7 +59,7 @@ public async Task Dynamic_action_POST()
         [ClassInitialize]
         public static void Cleanup(TestContext context)
         {
-            Initializer.InitializeServer();
+            Initializer.InitializeServer(context);
 
             var root = Content.LoadAsync(RootPath).Result;
             root?.DeleteAsync().ConfigureAwait(false).GetAwaiter().GetResult();

src/SenseNet.Client.IntegrationTests/Legacy/BinaryStreamTests.cs

@@ -6,9 +6,9 @@ namespace SenseNet.Client.IntegrationTests.Legacy
     public class BinaryStreamTests
     {
         [ClassInitialize]
-        public static void ClassInitializer(TestContext _)
+        public static void ClassInitializer(TestContext context)
         {
-            Initializer.InitializeServer();
+            Initializer.InitializeServer(context);
         }
 
         [TestMethod]

src/SenseNet.Client.IntegrationTests/Legacy/CertificateValidationTests.cs

@@ -7,9 +7,9 @@ namespace SenseNet.Client.IntegrationTests.Legacy
     public class CertificateValidationTests
     {
         [ClassInitialize]
-        public static void ClassInitializer(TestContext _)
+        public static void ClassInitializer(TestContext context)
         {
-            Initializer.InitializeServer();
+            Initializer.InitializeServer(context);
         }
 
 

src/SenseNet.Client.IntegrationTests/Legacy/ContentTests.cs

@@ -9,9 +9,9 @@ namespace SenseNet.Client.IntegrationTests.Legacy
     public class ContentTests
     {
         [ClassInitialize]
-        public static void ClassInitializer(TestContext _)
+        public static void ClassInitializer(TestContext context)
         {
-            Initializer.InitializeServer();
+            Initializer.InitializeServer(context);
         }
 
         [TestMethod]

src/SenseNet.Client.IntegrationTests/Legacy/ErrorHandlingTests.cs

@@ -6,9 +6,9 @@ namespace SenseNet.Client.IntegrationTests.Legacy
     public class ErrorHandlingTests
     {
         [ClassInitialize]
-        public static void ClassInitializer(TestContext _)
+        public static void ClassInitializer(TestContext context)
         {
-            Initializer.InitializeServer();
+            Initializer.InitializeServer(context);
         }
 
         [TestMethod]

src/SenseNet.Client.IntegrationTests/Legacy/FieldTests.cs

@@ -6,9 +6,9 @@ namespace SenseNet.Client.IntegrationTests.Legacy
     public class FieldTests
     {
         [ClassInitialize]
-        public static void ClassInitializer(TestContext _)
+        public static void ClassInitializer(TestContext context)
         {
-            Initializer.InitializeServer();
+            Initializer.InitializeServer(context);
         }
 
         [TestMethod]

src/SenseNet.Client.IntegrationTests/Legacy/LoadContentTests.cs

@@ -6,9 +6,9 @@ namespace SenseNet.Client.IntegrationTests.Legacy
     public class LoadContentTests
     {
         [ClassInitialize]
-        public static void ClassInitializer(TestContext _)
+        public static void ClassInitializer(TestContext context)
         {
-            Initializer.InitializeServer();
+            Initializer.InitializeServer(context);
         }
 
         [TestMethod]

src/SenseNet.Client.IntegrationTests/Legacy/RenameTests.cs

@@ -30,7 +30,7 @@ public async Task Rename_Folder_01()
         [ClassInitialize]
         public static void Cleanup(TestContext context)
         {
-            Initializer.InitializeServer();
+            Initializer.InitializeServer(context);
 
             var root = Content.LoadAsync(ROOTPATH).Result;
             root?.DeleteAsync().ConfigureAwait(false).GetAwaiter().GetResult();

src/SenseNet.Client.IntegrationTests/SenseNet.Client.IntegrationTests.csproj

@@ -6,6 +6,8 @@
     <Nullable>enable</Nullable>
 
     <IsPackable>false</IsPackable>
+
+    <UserSecretsId>22be19f4-4194-458c-b7c4-26cec471f8e6</UserSecretsId>
   </PropertyGroup>
 
   <ItemGroup>

src/SenseNet.Client.TestsForDocs/BasicConcepts.cs

@@ -652,7 +652,7 @@ public async Task Docs2_BasicConcepts_AutoFilters()
             }, cancel)/*/<doc>*/.ConfigureAwait(false);
 
             var contents = result.ToArray();
-            Assert.IsTrue(2 < contents.Length);
+            Assert.IsTrue(contents.Any());
             var types = contents.Select(c => c["Type"].ToString()).Distinct().OrderBy(x => x).ToArray();
             Assert.IsTrue(types.Contains("SystemFolder"));
         }

src/SenseNet.Client.TestsForDocs/Infrastructure/ClientIntegrationTestBase.cs

@@ -5,6 +5,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+using SenseNet.Client.Authentication;
 using SenseNet.Diagnostics;
 using SenseNet.Extensions.DependencyInjection;
 
@@ -18,14 +19,9 @@ public class ClientIntegrationTestBase
         public static readonly string Url = "https://localhost:44362";
 
         [AssemblyInitialize]
-        public static void InititalizeAllTests(TestContext testContext)
+        public static void InitializeAllTests(TestContext context)
         {
-            ClientContext.Current.AddServer(new ServerContext
-            {
-                Url = Url,
-                Username = "builtin\\admin",
-                Password = "admin"
-            });
+            InitServer(context);
 
             EnsureBasicStructureAsync().ConfigureAwait(false).GetAwaiter().GetResult();
 
@@ -94,14 +90,35 @@ private static async Task EnsureBasicStructureAsync()
         [TestInitialize]
         public void InitializeTest()
         {
+        }
+
+        private static void InitServer(TestContext context)
+        {
+            // workaround for authenticating using the configured client id and secret
+            var config = new ConfigurationBuilder()
+                .SetBasePath(context.DeploymentDirectory)
+                .AddJsonFile("appsettings.json", optional: true)
+                .AddUserSecrets<ClientIntegrationTestBase>()
+                .Build();
+
+            // create a service collection and register the sensenet client
+            var services = new ServiceCollection()
+                .AddSenseNetClient()
+                .ConfigureSenseNetRepository(repositoryOptions =>
+                {
+                    config.GetSection("sensenet:repository").Bind(repositoryOptions);
+                })
+                .BuildServiceProvider();
+
+            // get the repository amd extract the server context
+            var repositories = services.GetRequiredService<IRepositoryCollection>();
+            var repository = repositories.GetRepositoryAsync(CancellationToken.None).GetAwaiter().GetResult();
+
+            var server = repository.Server;
+
             var ctx = ClientContext.Current;
             ctx.RemoveServers(ctx.Servers);
-            ctx.AddServer(new ServerContext
-            {
-                Url = Url,
-                Username = "builtin\\admin",
-                Password = "admin"
-            });
+            ctx.AddServer(server);
         }
 
         protected Task<Content> EnsureContentAsync(string path, string typeName)
@@ -144,7 +161,7 @@ protected IRepositoryCollection GetRepositoryCollection(Action<IServiceCollectio
 
             var config = new ConfigurationBuilder()
                 .AddJsonFile("appsettings.json", optional: true)
-                //.AddUserSecrets<ContentTests>()
+                .AddUserSecrets<ClientIntegrationTestBase>()
                 .Build();
 
             services

src/SenseNet.Client.TestsForDocs/SenseNet.Client.TestsForDocs.csproj

@@ -6,6 +6,8 @@
     <Nullable>enable</Nullable>
 
     <IsPackable>false</IsPackable>
+
+    <UserSecretsId>a6572a95-e6b3-4d89-aa3c-c7ccf00e82d0</UserSecretsId>
   </PropertyGroup>
 
   <ItemGroup>

src/SenseNet.Client/DefaultRestCaller.cs

@@ -2,31 +2,51 @@
 using System;
 using System.Net.Http;
 using System.Threading;
+using SenseNet.Tools;
 
 namespace SenseNet.Client;
 
 public class DefaultRestCaller : IRestCaller
 {
-    public async Task<string> GetResponseStringAsync(Uri uri, ServerContext server, CancellationToken cancel,
+    private readonly IRetrier _retrier;
+
+    public DefaultRestCaller(IRetrier retrier)
+    {
+        _retrier = retrier;
+    }
+
+    public Task<string> GetResponseStringAsync(Uri uri, ServerContext server, CancellationToken cancel,
         HttpMethod method = null, string jsonBody = null)
     {
-        if (method == null)
-            return await RESTCaller.GetResponseStringAsync(uri, server).ConfigureAwait(false);
-        return await RESTCaller.GetResponseStringAsync(uri, server, method, jsonBody).ConfigureAwait(false);
+        return _retrier.RetryAsync(
+            () => method == null
+                ? RESTCaller.GetResponseStringAsync(uri, server)
+                : RESTCaller.GetResponseStringAsync(uri, server, method, jsonBody),
+            shouldRetryOnError: (ex, _) => ex.ShouldRetry(),
+            cancel: cancel);
     }
 
     public Task<dynamic> PostContentAsync(string parentPath, object postData, ServerContext server, CancellationToken cancel)
     {
-        return RESTCaller.PostContentAsync(parentPath, postData, server);
+        return _retrier.RetryAsync(
+            () => RESTCaller.PostContentAsync(parentPath, postData, server),
+            shouldRetryOnError: (ex, _) => ex.ShouldRetry(),
+            cancel: cancel);
     }
 
     public Task<dynamic> PatchContentAsync(int contentId, object postData, ServerContext server, CancellationToken cancel)
     {
-        return RESTCaller.PatchContentAsync(contentId, postData, server);
+        return _retrier.RetryAsync(
+            () => RESTCaller.PatchContentAsync(contentId, postData, server),
+            shouldRetryOnError: (ex, _) => ex.ShouldRetry(),
+            cancel: cancel);
     }
 
     public Task<dynamic> PatchContentAsync(string path, object postData, ServerContext server, CancellationToken cancel)
     {
-        return RESTCaller.PatchContentAsync(path, postData, server);
+        return _retrier.RetryAsync(
+            () => RESTCaller.PatchContentAsync(path, postData, server),
+            shouldRetryOnError: (ex, _) => ex.ShouldRetry(),
+            cancel: cancel);
     }
 }

src/SenseNet.Client/RESTExtensions.cs

@@ -1,7 +1,11 @@
-using System.Text;
+using System.Net.Http;
+using System.Net;
+using System;
+using System.Text;
 
 namespace SenseNet.Client
 {
+    // ReSharper disable once InconsistentNaming
     internal static class RESTExtensions
     {
         /// <summary>
@@ -18,5 +22,43 @@ public static void AppendParameter(this StringBuilder sb, string key, object val
 
             sb.AppendFormat("{0}={1}", key, value);
         }
+
+        /// <summary>
+        /// Returns whether the system should retry the operation in case of an exception.
+        /// This method does not throw an exception.
+        /// </summary>
+        /// <remarks>
+        /// Checks if there was an exception during execution. In case there wasn't, the result
+        /// is FALSE and the retry cycle breaks.
+        /// In case there was an error and it is one of the well-known exceptions, this method
+        /// returns TRUE and the system will retry the operation.
+        /// If the exception is unknown, the result is FALSE and Retrier will throw the exception by default.
+        /// </remarks>
+        /// <param name="exception">An exception if there was an error during execution.</param>
+        public static bool ShouldRetry(this Exception exception)
+        {
+            return exception switch
+            {
+                null => false,
+
+#if NET6_0_OR_GREATER
+                // HttpStatusCode.TooManyRequests is not available in netstandard 2.0
+                ClientException { StatusCode: HttpStatusCode.TooManyRequests } => true,
+#endif
+                ClientException { StatusCode: HttpStatusCode.RequestTimeout or HttpStatusCode.GatewayTimeout } => true,
+                ClientException { InnerException: HttpRequestException rex } when
+                    rex.Message.Contains("The SSL connection could not be established") ||
+                    rex.Message.Contains("An error occurred while sending the request")
+                    => true,
+                ClientException { StatusCode: HttpStatusCode.InternalServerError } cex
+                    when cex.Message.Contains("Error in datastore when loading nodes.") ||
+                         cex.Message.Contains("Data layer timeout occurred.") => true,
+
+                // Add more well-known exceptions that can be retried here.
+                // All unknown exceptions should be thrown immediately
+                // (FALSE means do not retry).
+                _ => false
+            };
+        }
     }
 }

src/SenseNet.Client/Repository/IRepository.cs

@@ -16,7 +16,7 @@ public interface IRepository
     /// A context object that represents a connection to a sensenet service.
     /// </summary>
     /// <remarks>A repository instance always belongs to a single sensenet service.</remarks>
-    public ServerContext Server { get; internal set; }
+    public ServerContext Server { get; set; }
 
     /// <summary>
     /// Gets the registered repository-independent content types.