-
-
Notifications
You must be signed in to change notification settings - Fork 18
refactor(engine): Add behavior metadata caching infrastructure and simplify AlwaysRun check (#1813) #1827
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
Closed
refactor(engine): Add behavior metadata caching infrastructure and simplify AlwaysRun check (#1813) #1827
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| using ModularPipelines.Modules.Behaviors; | ||
|
|
||
| namespace ModularPipelines.Engine; | ||
|
|
||
| /// <summary> | ||
| /// Cached metadata for module behavior interfaces. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// This caches the result of runtime type checks for behavior interfaces | ||
| /// to avoid repeated <c>is</c> checks during module execution. | ||
| /// | ||
| /// Behavior interfaces: | ||
| /// - ISkippable: Module can be skipped based on conditions | ||
| /// - IHookable: Module has before/after execution hooks | ||
| /// - ITimeoutable: Module has a timeout configuration | ||
| /// - IRetryable: Module has a retry policy | ||
| /// - IIgnoreFailures: Module failures are non-fatal | ||
| /// - IAlwaysRun: Module runs regardless of pipeline cancellation | ||
| /// </remarks> | ||
| internal sealed record ModuleBehaviorMetadata | ||
| { | ||
| /// <summary> | ||
| /// Gets a value indicating whether the module implements ISkippable. | ||
| /// </summary> | ||
| public bool IsSkippable { get; init; } | ||
|
|
||
| /// <summary> | ||
| /// Gets a value indicating whether the module implements IHookable. | ||
| /// </summary> | ||
| public bool IsHookable { get; init; } | ||
|
|
||
| /// <summary> | ||
| /// Gets a value indicating whether the module implements ITimeoutable. | ||
| /// </summary> | ||
| public bool IsTimeoutable { get; init; } | ||
|
|
||
| /// <summary> | ||
| /// Gets a value indicating whether the module implements IRetryable. | ||
| /// </summary> | ||
| public bool IsRetryable { get; init; } | ||
|
|
||
| /// <summary> | ||
| /// Gets a value indicating whether the module implements IIgnoreFailures. | ||
| /// </summary> | ||
| public bool IsIgnoreFailures { get; init; } | ||
|
|
||
| /// <summary> | ||
| /// Gets a value indicating whether the module implements IAlwaysRun. | ||
| /// </summary> | ||
| public bool IsAlwaysRun { get; init; } | ||
|
|
||
| /// <summary> | ||
| /// Creates behavior metadata from a module type by checking implemented interfaces. | ||
| /// Uses type-safe IsAssignableFrom checks to avoid namespace collision issues. | ||
| /// </summary> | ||
| /// <param name="moduleType">The module type to analyze.</param> | ||
| /// <returns>Metadata containing cached behavior flags.</returns> | ||
| public static ModuleBehaviorMetadata FromType(Type moduleType) | ||
| { | ||
| // Use type-safe IsAssignableFrom instead of string-based name matching | ||
| // to avoid namespace collision issues | ||
| return new ModuleBehaviorMetadata | ||
| { | ||
| IsSkippable = typeof(ISkippable).IsAssignableFrom(moduleType), | ||
| IsHookable = typeof(IHookable).IsAssignableFrom(moduleType), | ||
| IsTimeoutable = typeof(ITimeoutable).IsAssignableFrom(moduleType), | ||
| IsRetryable = moduleType.GetInterfaces().Any(i => | ||
| i.IsGenericType && i.GetGenericTypeDefinition() == typeof(IRetryable<>)), | ||
| IsIgnoreFailures = typeof(IIgnoreFailures).IsAssignableFrom(moduleType), | ||
| IsAlwaysRun = typeof(IAlwaysRun).IsAssignableFrom(moduleType), | ||
| }; | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The ModuleBehaviorMetadata class and GetBehaviorMetadata method are not being used anywhere in the codebase. While the caching infrastructure is in place, no code is actually calling GetBehaviorMetadata to leverage these cached behavior flags. This creates unused code that adds maintenance burden without providing any performance benefit. Either integrate this metadata into the module execution pipeline to replace runtime type checks, or remove it until it's ready to be used.