move datanode to internal/node #82
Merged
Conversation
This file contains 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
Clues has grown organically into a split between the api that places data in the right spot (clues) and the structure which contains the data (nodes). As we move more behavior into subpackages, and as we look forward to future subpackage additions, it makes the most sense to move the node systems into an internal package so that they can be generically utilized across all clues subpackages without issues like import cycles.
This movement is 80% copy/paste, 19% renaming and reorganization, and 1% interface/import adaptation. No logical changes were intended.
copy/paste: datanode.go has moved into /internal/node/node.go. otel.go has moved into /internal/node/otel.go.
reorganization: datanode.go has been broken into multiple files. Discrete concerns (comments, agents, otel) all exist as various files within /node. Generic and basic functionality stays in /node/node.go.
adaptation: OTELConfig now has a user-facing config builder in /clues/otel.go, while the core otel config struct still lives in /internal/node/otel.go.
ryanfkeepers
force-pushed
the
internal-datanode
branch
from
aa1f138 to
869138e
Compare
pandeyabs
approved these changes
Dec 3, 2024
clues.go
Outdated
| // --------------------------------------------------------------------------- | ||
|
|
||
| // In retrieves the clues structured data from the context. | ||
| // TODO: turn return an interface instead of a node, have nodes |
There was a problem hiding this comment.
Suggested change
| // TODO: turn return an interface instead of a node, have nodes | |
| // TODO: return an interface instead of a node, have nodes |
| } | ||
|
|
||
| // AddComment creates a new nodewith a comment but no other properties. | ||
| func (dn *Node) AddComment( |
There was a problem hiding this comment.
I see that TestAddComment exists but in clues_test.go. Could you move it to comments_test.go file in a future PR?
Split the clues interface between context management and error handling by moving all error functionality to a new subpackage: /clerr. This change is 80% copy/paste, and 20% renaming/reorganization. No logical changes are intended. * `copy/paste`: all error stuffs have been moved to /clerr. Since error tests and clues tests shared a common test framework, that framework has moved to /internal/tester to be available for both. * 'reorganization': the err.go file has been split into a couple files, primarily cluerr.go (the public interface) and err.go (the backing struct). Extensions like comments and labels have moved into their own file.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Clues has grown organically into a split between the api that places data in the right spot (clues) and the structure which contains the data (nodes). As we move more behavior into subpackages, and as we look forward to future subpackage additions, it makes the most sense to move the node systems into an internal package so that they can be generically utilized across all clues subpackages without issues like import cycles.
This movement is 80% copy/paste, 19% renaming and reorganization, and 1% interface/import adaptation. No logical changes were intended.