Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
62 changes: 44 additions & 18 deletions .github/scripts/issue-review/common.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import crypto from "node:crypto";

export const ISSUE_REVIEW_SCHEMA_VERSION = 3;
export const ISSUE_REVIEW_SCHEMA_VERSION = 4;
export const PREFIXED_TITLE = /^[a-z][a-z0-9-]*(?:\/[a-z][a-z0-9-]*)*: \S.*$/;

export function sha256(value) {
Expand All @@ -11,6 +11,26 @@ function blocker(code, message) {
return { source: "issue-format", code, message };
}

function normalizeIssueReferences(references, defaultRepository) {
return [...new Map((Array.isArray(references) ? references : [])
.map((reference) => ({
repository: String(reference?.repository ?? defaultRepository),
number: Number(reference?.number),
state: String(reference?.state ?? "OPEN").toUpperCase(),
}))
.filter((reference) => (
reference.repository
&& Number.isSafeInteger(reference.number)
))
.map((reference) => [
`${reference.repository.toLowerCase()}#${reference.number}`,
reference,
])).values()].sort((left, right) => (
left.repository.localeCompare(right.repository)
|| left.number - right.number
));
}

export function issueSnapshot(issue) {
const repository = String(issue.repository ?? "");
const rawSubIssues = Array.isArray(issue.sub_issues)
Expand All @@ -20,23 +40,9 @@ export function issueSnapshot(issue) {
number,
state: "OPEN",
}));
const subIssues = [...new Map(rawSubIssues
.map((subIssue) => ({
repository: String(subIssue?.repository ?? repository),
number: Number(subIssue?.number),
state: String(subIssue?.state ?? "OPEN").toUpperCase(),
}))
.filter((subIssue) => (
subIssue.repository
&& Number.isSafeInteger(subIssue.number)
))
.map((subIssue) => [
`${subIssue.repository.toLowerCase()}#${subIssue.number}`,
subIssue,
])).values()].sort((left, right) => (
left.repository.localeCompare(right.repository)
|| left.number - right.number
));
const subIssues = normalizeIssueReferences(rawSubIssues, repository);
const blockedBy = normalizeIssueReferences(issue.blocked_by, repository);
const blocking = normalizeIssueReferences(issue.blocking, repository);
return {
repository,
number: Number(issue.number),
Expand All @@ -51,6 +57,14 @@ export function issueSnapshot(issue) {
: Number(issue.sub_issue_count),
sub_issue_numbers: subIssues.map((subIssue) => subIssue.number),
sub_issues: subIssues,
blocked_by_count: issue.blocked_by_count == null
? blockedBy.length
: Number(issue.blocked_by_count),
blocked_by: blockedBy,
blocking_count: issue.blocking_count == null
? blocking.length
: Number(issue.blocking_count),
blocking,
};
}

Expand All @@ -73,6 +87,18 @@ export function analyzeIssue(issue) {
"The workflow could not snapshot every native sub-issue and must fail closed.",
));
}
if (snapshot.blocked_by_count > snapshot.blocked_by.length) {
blockers.push(blocker(
"blocked-by-truncated",
"The workflow could not snapshot every native blocking prerequisite and must fail closed.",
));
}
if (snapshot.blocking_count > snapshot.blocking.length) {
blockers.push(blocker(
"blocking-truncated",
"The workflow could not snapshot every natively blocked Issue and must fail closed.",
));
}

