Skip to content

Update verify-feature-promotion HTML output to sort entries and fix overflow #2793

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.

Sign up for GitHub

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

Open
JoelSpeed wants to merge 2 commits into
base: master
Choose a base branch
from
+33 −13
Open

Update verify-feature-promotion HTML output to sort entries and fix overflow #2793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7d84d8
Use static ordering of job variants in HTML output
JoelSpeed Apr 2, 2026
7480ccd
Add extra padding to avoid table being cut-off
JoelSpeed Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 32 additions & 13 deletions tools/codegen/cmd/featuregate-test-analyzer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,18 +262,10 @@ func (o *FeatureGateTestAnalyzerOptions) Run(ctx context.Context) error {

func buildHTMLFeatureGateData(name string, testingResults map[JobVariant]*TestingResults, blockingErrors []error, release string) utils.HTMLFeatureGate {
jobVariantsSet := sets.KeySet(testingResults)
jobVariants := jobVariantsSet.UnsortedList()
jobVariants := OrderedJobVariants(jobVariantsSet.UnsortedList())

sort.Sort(jobVariants)

// For HTML sort so that the network stacks are in the same order.
var networkStackOrder = map[string]int{
"": 0,
"ipv4": 1,
"ipv6": 2,
"dual": 3,
}
sort.SliceStable(jobVariants, func(i, j int) bool {
return networkStackOrder[jobVariants[i].NetworkStack] < networkStackOrder[jobVariants[j].NetworkStack]
})
variants := make([]utils.HTMLVariantColumn, 0, len(jobVariants))
for i, jv := range jobVariants {
variants = append(variants, utils.HTMLVariantColumn{
Expand Down Expand Up @@ -645,14 +637,41 @@ func (a OrderedJobVariants) Less(i, j int) bool {
return false
}

// Map these to an ordered list of strings so that we can define the order
// rather than them being alphabetical.
var networkStackOrder = map[string]string{
"": "0",
"ipv4": "1",
"ipv6": "2",
"dual": "3",
}

if strings.Compare(networkStackOrder[a[i].NetworkStack], networkStackOrder[a[j].NetworkStack]) < 0 {
return true
} else if strings.Compare(networkStackOrder[a[i].NetworkStack], networkStackOrder[a[j].NetworkStack]) > 0 {
return false
}

if strings.Compare(a[i].OS, a[j].OS) < 0 {
return true
} else if strings.Compare(a[i].OS, a[j].OS) > 0 {
return false
}

if strings.Compare(a[i].JobTiers, a[j].JobTiers) < 0 {
return true
} else if strings.Compare(a[i].JobTiers, a[j].JobTiers) > 0 {
return false
}

return false
Comment on lines +655 to 667
Copy link
Copy Markdown

@qodo-code-review qodo-code-review bot Apr 2, 2026

Choose a reason for hiding this comment

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

Action required

1. Optional not in sort 🐞 Bug ≡ Correctness

OrderedJobVariants.Less() never compares JobVariant.Optional, so two distinct variants that
differ only by Optional are treated as equal and sort.Sort may emit them in a non-deterministic
order when the input comes from UnsortedList(). This can break the PR goal of stable HTML/Markdown
column ordering if optional/required variants share the same other fields.
Agent Prompt 
### Issue description
`OrderedJobVariants.Less()` does not include `JobVariant.Optional` in its comparison chain. That means two distinct variants that only differ by `Optional` compare equal, and since inputs come from `UnsortedList()` the final ordering can still vary across runs.

### Issue Context
Both HTML and Markdown outputs sort variants derived from a set/map key list.

### Fix Focus Areas
- tools/codegen/cmd/featuregate-test-analyzer.go[621-668]

### Suggested fix
Add a final comparison for `Optional` (and keep it last so it only affects ties), e.g.:
- if `a[i].Optional != a[j].Optional`, return `!a[i].Optional && a[j].Optional` (non-optional first)

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

}

type TestingResults struct {
JobVariant JobVariant

TestResults []TestResults
HasCandidateTierResults bool // true if candidate-tier queries returned any test data
TestResults []TestResults
HasCandidateTierResults bool // true if candidate-tier queries returned any test data
}

type TestResults struct {
Expand Down
1 change: 1 addition & 0 deletions tools/codegen/pkg/utils/html.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ const HTMLTemplateSrc = `<!DOCTYPE html>
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<style>
body { padding: 20px; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif; }
.container-fluid { padding-bottom: 20px; }
.sortable { cursor: pointer; user-select: none; }
.sortable:hover { background-color: #e9ecef; }
.sort-indicator::after { content: ' \2195'; opacity: 0.3; font-size: 0.8em; }
Expand Down