- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| src | -
-
- |
- 100% | -10/10 | -100% | -0/0 | -100% | -1/1 | -100% | -10/10 | -
| src/rds | -
-
- |
- 21.42% | -3/14 | -0% | -0/5 | -0% | -0/3 | -21.42% | -3/14 | -
| src/ssm | -
-
- |
- 100% | -5/5 | -75% | -3/4 | -100% | -1/1 | -100% | -5/5 | -
| src/webhook | -
-
- |
- 96.15% | -50/52 | -80% | -12/15 | -100% | -4/4 | -96.15% | -50/52 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| lambda.ts | -
-
- |
- 100% | -10/10 | -100% | -0/0 | -100% | -1/1 | -100% | -10/10 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 | - -1x -1x - - - - - -1x -3x -3x - -3x -3x - -1x -1x - - - - -3x - - | import { APIGatewayEvent, Callback, Context } from 'aws-lambda';
-
-import { handle } from './webhook/handler';
-import { logger } from './webhook/logger';
-
-export interface Response {
- statusCode: number;
- body?: string;
-}
-export async function githubWebhook(event: APIGatewayEvent, context: Context): Promise<Response> {
- logger.setSettings({ requestId: context.awsRequestId });
- logger.debug(JSON.stringify(event));
- let result: Response;
- try {
- result = await handle(event.headers, event.body as string, event.requestContext.requestTimeEpoch);
- } catch (e) {
- logger.error(e);
- result = {
- statusCode: 500,
- body: 'Check the Lambda logs for the error details.',
- };
- }
- return result;
-}
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| index.ts | -
-
- |
- 21.42% | -3/14 | -0% | -0/5 | -0% | -0/3 | -21.42% | -3/14 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 | 2x -2x - -2x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | import { Pool, PoolConfig, QueryResult } from 'pg'
-import { getParameterValue } from '../ssm'
-
-export class RDS {
- private static rds?: RDS
- private pool: Pool
- private database: string
- private table: string
- private constructor(config: PoolConfig) {
- this.database = process.env.RDS_DATABASE || 'postgres'
- this.table = process.env.RDS_TABLE || 'github_events'
- this.pool = new Pool({
- database: this.database,
- ...config
- })
- }
- static async get(): Promise<RDS> {
- Iif (! this.rds) {
- const host = await getParameterValue('rds_address')
- const port = +(await getParameterValue('rds_port'))
- const user = await getParameterValue('rds_username')
- const password = await getParameterValue('rds_password')
- this.rds = new RDS({
- host,
- port,
- user,
- password
- })
- }
- return this.rds
- }
- async insert(event: string, delivery: string, organization: string, repository: string, receipt: number, payload: string): Promise<QueryResult> {
- return this.pool.query(
- `INSERT INTO ${this.table} (event, delivery, organization, repository, receipt, payload) VALUES($1, $2, $3, $4, TO_TIMESTAMP($5), $6)`,
- [event, delivery, organization, repository, receipt, payload]
- )
- }
-}
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| index.ts | -
-
- |
- 100% | -5/5 | -75% | -3/4 | -100% | -1/1 | -100% | -5/5 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 | 3x - -3x -1x -1x -1x - - | import { SSM } from '@aws-sdk/client-ssm';
-
-export async function getParameterValue(name: string): Promise<string> {
- const parameter_name = `/events_observer/${name}`;
- const client = new SSM({ region: process.env.AWS_REGION as string });
- return (await client.getParameter({ Name: parameter_name, WithDecryption: true })).Parameter?.Value as string;
-}
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 | 2x - - - - -2x -2x -2x - -2x - -2x - -5x -10x - - -5x -5x -5x -5x -5x - -5x -5x -5x -5x - -5x - -5x - -5x -2x - - -3x - -3x -1x - - -2x -2x - -2x - - - - - - - - -2x - - - - - -3x -3x - -3x - -3x - - - - - - - - -3x -1x - - - - - - - -2x - - - - - - -5x -1x - -4x - -5x -1x - - - - - - - -4x - -4x - - -4x -1x - - - - - - -3x - - - - | import { Webhooks } from '@octokit/webhooks';
-import { APIGatewayEventRequestContext, Context } from 'aws-lambda';
-import { IncomingHttpHeaders } from 'http';
-
-import { Response } from '../lambda';
-import { RDS } from '../rds';
-import { getParameterValue } from '../ssm';
-import { LogFields, logger as rootLogger } from './logger';
-
-const logger = rootLogger.getChildLogger();
-
-export async function handle(headers: IncomingHttpHeaders, body: string, timestamp: number): Promise<Response> {
- // ensure header keys lower case since github headers can contain capitals.
- for (const key in headers) {
- headers[key.toLowerCase()] = headers[key];
- }
-
- const event = headers['x-github-event'] as string;
- const delivery = headers['x-github-delivery'] as string;
- const organization = headers['x-github-organization'] as string;
- const repository = headers['x-github-repository'] as string;
- const receipt = timestamp
-
- LogFields.fields.event = event;
- LogFields.fields.delivery = delivery;
- LogFields.fields.organization = organization;
- LogFields.fields.repository = repository;
-
- logger.info(`Processing Github event`, LogFields.print());
-
- let response: Response = await verifySignature(headers, body);
-
- if (response.statusCode != 200) {
- return response;
- }
-
- response = await verifyOrganization(headers, body);
-
- if (response.statusCode != 200) {
- return response;
- }
-
- const rds = await RDS.get()
- const insert = await rds.insert(event, delivery, organization, repository, receipt, body)
-
- Iif (insert.rowCount != 1) {
- return {
- statusCode: 500,
- body: JSON.stringify({
- statusMessage: "Failed to insert the event into the database."
- })
- }
- }
-
- return {
- statusCode: 201
- };
-}
-
-async function verifyOrganization(headers: IncomingHttpHeaders, body: string): Promise<Response> {
- const organizationAllowListEnv = process.env.ORGANIZATION_ALLOW_LIST || '[]';
- const organizationAllowList = JSON.parse(organizationAllowListEnv) as Array<string>;
-
- const organization = headers['x-github-organization'] as string;
-
- Iif (!organization) {
- return {
- statusCode: 500,
- body: JSON.stringify({
- statusMessage: "Github event doesn't have organization. This webhook requires an organization header to be configured."
- })
- }
- }
-
- if (! organizationAllowList.includes(organization)) {
- return {
- statusCode: 403,
- body: JSON.stringify({
- statusMessage: `Received event from unauthorized organization ${organization}`
- })
- }
- }
-
- return {
- statusCode: 200
- }
-}
-
-async function verifySignature(headers: IncomingHttpHeaders, body: string): Promise<Response> {
- let signature;
- if ('x-hub-signature-256' in headers) {
- signature = headers['x-hub-signature-256'] as string;
- } else {
- signature = headers['x-hub-signature'] as string;
- }
- if (!signature) {
- return {
- statusCode: 500,
- body: JSON.stringify({
- statusMessage: "Github event doesn't have signature. This webhook requires a secret to be configured."
- })
- }
- }
-
- const secret = await getParameterValue('github_app_webhook_secret');
-
- const webhooks = new Webhooks({
- secret: secret,
- });
- if (!(await webhooks.verify(body, signature))) {
- return {
- statusCode: 401,
- body: JSON.stringify({
- statusMessage: "Unable to verify signature!"
- })
- }
- }
- return {
- statusCode: 200
- }
-}
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| handler.ts | -
-
- |
- 95.74% | -45/47 | -72.72% | -8/11 | -100% | -3/3 | -95.74% | -45/47 | -
| logger.ts | -
-
- |
- 100% | -5/5 | -100% | -4/4 | -100% | -1/1 | -100% | -5/5 | -
| modules.d.ts | -
-
- |
- 0% | -0/0 | -0% | -0/0 | -0% | -0/0 | -0% | -0/0 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 | 3x - -3x - - - - - - - - -3x -3x - - -5x - - - | import { Logger } from 'tslog';
-
-export const logger = new Logger({
- colorizePrettyLogs: false,
- displayInstanceName: false,
- minLevel: process.env.LOG_LEVEL || 'info',
- name: 'webhook',
- overwriteConsole: true,
- type: process.env.LOG_TYPE || 'pretty',
-});
-
-export class LogFields {
- static fields: { [key: string]: string } = {};
-
- public static print(): string {
- return JSON.stringify(LogFields.fields);
- }
-}
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 | - - - - - - - | declare namespace NodeJS {
- export interface ProcessEnv {
- LOG_LEVEL: 'silly' | 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
- LOG_TYPE: 'json' | 'pretty' | 'hidden';
- ORGANIZATION_ALLOW_LIST: string;
- }
-}
- |