Skip to content
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

fix: UI Jobs streams are not cleaned up after PR is closed #5359

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+6 −4
Open

fix: UI Jobs streams are not cleaned up after PR is closed #5359

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
139ae74
Update pull_closed_executor.go
joe1981al Feb 24, 2025
c9c3f4e
updated with gofmt
joe1981al Feb 24, 2025
b2d2df6
Merge branch 'main' into main
X-Guardian Feb 25, 2025
60df52d
Merge branch 'main' into main
jamengual Feb 26, 2025
0bc42d5
Merge branch 'main' into main
joe1981al Mar 4, 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
10 changes: 6 additions & 4 deletions server/events/pull_closed_executor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,12 @@ func (p *PullClosedExecutor) CleanUpPull(logger logging.SimpleLogging, repo mode
if pullStatus != nil {
for _, project := range pullStatus.Projects {
jobContext := jobs.PullInfo{
PullNum: pull.Num,
Repo: pull.BaseRepo.Name,
Workspace: project.Workspace,
ProjectName: project.ProjectName,
PullNum: pull.Num,
Repo: pull.BaseRepo.Name,
RepoFullName: pull.BaseRepo.FullName,
ProjectName: project.ProjectName,
Path: project.RepoRelDir,
Workspace: project.Workspace,
Comment on lines +90 to +95
Copy link
Member

Choose a reason for hiding this comment

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

can you also add unit tests for such changes?

Copy link
Author

Choose a reason for hiding this comment

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

@chenrui333, I'm not deeply familiar with go unit testing, but it looks like there are test around this, but problem was not enough information was being passed to match what was actually in the map, so it thought everything related was being cleaned up but it was not matching the actual entry.

Copy link
Author

Choose a reason for hiding this comment

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

More details, on debugging done on p.LogStreamResourceCleaner.CleanUp(jobContext) that this calls.

I added more logging to see what the contents of the map p.pullToJobMapping, and this is what I had (removing identifying info):

{
 "{54106 repo azureorg/project/repo  terraform/project/path default}": {
  "0cea6de8-5618-405f-b819-42d377b6f5ae": {
   "JobID": "0cea6de8-5618-405f-b819-42d377b6f5ae",
   "JobIDUrl": "",
   "JobDescription": "",
   "Time": "2025-02-21T12:44:55.947183432-06:00",
   "TimeFormatted": "",
   "JobStep": "plan"
  }
 }
}

but looking at the input to the function:

jobs.PullInfo {PullNum: 54106, Repo: "repo", RepoFullName: "", ProjectName: "", Path: "", Workspace: "default"}

Some of the objects in the key were not included in the input, so the if statement for the matching was just skipping the removal since no maps matched and there are no checks to make sure items related to a pull are removed from the mapping.

}
p.LogStreamResourceCleaner.CleanUp(jobContext)
}
Expand Down
Loading