Restructure the project - #234
Merged
Merged
Conversation
hovsep
enabled auto-merge (rebase)
July 23, 2026 14:10
hovsep
force-pushed
the
revamp_project_layout
branch
from
July 23, 2026 14:11
6579217 to
5bd6402
Compare
hovsep
disabled auto-merge
July 23, 2026 14:11
Benchmark report (advisory)Statistically significant changes: 13 regression(s), 15 improvement(s) (PR head vs. base branch).
Higher is worse on every metric. Full benchstat table |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces several improvements and refactorings to the codebase, focusing on internal API organization, documentation, and test helper centralization. The most significant changes are the migration of the
hookpackage tointernal/hook(making it non-public), the addition of package-level documentation, and the consolidation of test helpers into a shared internal package. These changes clarify the public API surface, improve maintainability, and simplify test code.Internal API organization and encapsulation:
hookpackage tointernal/hook, making it internal and not part of the public API; updated all references and documentation to reflect this change. (.agent/docs/design.md[1].agent/docs/hooks.md[2]component/activation.go[3]component/hooks.go[4]hooks.go[5]docs/wiki/999.-Internals.md[6]Pluginstype toplugins(unexported) incomponent/plugin.goandcomponent/component.goto clarify its internal usage. (component/plugin.go[1]component/component.go[2]Documentation improvements:
component,cycle, andfmesh, providing clear overviews and usage guidance. (component/doc.go[1]cycle/doc.go[2]doc.go[3].agent/docs/hooks.md[1].agent/docs/design.md[2]docs/wiki/999.-Internals.md[3]Test helper centralization:
mustComponent,mustInputPort) tointernal/testutilfor use across integration and external test packages; updated tests to use these shared helpers and removed local duplicates. (integration_tests/chainability/chainability_test.go[1] [2] [3] [4] [5] [6];integration_tests/component_hooks/basic_test.go[7] [8] [9] [10] [11].agent/docs/testing.mdto document the shared test helper pattern and its location.Testing and examples:
example_test.gofile with a quick-start example demonstrating basic mesh setup and execution, mirroring the README.Minor refactoring and consistency:
MarkStarted/MarkStoppedmethod calls to their unexported forms (markStarted/markStopped) for consistency with internal API conventions. (fmesh.go[1] [2]fmesh_test.go[3]fmesh_test.goand clarified comments about import cycles. [1] [2]These changes collectively improve the clarity, maintainability, and testability of the codebase.