Release the resources

[Jim8y]

Description

This pr tries to hunt for the frequent memory issues reported by community.

Fixes #

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?

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

[Copilot]

Pull Request Overview

This PR optimizes resource management by releasing unmanaged resources more proactively while extending IDisposable implementations and tests. Key changes include:

• Adding a unit test to verify cache capacity handling in HeaderCache.
• Extending TrackerBase to implement IDisposable.
• Disposing resources in StateStore and NeoStore to prevent resource leaks.
• Enforcing a cache limit in HeaderCache.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/Neo.UnitTests/Ledger/UT_HeaderCache.cs	Adds a new test (TestHeaderCache_Limit) to validate the cache capacity logic.
src/Plugins/TokensTracker/Trackers/TrackerBase.cs	Extends TrackerBase class to implement IDisposable for safer resource management.
src/Plugins/StateService/Storage/StateStore.cs	Disposes the state snapshot and resources in both UpdateLocalStateRoot and PostStop.
src/Plugins/ApplicationLogs/Store/NeoStore.cs	Adds disposal of _blocklogsnapshot to ensure resource release.
src/Neo/Ledger/HeaderCache.cs	Enforces a limit on headers to prevent over-allocation and potential memory issues.

Comments suppressed due to low confidence (1)

src/Neo/Ledger/HeaderCache.cs:110

• [nitpick] Consider adding curly braces '{}' around the if-statement body to improve clarity and reduce the risk of errors in future modifications.

if (headers.Count >= 10000)

[Copilot]

Pull Request Overview

This PR addresses memory issues by optimizing resource management and enforcing limits in cache implementations. Key changes include the addition of new unit tests for header cache limits, the introduction of nullable reference handling and Dispose pattern in TrackerBase, and various adjustments to resource management in StateStore, NeoStore, and HeaderCache.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/Neo.UnitTests/Ledger/UT_HeaderCache.cs	Adds a test method to ensure the HeaderCache respects its capacity limit.
src/Plugins/TokensTracker/Trackers/TrackerBase.cs	Enables nullable reference handling and implements the Dispose pattern for improved resource management.
src/Plugins/StateService/Storage/StateStore.cs	Refactors singleton handling and snapshot disposal; however, an issue was introduced with cache initialization.
src/Plugins/ApplicationLogs/Store/NeoStore.cs	Disposes of the block log snapshot to release resources.
src/Neo/Ledger/HeaderCache.cs	Introduces a constant for maximum headers and updates the Add method to enforce the cache limit.
src/Neo/Ledger/Blockchain.cs	Updates header addition logic to check for cache capacity before adding headers.

Comments suppressed due to low confidence (1)

src/Plugins/TokensTracker/Trackers/TrackerBase.cs:98

• Using the null-forgiving operator on '_levelDbSnapshot' may lead to a NullReferenceException if it is null. Consider adding an explicit null-check to guarantee that _levelDbSnapshot is not null before calling Put.

_levelDbSnapshot!.Put(Key(prefix, key), value.ToArray());