Improved developer documentation with flowcharts #546
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
ninaagrawal
force-pushed
the
ninaagrawal/developer_docs
branch
from
101f31b to
7427359
Compare
fix: allow flowchart to be recognized by site
ninaagrawal
force-pushed
the
ninaagrawal/developer_docs
branch
from
7427359 to
2b575be
Compare
|
I'm looking for something a little lower-level, along the lines of this quick sketch: 
The goal is that a developer can read it to understand quickly how control flows through the different components of the hipcheck core and SDK around querying |
alilleybrinker
changed the title
feat: added picture of the flowchart
…/hipcheck into ninaagrawal/developer_docs fix: needed updated changes from branch
j-lanson
reviewed
Nov 11, 2024
Comment on lines
+15
to
+17
| direction TB | ||
| hipcheck_proto --Opens an rpc protocol so Hipcheck can request queries to the plugin and the plugins may issue queries to other plugins-->finishHipcheck | ||
| end |
There was a problem hiding this comment.
Not relevant to this particular graph, we're discussing what happens once the gRPC channel is already open. Also, if this were in the graph it would happen before the start block.
j-lanson
reviewed
Nov 11, 2024
| recv--creates a variable called msg_chunks that will get the result from recv_raw.-->recv_raw --returns a queue of messages returned from send function if the grpc channel is still open as a vector -->recv --reads the messages from recv_raw --> finishSDK | ||
| end | ||
|
|
||
| Z-- The send function sends a grpc query from the plugin to the hipcheck server. The query parameter is given the RPC type InitiateQueryProtocolResponse-->ZA --Control transfers back to SDK-->ZB |
There was a problem hiding this comment.
The specific type InitiateQueryProtocolResponse is not necessary here
j-lanson
reviewed
Nov 11, 2024
| subgraph Z["SDK"] | ||
| direction TB | ||
| start--query's() parameters are the input value and target plugin/query endpoint from the starting plugin's query trait's run() function.--> | ||
| query --The target plugin/query endpoint is converted from the generic T to a QueryTarget. The input is converted to a JSON value with an InvalidJSONInQuery Key error if not properly converted. The variables are named query_target and input. From there query's inner function, query_inner() is called with the query_target and input as parameters--> query_inner-- During normal execution, when the engine is not a mock engine, the query() function creates a QueryTarget object and calls the send() function. The Query object is the send() function's parameter.-->send |
There was a problem hiding this comment.
We don't need to describe the error paths, particularly to do with JSON deserialization.
j-lanson
requested changes
Nov 11, 2024
There was a problem hiding this comment.
I would like this graph to answer these outstanding questions:
- once gRPC messages are received by HC core, how do they make it up to
engine.rs::query(), asAwaitingResult? - messages from HC core arrive at a plugin at
plugin_engine.rs::HcSessionSocet::listen(), how do they get toPluginEngine::recv_raw()
Also, please remove the erroneously added .jpg files, they should not be part of the PR.
Signed-off-by: Nina "Nino" Agrawal <[email protected]>
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.
added some documentation for developers