return {
schema_version: ISSUE_REVIEW_SCHEMA_VERSION,
Expand Down
71 changes: 71 additions & 0 deletions .github/scripts/issue-review/test.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
import assert from "node:assert/strict";
import {
analyzeIssue,
issueSnapshot,
issueSnapshotSha256,
ISSUE_REVIEW_SCHEMA_VERSION,
} from "./common.mjs";

const validBody = [
Expand Down Expand Up @@ -39,7 +41,12 @@ const valid = {
parent_number: null,
sub_issue_numbers: [],
sub_issues: [],
blocked_by_count: 0,
blocked_by: [],
blocking_count: 0,
blocking: [],
};
assert.equal(ISSUE_REVIEW_SCHEMA_VERSION, 4);
assert.deepEqual(analyzeIssue(valid).deterministic_blockers, []);
assert.equal(issueSnapshotSha256(valid), issueSnapshotSha256({ ...valid }));
assert.notEqual(
Expand All @@ -54,6 +61,56 @@ assert.notEqual(
issueSnapshotSha256(valid),
issueSnapshotSha256({ ...valid, state: "CLOSED" }),
);
const dependencies = {
...valid,
blocked_by_count: 3,
blocked_by: [
{ repository: "zeta/example", number: 20, state: "open" },
{ repository: "Alpha/example", number: 30, state: "CLOSED" },
{ repository: "zeta/example", number: 20, state: "open" },
{ repository: "Alpha/example", number: 10, state: "open" },
],
blocking_count: 1,
blocking: [
{ repository: "GizClaw/example", number: 40, state: "open" },
],
};
assert.deepEqual(issueSnapshot(dependencies).blocked_by, [
{ repository: "Alpha/example", number: 10, state: "OPEN" },
{ repository: "Alpha/example", number: 30, state: "CLOSED" },
{ repository: "zeta/example", number: 20, state: "OPEN" },
]);
assert.deepEqual(issueSnapshot(dependencies).blocking, [
{ repository: "GizClaw/example", number: 40, state: "OPEN" },
]);
assert.deepEqual(analyzeIssue(dependencies).deterministic_blockers, []);
assert.notEqual(
issueSnapshotSha256(dependencies),
issueSnapshotSha256({
...dependencies,
blocked_by: dependencies.blocked_by.map((dependency, index) => (
index === 1 ? { ...dependency, state: "OPEN" } : dependency
)),
}),
);
assert.notEqual(
issueSnapshotSha256(dependencies),
issueSnapshotSha256({
...dependencies,
blocked_by_count: 2,
blocked_by: dependencies.blocked_by.slice(1),
}),
);
assert.notEqual(
issueSnapshotSha256(dependencies),
issueSnapshotSha256({
...dependencies,
blocked_by_count: 0,
blocked_by: [],
blocking_count: dependencies.blocked_by_count,
blocking: dependencies.blocked_by,
}),
);
assert.ok(analyzeIssue({ ...valid, body_truncated: true })
.deterministic_blockers.some((item) => item.code === "issue-body-truncated"));
assert.deepEqual(
Expand All @@ -68,6 +125,20 @@ assert.ok(analyzeIssue({
}).deterministic_blockers.some(
(item) => item.code === "sub-issues-truncated",
));
assert.ok(analyzeIssue({
...valid,
blocked_by_count: 2,
blocked_by: [{ repository: valid.repository, number: 20, state: "OPEN" }],
}).deterministic_blockers.some(
(item) => item.code === "blocked-by-truncated",
));
assert.ok(analyzeIssue({
...valid,
blocking_count: 2,
blocking: [{ repository: valid.repository, number: 20, state: "OPEN" }],
}).deterministic_blockers.some(
(item) => item.code === "blocking-truncated",
));
assert.deepEqual(analyzeIssue({
...valid,
issue_type: "Task",
Expand Down
100 changes: 100 additions & 0 deletions .github/scripts/pr-readiness/test.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,15 @@ const input = {
issue_type: "Feature",
sub_issue_numbers: [],
sub_issues: [],
blocked_by_count: 2,
blocked_by: [
{ repository: "GizClaw/example", number: 9, state: "OPEN" },
{ repository: "Other/example", number: 30, state: "CLOSED" },
],
blocking_count: 1,
blocking: [
{ repository: "GizClaw/example", number: 20, state: "OPEN" },
],
}],
};
const context = {
Expand Down Expand Up @@ -88,6 +97,10 @@ const workflowSource = fs.readFileSync(
);
for (const source of [verifySource, workflowSource]) {
assert.match(source, /closingIssuesReferences\(first: 100\)/);
assert.match(source, /blockedBy\(first: 100\)/);
assert.match(source, /blocking\(first: 100\)/);
assert.match(source, /blocked_by_count:\s*issue\.blockedBy\.totalCount/);
assert.match(source, /blocking_count:\s*issue\.blocking\.totalCount/);
assert.doesNotMatch(source, /closingIssuesReferences\.nodes\s*\.slice\(/);
}
assert.deepEqual(context.readiness.deterministic_blockers, []);
Expand Down Expand Up @@ -238,6 +251,30 @@ assert.ok(blockerCodes(analyzePullRequest({
sub_issue_numbers: Array.from({ length: 100 }, (_, index) => index + 1),
}],
})).includes("sub-issues-truncated"));
assert.ok(blockerCodes(analyzePullRequest({
...input,
linked_issues: [{
...input.linked_issues[0],
blocked_by_count: 101,
blocked_by: Array.from({ length: 100 }, (_, index) => ({
repository: input.repository,
number: index + 1,
state: "OPEN",
})),
}],
})).includes("blocked-by-truncated"));
assert.ok(blockerCodes(analyzePullRequest({
...input,
linked_issues: [{
...input.linked_issues[0],
blocking_count: 101,
blocking: Array.from({ length: 100 }, (_, index) => ({
repository: input.repository,
number: index + 1,
state: "OPEN",
})),
}],
})).includes("blocking-truncated"));
assert.ok(blockerCodes(analyzePullRequest({
...input,
linked_issue_count: 2,
Expand Down Expand Up @@ -309,6 +346,30 @@ assert.notEqual(
}],
}).snapshot_sha256,
);
assert.notEqual(
analyzePullRequest(input).snapshot_sha256,
analyzePullRequest({
...input,
linked_issues: [{
...input.linked_issues[0],
blocked_by: input.linked_issues[0].blocked_by.map(
(dependency, index) => index === 0
? { ...dependency, state: "CLOSED" }
: dependency,
),
}],
}).snapshot_sha256,
);
assert.notEqual(
analyzePullRequest(input).snapshot_sha256,
analyzePullRequest({
...input,
linked_issues: [{
...input.linked_issues[0],
blocked_by_count: input.linked_issues[0].blocked_by_count + 1,
}],
}).snapshot_sha256,
);

const cleanReview = {
findings: [],
Expand Down Expand Up @@ -441,6 +502,22 @@ try {
issueType: { name: "Feature" },
parent: null,
subIssues: { totalCount: 0, nodes: [] },
blockedBy: {
totalCount: input.linked_issues[0].blocked_by_count,
nodes: input.linked_issues[0].blocked_by.map((dependency) => ({
repository: { nameWithOwner: dependency.repository },
number: dependency.number,
state: dependency.state,
})),
},
blocking: {
totalCount: input.linked_issues[0].blocking_count,
nodes: input.linked_issues[0].blocking.map((dependency) => ({
repository: { nameWithOwner: dependency.repository },
number: dependency.number,
state: dependency.state,
})),
},
}],
},
reviewThreads: {
Expand Down Expand Up @@ -491,6 +568,22 @@ try {
state: subIssue.state,
})),
},
blockedBy: {
totalCount: issue.blocked_by_count ?? 0,
nodes: (issue.blocked_by ?? []).map((dependency) => ({
repository: { nameWithOwner: dependency.repository },
number: dependency.number,
state: dependency.state,
})),
},
blocking: {
totalCount: issue.blocking_count ?? 0,
nodes: (issue.blocking ?? []).map((dependency) => ({
repository: { nameWithOwner: dependency.repository },
number: dependency.number,
state: dependency.state,
})),
},
})),
};
fs.writeFileSync(fixtureFile, JSON.stringify(manyFixture));
Expand Down Expand Up @@ -532,6 +625,13 @@ try {
}],
};
});
assertStale((pullRequest) => {
pullRequest.closingIssuesReferences.nodes[0].blockedBy.nodes[0].state =
"CLOSED";
});
assertStale((pullRequest) => {
pullRequest.closingIssuesReferences.nodes[0].blocking.totalCount += 1;
});
assertStale((pullRequest) => {
pullRequest.reviewThreads.nodes.push({
isResolved: false,
Expand Down
28 changes: 28 additions & 0 deletions .github/scripts/pr-readiness/verify.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,22 @@ async function fetchPullRequest() {
state
}
}
blockedBy(first: 100) {
totalCount
nodes {
repository { nameWithOwner }
number
state
}
}
blocking(first: 100) {
totalCount
nodes {
repository { nameWithOwner }
number
state
}
}
}
}
reviewThreads(first: 100) {
Expand Down Expand Up @@ -116,6 +132,18 @@ const linkedIssues = pullRequest.closingIssuesReferences.nodes
number: item.number,
state: item.state,
})),
blocked_by_count: issue.blockedBy.totalCount,
blocked_by: issue.blockedBy.nodes.map((item) => ({
repository: item.repository.nameWithOwner,
number: item.number,
state: item.state,
})),
blocking_count: issue.blocking.totalCount,
blocking: issue.blocking.nodes.map((item) => ({
repository: item.repository.nameWithOwner,
number: item.number,
state: item.state,
})),
}));
const current = analyzePullRequest({
repository: data.repository.nameWithOwner,
Expand Down
Loading
Loading