Headless CMS and Content Managment Hub
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

550 lines
18 KiB

// ==========================================================================
// Squidex Headless CMS
// ==========================================================================
// Copyright (c) Squidex UG (haftungsbeschraenkt)
// All rights reserved. Licensed under the MIT license.
// ==========================================================================
using FakeItEasy;
using FluentAssertions;
using Microsoft.Extensions.Logging;
using Orleans.Storage;
using Squidex.Infrastructure.Orleans;
using Squidex.Infrastructure.TestHelpers;
using Xunit;
namespace Squidex.Infrastructure.EventSourcing.Grains
{
public class EventConsumerGrainTests
{
public sealed class MyEventConsumerGrain : EventConsumerGrain
{
private IEventSubscriber? currentSubscriber;
public MyEventConsumerGrain(
EventConsumerFactory eventConsumerFactory,
IGrainState<EventConsumerState> state,
IEventStore eventStore,
IEventDataFormatter eventDataFormatter,
ILogger<EventConsumerGrain> log)
: base(eventConsumerFactory, state, eventStore, eventDataFormatter, log)
{
}
public Task OnEventAsync(IEventSubscription subscription, StoredEvent storedEvent)
{
return currentSubscriber!.OnEventAsync(subscription, storedEvent);
}
public Task OnErrorAsync(IEventSubscription subscription, Exception exception)
{
return currentSubscriber!.OnErrorAsync(subscription, exception);
}
protected override IEventSubscription CreateRetrySubscription(IEventSubscriber subscriber)
{
return CreateSubscription(subscriber);
}
protected override IEventSubscription CreateSubscription(IEventSubscriber subscriber)
{
currentSubscriber = subscriber;
return base.CreateSubscription(subscriber);
}
}
private readonly IGrainState<EventConsumerState> grainState = A.Fake<IGrainState<EventConsumerState>>();
private readonly IEventConsumer eventConsumer = A.Fake<IEventConsumer>();
private readonly IEventDataFormatter formatter = A.Fake<IEventDataFormatter>();
private readonly IEventStore eventStore = A.Fake<IEventStore>();
private readonly IEventSubscription eventSubscription = A.Fake<IEventSubscription>();
private readonly StoredEvent storedEvent;
private readonly EventData eventData = new EventData("Type", new EnvelopeHeaders(), "Payload");
private readonly Envelope<IEvent> envelope = new Envelope<IEvent>(new MyEvent());
private readonly MyEventConsumerGrain sut;
private readonly string consumerName;
private readonly string initialPosition = Guid.NewGuid().ToString();
public EventConsumerGrainTests()
{
grainState.Value = new EventConsumerState
{
Position = initialPosition
};
consumerName = eventConsumer.GetType().Name;
A.CallTo(() => eventStore.CreateSubscription(A<IEventSubscriber>._, A<string>._, A<string>._))
.Returns(eventSubscription);
A.CallTo(() => eventConsumer.Name)
.Returns(consumerName);
A.CallTo(() => eventConsumer.Handles(A<StoredEvent>._))
.Returns(true);
A.CallTo(() => eventConsumer.On(A<IEnumerable<Envelope<IEvent>>>._))
.Invokes((IEnumerable<Envelope<IEvent>> events) =>
{
foreach (var @event in events)
{
eventConsumer.On(@event).Wait();
}
});
A.CallTo(() => eventSubscription.Sender)
.Returns(eventSubscription);
storedEvent = new StoredEvent("Stream", Guid.NewGuid().ToString(), 123, eventData);
A.CallTo(() => formatter.ParseIfKnown(storedEvent))
.Returns(envelope);
var log = A.Fake<ILogger<EventConsumerGrain>>();
sut = new MyEventConsumerGrain(
x => eventConsumer,
grainState,
eventStore,
formatter,
log);
}
[Fact]
public async Task Should_not_subscribe_to_event_store_if_stopped_in_db()
{
grainState.Value = grainState.Value.Stopped();
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await sut.CompleteAsync();
AssertGrainState(isStopped: true, position: initialPosition);
A.CallTo(() => eventStore.CreateSubscription(A<IEventSubscriber>._, A<string>._, A<string>._))
.MustNotHaveHappened();
}
[Fact]
public async Task Should_subscribe_to_event_store_if_not_found_in_db()
{
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: initialPosition);
A.CallTo(() => eventStore.CreateSubscription(A<IEventSubscriber>._, A<string>._, A<string>._))
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_subscribe_to_event_store_if_failed()
{
grainState.Value = grainState.Value.Stopped(new InvalidOperationException());
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: initialPosition);
A.CallTo(() => eventStore.CreateSubscription(A<IEventSubscriber>._, A<string>._, A<string>._))
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_subscribe_to_event_store_if_not_stopped_in_db()
{
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: initialPosition);
A.CallTo(() => eventStore.CreateSubscription(A<IEventSubscriber>._, A<string>._, A<string>._))
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_stop_subscription_if_stopped()
{
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await sut.StopAsync();
await sut.StopAsync();
await sut.CompleteAsync();
AssertGrainState(isStopped: true, position: initialPosition);
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventSubscription.Unsubscribe())
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_reset_consumer_if_resetting()
{
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await sut.StopAsync();
await sut.ResetAsync();
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: null);
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappened(2, Times.Exactly);
A.CallTo(() => eventConsumer.ClearAsync())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventSubscription.Unsubscribe())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventStore.CreateSubscription(A<IEventSubscriber>._, A<string>._, grainState.Value.Position))
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventStore.CreateSubscription(A<IEventSubscriber>._, A<string>._, null))
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_invoke_and_update_position_if_event_received()
{
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnEventAsync(eventSubscription, storedEvent);
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: storedEvent.EventPosition, count: 1);
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventConsumer.On(envelope))
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_invoke_and_update_position_if_event_received_one_by_one()
{
A.CallTo(() => eventConsumer.BatchSize)
.Returns(1);
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnEventAsync(eventSubscription, storedEvent);
await OnEventAsync(eventSubscription, storedEvent);
await OnEventAsync(eventSubscription, storedEvent);
await OnEventAsync(eventSubscription, storedEvent);
await OnEventAsync(eventSubscription, storedEvent);
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: storedEvent.EventPosition, count: 5);
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappened(5, Times.Exactly);
A.CallTo(() => eventConsumer.On(A<IEnumerable<Envelope<IEvent>>>._))
.MustHaveHappened(5, Times.Exactly);
}
[Fact]
public async Task Should_invoke_and_update_position_if_event_received_batched()
{
A.CallTo(() => eventConsumer.BatchSize)
.Returns(100);
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnEventAsync(eventSubscription, storedEvent);
await OnEventAsync(eventSubscription, storedEvent);
await OnEventAsync(eventSubscription, storedEvent);
await OnEventAsync(eventSubscription, storedEvent);
await OnEventAsync(eventSubscription, storedEvent);
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: storedEvent.EventPosition, count: 5);
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventConsumer.On(A<IEnumerable<Envelope<IEvent>>>._))
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_not_invoke_but_update_position_if_consumer_does_not_want_to_handle()
{
A.CallTo(() => eventConsumer.Handles(storedEvent))
.Returns(false);
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnEventAsync(eventSubscription, storedEvent);
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: storedEvent.EventPosition);
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventConsumer.On(envelope))
.MustNotHaveHappened();
}
[Fact]
public async Task Should_ignore_old_events()
{
A.CallTo(() => formatter.ParseIfKnown(A<StoredEvent>.That.Matches(x => x.Data == eventData)))
.Returns(null);
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnEventAsync(eventSubscription, storedEvent);
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: storedEvent.EventPosition);
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventConsumer.On(envelope))
.MustNotHaveHappened();
}
[Fact]
public async Task Should_not_invoke_and_update_position_if_event_is_from_another_subscription()
{
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnEventAsync(A.Fake<IEventSubscription>(), storedEvent);
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: initialPosition);
A.CallTo(() => eventConsumer.On(envelope))
.MustNotHaveHappened();
}
[Fact]
public async Task Should_stop_if_consumer_failed()
{
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
var ex = new InvalidOperationException();
await OnErrorAsync(eventSubscription, ex);
await sut.CompleteAsync();
AssertGrainState(isStopped: true, position: initialPosition, error: ex.ToString());
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventSubscription.Unsubscribe())
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_not_make_error_handling_if_exception_is_from_another_subscription()
{
var ex = new InvalidOperationException();
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnErrorAsync(A.Fake<IEventSubscription>(), ex);
await sut.CompleteAsync();
AssertGrainState(isStopped: false, position: initialPosition);
A.CallTo(() => grainState.WriteAsync())
.MustNotHaveHappened();
}
[Fact]
public async Task Should_wakeup_if_already_subscribed()
{
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await sut.ActivateAsync();
await sut.CompleteAsync();
A.CallTo(() => eventSubscription.WakeUp())
.MustHaveHappened();
}
[Fact]
public async Task Should_stop_if_resetting_failed()
{
var ex = new InvalidOperationException();
A.CallTo(() => eventConsumer.ClearAsync())
.Throws(ex);
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await sut.ResetAsync();
await sut.CompleteAsync();
AssertGrainState(isStopped: true, position: initialPosition, error: ex.ToString());
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventSubscription.Unsubscribe())
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_stop_if_handling_failed()
{
var ex = new InvalidOperationException();
A.CallTo(() => eventConsumer.On(envelope))
.Throws(ex);
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnEventAsync(eventSubscription, storedEvent);
await sut.CompleteAsync();
AssertGrainState(isStopped: true, position: initialPosition, error: ex.ToString());
A.CallTo(() => eventConsumer.On(envelope))
.MustHaveHappened();
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventSubscription.Unsubscribe())
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_stop_if_deserialization_failed()
{
var ex = new InvalidOperationException();
A.CallTo(() => formatter.ParseIfKnown(A<StoredEvent>.That.Matches(x => x.Data == eventData)))
.Throws(ex);
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnEventAsync(eventSubscription, storedEvent);
await sut.CompleteAsync();
AssertGrainState(isStopped: true, position: initialPosition, error: ex.ToString());
A.CallTo(() => eventConsumer.On(envelope))
.MustNotHaveHappened();
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventSubscription.Unsubscribe())
.MustHaveHappenedOnceExactly();
}
[Fact]
public async Task Should_start_after_stop_if_handling_failed()
{
var ex = new InvalidOperationException();
A.CallTo(() => eventConsumer.On(envelope))
.Throws(ex);
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnEventAsync(eventSubscription, storedEvent);
await sut.CompleteAsync();
await sut.StopAsync();
await sut.StartAsync();
await sut.StartAsync();
AssertGrainState(isStopped: false, position: initialPosition);
A.CallTo(() => eventConsumer.On(envelope))
.MustHaveHappened();
A.CallTo(() => grainState.WriteAsync())
.MustHaveHappened(2, Times.Exactly);
A.CallTo(() => eventSubscription.Unsubscribe())
.MustHaveHappenedOnceExactly();
A.CallTo(() => eventStore.CreateSubscription(A<IEventSubscriber>._, A<string>._, A<string>._))
.MustHaveHappened(2, Times.Exactly);
}
[Fact]
public async Task Should_fail_if_writing_failed()
{
var ex = new InconsistentStateException();
A.CallTo(() => grainState.WriteAsync())
.Throws(ex);
await sut.ActivateAsync(consumerName);
await sut.ActivateAsync();
await OnEventAsync(eventSubscription, storedEvent);
await sut.CompleteAsync();
AssertGrainState(isStopped: true, position: storedEvent.EventPosition, error: ex.ToString(), 1);
}
private Task OnErrorAsync(IEventSubscription subscription, Exception exception)
{
return sut.OnErrorAsync(subscription, exception);
}
private Task OnEventAsync(IEventSubscription subscription, StoredEvent ev)
{
return sut.OnEventAsync(subscription, ev);
}
private void AssertGrainState(bool isStopped = false, string? position = null, string? error = null, int count = 0)
{
var expected = new EventConsumerState { IsStopped = isStopped, Position = position, Error = error, Count = count };
grainState.Value.Should().BeEquivalentTo(expected);
}
}
}