[Neo Plugin New feature] UnhandledExceptionPolicy on Plugin Unhandled Exception #3311

Jim8y · 2024-06-09T10:42:56Z

Description

This is a follow up work after #3309. This pr will stop a plugin if a plugin throws an unhandled exception, but we also allow user to specify plugins not to stop on exception (except store plugins.).

Every single plugin can specifiy their own policy when unhandled exception is throw out of the plugin:

StopNode. Exception will be throw directly and not handled, this will cause the node to stop working. And this is current logic.
StopPlugin. Exception will be handled by the core and the plugin will be stoped from running.
Ignore. Exception will be recorded, but node and plugin will keep running.

Fixes # follow #3309

Type of change

Optimization (the change is only an optimization)
Style (the change is only a code style for better maintenance or standard purpose)
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

TestOnPluginStopOnException
TestOnPluginStopped
TestOnNodeStopOnPluginException

Test Configuration:

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules

…st data pollution.

src/Neo/Plugins/PluginSettings.cs

src/Neo/Ledger/Blockchain.cs

Clean

src/Neo/Plugins/PluginSettings.cs

Co-authored-by: Shargon <[email protected]>

src/Neo/Plugins/PluginSettings.cs

src/Plugins/TokensTracker/TokensTracker.cs

Co-authored-by: Christopher Schuchardt <[email protected]>

resolved

superboyiii · 2024-06-17T07:36:48Z

Maybe TokenTracker should be the same default settings as Applicationlogs, they're working in similar behaviours.

Jim8y · 2024-06-17T10:46:55Z

Maybe TokenTracker should be the same default settings as Applicationlogs, they're working in similar behaviours.

will update.

src/Plugins/TokensTracker/TokensTracker.json

Jim8y · 2024-06-18T07:55:24Z

Following the call of the TC, this pr will be halted for 3-6 months. Thus please don't merge this pr.

shargon · 2024-06-18T10:26:07Z

Following the call of the TC, this pr will be halted for 3-6 months. Thus please don't merge this pr.

This is required if we merged the previous related one. I Didn't read it nothing related against this pr

#3309 (review)

Jim8y · 2024-06-18T15:12:06Z

Following the call of the TC, this pr will be halted for 3-6 months. Thus please don't merge this pr.

This is required if we merged the previous related one. I Didn't read it nothing related against this pr

#3309 (review)

sure. since coredev meeting is scheduled next week, i think it should still be fine to merge this one.

Jim8y · 2024-06-18T15:12:49Z

@shargon can you please merge this branch to master?

vncoelho · 2024-06-18T15:14:36Z

@Jim8y

Try https://github.com/neo-project/neo/compare/plugin-unhandled-exception?expand=1

