Skip to content
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

fix: update return codes, no error code for job that are ignored #1381

Merged
merged 1 commit into from
Nov 9, 2021
Merged

fix: update return codes, no error code for job that are ignored #1381

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: 7 additions & 4 deletions modules/webhook/lambdas/webhook/src/lambda.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@ import { handle } from './webhook/handler';
import { APIGatewayEvent, Context, Callback } from 'aws-lambda';
import { logger } from './webhook/logger';

export interface Response {
statusCode: number;
body?: string;
}

export const githubWebhook = async (event: APIGatewayEvent, context: Context, callback: Callback): Promise<void> => {
logger.setSettings({ requestId: context.awsRequestId });
logger.debug(JSON.stringify(event));
try {
const statusCode = await handle(event.headers, event.body as string);
callback(null, {
statusCode: statusCode,
});
const response = await handle(event.headers, event.body as string);
callback(null, response);
} catch (e) {
callback(e as Error);
}
Expand Down
2 changes: 1 addition & 1 deletion modules/webhook/lambdas/webhook/src/local.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ app.use(bodyParser.json());

app.post('/event_handler', (req, res) => {
handle(req.headers, JSON.stringify(req.body))
.then((c) => res.status(c).end())
.then((c) => res.status(c.statusCode).end())
.catch((e) => {
console.log(e);
res.status(404);
Expand Down
38 changes: 19 additions & 19 deletions modules/webhook/lambdas/webhook/src/webhook/handler.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ describe('handler', () => {

it('returns 500 if no signature available', async () => {
const resp = await handle({}, '');
expect(resp).toBe(500);
expect(resp.statusCode).toBe(500);
});

it('returns 401 if signature is invalid', async () => {
const resp = await handle({ 'X-Hub-Signature': 'bbb' }, 'aaaa');
expect(resp).toBe(401);
expect(resp.statusCode).toBe(401);
});

describe('Test for workflowjob event: ', () => {
Expand All @@ -56,14 +56,14 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).toBeCalled();
});

it('does not handle other events', async () => {
const event = JSON.stringify(workflowjob_event);
const resp = await handle({ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'push' }, event);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(202);
expect(sendActionRequest).not.toBeCalled();
});

Expand All @@ -73,7 +73,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).not.toBeCalled();
});

Expand All @@ -83,7 +83,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).not.toBeCalled();
});

Expand All @@ -94,7 +94,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(403);
expect(resp.statusCode).toBe(403);
expect(sendActionRequest).not.toBeCalled();
});

Expand All @@ -105,7 +105,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).toBeCalled();
});

Expand All @@ -122,7 +122,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).toBeCalled();
});

Expand All @@ -139,7 +139,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).toBeCalled();
});

Expand All @@ -156,7 +156,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).toBeCalled();
});

Expand All @@ -173,7 +173,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).toBeCalled();
});

Expand All @@ -191,7 +191,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).toBeCalled();
});
it('Check not allowed runner label is declined', async () => {
Expand All @@ -207,7 +207,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'workflow_job' },
event,
);
expect(resp).toBe(403);
expect(resp.statusCode).toBe(202);
expect(sendActionRequest).not.toBeCalled();
});
});
Expand All @@ -219,7 +219,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'check_run' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).toBeCalled();
});

Expand All @@ -229,7 +229,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'check_run' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).not.toBeCalled();
});

Expand All @@ -239,7 +239,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'check_run' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).not.toBeCalled();
});

Expand All @@ -250,7 +250,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'check_run' },
event,
);
expect(resp).toBe(403);
expect(resp.statusCode).toBe(403);
expect(sendActionRequest).not.toBeCalled();
});

Expand All @@ -261,7 +261,7 @@ describe('handler', () => {
{ 'X-Hub-Signature': await webhooks.sign(event), 'X-GitHub-Event': 'check_run' },
event,
);
expect(resp).toBe(200);
expect(resp.statusCode).toBe(201);
expect(sendActionRequest).toBeCalled();
});
});
Expand Down
43 changes: 28 additions & 15 deletions modules/webhook/lambdas/webhook/src/webhook/handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,48 @@ import { sendActionRequest } from '../sqs';
import { CheckRunEvent, WorkflowJobEvent } from '@octokit/webhooks-types';
import { getParameterValue } from '../ssm';
import { logger as rootLogger } from './logger';
import { Response } from '../lambda';

