Abstract submit and poll operations (#19688)
* Started implementing new LongRunningOperationService and adjusting tasks to use this service This service will manage operations that require status to be synced between servers (load balanced setup). * Missing migration to add new lock. Other simplifications. * Add job to cleanup the LongRunningOperations entries * Add new DatabaseCacheRebuilder.RebuildAsync method This is both async and returns an attempt, which will fail if a rebuild operation is already running. * Missing LongRunningOperation database table creation on clean install * Store expire date in the long running operation. Better handling of non-background operations. Storing an expiration date allows setting different expiration times depending on the type of operation, and whether it is running in the background or not. * Added integration tests for LongRunningOperationRepository * Added unit tests for LongRunningOperationService * Add type as a parameter to more repository calls. Distinguish between expiration and deletion in `LongRunningOperationRepository.CleanOperations`. * Fix failing unit test * Fixed `PerformPublishBranchAsync` result not being deserialized correctly * Remove unnecessary DatabaseCacheRebuildResult value * Add status to `LongRunningOperationService.GetResult` attempt to inform on why a result could not be retrieved * General improvements * Missing rename * Improve the handling of long running operations that are not in background and stale operations * Fix failing unit tests * Fixed small mismatch between interface and implementation * Use a fire and forget task instead of the background queue * Apply suggestions from code review Co-authored-by: Andy Butland <abutland73@gmail.com> * Make sure exceptions are caught when running in the background * Alignment with other repositories (async + pagination) * Additional fixes * Add Async suffix to service methods * Missing adjustment * Moved hardcoded settings to IOptions * Fix issue in SQL Server where 0 is not accepted as requested number of rows * Fix issue in SQL Server where query provided to count cannot contain orderby * Additional SQL Server fixes --------- Co-authored-by: Andy Butland <abutland73@gmail.com>
This commit is contained in:
Laura Neto
@@ -0,0 +1,228 @@
|
||||
using System.Data.Common;
|
||||
using NUnit.Framework;
|
||||
using Umbraco.Cms.Core.Cache;
|
||||
using Umbraco.Cms.Core.Models;
|
||||
using Umbraco.Cms.Core.Serialization;
|
||||
using Umbraco.Cms.Infrastructure.Persistence.Repositories.Implement;
|
||||
using Umbraco.Cms.Infrastructure.Scoping;
|
||||
using Umbraco.Cms.Tests.Common.Testing;
|
||||
using Umbraco.Cms.Tests.Integration.Testing;
|
||||
|
||||
namespace Umbraco.Cms.Tests.Integration.Umbraco.Infrastructure.Persistence.Repositories;
|
||||
|
||||
[TestFixture]
|
||||
[UmbracoTest(Database = UmbracoTestOptions.Database.NewSchemaPerTest)]
|
||||
public class LongRunningOperationRepositoryTests : UmbracoIntegrationTest
|
||||
{
|
||||
[Test]
|
||||
public async Task Get_ReturnsNull_WhenOperationDoesNotExist()
|
||||
{
|
||||
var provider = ScopeProvider;
|
||||
using var scope = provider.CreateScope();
|
||||
var repository = CreateRepository(provider);
|
||||
await CreateTestData(repository);
|
||||
|
||||
var result = await repository.GetAsync(Guid.NewGuid());
|
||||
Assert.IsNull(result);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task Get_ReturnsExpectedOperation_WhenOperationExists()
|
||||
{
|
||||
var provider = ScopeProvider;
|
||||
using var scope = provider.CreateScope();
|
||||
var repository = CreateRepository(provider);
|
||||
await CreateTestData(repository);
|
||||
|
||||
var testOperation = _operations[1];
|
||||
var result = await repository.GetAsync(testOperation.Operation.Id);
|
||||
|
||||
Assert.IsNotNull(result);
|
||||
Assert.AreEqual(testOperation.Operation.Id, result.Id);
|
||||
Assert.AreEqual(testOperation.Operation.Type, result.Type);
|
||||
Assert.AreEqual(testOperation.Operation.Status, result.Status);
|
||||
}
|
||||
|
||||
[TestCase("Test", new LongRunningOperationStatus[] { }, 0, 100, 5, 5)]
|
||||
[TestCase("Test", new[] { LongRunningOperationStatus.Enqueued }, 0, 100, 1, 1)]
|
||||
[TestCase("Test", new[] { LongRunningOperationStatus.Running }, 0, 100, 1, 1)]
|
||||
[TestCase("Test", new[] { LongRunningOperationStatus.Enqueued, LongRunningOperationStatus.Running }, 0, 100, 2, 2)]
|
||||
[TestCase("Test", new[] { LongRunningOperationStatus.Stale }, 0, 100, 1, 1)]
|
||||
[TestCase("Test", new[] { LongRunningOperationStatus.Running, LongRunningOperationStatus.Stale }, 0, 100, 2, 2)]
|
||||
[TestCase("Test", new[] { LongRunningOperationStatus.Success, LongRunningOperationStatus.Stale }, 0, 100, 2, 2)]
|
||||
[TestCase("AnotherTest", new LongRunningOperationStatus[] { }, 0, 100, 1, 1)]
|
||||
[TestCase("Test", new LongRunningOperationStatus[] { }, 0, 0, 0, 5)]
|
||||
[TestCase("Test", new LongRunningOperationStatus[] { }, 0, 1, 1, 5)]
|
||||
[TestCase("Test", new LongRunningOperationStatus[] { }, 2, 2, 2, 5)]
|
||||
[TestCase("Test", new LongRunningOperationStatus[] { }, 5, 1, 0, 5)]
|
||||
public async Task GetByType_ReturnsExpectedOperations(string type, LongRunningOperationStatus[] statuses, int skip, int take, int expectedCount, int expectedTotal)
|
||||
{
|
||||
var provider = ScopeProvider;
|
||||
using var scope = provider.CreateScope();
|
||||
var repository = CreateRepository(provider);
|
||||
await CreateTestData(repository);
|
||||
|
||||
var result = await repository.GetByTypeAsync(type, statuses, skip, take);
|
||||
|
||||
Assert.IsNotNull(result);
|
||||
Assert.AreEqual(expectedCount, result.Items.Count(), "Count of returned items should match the expected count");
|
||||
Assert.AreEqual(expectedTotal, result.Total, "Total count should match the expected total count");
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task GetStatus_ReturnsNull_WhenOperationDoesNotExist()
|
||||
{
|
||||
var provider = ScopeProvider;
|
||||
using var scope = provider.CreateScope();
|
||||
var repository = CreateRepository(provider);
|
||||
await CreateTestData(repository);
|
||||
|
||||
var result = await repository.GetStatusAsync(Guid.NewGuid());
|
||||
Assert.IsNull(result);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task GetStatus_ReturnsExpectedStatus_WhenOperationExists()
|
||||
{
|
||||
var provider = ScopeProvider;
|
||||
using var scope = provider.CreateScope();
|
||||
var repository = CreateRepository(provider);
|
||||
await CreateTestData(repository);
|
||||
|
||||
var result = await repository.GetStatusAsync(_operations[0].Operation.Id);
|
||||
Assert.AreEqual(_operations[0].Operation.Status, result);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task Create_InsertsOperationIntoDatabase()
|
||||
{
|
||||
var provider = ScopeProvider;
|
||||
using var scope = provider.CreateScope();
|
||||
var repository = CreateRepository(provider);
|
||||
await CreateTestData(repository);
|
||||
|
||||
var newOperation = new LongRunningOperation
|
||||
{
|
||||
Id = Guid.NewGuid(),
|
||||
Type = "NewTest",
|
||||
Status = LongRunningOperationStatus.Enqueued,
|
||||
};
|
||||
await repository.CreateAsync(newOperation, DateTimeOffset.UtcNow.AddMinutes(5));
|
||||
|
||||
var result = await repository.GetAsync(newOperation.Id);
|
||||
Assert.IsNotNull(result);
|
||||
Assert.AreEqual(newOperation.Id, result.Id);
|
||||
Assert.AreEqual(newOperation.Type, result.Type);
|
||||
Assert.AreEqual(newOperation.Status, result.Status);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task Create_ThrowsException_WhenOperationWithTheSameIdExists()
|
||||
{
|
||||
var provider = ScopeProvider;
|
||||
using var scope = provider.CreateScope();
|
||||
var repository = CreateRepository(provider);
|
||||
await CreateTestData(repository);
|
||||
|
||||
var newOperation = new LongRunningOperation
|
||||
{
|
||||
Id = _operations[0].Operation.Id,
|
||||
Type = "NewTest",
|
||||
Status = LongRunningOperationStatus.Enqueued,
|
||||
};
|
||||
Assert.ThrowsAsync(Is.InstanceOf<DbException>(), () => repository.CreateAsync(newOperation, DateTimeOffset.UtcNow.AddMinutes(5)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task UpdateStatus_UpdatesOperationStatusInDatabase()
|
||||
{
|
||||
var provider = ScopeProvider;
|
||||
using var scope = provider.CreateScope();
|
||||
var repository = CreateRepository(provider);
|
||||
await CreateTestData(repository);
|
||||
|
||||
var testOperation = _operations[1];
|
||||
repository.UpdateStatusAsync(testOperation.Operation.Id, LongRunningOperationStatus.Failed, DateTimeOffset.UtcNow);
|
||||
|
||||
var result = await repository.GetAsync(testOperation.Operation.Id);
|
||||
Assert.IsNotNull(result);
|
||||
Assert.AreEqual(LongRunningOperationStatus.Failed, result.Status);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task SetResult_UpdatesOperationResultInDatabase()
|
||||
{
|
||||
var provider = ScopeProvider;
|
||||
using var scope = provider.CreateScope();
|
||||
var repository = CreateRepository(provider);
|
||||
await CreateTestData(repository);
|
||||
|
||||
var testOperation = _operations[1];
|
||||
var opResult = new LongRunningOperationResult { Result = true };
|
||||
await repository.SetResultAsync(testOperation.Operation.Id, opResult);
|
||||
|
||||
var result = await repository.GetAsync<LongRunningOperationResult>(testOperation.Operation.Id);
|
||||
Assert.IsNotNull(result);
|
||||
Assert.IsNotNull(result.Result);
|
||||
Assert.AreEqual(opResult.Result, result.Result.Result);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task CleanOperations_RemovesOldOperationsFromTheDatabase()
|
||||
{
|
||||
var provider = ScopeProvider;
|
||||
using var scope = provider.CreateScope();
|
||||
var repository = CreateRepository(provider);
|
||||
await CreateTestData(repository);
|
||||
|
||||
var oldOperation = _operations[0];
|
||||
|
||||
// Check that the operation is present before cleaning
|
||||
var result = await repository.GetAsync(oldOperation.Operation.Id);
|
||||
Assert.IsNotNull(result);
|
||||
|
||||
await repository.CleanOperationsAsync(DateTimeOffset.UtcNow.AddMinutes(1));
|
||||
|
||||
// Check that the operation is removed after cleaning
|
||||
result = await repository.GetAsync(oldOperation.Operation.Id);
|
||||
Assert.IsNull(result);
|
||||
}
|
||||
|
||||
private LongRunningOperationRepository CreateRepository(IScopeProvider provider)
|
||||
=> new(GetRequiredService<IJsonSerializer>(), (IScopeAccessor)provider, AppCaches.Disabled, TimeProvider.System);
|
||||
|
||||
private async Task CreateTestData(LongRunningOperationRepository repository)
|
||||
{
|
||||
foreach (var op in _operations)
|
||||
{
|
||||
await repository.CreateAsync(op.Operation, op.ExpiresIn);
|
||||
}
|
||||
}
|
||||
|
||||
private readonly List<(LongRunningOperation Operation, DateTimeOffset ExpiresIn)> _operations =
|
||||
[
|
||||
(
|
||||
Operation: new LongRunningOperation { Id = Guid.NewGuid(), Type = "Test", Status = LongRunningOperationStatus.Success },
|
||||
ExpiresIn: DateTimeOffset.UtcNow.AddMinutes(5)),
|
||||
(
|
||||
Operation: new LongRunningOperation { Id = Guid.NewGuid(), Type = "Test", Status = LongRunningOperationStatus.Enqueued },
|
||||
ExpiresIn: DateTimeOffset.UtcNow.AddMinutes(5)),
|
||||
(
|
||||
Operation: new LongRunningOperation { Id = Guid.NewGuid(), Type = "Test", Status = LongRunningOperationStatus.Running },
|
||||
ExpiresIn: DateTimeOffset.UtcNow.AddMinutes(5)),
|
||||
(
|
||||
Operation: new LongRunningOperation { Id = Guid.NewGuid(), Type = "Test", Status = LongRunningOperationStatus.Running },
|
||||
ExpiresIn: DateTimeOffset.UtcNow.AddMinutes(-1)),
|
||||
(
|
||||
Operation: new LongRunningOperation { Id = Guid.NewGuid(), Type = "Test", Status = LongRunningOperationStatus.Failed },
|
||||
ExpiresIn: DateTimeOffset.UtcNow.AddMinutes(-1)),
|
||||
(
|
||||
Operation: new LongRunningOperation { Id = Guid.NewGuid(), Type = "AnotherTest", Status = LongRunningOperationStatus.Success, },
|
||||
ExpiresIn: DateTimeOffset.UtcNow.AddMinutes(5)),
|
||||
];
|
||||
|
||||
private class LongRunningOperationResult
|
||||
{
|
||||
public bool Result { get; init; }
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user