Skip to content

improve feature analysis loading #663

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

Merged
openshift-merge-bot merged 3 commits into from
Feb 28, 2025
Merged

improve feature analysis loading #663

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d3dead
if the feature analysis takes longer than 15 sec, return a wait and c…
hoxhaeris Feb 28, 2025
cdff93f
improve the wait message
hoxhaeris Feb 28, 2025
b72a6f5
fix lint
hoxhaeris Feb 28, 2025
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
295 changes: 184 additions & 111 deletions cmd/release-controller-api/http.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1010,131 +1010,204 @@ func (c *Controller) httpFeatureInfo(w http.ResponseWriter, req *http.Request) {
if from == "" {
from = "the last version"
}
klog.V(4).Infof("running feature anaysis: Tag %s from %s at %s\n:", tagInfo.Tag, from, time.Now())
featureTrees, err := c.releaseFeatureInfo(tagInfo)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
klog.V(4).Infof("running feature anaysis: Tag %s from %s at %s\n", tagInfo.Tag, from, time.Now())

var (
buf bytes.Buffer
completedFeatures []*FeatureTree
unCompletedFeatures []*FeatureTree
completedEpicWithoutFeature []*FeatureTree
unCompletedEpicWithoutFeature []*FeatureTree
completedNoEpicNoFeature []*FeatureTree
unCompletedNoEpicNoFeature []*FeatureTree
)

for _, feature := range featureTrees {
if !unlinkedIssuesSections.Has(feature.NotLinkedType) {
if feature.IncludedInBuild {
completedFeatures = append(completedFeatures, feature)
} else {
unCompletedFeatures = append(unCompletedFeatures, feature)
}
}
if feature.NotLinkedType == sectionTypeNoFeatureWithEpic {
if feature.IncludedInBuild {
completedEpicWithoutFeature = append(completedEpicWithoutFeature, feature)
} else {
unCompletedEpicWithoutFeature = append(unCompletedEpicWithoutFeature, feature)
}
// Channels to receive the rendered HTML or an error.
resultChan := make(chan []byte, 1)
errChan := make(chan error, 1)

go func() {
var buf bytes.Buffer

featureTrees, err := c.releaseFeatureInfo(tagInfo)
if err != nil {
errChan <- err
return
}
if feature.NotLinkedType == sectionTypeNoEpicNoFeature {
if feature.IncludedInBuild {
completedNoEpicNoFeature = append(completedNoEpicNoFeature, feature)
} else {
unCompletedNoEpicNoFeature = append(unCompletedNoEpicNoFeature, feature)

var (
completedFeatures []*FeatureTree
unCompletedFeatures []*FeatureTree
completedEpicWithoutFeature []*FeatureTree
unCompletedEpicWithoutFeature []*FeatureTree
completedNoEpicNoFeature []*FeatureTree
unCompletedNoEpicNoFeature []*FeatureTree
)

for _, feature := range featureTrees {
if !unlinkedIssuesSections.Has(feature.NotLinkedType) {
if feature.IncludedInBuild {
completedFeatures = append(completedFeatures, feature)
} else {
unCompletedFeatures = append(unCompletedFeatures, feature)
}
}
if feature.NotLinkedType == sectionTypeNoFeatureWithEpic {
if feature.IncludedInBuild {
completedEpicWithoutFeature = append(completedEpicWithoutFeature, feature)
} else {
unCompletedEpicWithoutFeature = append(unCompletedEpicWithoutFeature, feature)
}
}
if feature.NotLinkedType == sectionTypeNoEpicNoFeature {
if feature.IncludedInBuild {
completedNoEpicNoFeature = append(completedNoEpicNoFeature, feature)
} else {
unCompletedNoEpicNoFeature = append(unCompletedNoEpicNoFeature, feature)
}
}
}
}
for _, s := range [][]*FeatureTree{completedFeatures, unCompletedFeatures, completedEpicWithoutFeature, unCompletedEpicWithoutFeature} {
sortByTitle(s)
// TODO - check this, should be moot, since every leaf has a PR linked to it
//sortByPRs(s, 1000)
}

var sections []SectionInfo
for _, s := range [][]*FeatureTree{
completedFeatures,
unCompletedFeatures,
completedEpicWithoutFeature,
unCompletedEpicWithoutFeature,
} {
sortByTitle(s)
// sortByPRs(s, 1000)
}

var sections []SectionInfo

completed := Sections{
Tickets: completedFeatures,
Title: "Lists of features that were completed when this image was built",
Header: "Complete Features",
Note: "These features were completed when this image was assembled",
}
unCompleted := Sections{
Tickets: unCompletedFeatures,
Title: "Lists of features that were not completed when this image was built",
Header: "Incomplete Features",
Note: "When this image was assembled, these features were not yet completed. Therefore, only the Jira Cards included here are part of this release",
}
completedEpicWithoutFeatureSection := Sections{
Tickets: completedEpicWithoutFeature,
Title: "",
Header: "Complete Epics",
Note: "This section includes Jira cards that are linked to an Epic, but the Epic itself is not linked to any Feature. These epics were completed when this image was assembled",
}
unCompletedEpicWithoutFeatureSection := Sections{
Tickets: unCompletedEpicWithoutFeature,
Title: "",
Header: "Incomplete Epics",
Note: "This section includes Jira cards that are linked to an Epic, but the Epic itself is not linked to any Feature. These epics were not completed when this image was assembled",
}
completedNoEpicNoFeatureSection := Sections{
Tickets: completedNoEpicNoFeature,
Title: "",
Header: "Other Complete",
Note: "This section includes Jira cards that are not linked to either an Epic or a Feature. These tickets were completed when this image was assembled",
}
unCompletedNoEpicNoFeatureSection := Sections{
Tickets: unCompletedNoEpicNoFeature,
Title: "",
Header: "Other Incomplete",
Note: "This section includes Jira cards that are not linked to either an Epic or a Feature. These tickets were not completed when this image was assembled",
}

// the key needs to be a unique value per section
for _, section := range []SectionInfo{
{"completed_features", completed},
{"uncompleted_features", unCompleted},
{"completed_epic_without_feature", completedEpicWithoutFeatureSection},
{"uncompleted_epic_without_feature", unCompletedEpicWithoutFeatureSection},
{"completed_no_epic_no_feature", completedNoEpicNoFeatureSection},
{"uncompleted_no_epic_no_feature", unCompletedNoEpicNoFeatureSection},
} {
if len(section.Section.Tickets) > 0 {
sections = append(sections, section)
}
}

// define the UI sections
completed := Sections{
Tickets: completedFeatures,
Title: "Lists of features that were completed when this image was built",
Header: "Complete Features",
Note: "These features were completed when this image was assembled",
}
unCompleted := Sections{
Tickets: unCompletedFeatures,
Title: "Lists of features that were not completed when this image was built",
Header: "Incomplete Features",
Note: "When this image was assembled, these features were not yet completed. Therefore, only the Jira Cards included here are part of this release",
}
completedEpicWithoutFeatureSection := Sections{
Tickets: completedEpicWithoutFeature,
Title: "",
Header: "Complete Epics",
Note: "This section includes Jira cards that are linked to an Epic, but the Epic itself is not linked to any Feature. These epics were completed when this image was assembled",
}
unCompletedEpicWithoutFeatureSection := Sections{
Tickets: unCompletedEpicWithoutFeature,
Title: "",
Header: "Incomplete Epics",
Note: "This section includes Jira cards that are linked to an Epic, but the Epic itself is not linked to any Feature. These epics were not completed when this image was assembled",
}
completedNoEpicNoFeatureSection := Sections{
Tickets: completedNoEpicNoFeature,
Title: "",
Header: "Other Complete",
Note: "This section includes Jira cards that are not linked to either an Epic or a Feature. These tickets were completed when this image was assembled",
}
unCompletedNoEpicNoFeatureSection := Sections{
Tickets: unCompletedNoEpicNoFeature,
Title: "",
Header: "Other Incomplete",
Note: "This section includes Jira cards that are not linked to either an Epic or a Feature. These tickets were not completed when this image was assembled",
}
data := template.Must(template.New("featureRelease.html").Funcs(
template.FuncMap{
"jumpLinks": jumpLinks,
"includeKey": includeKey,
},
).ParseFS(resources, "featureRelease.html"))

// the key needs to be a unique value per section
for _, section := range []SectionInfo{
{"completed_features", completed},
{"uncompleted_features", unCompleted},
{"completed_epic_without_feature", completedEpicWithoutFeatureSection},
{"uncompleted_epic_without_feature", unCompletedEpicWithoutFeatureSection},
{"completed_no_epic_no_feature", completedNoEpicNoFeatureSection},
{"uncompleted_no_epic_no_feature", unCompletedNoEpicNoFeatureSection},
} {
if len(section.Section.Tickets) > 0 {
sections = append(sections, section)
err = data.Execute(&buf, httpFeatureData{
DisplaySections: sections,
To: tagInfo.Tag,
From: from,
})
if err != nil {
errChan <- err
return
}
}

data := template.Must(template.New("featureRelease.html").Funcs(
template.FuncMap{
"jumpLinks": jumpLinks,
"includeKey": includeKey,
},
).ParseFS(resources, "featureRelease.html"))

err = data.Execute(&buf, httpFeatureData{
DisplaySections: sections,
To: tagInfo.Tag,
From: from,
})
klog.V(4).Infof("finished running feature anaysis: Tag %s from %s at %s\n", tagInfo.Tag, from, time.Now())
resultChan <- buf.Bytes()
}()

if err != nil {
select {
case res := <-resultChan:
w.Header().Set("Content-Type", "text/html;charset=UTF-8")
if _, err := w.Write(res); err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
}
case err := <-errChan:
klog.Errorf("Unable to render page: %v", err)
http.Error(w, "Unable to render page", http.StatusInternalServerError)
return
}

w.Header().Set("Content-Type", "text/html;charset=UTF-8")
if _, err := w.Write(buf.Bytes()); err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
case <-time.After(15 * time.Second):
w.Header().Set("Content-Type", "text/html;charset=UTF-8")
w.WriteHeader(http.StatusGatewayTimeout)
// Return HTML with a meta refresh so the page reloads automatically.
_, err = w.Write([]byte(`
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta http-equiv="refresh" content="20">
<title>Processing...</title>
<style>
body {
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
background: #f0f4f8;
margin: 0;
display: flex;
align-items: center;
justify-content: center;
height: 100vh;
}
.container {
background: #ffffff;
padding: 30px 40px;
border-radius: 10px;
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15);
text-align: center;
max-width: 600px;
}
h1 {
margin-top: 0;
color: #333;
}
p {
font-size: 1.1em;
line-height: 1.6;
color: #555;
margin: 20px 0;
}
</style>
</head>
<body>
<div class="container">
<h1>Processing...</h1>
<p>The request is taking longer than expected.</p>
<p>If this is the first time loading, it might take multiple minutes to gather all data.</p>
<p>This page will automatically reload once processing is complete. Please wait...</p>
</div>
</body>
</html>

`))
if err != nil {
return
}
klog.Warningf("Feature analysis taking too long: Tag %s from %s", tagInfo.Tag, from)
}
klog.V(4).Infof("finished running feature anaysis: Tag %s from %s at %s\n:", tagInfo.Tag, from, time.Now())
}

func includeKey(key string) bool {
Expand Down