const logger = rootLogger.getChildLogger();

export async function handle(headers: IncomingHttpHeaders, body: string): Promise<number> {
export async function handle(headers: IncomingHttpHeaders, body: string): Promise<Response> {
// ensure header keys lower case since github headers can contain capitals.
for (const key in headers) {
headers[key.toLowerCase()] = headers[key];
}

const githubEvent = headers['x-github-event'] as string;

let status = await verifySignature(githubEvent, headers['x-hub-signature'] as string, body);
if (status != 200) {
return status;
let response: Response = {
statusCode: await verifySignature(githubEvent, headers['x-hub-signature'] as string, body),
};

if (response.statusCode != 200) {
return response;
}
const payload = JSON.parse(body);
logger.info(`Received Github event ${githubEvent} from ${payload.repository.full_name}`);

if (isRepoNotAllowed(payload.repository.full_name)) {
console.error(`Received event from unauthorized repository ${payload.repository.full_name}`);
return 403;
console.warn(`Received event from unauthorized repository ${payload.repository.full_name}`);
return {
statusCode: 403,
};
}

if (githubEvent == 'workflow_job') {
status = await handleWorkflowJob(payload as WorkflowJobEvent, githubEvent);
response = await handleWorkflowJob(payload as WorkflowJobEvent, githubEvent);
} else if (githubEvent == 'check_run') {
status = await handleCheckRun(payload as CheckRunEvent, githubEvent);
response = await handleCheckRun(payload as CheckRunEvent, githubEvent);
} else {
logger.warn(`Ignoring unsupported event ${githubEvent}`);
response = {
statusCode: 202,
body: `Ignoring unsupported event ${githubEvent}`,
};
}

return status;
return response;
}

async function verifySignature(githubEvent: string, signature: string, body: string): Promise<number> {
Expand All @@ -56,12 +66,15 @@ async function verifySignature(githubEvent: string, signature: string, body: str
return 200;
}

async function handleWorkflowJob(body: WorkflowJobEvent, githubEvent: string): Promise<number> {
async function handleWorkflowJob(body: WorkflowJobEvent, githubEvent: string): Promise<Response> {
const disableCheckWorkflowJobLabelsEnv = process.env.DISABLE_CHECK_WORKFLOW_JOB_LABELS || 'false';
const disableCheckWorkflowJobLabels = JSON.parse(disableCheckWorkflowJobLabelsEnv) as boolean;
if (!disableCheckWorkflowJobLabels && !canRunJob(body)) {
logger.error(`Received event contains runner labels '${body.workflow_job.labels}' that are not accepted.`);
return 403;
logger.warn(`Received event contains runner labels '${body.workflow_job.labels}' that are not accepted.`);
return {
statusCode: 202,
body: `Received event contains runner labels '${body.workflow_job.labels}' that are not accepted.`,
};
}

let installationId = body.installation?.id;
Expand All @@ -78,10 +91,10 @@ async function handleWorkflowJob(body: WorkflowJobEvent, githubEvent: string): P
});
}
console.info(`Successfully queued job for ${body.repository.full_name}`);
return 200;
return { statusCode: 201 };
}

async function handleCheckRun(body: CheckRunEvent, githubEvent: string): Promise<number> {
async function handleCheckRun(body: CheckRunEvent, githubEvent: string): Promise<Response> {
let installationId = body.installation?.id;
if (installationId == null) {
installationId = 0;
Expand All @@ -96,7 +109,7 @@ async function handleCheckRun(body: CheckRunEvent, githubEvent: string): Promise
});
}
console.info(`Successfully queued job for ${body.repository.full_name}`);
return 200;
return { statusCode: 201 };
}

function isRepoNotAllowed(repo_full_name: string): boolean {
Expand Down