Fork me on GitHub

Copy and transform stream Edit on GitHub


This scenario demonstrates how to copy and transform event stream to enable

  • Introduction of new events
  • Deletion of events

Scenario

Lets say we have an event stream, from which we would like to delete events of specific kind. Furthermore, we have a new event type that we would like to compose from existing data (akin to versioning). In the sample below, we setup our initial stream.


			var started = new QuestStarted { Name = "Find the Orb" };
			var joined = new MembersJoined { Day = 2, Location = "Faldor's Farm", Members = new[] { "Garion", "Polgara", "Belgarath" } };
			var slayed1 = new MonsterSlayed { Name = "Troll" };
			var slayed2 = new MonsterSlayed { Name = "Dragon" };
			
			using (var session = theStore.OpenSession())
			{
				session.Events.StartStream<Quest>(started.Name,started, joined, slayed1, slayed2);
				session.SaveChanges();
			}

Next, we introduce a new event type to expand the MembersJoined to a series of events, one for each member.


		public class MemberJoined
		{
			public int Day { get; set; }
			public string Location { get; set; }
			public string Name { get; set; }

			public MemberJoined()
			{
			}

			public MemberJoined(int day, string location, string name)
			{
				Day = day;
				Location = location;
				Name = name;
			}

			public static MemberJoined[] From(MembersJoined @event)
			{
				return @event.Members.Select(x => new MemberJoined(@event.Day, @event.Location, x)).ToArray();
			}
		}

Lastly, we want trolls (MonsterSlayed) removed from our stream. However, the stream is a series of ordered, immutable data, with no functionality to patch or otherwise modify existing data. Instead of trying to mutate the stream, we can use the copy and transform pattern to introduce a new event stream. We do this by copying the existing stream to a new one, while applying any needed transforms to the event data being copied.


			using (var session = theStore.OpenSession())
			{
				var events = session.Events.FetchStream(started.Name);

				var transformedEvents = events.SelectMany(x =>
				{
					switch (x.Data)
					{
						case MonsterSlayed monster:
						{
							// Trolls we remove from our transformed stream
							return monster.Name.Equals("Troll") ? new object[] { } : new[] { monster };
						}
						case MembersJoined members:
						{
							// MembersJoined events we transform into a series of events
							return MemberJoined.From(members);
						}
					}

					return new[] { x.Data };
				}).Where(x => x != null).ToArray();

				var moveTo = $"{started.Name} without Trolls";
				// We copy the transformed events to a new stream
				session.Events.StartStream<Quest>(moveTo, transformedEvents);
				// And additionally mark the old stream as moved. Furthermore, we assert on the new expected stream version to guard against any racing updates
				session.Events.Append(started.Name, events.Count + 1, new StreamMovedTo
				{
					To = moveTo
				});

				// Transactionally update the streams.
				session.SaveChanges();
			}

As the new stream is produced, within the same transaction we introduce an event dictating the stream being copied to have been moved. This should serve as an indication to no longer append new events into the stream. Furthermore, it ensures that the underlying stream being copied has not changed during the copy & transform process (as we assert on the expected stream version).


		public class StreamMovedTo
		{
			public string To { get; set; }
		}