* [Neo Core] Part 1. Isolate Plugins Exceptions from the Node. (#3309) * catch plugin exceptions. * add UT test * udpate format * make the test more complete * complete the ut test * format * complete UT tests with NonPlugin case * async invoke * Update src/Neo/Ledger/Blockchain.cs Co-authored-by: Christopher Schuchardt <[email protected]> --------- Co-authored-by: Christopher Schuchardt <[email protected]> * [Neo Plugin New feature] UnhandledExceptionPolicy on Plugin Unhandled Exception (#3311) * catch plugin exceptions. * add UT test * udpate format * make the test more complete * complete the ut test * format * complete UT tests with NonPlugin case * async invoke * stop plugin on exception * remove watcher from blockchain if uint test is done to avoid cross test data pollution. * add missing file * 3 different policy on handling plugin exception * add missing file * fix null warning * format * Apply suggestions from code review Clean * Update src/Neo/Plugins/PluginSettings.cs Co-authored-by: Shargon <[email protected]> * Update src/Neo/Plugins/PluginSettings.cs Co-authored-by: Christopher Schuchardt <[email protected]> * Update src/Plugins/TokensTracker/TokensTracker.cs Co-authored-by: Christopher Schuchardt <[email protected]> * Update src/Plugins/TokensTracker/TokensTracker.json --------- Co-authored-by: Shargon <[email protected]> Co-authored-by: Christopher Schuchardt <[email protected]> * make the exception message clear --------- Co-authored-by: Christopher Schuchardt <[email protected]> Co-authored-by: Shargon <[email protected]> Co-authored-by: NGD Admin <[email protected]>

Jim8y added 9 commits June 9, 2024 00:35

catch plugin exceptions.

3c02309

add UT test

e426ed6

udpate format

5d6fa28

make the test more complete

439f504

complete the ut test

e569fed

format

d701dd3

complete UT tests with NonPlugin case

db1c7f0

async invoke

17f74ef

stop plugin on exception

3cd8df7

Jim8y marked this pull request as draft June 9, 2024 10:46

remove watcher from blockchain if uint test is done to avoid cross te…

d7799f3

…st data pollution.

Jim8y marked this pull request as ready for review June 9, 2024 15:21

Jim8y added Blocked This issue can't be worked at the moment Waiting for Review labels Jun 9, 2024

add missing file

90405c5

Jim8y requested review from shargon, cschuchardt88, vncoelho, roman-khimov, AnnaShaleva and superboyiii June 9, 2024 15:27

Jim8y mentioned this pull request Jun 9, 2024

[Neo Core] Part 1. Isolate Plugins Exceptions from the Node. #3309

Merged

14 tasks

Jim8y added 2 commits June 10, 2024 00:05

3 different policy on handling plugin exception

005d057

add missing file

1da63a2

Jim8y changed the title ~~[Neo Plugin New feature] Stop plugins on Unhandled Exception~~ [Neo Plugin New feature] UnhandledExceptionPolicy on Plugin Unhandled Exception Jun 9, 2024

Jim8y added 2 commits June 10, 2024 00:58

fix null warning

850baf3

format

4e9ec4a

cschuchardt88 previously approved these changes Jun 9, 2024

View reviewed changes

shargon reviewed Jun 10, 2024

View reviewed changes

src/Neo/Plugins/PluginSettings.cs Outdated Show resolved Hide resolved

src/Neo/Ledger/Blockchain.cs Outdated Show resolved Hide resolved

Apply suggestions from code review

baf2f30

Clean

shargon reviewed Jun 10, 2024

View reviewed changes

src/Neo/Plugins/PluginSettings.cs Outdated Show resolved Hide resolved

Update src/Neo/Plugins/PluginSettings.cs

77e8ea8

Co-authored-by: Shargon <[email protected]>

Jim8y changed the base branch from master to plugin-unhandled-exception June 10, 2024 14:10

cschuchardt88 previously requested changes Jun 11, 2024

View reviewed changes

src/Neo/Plugins/PluginSettings.cs Outdated Show resolved Hide resolved

src/Plugins/TokensTracker/TokensTracker.cs Outdated Show resolved Hide resolved

Update src/Neo/Plugins/PluginSettings.cs

5f11c4c

Co-authored-by: Christopher Schuchardt <[email protected]>

Jim8y removed the Blocked This issue can't be worked at the moment label Jun 16, 2024

Jim8y and others added 2 commits June 16, 2024 19:24

Update src/Plugins/TokensTracker/TokensTracker.cs

bce7b65

Co-authored-by: Christopher Schuchardt <[email protected]>

Merge branch 'plugin-unhandled-exception' into stop-plugins-on-fault

7e7e420

Jim8y requested review from shargon and cschuchardt88 June 16, 2024 11:27

shargon approved these changes Jun 16, 2024

View reviewed changes

cschuchardt88 approved these changes Jun 16, 2024

View reviewed changes

Jim8y added the Ready to Merge label Jun 17, 2024

Jim8y commented Jun 18, 2024

View reviewed changes

src/Plugins/TokensTracker/TokensTracker.json Outdated Show resolved Hide resolved

Update src/Plugins/TokensTracker/TokensTracker.json

10ba5e9

cschuchardt88 approved these changes Jun 18, 2024

View reviewed changes

cschuchardt88 added Wait Technical Committee Blocked This issue can't be worked at the moment and removed Waiting for Review labels Jun 18, 2024

Jim8y merged commit c696cec into neo-project:plugin-unhandled-exception Jun 18, 2024
7 checks passed

Jim8y deleted the stop-plugins-on-fault branch July 19, 2024 01:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Neo Plugin New feature] UnhandledExceptionPolicy on Plugin Unhandled Exception #3311

[Neo Plugin New feature] UnhandledExceptionPolicy on Plugin Unhandled Exception #3311

Jim8y commented Jun 9, 2024 •

edited

Loading

superboyiii commented Jun 17, 2024 •

edited

Loading

Jim8y commented Jun 17, 2024

Jim8y commented Jun 18, 2024

shargon commented Jun 18, 2024 •

edited

Loading

Jim8y commented Jun 18, 2024

Jim8y commented Jun 18, 2024

vncoelho commented Jun 18, 2024

[Neo Plugin New feature] UnhandledExceptionPolicy on Plugin Unhandled Exception #3311

[Neo Plugin New feature] UnhandledExceptionPolicy on Plugin Unhandled Exception #3311

Conversation

Jim8y commented Jun 9, 2024 • edited Loading

Description

Type of change

How Has This Been Tested?

Checklist:

superboyiii commented Jun 17, 2024 • edited Loading

Jim8y commented Jun 17, 2024

Jim8y commented Jun 18, 2024

shargon commented Jun 18, 2024 • edited Loading

Jim8y commented Jun 18, 2024

Jim8y commented Jun 18, 2024

vncoelho commented Jun 18, 2024

Jim8y commented Jun 9, 2024 •

edited

Loading

superboyiii commented Jun 17, 2024 •

edited

Loading

shargon commented Jun 18, 2024 •

edited

Loading