[Bug] Deserialization of IntegrationEvent

Possible Issue

Deserialization of IntegrationEvent based classes won’t assign the same Id and CreationDate properties of the published events.

Example

From my understanding based on the current implementation of the IntegrationEvent those properties being { get; } only will not be populated by the current deserialization provided by the event bus implementations (AzureServiceBus and RabbitMQ) but instead get new values based on the constructor (issue link on Newtonsoft.Json project).

IntegrationEvent snippet

public class IntegrationEvent
{
    public IntegrationEvent()
    {
        Id = Guid.NewGuid();
        CreationDate = DateTime.UtcNow;
    }

    public Guid Id  { get; }
    public DateTime CreationDate { get; }
}

deserialization snippet

var integrationEvent = JsonConvert.DeserializeObject(message, eventType);

Question

Is this an unintended behavior (bug) or an integration event is by design supposed to have a new Id and CreationDate whenever it gets within the context of a microservice (subscriber)?.

– Best regards, Diogo Pinho

[mvelosop]

Hi @Diggzinc, this is actually a bug.

We intent to fix it this way to minimize changes and still keep the class immutable (in practice) and also “extend” this “immutability” implementation to the derived events:

public class IntegrationEvent
{
  public IntegrationEvent()
  {
    Id = Guid.NewGuid();
    CreationDate = DateTime.UtcNow;
  }

  [JsonProperty]
  public Guid Id { get; private set; }
  [JsonProperty]
  public DateTime CreationDate { get; private set; }
}

This solves the issue from the deserializer perspective, as it can find its way through the private setter, but has to be tested in the real app to be sure it works as expected.

Hope this helps in the meantime.

[mvelosop]

Closing this issue as it was solved with commit 06de1b68e3a758c854084200924c7e0799aa8b53