Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
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
29 changes: 29 additions & 0 deletions .github/scripts/revision-guard/helpers/constants.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
const DEFAULT_MANAGED_LABELS = [
Comment thread
exploreriii marked this conversation as resolved.
'queue:junior-committer',
'queue:committers',
'queue:maintainers',
'status: ready-to-merge',
'status: failed checks',
'open to community review',
];

function parseManagedLabels(value) {
if (typeof value !== 'string' || value.trim().length === 0) {
return [...DEFAULT_MANAGED_LABELS];
}

const customLabels = value
.split(',')
.map(label => label.trim())
.filter(Boolean);

// Merge custom labels with defaults so that setting REVISION_GUARD_MANAGED_LABELS
// adds to the managed set rather than silently discarding the default labels.
const merged = new Set([...DEFAULT_MANAGED_LABELS, ...customLabels]);
return [...merged];
}

module.exports = {
DEFAULT_MANAGED_LABELS,
parseManagedLabels,
};
30 changes: 30 additions & 0 deletions .github/scripts/revision-guard/helpers/draft.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
function isBotAuthor(pr) {
Comment thread
exploreriii marked this conversation as resolved.
const login = pr?.user?.login || '';
return pr?.user?.type === 'Bot' || login.endsWith('[bot]');
}

function isDraft(pr) {
return pr?.draft === true;
}

async function convertToDraft(github, { pullRequestId }) {
await github.graphql(
`
mutation ConvertPullRequestToDraft($pullRequestId: ID!) {
convertPullRequestToDraft(input: { pullRequestId: $pullRequestId }) {
pullRequest {
id
isDraft
}
}
}
`,
{ pullRequestId }
);
}

module.exports = {
convertToDraft,
isBotAuthor,
isDraft,
};
14 changes: 14 additions & 0 deletions .github/scripts/revision-guard/helpers/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
const { DEFAULT_MANAGED_LABELS, parseManagedLabels } = require('./constants');
const { convertToDraft, isBotAuthor, isDraft } = require('./draft');
const { getManagedLabels, getPresentManagedLabels, removeManagedLabels } = require('./labels');

module.exports = {
DEFAULT_MANAGED_LABELS,
parseManagedLabels,
convertToDraft,
isBotAuthor,
isDraft,
getManagedLabels,
getPresentManagedLabels,
removeManagedLabels,
};
38 changes: 38 additions & 0 deletions .github/scripts/revision-guard/helpers/labels.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
const { parseManagedLabels } = require('./constants');

function getManagedLabels() {
return parseManagedLabels(process.env.REVISION_GUARD_MANAGED_LABELS);
}

function getPresentManagedLabels(prLabels, managedLabels = getManagedLabels()) {
const currentLabels = Array.isArray(prLabels)
? prLabels
.map(label => typeof label === 'string' ? label : label?.name)
.filter(Boolean)
: [];

return managedLabels.filter(label => currentLabels.includes(label));
}

async function removeManagedLabels(github, { owner, repo, issueNumber, labels }) {
for (const name of labels) {
try {
await github.rest.issues.removeLabel({
Comment thread
exploreriii marked this conversation as resolved.
owner,
repo,
issue_number: issueNumber,
name,
});
} catch (error) {
if (error?.status !== 404) {
throw error;
}
}
}
}

module.exports = {
getManagedLabels,
getPresentManagedLabels,
removeManagedLabels,
};
78 changes: 78 additions & 0 deletions .github/scripts/revision-guard/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
const {
convertToDraft,
getPresentManagedLabels,
isBotAuthor,
isDraft,
removeManagedLabels,
} = require('./helpers');

module.exports = async function revisionGuard({ github, context, core }) {
const payload = context?.payload;
const repo = context?.repo;
const reviewState = payload?.review?.state;
const pr = payload?.pull_request;

if (
!payload ||
!repo?.owner ||
!repo?.repo ||
!pr ||
typeof pr.number !== 'number' ||
reviewState !== 'changes_requested'
) {
core?.info?.('Skipping revision guard due to missing or non-matching payload data.');
return;
}

if (isBotAuthor(pr)) {
core?.info?.(`Skipping PR #${pr.number} because it is bot-authored.`);
return;
}

const labelsToRemove = getPresentManagedLabels(pr.labels);

if (!isDraft(pr)) {
if (process.env.REVIEWBOT_TOKEN && typeof pr.node_id === 'string') {
try {
await convertToDraft(github, {
pullRequestId: pr.node_id,
});
core?.info?.(`Converted PR #${pr.number} to draft.`);
} catch (error) {
core?.error?.(
`Failed to convert PR #${pr.number} to draft: ${error.message}. ` +
'Continuing with managed label cleanup.'
);
}
} else {
core?.info?.(
`Skipping draft conversion for PR #${pr.number}; REVIEWBOT_TOKEN is not configured.`
);
}
} else {
core?.info?.(`PR #${pr.number} is already a draft.`);
}

if (labelsToRemove.length === 0) {
core?.info?.(`No managed labels to remove for PR #${pr.number}.`);
return;
}

try {
await removeManagedLabels(github, {
owner: repo.owner,
repo: repo.repo,
issueNumber: pr.number,
labels: labelsToRemove,
});
core?.info?.(
`Removed managed labels from PR #${pr.number}: ${labelsToRemove.join(', ')}.`
);
} catch (error) {
core?.error?.(
`Failed to remove labels from PR #${pr.number}: ${error.message}. ` +
`Labels to remove: ${labelsToRemove.join(', ')}.`
);
throw error;
}
};
196 changes: 196 additions & 0 deletions .github/scripts/revision-guard/index.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
const { describe, it, beforeEach, afterEach } = require('node:test');
Comment thread
exploreriii marked this conversation as resolved.
const assert = require('node:assert/strict');

