Skip to content

fix(pod group): fix instance workload calculation bug#174

Open
JasonHe-WQ wants to merge 1 commit intosgl-project:mainfrom
JasonHe-WQ:pod-group
Open

fix(pod group): fix instance workload calculation bug#174
JasonHe-WQ wants to merge 1 commit intosgl-project:mainfrom
JasonHe-WQ:pod-group

Conversation

@JasonHe-WQ
Copy link
Contributor

Ⅰ. Motivation

if xpod group calculation bug

Ⅱ. Modifications

add unit test and add instance workload calculation

Ⅲ. Does this pull request fix one issue?

fixes #172

Ⅳ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.

Ⅴ. Describe how to verify it

VI. Special notes for reviews

Checklist

  • Format your code make fmt.
  • Add unit tests or integration tests.
  • Update the documentation related to the change.

@gemini-code-assist
Copy link

Summary of Changes

Hello, 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 addresses a critical bug in the pod group workload calculation, specifically for InstanceSetWorkloadType roles configured with a LeaderWorkerSet. The changes ensure that the total group size is accurately computed by correctly incorporating the LeaderWorkerSet.Size into the replica count. A new unit test has been introduced to validate this corrected behavior, improving the robustness of the scheduling logic.

Highlights

  • Bug Fix: Instance Workload Calculation: Resolved an issue where the GetGroupSize function incorrectly calculated the total number of instances for InstanceSetWorkloadType roles when a LeaderWorkerSet was specified. The calculation now correctly accounts for the LeaderWorkerSet.Size.
  • Enhanced Group Size Calculation Logic: Modified the GetGroupSize helper function to properly handle InstanceSetWorkloadType roles that utilize a LeaderWorkerSet, ensuring the LeaderWorkerSet.Size is multiplied by the role's replicas. It also adds a check for nil replicas.
  • New Unit Test Coverage: Added a new unit test case to podgroup_manager_test.go to specifically verify the correct calculation of pod group size for InstanceSetWorkloadType roles with an associated LeaderWorkerSet.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • api/workloads/v1alpha1/helper.go
    • Updated GetGroupSize function to correctly calculate group size for InstanceSetWorkloadType roles with LeaderWorkerSet.
    • Added a check to skip roles if role.Replicas is nil.
    • Introduced sizePerReplica variable for clearer calculation logic.
  • pkg/scheduler/podgroup_manager_test.go
    • Added a new unit test case named 'create kube pod group with instanceset lws role should use lws size' to TestPodGroupScheduler_Reconcile.
Activity
  • JasonHe-WQ opened this pull request to fix a bug related to instance workload calculation.
  • The pull request includes modifications to the GetGroupSize helper function and adds a corresponding unit test.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly fixes a bug in the pod group size calculation for InstanceSet workloads that use a LeaderWorkerSet template. A corresponding unit test has been added to verify the fix, which is great. I have one suggestion to improve the readability of the new calculation logic.

Comment on lines +34 to +44
if role.Workload.String() == LeaderWorkerSetWorkloadType ||
(role.Workload.String() == InstanceSetWorkloadType && role.LeaderWorkerSet != nil) {
sizePerReplica := int32(1)
if role.LeaderWorkerSet != nil && role.LeaderWorkerSet.Size != nil && *role.LeaderWorkerSet.Size > 0 {
sizePerReplica = *role.LeaderWorkerSet.Size
}
ret += int(*role.LeaderWorkerSet.Size) * int(*role.Replicas)
} else {
ret += int(*role.Replicas)
ret += int(sizePerReplica * *role.Replicas)
continue
}

ret += int(*role.Replicas)

Choose a reason for hiding this comment

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

medium

For improved readability and maintainability, consider refactoring this block. Extracting the complex condition into a boolean variable and using a standard if-else structure instead of continue can make the code's intent clearer and easier to follow.

		workloadType := role.Workload.String()
		useLwsSize := workloadType == LeaderWorkerSetWorkloadType ||
			(workloadType == InstanceSetWorkloadType && role.LeaderWorkerSet != nil)

		if useLwsSize {
			sizePerReplica := int32(1)
			if role.LeaderWorkerSet != nil && role.LeaderWorkerSet.Size != nil && *role.LeaderWorkerSet.Size > 0 {
				sizePerReplica = *role.LeaderWorkerSet.Size
			}
			ret += int(sizePerReplica * *role.Replicas)
		} else {
			ret += int(*role.Replicas)
		}

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.

[Bug] pod group support instance

1 participant