Unify all state change events on BlockChain<T> into IRenderer<T> #963

dahlia · 2020-08-21T20:52:29Z

Closes #959.

This pull request introduces a new interface named IRenderer<T> and replaces rendering methods of IAction and TipChanged/Reorged events on BlockChain<T> with it.

To make IAction to satisfy separation of concerns, the interface becomes no more aware of rendering, but only has Execute() and knows how to serialize and deserialize itself. Instead, rendering mechanism is extracted into the new interface named IRenderer<T>, and it needs to be injected into BlockChain<T>. In order to watch state changes via IRenderer<T>, BlockChain<T>() constructor now takes renderers, IEnumerable<IRenderer<T>>:

public class SampleRenderer : IRenderer<SampleAction>
{
        public void RenderAction(
            IAction action,
            IActionContext context,
            IAccountStateDelta nextStates
        ) =>
            RENDER_THINGS_HERE;
        // …
}
IRenderer<SampleAction> renderer = new SampleRenderer();
var chain = new BlockChain<SampleAction>(..., renderers: new[] { renderer });

Besides rendering IActions, IRenderer<T> also replaces BlockChain<T>.TipChanged event (introduced in #517 & #526) with IRenderer<T>.RenderBlock() method, and BlockChain<T>.Reorged event (introduced in #945) with IRenderer<T>.RenderReorg() method. It means now all events regarding state changes on BlockChain<T> become unified into one interface IRenderer<T>.

(FYI I actually left BlockChain<T>.TipChanged event private for an internal use: cancelling undergoing mining when a new block is appended. However, still it is invisible from public surface.)

This patch also removed the render option from the BlockChain<T>() constructor (introduced in #883). As renderers: null is equivalent to render: false, it's redundant.

For the sake of convenient development (writing unit tests in particular), I added two built-in renderers as well:

AnonymousRenderer<T> mimics Java's anonymous class for implementing IRenderer<T>. If you need only one-use renderer, it helps you to avoid a tedious inner class:
```
var renderer = new AnonymousRenderer<SampleAction>
{
    RenderAction = (action, context, nextStates) => RENDER_THINGS_HERE,
};
```
LoggedRenderer<T> decorates another IRenderer<T> with fine-grained logging. Its constructor takes a IRenderer<T> and a Serilog ILogger, and logs starting and ending point of every event. If any exception happens during event handling it also logs the exception with traceback.
```
IRenderer<SampleAction> renderer;
renderer = new AnonymousRenderer<SampleAction> { /* … */ };
renderer = new LoggedRenderer(renderer, Log.Logger);
```

codecov · 2020-08-21T21:07:53Z

Codecov Report

Merging #963 into main will increase coverage by 0.47%.
The diff coverage is 96.55%.

@@            Coverage Diff             @@
##             main     #963      +/-   ##
==========================================
+ Coverage   88.29%   88.76%   +0.47%     
==========================================
  Files         284      288       +4     
  Lines       26161    26766     +605     
==========================================
+ Hits        23099    23760     +661     
+ Misses       1533     1476      -57     
- Partials     1529     1530       +1

Impacted Files	Coverage Δ
Libplanet.Tests/Action/PolymorphicActionTest.cs	`86.48% <ø> (+8.43%)`	⬆️
Libplanet.Tests/Common/Action/DumbAction.cs	`82.16% <ø> (-0.95%)`	⬇️
Libplanet.Tests/Common/Action/MinerReward.cs	`54.83% <ø> (-14.52%)`	⬇️
Libplanet.Tests/Common/Action/ThrowException.cs	`100.00% <ø> (+20.00%)`	⬆️
Libplanet.Tests/Common/RenderRecord.cs	`100.00% <ø> (ø)`
Libplanet.Tests/Net/SwarmTest.Fixtures.cs	`100.00% <ø> (ø)`
Libplanet/Action/PolymorphicAction.cs	`100.00% <ø> (+7.54%)`	⬆️
Libplanet/Net/Swarm.cs	`86.10% <0.00%> (ø)`
Libplanet/Store/StoreExtensions.cs	`50.00% <ø> (+5.71%)`	⬆️
Libplanet/Blockchain/BlockChain.cs	`90.83% <85.29%> (+0.34%)`	⬆️
... and 23 more

longfin · 2020-08-24T00:53:24Z

Libplanet/Blockchain/Renderers/LoggedRenderer.cs

+            const string endMessage =
+                "Invoked {MethodName}() for an action {ActionType} at block #{BlockIndex}";
+
+            if (context.Rehearsal)


Is there a case where context.Rehearsal is true during rendering?

If we correctly implemented and our intention won't change at all there is indeed no such case. However, this is for the sake of easier debugging, so I thought it's useful.

Libplanet/Blockchain/Renderers/IRenderer.cs

riemannulus · 2020-08-24T02:10:36Z

Libplanet/Blockchain/BlockChain.cs

-        /// An event which is invoked when the chain is reorged.
-        /// </summary>
-        public event EventHandler<ReorgedEventArgs> Reorged;
+        private event EventHandler<(Block<T> OldTip, Block<T> NewTip)> TipChanged;


This pull request introduces a new interface named IRenderer and replaces rendering methods of IAction and TipChanged/Reorged events on BlockChain with it.

Just curiosity... Is this change make replaces TipChanged event from BlockChain<T> to IRenderer<T>?

Just curiosity... Is this change make replaces TipChanged event from BlockChain<T> to IRenderer<T>?

Yes!:

Besides rendering IActions, IRenderer<T> also replaces BlockChain<T>.TipChanged event (introduced in #517 & #526) with IRenderer<T>.RenderBlock() method, and BlockChain<T>.Reorged event (introduced in #945) with IRenderer<T>.RenderReorg() method. It means now all events regarding state changes on BlockChain<T> become unified into one interface IRenderer<T>.

(FYI I actually left BlockChain<T>.TipChanged event private for an internal use: cancelling undergoing mining when a new block is appended. However, still it is invisible from public surface.)

Ah, I understand. Move rendering role from TipChanged event to IRenderer<T>.RenderBlock() . also TipChanged have only check changed tip blockchain itself. right?

@riemannulus Right!

Because without the render option, the same behaviour can be achieved by using non renderers. See also planetarium#883

which is replaced by IRenderer<T>.BlockRender() method.

which is replaced by IRenderer<T>.RenderReorg() method. See also planetarium#945

dahlia · 2020-08-24T07:02:31Z

@planetarium/libplanet I fixed a small typo; please review this again!

from planetarium#963

dahlia self-assigned this Aug 21, 2020

dahlia force-pushed the renderer branch 3 times, most recently from 3fe7884 to 99d9f97 Compare August 23, 2020 12:57

Add words to dictionary

f5ef45e

dahlia force-pushed the renderer branch from 99d9f97 to 375f199 Compare August 23, 2020 13:39

dahlia changed the title ~~WIP: IRenderer<T> and BlockChain<T>.Renderers~~ WIP: Replace IAction.Render*() methods with IRenderer<T> Aug 23, 2020

dahlia changed the title ~~WIP: Replace IAction.Render*() methods with IRenderer<T>~~ WIP: Replace IAction rendering methods with IRenderer<T> Aug 23, 2020

dahlia force-pushed the renderer branch 3 times, most recently from 938739a to e03b2c9 Compare August 23, 2020 19:15

dahlia changed the title ~~WIP: Replace IAction rendering methods with IRenderer<T>~~ WIP: Unify all state change events on BlockChain<T> into IRenderer<T> Aug 23, 2020

dahlia changed the title ~~WIP: Unify all state change events on BlockChain<T> into IRenderer<T>~~ Unify all state change events on BlockChain<T> into IRenderer<T> Aug 23, 2020

dahlia marked this pull request as ready for review August 23, 2020 21:58

longfin requested review from longfin, riemannulus, earlbread, limebell and moreal August 24, 2020 00:28

longfin reviewed Aug 24, 2020

View reviewed changes

earlbread reviewed Aug 24, 2020

View reviewed changes

Libplanet/Blockchain/Renderers/IRenderer.cs Outdated Show resolved Hide resolved

Libplanet/Blockchain/Renderers/IRenderer.cs Outdated Show resolved Hide resolved

riemannulus reviewed Aug 24, 2020

View reviewed changes

dahlia force-pushed the renderer branch from e03b2c9 to fe14766 Compare August 24, 2020 04:19

dahlia requested review from riemannulus, earlbread and longfin August 24, 2020 04:20

longfin previously approved these changes Aug 24, 2020

View reviewed changes

earlbread previously approved these changes Aug 24, 2020

View reviewed changes

riemannulus previously approved these changes Aug 24, 2020

View reviewed changes

dahlia added 8 commits August 24, 2020 16:01

IRenderer<T>.RenderReorg()

8656d8e

Libplanet.Blockchain.Renderers namespace

9d96535

AnonymousRenderer<T>

5ec745b

LoggedRenderer<T>

8047033

Replace IAction render methods with IRenderer<T>

a5d9e30

Remove render option from BlockChain<T>

6fef47d

Because without the render option, the same behaviour can be achieved by using non renderers. See also planetarium#883

Remove BlockChain<T>.TipChanged

4380959

which is replaced by IRenderer<T>.BlockRender() method.

Remove BlockChain<T>.Reorged event

4d080b5

which is replaced by IRenderer<T>.RenderReorg() method. See also planetarium#945

dahlia dismissed stale reviews from moreal, limebell, earlbread, and longfin via 4d080b5 August 24, 2020 07:01

dahlia force-pushed the renderer branch from 86dcbdc to 4d080b5 Compare August 24, 2020 07:01

dahlia requested review from longfin, earlbread, limebell and moreal August 24, 2020 07:02

moreal approved these changes Aug 24, 2020

View reviewed changes

earlbread approved these changes Aug 24, 2020

View reviewed changes

limebell approved these changes Aug 24, 2020

View reviewed changes

dahlia merged commit 5b1ef5d into planetarium:main Aug 24, 2020

This was referenced Aug 25, 2020

Implement IRenderer<T> interface planetarium/lib9c#23

Merged

Let IRenderer<T> turn on and off evaluating actions #967

Closed

dahlia added a commit to dahlia/libplanet that referenced this pull request Aug 27, 2020

Add a missing changelog and removed a wrong one

4827b49

from planetarium#963

dahlia mentioned this pull request Aug 27, 2020

Short-circuit evaluation of stale actions on reorg #970

Merged

dahlia added a commit to dahlia/libplanet that referenced this pull request Aug 28, 2020

Add a missing changelog and removed a wrong one

6576e2a

from planetarium#963

dahlia added a commit to dahlia/libplanet that referenced this pull request Aug 28, 2020

Add a missing changelog and removed a wrong one

b290bc6

from planetarium#963

limebell mentioned this pull request Sep 14, 2020

More events on renderers #1000

Merged

dahlia mentioned this pull request Sep 28, 2020

As BlockChain<T>.Id keeps being changed, an app (library client) should be aware of that #184

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unify all state change events on BlockChain<T> into IRenderer<T> #963

Unify all state change events on BlockChain<T> into IRenderer<T> #963

dahlia commented Aug 21, 2020 •

edited

Loading

codecov bot commented Aug 21, 2020 •

edited

Loading

longfin Aug 24, 2020

dahlia Aug 24, 2020

riemannulus Aug 24, 2020

dahlia Aug 24, 2020

riemannulus Aug 24, 2020 •

edited

Loading

dahlia Aug 24, 2020

dahlia commented Aug 24, 2020

Unify all state change events on BlockChain<T> into IRenderer<T> #963

Unify all state change events on BlockChain<T> into IRenderer<T> #963

Conversation

dahlia commented Aug 21, 2020 • edited Loading

codecov bot commented Aug 21, 2020 • edited Loading

Codecov Report

longfin Aug 24, 2020

Choose a reason for hiding this comment

dahlia Aug 24, 2020

Choose a reason for hiding this comment

riemannulus Aug 24, 2020

Choose a reason for hiding this comment

dahlia Aug 24, 2020

Choose a reason for hiding this comment

riemannulus Aug 24, 2020 • edited Loading

Choose a reason for hiding this comment

dahlia Aug 24, 2020

Choose a reason for hiding this comment

dahlia commented Aug 24, 2020

dahlia commented Aug 21, 2020 •

edited

Loading

codecov bot commented Aug 21, 2020 •

edited

Loading

riemannulus Aug 24, 2020 •

edited

Loading