function freshRequire() {
const indexPath = require.resolve('./index.js');
const helpersPath = require.resolve('./helpers/index.js');
const labelsPath = require.resolve('./helpers/labels.js');
const constantsPath = require.resolve('./helpers/constants.js');
const draftPath = require.resolve('./helpers/draft.js');

delete require.cache[indexPath];
delete require.cache[helpersPath];
delete require.cache[labelsPath];
delete require.cache[constantsPath];
delete require.cache[draftPath];

return require('./index.js');
}

function createGithubMock() {
const removedLabels = [];
const graphqlCalls = [];
let graphqlError;

return {
removedLabels,
graphqlCalls,
failGraphql(error) {
graphqlError = error;
},
graphql: async (query, variables) => {
graphqlCalls.push({ query, variables });
if (graphqlError) {
throw graphqlError;
}
return {
convertPullRequestToDraft: {
pullRequest: {
id: variables.pullRequestId,
isDraft: true,
},
},
};
},
rest: {
issues: {
removeLabel: async ({ name }) => {
removedLabels.push(name);
},
},
},
};
}

function createContext(overrides = {}) {
return {
repo: { owner: 'hiero-ledger', repo: 'hiero-sdk-python' },
payload: {
review: { state: 'changes_requested' },
pull_request: {
number: 42,
node_id: 'PR_node_42',
draft: false,
user: { login: 'contributor', type: 'User' },
labels: [
{ name: 'queue:committers' },
{ name: 'status: ready-to-merge' },
{ name: 'some other label' },
],
},
...overrides,
},
};
}

describe('revision-guard index', () => {
beforeEach(() => {
delete process.env.REVISION_GUARD_MANAGED_LABELS;
delete process.env.REVIEWBOT_TOKEN;
});

afterEach(() => {
delete process.env.REVISION_GUARD_MANAGED_LABELS;
delete process.env.REVIEWBOT_TOKEN;
});

it('removes only managed labels without draft conversion when no review bot token is configured', async () => {
const handler = freshRequire();
const github = createGithubMock();
const context = createContext();

await handler({ github, context, core: { info() {} } });

assert.equal(github.graphqlCalls.length, 0);
assert.deepEqual(github.removedLabels, [
'queue:committers',
'status: ready-to-merge',
]);
});

it('skips bot-authored PRs', async () => {
const handler = freshRequire();
const github = createGithubMock();
const context = createContext({
pull_request: {
number: 43,
node_id: 'PR_node_43',
draft: false,
user: { login: 'github-actions[bot]', type: 'Bot' },
labels: [{ name: 'queue:committers' }],
},
});

await handler({ github, context, core: { info() {} } });

assert.equal(github.graphqlCalls.length, 0);
assert.equal(github.removedLabels.length, 0);
});

it('removes managed labels from already-draft PRs without converting again', async () => {
const handler = freshRequire();
const github = createGithubMock();
const context = createContext({
pull_request: {
number: 44,
node_id: 'PR_node_44',
draft: true,
user: { login: 'contributor', type: 'User' },
labels: [{ name: 'queue:committers' }],
},
});

await handler({ github, context, core: { info() {} } });

assert.equal(github.graphqlCalls.length, 0);
assert.deepEqual(github.removedLabels, ['queue:committers']);
});

it('converts to draft when a review bot token is configured', async () => {
process.env.REVIEWBOT_TOKEN = 'token';
const handler = freshRequire();
const github = createGithubMock();
const context = createContext();

await handler({ github, context, core: { info() {} } });

assert.equal(github.graphqlCalls.length, 1);
assert.match(github.graphqlCalls[0].query, /convertPullRequestToDraft/);
assert.deepEqual(github.graphqlCalls[0].variables, { pullRequestId: 'PR_node_42' });
assert.deepEqual(github.removedLabels, [
'queue:committers',
'status: ready-to-merge',
]);
});

it('still removes managed labels when draft conversion fails', async () => {
process.env.REVIEWBOT_TOKEN = 'token';
const handler = freshRequire();
const github = createGithubMock();
github.failGraphql(new Error('Resource not accessible by integration'));
const context = createContext();

await handler({ github, context, core: { error() {}, info() {} } });

assert.equal(github.graphqlCalls.length, 1);
assert.deepEqual(github.removedLabels, [
'queue:committers',
'status: ready-to-merge',
]);
});

it('uses configurable managed labels and still removes defaults', async () => {
process.env.REVISION_GUARD_MANAGED_LABELS = 'custom: one, custom: two';
const handler = freshRequire();
const github = createGithubMock();
const context = createContext({
pull_request: {
number: 45,
node_id: 'PR_node_45',
draft: false,
user: { login: 'contributor', type: 'User' },
labels: [
{ name: 'custom: one' },
{ name: 'queue:committers' },
{ name: 'custom: two' },
],
},
});

await handler({ github, context, core: { info() {} } });

assert.equal(github.graphqlCalls.length, 0);
// Custom labels AND the matching default (queue:committers) must both be removed.
assert.deepEqual(github.removedLabels, ['queue:committers', 'custom: one', 'custom: two']);
});
});
Loading