Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature refactor processor and parser #6

Merged
merged 6 commits into from
Aug 21, 2024

Conversation

teamjorge
Copy link
Owner

Description:

This change is primarily aimed at improving the feel and efficiency of the Processor and Parsing sections. Mainly, the whitelist column portion was targeted to reduce vast amounts of variables being used on retrieving telemetry data and being passed to every processor. The Tick type was added for ease of retrieving and manipulating telemetry information, rather than just relying on the bulky map[string]VarHeader.

Additionally, examples will benefit from having a common set of funcs and a README. This will ease adding additional examples.

  • Refactor Process() into separate functions.
  • Add context to Process() for concurrent operations.
  • Move whitelist operations to Process instead of parsing.
  • Add parseAndValidateWhitelist for parsing a processors whitelist.
  • Add buildWhitelist for compiling the whitelists from multiple processors.
  • Create Tick type for the output of parser.Next().
  • Add sets utilities to help with distinct whitelists.
  • Add file open and close operations to stubs.
  • Update type 0 non-array value to uint8
  • Update examples to have a common README.
  • Refactor track_temp to use some common example functions.
  • Add a README for track_temp example.
  • Update docstring on Varheader
  • Add a comment to tempMap regarding it's use.

Add context to Process() for concurrent operations.
Move whitelist operations to Process instead of parsing.
Add parseAndValidateWhitelist for parsing a processors whitelist.
Add buildWhitelist for compiling the whitelists from multiple processors.
Create Tick type for the output of parser.Next().
Add sets utilities to help with distinct whitelists.
Refactor track_temp to use some common example functions.
Add a README for track_temp example.
@teamjorge teamjorge self-assigned this Aug 21, 2024
@codecov-commenter
Copy link

codecov-commenter commented Aug 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.60%. Comparing base (2318ce7) to head (0c3c1ea).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main       #6      +/-   ##
==========================================
+ Coverage   95.03%   95.60%   +0.57%     
==========================================
  Files          12       14       +2     
  Lines         322      364      +42     
==========================================
+ Hits          306      348      +42     
  Misses         11       11              
  Partials        5        5              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@teamjorge teamjorge merged commit 4bc4a47 into main Aug 21, 2024
3 checks passed
@teamjorge teamjorge deleted the feature-refactor-processor-and-parser branch August 21, 2024 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants