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

Some prep work for further changes to the executor #3874

Merged
merged 1 commit into from
Jul 12, 2024
Merged

Conversation

dmjb
Copy link
Contributor

@dmjb dmjb commented Jul 12, 2024

These changes will simplify some upcoming PRs. They include:

  1. Moving the rule type engine into its own sub package.
  2. Removing the rule type PB struct from the evaluation parameters. The
    alerting code currently accesses the rule type information by
    multiple paths (some of it is passed to the constructor for the
    alert, and other bits from the evaluation parameters). By picking a
    single way to pass the rule type around, changes for caching are
    simplified.

Changes validated locally.

Summary

Provide a brief overview of the changes and the issue being addressed.
Explain the rationale and any background necessary for understanding the changes.
List dependencies required by this change, if any.

Fixes #(related issue)

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

@dmjb dmjb requested a review from a team as a code owner July 12, 2024 11:52
These changes will simplify some upcoming PRs. They include:

1) Moving the rule type engine into its own sub package.
2) Removing the rule type PB struct from the evaluation parameters. The
   alerting code currently accesses the rule type information by
   multiple paths (some of it is passed to the constructor for the
   alert, and other bits from the evaluation parameters). By picking a
   single way to pass the rule type around, changes for caching are
   simplified.
@coveralls
Copy link

coveralls commented Jul 12, 2024

Coverage Status

coverage: 53.057% (+0.002%) from 53.055%
when pulling 47ecdc8 on cache-cleanup-prep
into 8324246 on main.

Copy link
Contributor

@blkt blkt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Non-blocking comment.

Comment on lines +15 to +16
// Package rtengine contains the rule type engine
package rtengine
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (non-blocking): I would name it simply rules, this package is under internal/engine anyway.

Copy link
Contributor Author

@dmjb dmjb Jul 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@blkt Selecting a good name for this package was a pain. The problem is that rules, rule, ruletype and ruletypes are common variable names in the code which import this package. ruleengine was considered, but that is just annoying to type :)

@dmjb dmjb merged commit 41e4833 into main Jul 12, 2024
23 checks passed
@dmjb dmjb deleted the cache-cleanup-prep branch July 12, 2024 13:00
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.

5 participants