Skip to content

fix(scale-up): prevent runnerLabels accumulation across dynamic label groups #5176

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

Open
Brend-Smits wants to merge 1 commit into
base: main
Choose a base branch
from
+103 −4
Open

fix(scale-up): prevent runnerLabels accumulation across dynamic label groups #5176

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
94 changes: 94 additions & 0 deletions lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -955,6 +955,100 @@ describe('scaleUp with GHES', () => {
}),
);
});

it('does not accumulate labels across groups when multiple messages have different dynamic labels', async () => {
const testDataMultipleGroups = [
{
...TEST_DATA_SINGLE,
labels: ['self-hosted', 'linux', 'ghr-ec2-instance-type:m7a.large', 'ghr-job-id:run-1-inst-0'],
messageId: 'msg-1',
},
{
...TEST_DATA_SINGLE,
labels: ['self-hosted', 'linux', 'ghr-ec2-instance-type:m7i.xlarge', 'ghr-job-id:run-1-inst-1'],
messageId: 'msg-2',
},
{
...TEST_DATA_SINGLE,
labels: ['self-hosted', 'linux', 'ghr-ec2-instance-type:c7a.large', 'ghr-job-id:run-1-inst-2'],
messageId: 'msg-3',
},
];

await scaleUpModule.scaleUp(testDataMultipleGroups);

expect(createRunner).toBeCalledTimes(3);

const jitCalls = mockOctokit.actions.generateRunnerJitconfigForOrg.mock.calls;
expect(jitCalls).toHaveLength(3);

for (const call of jitCalls) {
const labels = call[0].labels as string[];

if (labels.includes('ghr-ec2-instance-type:m7a.large')) {
expect(labels).toContain('ghr-job-id:run-1-inst-0');
expect(labels).not.toContain('ghr-job-id:run-1-inst-1');
expect(labels).not.toContain('ghr-job-id:run-1-inst-2');
expect(labels).not.toContain('ghr-ec2-instance-type:m7i.xlarge');
expect(labels).not.toContain('ghr-ec2-instance-type:c7a.large');
} else if (labels.includes('ghr-ec2-instance-type:m7i.xlarge')) {
expect(labels).toContain('ghr-job-id:run-1-inst-1');
expect(labels).not.toContain('ghr-job-id:run-1-inst-0');
expect(labels).not.toContain('ghr-job-id:run-1-inst-2');
expect(labels).not.toContain('ghr-ec2-instance-type:m7a.large');
expect(labels).not.toContain('ghr-ec2-instance-type:c7a.large');
} else if (labels.includes('ghr-ec2-instance-type:c7a.large')) {
expect(labels).toContain('ghr-job-id:run-1-inst-2');
expect(labels).not.toContain('ghr-job-id:run-1-inst-0');
expect(labels).not.toContain('ghr-job-id:run-1-inst-1');
expect(labels).not.toContain('ghr-ec2-instance-type:m7a.large');
expect(labels).not.toContain('ghr-ec2-instance-type:m7i.xlarge');
} else {
throw new Error(`Unexpected labels combination: ${labels.join(',')}`);
}
}
});

it('preserves base RUNNER_LABELS for each group without mutation', async () => {
process.env.RUNNER_LABELS = 'ubuntu-2404,x64';

const testDataTwoGroups = [
{
...TEST_DATA_SINGLE,
labels: ['self-hosted', 'ghr-ec2-instance-type:m7a.large', 'ghr-team:alpha'],
messageId: 'msg-a',
},
{
...TEST_DATA_SINGLE,
labels: ['self-hosted', 'ghr-ec2-instance-type:c7i.large', 'ghr-team:beta'],
messageId: 'msg-b',
},
];

await scaleUpModule.scaleUp(testDataTwoGroups);

expect(createRunner).toBeCalledTimes(2);

const jitCalls = mockOctokit.actions.generateRunnerJitconfigForOrg.mock.calls;
expect(jitCalls).toHaveLength(2);

for (const call of jitCalls) {
const labels = call[0].labels as string[];

expect(labels).toContain('ubuntu-2404');
expect(labels).toContain('x64');

if (labels.includes('ghr-team:alpha')) {
expect(labels).not.toContain('ghr-team:beta');
expect(labels).not.toContain('ghr-ec2-instance-type:c7i.large');
} else if (labels.includes('ghr-team:beta')) {
expect(labels).not.toContain('ghr-team:alpha');
expect(labels).not.toContain('ghr-ec2-instance-type:m7a.large');
} else {
throw new Error(`Unexpected labels combination: ${labels.join(',')}`);
}
}
});
});

describe('on repo level', () => {
Expand Down
13 changes: 9 additions & 4 deletions lambdas/functions/control-plane/src/scale-runners/scale-up.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise<stri

const enableOrgLevel = yn(process.env.ENABLE_ORGANIZATION_RUNNERS, { default: true });
const maximumRunners = parseInt(process.env.RUNNERS_MAXIMUM_COUNT || '3');
let runnerLabels = process.env.RUNNER_LABELS || '';
const runnerLabels = process.env.RUNNER_LABELS || '';
const runnerGroup = process.env.RUNNER_GROUP_NAME || 'Default';
const environment = process.env.ENVIRONMENT;
const ssmTokenPath = process.env.SSM_TOKEN_PATH;
Expand Down Expand Up @@ -457,16 +457,21 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise<stri

let ec2OverrideConfig: Ec2OverrideConfig | undefined = undefined;

// Reset per group to avoid accumulating labels across iterations
let groupRunnerLabels = runnerLabels;

if (messages.length > 0 && dynamicLabelsEnabled) {
logger.debug('Dynamic EC2 config enabled, processing labels', { labels: messages[0].labels });

const dynamicEC2Labels = messages[0].labels?.map((l) => l.trim()).filter((l) => l.startsWith('ghr-ec2-')) ?? [];
const allDynamicLabels = messages[0].labels?.map((l) => l.trim()).filter((l) => l.startsWith('ghr-')) ?? [];

if (allDynamicLabels.length > 0) {
runnerLabels = runnerLabels ? `${runnerLabels},${allDynamicLabels.join(',')}` : allDynamicLabels.join(',');
groupRunnerLabels = groupRunnerLabels
? `${groupRunnerLabels},${allDynamicLabels.join(',')}`
: allDynamicLabels.join(',');

logger.debug('Updated runner labels', { runnerLabels });
logger.debug('Updated runner labels', { runnerLabels: groupRunnerLabels });

if (dynamicEC2Labels.length > 0) {
ec2OverrideConfig = parseEc2OverrideConfig(dynamicEC2Labels);
Expand Down Expand Up @@ -562,7 +567,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise<stri
ephemeral: ephemeralEnabled,
enableJitConfig,
ghesBaseUrl,
runnerLabels,
runnerLabels: groupRunnerLabels,
runnerGroup,
runnerNamePrefix,
runnerOwner: runnerOwner,
Expand Down