From 30636606a02bbe7e7f298684d26dad99e7fc1935 Mon Sep 17 00:00:00 2001 From: John Colvin Date: Tue, 30 Jul 2024 17:22:01 +0000 Subject: [PATCH] Add ErrorChanged event to propagate DataStream exceptions --- .../Primitives/Filter/FilterStream.cs | 49 ++++++++++++++++--- .../Filter/StreamFilterException.cs | 19 +++++++ .../DataStreamCore/DataStream.cs | 20 +++++++- .../DataStreamCore/ViewStream.cs | 23 +++++---- 4 files changed, 93 insertions(+), 18 deletions(-) create mode 100644 src/DataStreamSuite/DataStream/Primitives/Filter/StreamFilterException.cs diff --git a/src/DataStreamSuite/DataStream/Primitives/Filter/FilterStream.cs b/src/DataStreamSuite/DataStream/Primitives/Filter/FilterStream.cs index 0fc5f8f21..1a9f7bf99 100644 --- a/src/DataStreamSuite/DataStream/Primitives/Filter/FilterStream.cs +++ b/src/DataStreamSuite/DataStream/Primitives/Filter/FilterStream.cs @@ -1,4 +1,7 @@ +using bts; + using Bts.DataStream; +using Bts.DataStream.Primitives.Filter; using mbts.config; @@ -26,6 +29,7 @@ namespace BCG.StreamWorld.Addition { myBaseStream = vs; myFilter = filter; + vs.ErrorChanged += OnError; if (filter is IDynamicStreamFilter) (filter as IDynamicStreamFilter).onFilterChange += new FilterChangeDelegate(myHandleFilterChange); } @@ -43,6 +47,16 @@ namespace BCG.StreamWorld.Addition myStateTable.clear(); } + bool filterRow(IBlueRow r) { + try { + return myFilter.filter(r); + } catch (Exception ex) { + Log.Gen.error($"FilterStream delegate threw exception: {ex}"); + OnError(new StreamFilterException(StreamId, StreamName, null, ex, r)); + } + return false; + } + private void myHandleChanges(object newValue) { DataPacket dp = newValue as DataPacket; @@ -66,7 +80,7 @@ namespace BCG.StreamWorld.Addition foreach (IBlueRow r in dp.addedRows) { myBaseTable.addRow(r); - if (myFilter.filter(r)) + if (filterRow(r)) { adds.addRow(r); myStateTable.addRow(r); @@ -85,9 +99,20 @@ namespace BCG.StreamWorld.Addition { IBlueRowCollection oldState = new BlueTable(myStateTable); myStateTable.clear(); - foreach (IBlueRow r in myBaseTable) - if (myFilter.filter(r)) - myStateTable.addRow(r); + // If the filter throws an exception, we can rethrow it as a StreamFilterException + // and include the 'currentRow' (for which the filter failed) to provide context. + IBlueRow? currentRow = null; + foreach (IBlueRow r in myBaseTable) { + try { + currentRow = r; + if (filterRow(r)) { + myStateTable.addRow(r); + } + } catch (Exception ex) { + Log.Gen.error($"FilterStream delegate threw exception: {ex}"); + OnError(new StreamFilterException(StreamId, StreamName, null, ex, currentRow)); + } + } IBlueRowCollection dels, adds; BlueDataUtility.computeDifferences(myStateTable, oldState, out dels, out adds); myFireEvent(new DataPacket(myStateTable, adds, dels)); @@ -233,7 +258,7 @@ namespace BCG (retVal.deletedRows as BlueTable).addRow(r); } foreach (IBlueRow r in arrivedPacket.addedRows) - if (myFilter.filter(r)) + if (filterRow(r)) { myLastFiredRows.addRow(r); (retVal.addedRows as BlueTable).addRow(r); @@ -244,7 +269,7 @@ namespace BCG myLastFiredRows = new BlueTable(arrivedPacket.schema); retVal = new DataPacket(myLastFiredRows, myLastFiredRows, new BlueTable(myLastFiredRows.schema)); foreach (IBlueRow r in arrivedPacket.newRows) - if (myFilter.filter(r)) + if (filterRow(r)) myLastFiredRows.addRow(r); } myFireEvent(retVal); @@ -267,7 +292,7 @@ namespace BCG { BlueTable nRows = new BlueTable(myLastReceivedRows.schema); foreach (IBlueRow r in myLastReceivedRows) - if (myFilter.filter(r)) + if (filterRow(r)) nRows.addRow(r); IBlueRowCollection dRows = new BlueTable(nRows.schema), aRows = new BlueTable(nRows.schema); @@ -298,5 +323,15 @@ namespace BCG { filter = myFilter; } + + bool filterRow(IBlueRow r) { + try { + return myFilter.filter(r); + } catch (Exception ex) { + Log.Gen.error($"FilterStream delegate threw exception: {ex}"); + OnError(new StreamFilterException(StreamId, StreamName, null, ex, r)); + } + return false; + } } } diff --git a/src/DataStreamSuite/DataStream/Primitives/Filter/StreamFilterException.cs b/src/DataStreamSuite/DataStream/Primitives/Filter/StreamFilterException.cs new file mode 100644 index 000000000..008c5b5bc --- /dev/null +++ b/src/DataStreamSuite/DataStream/Primitives/Filter/StreamFilterException.cs @@ -0,0 +1,19 @@ +#nullable enable +namespace Bts.DataStream.Primitives.Filter; + +using BCG; + +using System; + +public class StreamFilterException : Exception { + public StreamFilterException(Guid streamId, string streamName, string? message, Exception? innerException, IBlueRow? badRow = null) + : base(message, innerException) { + StreamId = streamId; + StreamName = streamName; + BadRow = badRow; + } + + public Guid StreamId { get; } + public string StreamName { get; } + public IBlueRow? BadRow { get; } +} diff --git a/src/DataStreamSuite/DataStreamCore/DataStream.cs b/src/DataStreamSuite/DataStreamCore/DataStream.cs index 63f5e9dd6..760c77393 100644 --- a/src/DataStreamSuite/DataStreamCore/DataStream.cs +++ b/src/DataStreamSuite/DataStreamCore/DataStream.cs @@ -32,6 +32,9 @@ namespace BCG public DataStream (DataStream realSource) { myRealSource = realSource; + if (myRealSource is not null) { + myRealSource.ErrorChanged += OnError; + } myOnChangeDelegate = null; myPendingAdds = new Stack(); } @@ -48,6 +51,8 @@ namespace BCG } } + public event Action ErrorChanged; + public delegate void ChangeDelegate(object newValue); public event ChangeDelegate onChange { @@ -120,8 +125,15 @@ namespace BCG protected virtual object myGetValueForInitialSubscription() {return myLastValue;} - protected void mySetRealSource (DataStream src) - {myRealSource = src;} + protected void mySetRealSource (DataStream src) { + if (myRealSource is not null) { + myRealSource.ErrorChanged -= OnError; + } + myRealSource = src; + if (myRealSource is not null) { + myRealSource.ErrorChanged += OnError; + } + } protected virtual void myOnFirstSubscriber() {myFirstSubImplemented = false;} protected virtual void myOnLastSubscriber () {myLastSubImplemented = false;} @@ -143,6 +155,10 @@ namespace BCG } } + protected void OnError(Exception error) { + ErrorChanged?.Invoke(error); + } + public Guid ID { get diff --git a/src/DataStreamSuite/DataStreamCore/ViewStream.cs b/src/DataStreamSuite/DataStreamCore/ViewStream.cs index df7345446..b5bb91a01 100644 --- a/src/DataStreamSuite/DataStreamCore/ViewStream.cs +++ b/src/DataStreamSuite/DataStreamCore/ViewStream.cs @@ -1,11 +1,5 @@ using System; -using BCG.Utilities; - -using Bts.DataStream; - -using mbts.config; - namespace BCG { /// @@ -18,14 +12,25 @@ namespace BCG // Configuration.get().UseUncopiedNewRowsInFire; protected bool myUseUncopiedNewRowsInFireEvent = false; + string streamName; + public ViewStream (ViewStream sourceStream) - : - base(sourceStream) - {} + : base(sourceStream) { + } + + public ViewStream(string streamName) { + this.streamName = streamName; + } public ViewStream() {} + public Guid StreamId { get; } = Guid.NewGuid(); + + public string StreamName => streamName + ?? (myRealSource as ViewStream)?.StreamName + ?? GetType().Name; + public IBlueRowCollection rows { get