[Persistence] Refactors TreeStore to Use Module Pattern

[dylanlott]

Description

Refactors the TreeStore to use the Module pattern and register it on the Bus.
Addresses comment from #756 by @Olshansk about making the TreeStore a full module.

Issue

Addresses refactor from #756 mentioned above.

Type of change

Please mark the relevant option(s):

• New feature, functionality or library
• Bug fix
• Code health or cleanup
• Major breaking change
• Documentation
• Other

List of changes

• Adds the TreeStore module plumbing
• Creates the TreeStoreModule interface in shared/modules

Testing

• make develop_test; if any code changes were made
• make test_e2e on k8s LocalNet; if any code changes were made
• e2e-devnet-test passes tests on DevNet; if any code was changed
• Docker Compose LocalNet; if any major functionality was changed or introduced
• k8s LocalNet; if any infrastructure or configuration changes were made

Required Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added, or updated, godoc format comments on touched members (see: tip.golang.org/doc/comment)
• I have tested my changes using the available tooling
• I have updated the corresponding CHANGELOG

If Applicable Checklist

• I have updated the corresponding README(s); local and/or global
• I have added tests that prove my fix is effective or that my feature works
• I have added, or updated, mermaid.js diagrams in the corresponding README(s)
• I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: -0.06 ⚠️

Comparison is base (f35bc5b) 30.86% compared to head (113e3be) 30.80%.

Additional details and impacted files

@@                    Coverage Diff                     @@
##           persistence/tree-store     #808      +/-   ##
==========================================================
- Coverage                   30.86%   30.80%   -0.06%     
==========================================================
  Files                         108      109       +1     
  Lines                        9228     9245      +17     
==========================================================
  Hits                         2848     2848              
- Misses                       6040     6057      +17     
  Partials                      340      340              

Impacted Files	Coverage Δ
persistence/trees/module.go	0.00% <0.00%> (ø)
persistence/trees/trees.go	0.00% <0.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[github-actions]

Here's a brief code review of the provided patch. The code seems to implement a treeStore module as part of a larger package dealing with trees. It has three methods: Create, GetModuleName, and the exported function Create.

Potential issues and suggestions for improvement:

1. Error handling: There isn't any explicit error handling in the provided code, which might be okay if the functionality is simple and doesn't require error checking. However, it's worth considering if any errors should be caught or returned by the functions.

2. Struct definition: Since treeStore struct is used here (as a pointer receiver in methods), its definition should also be added in this package. Make sure the corresponding struct definition is in the same package, or import it if necessary.

3. Comments and documentation: The code lacks comments and documentation. Providing descriptions for each function and their input parameters can make the code easier to understand, maintain, and use.

4. Consistent naming: In this code snippet, the Create method is implemented with a pointer receiver while the exported Create function creates an instance of treeStore. To avoid potential confusion, consider naming the exported function differently from the method. For example, you might rename it to NewTreeStore.

5. Module registration: bus.RegisterModule(m) doesn't seem to accept any error feedback. Ensure that proper error handling is performed within the RegisterModule() method or refactor the code to allow error reporting if registration fails.

[Olshansk]

@dylanlott Do you get value from these?

[dylanlott]

@Olshansk occasionally, I meant to turn it off earlier though, it's less useful when they're repeated

[h5law]

Suggested change

	m.SetBus(bus)
	bus.RegisterModule(m)

Is there a difference in these calls? I think doing this way and adding a method to the Bus interface would allow for TreeStore access outside of persistence, seeing as the method GetTreeStore was removed from the interface is this the intended way?

treeStore := bus.GetTreeStore()

[dylanlott]

@bryanchriswhite would be able to explain the difference better. I just followed his pointers on how to get my module working.

[h5law]

As we are removing this from the persistence context how can we access the TreeStore module from outside of the persistence package if needed?

[dylanlott]

It can't be accessed from the outside, which is the desired outcome. Only the PersistenceContext should be exposed for external calls.

[h5law]

I am confused as this is present but has been removed from the PersistenceModule interface?

[dylanlott]

Good catch, this was dead code, it's removed now. 👍