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

Move profile and ruletype logic out of engine package #3520

Merged
merged 1 commit into from
Jun 4, 2024

Conversation

dmjb
Copy link
Contributor

@dmjb dmjb commented Jun 4, 2024

A bunch of profile and rule type logic lives in the engine package. This PR moves those functions into the profiles and ruletypes packages.

This avoids circular dependencies in a future PR, and also groups logic for specific domain concepts in their own packages.

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.

This avoids circular dependencies in a future PR, and also keeps logic
for specific domain concepts in their own packages.
@dmjb dmjb requested a review from a team as a code owner June 4, 2024 15:35
@@ -78,14 +77,8 @@ func (r *Reconciler) handleProfileInitEvent(msg *message.Message) error {
return nil
}

ectx := &engine.EntityContext{
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The use of this type was leading to a circular dependency, and after reviewing the code - it appears it is only used to pass around a single value. Instead of fixing the circular dependency, I just removed the use of this type here.

@coveralls
Copy link

Coverage Status

coverage: 52.691% (+0.03%) from 52.662%
when pulling 508380b on move-functions-from-engine
into e9e43e9 on main.

@dmjb dmjb merged commit 54d663d into main Jun 4, 2024
24 of 25 checks passed
@dmjb dmjb deleted the move-functions-from-engine branch June 4, 2024 20:17
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.

3 participants