refactor: fix SonarCloud issue in WorkflowExecutor.ts#212
refactor: fix SonarCloud issue in WorkflowExecutor.ts#212thalesraymond wants to merge 1 commit intomainfrom
Conversation
Add readonly modifier to `WorkflowExecutor` constructor properties to satisfy SonarCloud rule typescript:S2933. The properties are never reassigned after initialization. Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refactors the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly adds the readonly modifier to the constructor properties in WorkflowExecutor.ts, which improves immutability and aligns with best practices. I have one suggestion to enhance robustness by adding validation for the concurrency parameter within the constructor. This will prevent unexpected behavior when non-positive values are provided.
| constructor( | ||
| private context: TContext, | ||
| private eventBus: EventBus<TContext>, | ||
| private stateManager: TaskStateManager<TContext>, | ||
| private strategy: IExecutionStrategy<TContext>, | ||
| private concurrency?: number | ||
| private readonly context: TContext, | ||
| private readonly eventBus: EventBus<TContext>, | ||
| private readonly stateManager: TaskStateManager<TContext>, | ||
| private readonly strategy: IExecutionStrategy<TContext>, | ||
| private readonly concurrency?: number | ||
| ) {} |
There was a problem hiding this comment.
The concurrency parameter is not validated. If a user provides 0 or a negative number, it can lead to unexpected behavior. A concurrency of 0 will prevent any tasks from running, causing them to be cancelled. A negative number will effectively disable the concurrency limit. It's best to add a check in the constructor to ensure that if concurrency is defined, it is a positive number.
constructor(
private readonly context: TContext,
private readonly eventBus: EventBus<TContext>,
private readonly stateManager: TaskStateManager<TContext>,
private readonly strategy: IExecutionStrategy<TContext>,
private readonly concurrency?: number
) {
if (this.concurrency !== undefined && this.concurrency <= 0) {
throw new Error("Concurrency, if provided, must be a positive number.");
}
}
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
1 participant
Add
readonlymodifier to properties insideWorkflowExecutor's constructor. This fixes the SonarCloud code smell (typescript:S2933) warning that class members injected in constructors and never reassigned should be markedreadonly.PR created automatically by Jules for task 10482727678408429855 started by @thalesraymond