Skip to content

MDBF-1226: Make duplicate push builds yield to PR builds #979

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
RazvanLiviuVarzaru merged 2 commits into from
Jun 25, 2026
Merged

MDBF-1226: Make duplicate push builds yield to PR builds #979

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d757205
Make duplicate push builds yield to PR builds
RazvanLiviuVarzaru Jun 23, 2026
e409eb5
Refactor branch cancellation logic to provide detailed rejection reasons
RazvanLiviuVarzaru Jun 25, 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
296 changes: 173 additions & 123 deletions utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
from buildbot.plugins import steps, util, worker
from buildbot.process.builder import Builder
from buildbot.process.buildstep import BuildStep
from buildbot.process.results import FAILURE, SUCCESS
from buildbot.process.results import CANCELLED, FAILURE, SUCCESS
from buildbot.process.workerforbuilder import AbstractWorkerForBuilder
from buildbot.worker import AbstractWorker
from constants import (
Expand Down Expand Up @@ -682,20 +682,27 @@ def mtrEnv(props: IProperties) -> dict:


class CancelDuplicateBuildRequests(BuildStep):
"""BuildStep to cancel duplicate buildrequests for the same commit on the same builder
if the current build is for a pull request event. It checks for other pending buildrequests
with the same builder and if they have a sourcestamp with the same revision as
the current build, it cancels them. It only cancels normal branch builds, not other
pull request refs, and avoids important branches like main, release or merge branches.
"""Stop duplicate push builds when a matching pull request build exists.

When GitHub sends push and pull_request events for the same commit, both can
queue tarball-docker requests. A normal branch push should yield to a matching
pull request buildrequest on the same builder.
"""

name = "cancel duplicate buildrequests"
description = ["checking duplicate buildrequests"]
descriptionDone = ["duplicate buildrequests checked"]

def __init__(self, dry_run=False, buildbot_base_url=None, **kwargs):
def __init__(
self,
dry_run=False,
buildbot_base_url=None,
recent_completed_limit=10,
**kwargs,
):
super().__init__(**kwargs)
self.dry_run = dry_run
self.recent_completed_limit = recent_completed_limit
self.buildbot_base_url = (
buildbot_base_url.rstrip("/") if buildbot_base_url else None
)
Expand All @@ -716,19 +723,93 @@ def _fmt_ss(ss):
)

@staticmethod
def _branch_is_cancelable(branch):
"""Only cancel duplicate builds originating from normal branch pushes."""
def _branch_rejection_reasons(branch):
"""Explain why a branch push must not yield to a pull request build."""
reasons = []

if not branch:
return False
return ["branch is missing"]

branch_lc = branch.lower()
return (
len(branch) > 5
and not branch_lc.startswith("refs/")
and "release" not in branch_lc
and "merge" not in branch_lc
and "preview" not in branch_lc
)
if len(branch) <= 5:
reasons.append(
f"branch is only {len(branch)} characters; it must be longer than 5"
)
if branch_lc.startswith("refs/"):
reasons.append("branch starts with 'refs/'")

matching_patterns = [
pattern
for pattern in SAVED_PACKAGE_BRANCHES
if fnmatch.fnmatch(branch, pattern)
]
if matching_patterns:
reasons.append(
f"branch matches saved-package pattern(s) {matching_patterns!r}"
)

return reasons

@classmethod
def _branch_is_cancelable(cls, branch):
"""Only let disposable normal branch pushes yield to pull request builds."""
return not cls._branch_rejection_reasons(branch)

@classmethod
def _sourcestamp_rejection_reasons(cls, ss):
reasons = []
if ss.get("revision") is None:
reasons.append("revision is missing")
reasons.extend(cls._branch_rejection_reasons(ss.get("branch")))
return reasons

@defer.inlineCallbacks
def _find_pull_request_matches(self, buildrequests, current_targets, source):
matches = []

for br in buildrequests:
other_buildsetid = br["buildsetid"]
other_buildset = yield self.master.data.get(("buildsets", other_buildsetid))
other_sourcestamps = other_buildset.get("sourcestamps", [])

matched_revision = None
matched_branch = None

for other_ss in other_sourcestamps:
other_revision = other_ss.get("revision")
other_branch = other_ss.get("branch")
other_target = (
other_revision,
other_ss.get("repository"),
other_ss.get("codebase", ""),
)

if not other_branch or not other_branch.startswith("refs/pull/"):
continue

if other_target in current_targets:
matched_revision = other_revision
matched_branch = other_branch
break

if matched_revision is None:
continue

matches.append(
{
"buildrequestid": br["buildrequestid"],
"claimed": br.get("claimed"),
"complete": br.get("complete"),
"buildsetid": other_buildsetid,
"revision": matched_revision,
"branch": matched_branch,
"url": self._buildrequest_url(br["buildrequestid"]),
"sourcestamps": other_sourcestamps,
"source": source,
}
)

return matches

@defer.inlineCallbacks
def run(self):
Expand All @@ -744,8 +825,8 @@ def run(self):
self.addCompleteLog("duplicate-buildrequests", "\n".join(lines) + "\n")
return SUCCESS

if event != "pull_request":
lines.append("Event is not 'pull_request'; nothing to do.")
if event != "push":
lines.append("Event is not 'push'; nothing to do.")
self.addCompleteLog("duplicate-buildrequests", "\n".join(lines) + "\n")
return SUCCESS

Expand All @@ -768,16 +849,23 @@ def run(self):
self.addCompleteLog("duplicate-buildrequests", "\n".join(lines) + "\n")
return SUCCESS

current_revisions = {
ss.get("revision")
current_targets = {
(ss.get("revision"), ss.get("repository"), ss.get("codebase", ""))
for ss in current_sourcestamps
if ss.get("revision") is not None
and self._branch_is_cancelable(ss.get("branch"))
}

if not current_revisions:
if not current_targets:
lines.append(
"Current buildset has no revision in sourcestamps; nothing to do."
"No current sourcestamp is eligible for duplicate cancellation; "
"nothing to do."
)
lines.append("Sourcestamp rejection details:")
for i, ss in enumerate(current_sourcestamps, 1):
reasons = self._sourcestamp_rejection_reasons(ss)
lines.append(f" [{i}] {self._fmt_ss(ss)}")
lines.extend(f" - {reason}" for reason in reasons)
self.addCompleteLog("duplicate-buildrequests", "\n".join(lines) + "\n")
return SUCCESS

Expand All @@ -787,20 +875,12 @@ def run(self):
if ss.get("branch") is not None
}

if not any(branch.startswith("refs/pull/") for branch in current_branches):
lines.append(
"Current build is a pull_request event, but no pull request ref "
"was found in sourcestamps; nothing to do."
)
self.addCompleteLog("duplicate-buildrequests", "\n".join(lines) + "\n")
return SUCCESS

lines.append("Current:")
lines.append(f" buildid={current_buildid}")
lines.append(f" buildrequestid={current_buildrequestid}")
lines.append(f" builderid={current_builderid}")
lines.append(f" buildsetid={current_buildsetid}")
lines.append(f" revisions={sorted(current_revisions)!r}")
lines.append(f" targets={sorted(current_targets)!r}")
lines.append(f" branches={sorted(current_branches)!r}")
current_url = self._buildrequest_url(current_buildrequestid)
if current_url:
Expand All @@ -810,6 +890,13 @@ def run(self):
lines.append(f" [{i}] {self._fmt_ss(ss)}")
lines.append("")

buildrequest_fields = [
"buildrequestid",
"buildsetid",
"builderid",
"claimed",
"complete",
]
filters = [
Filter("complete", "eq", [False]),
Filter("builderid", "eq", [current_builderid]),
Expand All @@ -818,105 +905,62 @@ def run(self):
buildrequests = yield self.master.data.get(
("buildrequests",),
filters=filters,
fields=[
"buildrequestid",
"buildsetid",
"builderid",
"claimed",
"complete",
],
fields=buildrequest_fields,
)

matches = []
actions = []
cancel_errors = []

for br in buildrequests:
brid = br["buildrequestid"]

# skip self
if brid == current_buildrequestid:
continue

other_buildsetid = br["buildsetid"]
other_buildset = yield self.master.data.get(("buildsets", other_buildsetid))
other_sourcestamps = other_buildset.get("sourcestamps", [])

matched_revision = None
matched_branch = None

for other_ss in other_sourcestamps:
other_revision = other_ss.get("revision")
other_branch = other_ss.get("branch")

if other_revision not in current_revisions:
continue

if not self._branch_is_cancelable(other_branch):
continue

matched_revision = other_revision
matched_branch = other_branch
break

if matched_revision is None:
continue
matches = yield self._find_pull_request_matches(
[
br
for br in buildrequests
if br["buildrequestid"] != current_buildrequestid
],
current_targets,
"incomplete",
)

info = {
"buildrequestid": brid,
"claimed": br.get("claimed"),
"complete": br.get("complete"),
"buildsetid": other_buildsetid,
"revision": matched_revision,
"branch": matched_branch,
"url": self._buildrequest_url(brid),
"sourcestamps": other_sourcestamps,
}
matches.append(info)
if not matches:
filters = [
Filter("complete", "eq", [True]),
Filter("builderid", "eq", [current_builderid]),
]
buildrequests = yield self.master.data.get(
("buildrequests",),
filters=filters,
fields=buildrequest_fields,
order=["-buildrequestid"],
limit=self.recent_completed_limit,
)
matches = yield self._find_pull_request_matches(
buildrequests,
current_targets,
"recent-completed",
)

actions = []
for info in matches:
brid = info["buildrequestid"]
if self.dry_run:
msg = (
f"[DRY-RUN] would cancel buildrequest {brid} "
f"(claimed={br.get('claimed')}, "
f"revision={matched_revision!r}, "
f"branch={matched_branch!r})"
f"[DRY-RUN] would stop current build "
f"because pull request buildrequest {brid} exists "
f"(source={info['source']}, "
f"claimed={info['claimed']}, "
f"revision={info['revision']!r}, "
f"branch={info['branch']!r})"
)
if info["url"]:
msg += f" url={info['url']}"
actions.append(msg)
else:
try:
yield self.master.data.control(
"cancel",
{"reason": "Duplicate build for same commit on same builder"},
("buildrequests", brid),
)
except Exception as e:
msg = (
f"Failed to request cancel for buildrequest {brid} "
f"(claimed={br.get('claimed')}, "
f"revision={matched_revision!r}, "
f"branch={matched_branch!r}, "
f"error={e!r})"
)
if info["url"]:
msg += f" url={info['url']}"
actions.append(msg)
cancel_errors.append(msg)
log.err(e, f"Failed to request cancel for buildrequest {brid}")
else:
msg = (
f"Requested cancel for buildrequest {brid} "
f"(claimed={br.get('claimed')}, "
f"revision={matched_revision!r}, "
f"branch={matched_branch!r})"
)
if info["url"]:
msg += f" url={info['url']}"
actions.append(msg)
msg = (
f"Stopping current build because pull request buildrequest {brid} "
f"exists (source={info['source']}, "
f"claimed={info['claimed']}, "
f"revision={info['revision']!r}, "
f"branch={info['branch']!r})"
)
if info["url"]:
msg += f" url={info['url']}"
actions.append(msg)

lines.append(f"Matched duplicate buildrequests: {len(matches)}")
lines.append(f"Cancel request failures: {len(cancel_errors)}")
lines.append(f"Matched pull request buildrequests: {len(matches)}")
lines.append("")

if matches:
Expand All @@ -926,6 +970,7 @@ def run(self):
lines.append(f" claimed={m['claimed']}")
lines.append(f" complete={m['complete']}")
lines.append(f" buildsetid={m['buildsetid']}")
lines.append(f" source={m['source']}")
lines.append(f" revision={m['revision']!r}")
lines.append(f" branch={m['branch']!r}")
if m["url"]:
Expand All @@ -934,9 +979,14 @@ def run(self):
lines.append("Actions:")
lines.extend(f" {a}" for a in actions)
else:
lines.append("No matching cancelable buildrequests found on this builder.")
lines.append(
"No matching pull request buildrequests found on this builder."
)

self.addCompleteLog("duplicate-buildrequests", "\n".join(lines) + "\n")
if matches and not self.dry_run:
self.build.stopBuild("Superseded by pull request build for same commit")
return CANCELLED
return SUCCESS


Expand Down