Skip to content

Make status comment revisions monotonic #140

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

Closed
trask wants to merge 1 commit into from
+49 −1
Closed

Make status comment revisions monotonic #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion .github/scripts/pull-request-dashboard/pr_status_comment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,10 @@ def prepare_rollout_state(
rollout_state: dict[str, Any],
open_pr_numbers: set[int],
) -> dict[str, Any]:
if rollout_state.get("target_revision") != STATUS_COMMENT_REVISION:
target_revision = int(rollout_state.get("target_revision") or 0)
if target_revision > STATUS_COMMENT_REVISION:
return dict(rollout_state)
if target_revision < STATUS_COMMENT_REVISION:
return {
"target_revision": STATUS_COMMENT_REVISION,
"completed_revision": int(rollout_state.get("completed_revision") or 0),
Expand Down Expand Up @@ -396,6 +399,12 @@ def update_status_comments_from_state(
return []

saved_rollout_state = load_status_comment_rollout_state()
if saved_rollout_state.get("target_revision", 0) > STATUS_COMMENT_REVISION:
print(
"status comment rollout targets a newer renderer revision; skipping stale worker",
file=sys.stderr,
)
return []
queued_pr_numbers = set(saved_rollout_state.get("pending_pr_numbers") or [])
rollout_state = prepare_rollout_state(saved_rollout_state, open_pr_numbers)
pending_pr_numbers = set(rollout_state["pending_pr_numbers"]) | queued_pr_numbers
Expand Down
39 changes: 39 additions & 0 deletions .github/scripts/pull-request-dashboard/test_pr_status_comment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,45 @@ def test_current_revision_drops_closed_prs_from_queue(self) -> None:

self.assertEqual([34], state["pending_pr_numbers"])

def test_older_revision_preserves_newer_rollout_state(self) -> None:
newer_state = {
"target_revision": pr_status_comment.STATUS_COMMENT_REVISION + 1,
"completed_revision": pr_status_comment.STATUS_COMMENT_REVISION,
"pending_pr_numbers": [12, 34],
}

state = pr_status_comment.prepare_rollout_state(newer_state, {34, 56})

self.assertEqual(newer_state, state)

@patch.object(pr_status_comment, "save_status_comment_rollout_state")
@patch.object(pr_status_comment, "publish_pr_status")
@patch.object(pr_status_comment, "load_dashboard_state_cache", return_value={"prs": {}})
@patch.object(
pr_status_comment,
"load_status_comment_rollout_state",
return_value={
"target_revision": pr_status_comment.STATUS_COMMENT_REVISION + 1,
"completed_revision": pr_status_comment.STATUS_COMMENT_REVISION,
"pending_pr_numbers": [12, 34],
},
)
def test_older_revision_does_not_publish_or_mutate_newer_rollout(
self,
_load_rollout: object,
_load_dashboard: object,
publish_pr_status: Mock,
save_rollout: Mock,
) -> None:
status = pr_status_comment.update_status_comments_from_state(
"open-telemetry/example",
{12, 34},
)

self.assertEqual([], status)
publish_pr_status.assert_not_called()
save_rollout.assert_not_called()

@patch.object(pr_status_comment, "save_status_comment_rollout_state")
@patch.object(pr_status_comment, "publish_pr_status")
@patch.object(pr_status_comment, "load_dashboard_state_cache", return_value={"prs": {}})
Expand Down