fix: or-1894 return bad request instead of server error when scroll timed out

src/OrganisationRegistry.Api/ElasticSearchFacade.cs

@@ -286,9 +286,14 @@ public IActionResult BuildApiSearchResult<T>(ISearchResponse<T> searchResults) w
 
         if (!searchResults.IsValid)
         {
-            _logger.LogCritical("Elasticsearch error occured on search! {Error}", searchResults.FormatError());
+            const string logMessage = "Er is een probleem opgetreden bij het uitvoeren van de zoekopdracht.";
 
-            throw new ApiException("Er is een probleem opgetreden bij het uitvoeren van de zoekopdracht.");
+            _logger.LogCritical(logMessage + " {Error}", searchResults.FormatError());
+
+            throw searchResults.ServerError.Error.Type.Equals("search_phase_execution_exception")
+            // throw searchResults.Hits.Count.Equals(0) && string.IsNullOrEmpty(searchResults.ScrollId) // Parameters for identifying a timed out scroll
+                ? new ElasticsearchScrollTimeoutException(logMessage)
+                : new ApiException(logMessage);
         }
 
         _httpContext.Response.AddElasticsearchMetaDataResponse(new ElasticsearchMetaData<T>(searchResults));

src/OrganisationRegistry.Api/Infrastructure/ElasticsearchScrollTimeoutException.cs

@@ -0,0 +1,18 @@
+namespace OrganisationRegistry.Api.Infrastructure;
+
+using System;
+
+public class ElasticsearchScrollTimeoutException : DomainException
+{
+    public ElasticsearchScrollTimeoutException()
+    {
+    }
+
+    public ElasticsearchScrollTimeoutException(string message) : base(message)
+    {
+    }
+
+    public ElasticsearchScrollTimeoutException(string message, Exception inner) : base(message, inner)
+    {
+    }
+}

test/OrganisationRegistry.ElasticSearch.Tests/OrganisationSearchTests.cs

@@ -0,0 +1,73 @@
+namespace OrganisationRegistry.ElasticSearch.Tests;
+
+using FluentAssertions;
+using Infrastructure.Events;
+using Microsoft.Extensions.Logging;
+using Projections.Infrastructure;
+using Scenario;
+using Xunit;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Api;
+using AutoFixture;
+using Location;
+using Location.Events;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging.Abstractions;
+using Moq;
+using OpenSearch.Net;
+using Organisation.Events;
+using OrganisationRegistry.Tests.Shared;
+using OrganisationRegistry.Tests.Shared.Stubs;
+using Organisations;
+using Osc;
+using Projections.Organisations;
+using Scenario.Specimen;
+using SqlServer.Infrastructure;
+
+[Collection(nameof(ElasticSearchFixture))]
+public class OrganisationSearchTests
+{
+    private readonly ElasticSearchFixture _fixture;
+    private readonly TestEventProcessor _eventProcessor;
+    private readonly LocationUpdated? lastLocationEvent;
+
+    public OrganisationSearchTests(ElasticSearchFixture fixture)
+    {
+        _fixture = fixture;
+    }
+
+    // [Fact]
+    [Fact(Skip = "Manual only")]
+    public async Task ElasticSearchClient_Search_With_Scroll_Timedout_Does_Not_Throw_Exception()
+    {
+        var client = _fixture.Elastic.ReadClient;
+        var indexName = "scroll-timeout-test-index";
+
+        try
+        {
+            var indexResponse = await _fixture.Elastic.WriteClient.Indices.CreateAsync(indexName);
+
+            var scrollTimeout = "1s";
+            var scroll = await client.SearchAsync<OrganisationDocument>(
+                s => s
+                    .Index(indexResponse.Index)
+                    .From(0)
+                    .Size(5)
+                    .Scroll(scrollTimeout));
+
+            await Task.Delay(5000);
+            scroll = await client.ScrollAsync<OrganisationDocument>(scrollTimeout, scroll.ScrollId);
+
+            Assert.Equal(scroll.ServerError.Error.Type, "search_phase_execution_exception");
+        }
+        finally
+        {
+            await _fixture.Elastic.WriteClient.Indices.DeleteAsync(indexName);
+        }
+    }
+}