배포 완료 시 슬랙으로 알려주기 (feat. AWS CodePipeline)

먼저 Lambda의 진입점이 되는 핸들러를 작성했다.

import { CodePipelineClient, PutJobSuccessResultCommand, PutJobFailureResultCommand } from "@aws-sdk/client-codepipeline";

export const handler = async (event) => {
  const jobId = event["CodePipeline.job"].id;

  const cp = new CodePipelineClient({ region: "ap-northeast-2" });
  await cp.send(new PutJobSuccessResultCommand({ jobId }));

  await sendSlackNotification()
};

여기서 중요한 포인트는 CodePipeline에 작업 성공을 알려주는 부분이다. CodePipeline에서 Lambda를 호출하면 event 객체에 파이프라인 정보가 담겨 온다. 여기서 jobId를 꺼내서 PutJobSuccessResultCommand를 통해 "정상적으로 실행했어요"라고 CodePipeline에 알려줘야 한다. 이 과정을 빠뜨리면 파이프라인이 계속 대기 상태로 남아있게 되니 주의해야 한다.

region은 CodePipeline을 생성한 지역으로 설정하면 된다. 우리는 서울 리전(ap-northeast-2)을 사용하고 있어서 해당 값으로 설정했다.

이제 본격적으로 슬랙에 알림을 보내는 함수를 만들어보자.

async function sendSlackNotification() {
  const payload = ..

	await fetch(SLACK_WEBHOOK_URL, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify(payload)
  });
}

로직은 정말 간단하다. 슬랙 웹훅 URL로 POST 요청만 보내면 끝이다. 슬랙 웹훅을 만드는 방법은 1) 슬랙 봇 만들기 글을 참고하면 된다.

웹훅을 간단히 설명하자면, 웹훅은 슬랙이 제공하는 고유한 URL이다. 이 URL로 정해진 형식의 JSON을 POST로 보내기만 하면 자동으로 슬랙 채널에 메시지가 전송된다. 별도의 인증 과정이 필요 없고, URL만 알면 누구나 메시지를 보낼 수 있어서 편하다.

여기서 중요한 건 payload의 구조다. 슬랙 메시지를 예쁘게 꾸미기 위해서는 Block Kit이라는 슬랙의 메시지 구성 시스템을 사용해야 한다.

const payload = {
  text: "✅ 배포 완료",
  blocks: [
    {
      type: "header",
      text: {
        type: "plain_text",
        text: "✅ 배포 완료",
        emoji: true
      }
    },
    {
      type: "section",
      text: {
        type: "mrkdwn",
        text: `🔗 *배포 URL:* <${deploymentUrl}|${deploymentUrl}>`
      }
    },
    {
      type: "context",
      elements: [
        {
          type: "mrkdwn",
          text: `배포 시간: ${new Date().toLocaleString('ko-KR', { timeZone: 'Asia/Seoul' })}`
        }
      ]
    },
  ]
};

여기서 text 필드는 알림이 왔을 때 미리보기로 보여줄 메시지다. 슬랙 데스크톱 앱이나 모바일에서 알림을 받으면 이 텍스트가 먼저 표시된다.

blocks는 실제 슬랙 채널에 렌더링될 메시지의 상세 내용이다. 블록 타입을 조합하면 메시지를 더 풍성하게 꾸민다. 위 코드에서는 헤더, 본문, 그리고 부가 정보를 담은 컨텍스트 블록으로 구성했다.

특히 mrkdwn 타입을 사용하면 마크다운 문법으로 텍스트를 꾸밀 수 있다. *텍스트*로 볼드 처리를 하거나, <URL|표시할 텍스트> 형식으로 링크를 만들 수 있다. 더 자세한 내용은 슬랙 공식문서에서 확인할 수 있다.

처음에는 슬랙 Block Kit이 복잡해 보였는데, Block Kit Builder라는 공식 도구를 사용하면 GUI로 메시지를 디자인하고 바로 코드를 생성해준다. 이걸 사용하면 훨씬 쉽게 원하는 형태의 메시지를 만들 수 있다.

Lambda를 작성했다면 실제 배포 전에 꼭 테스트해보는 걸 추천한다. AWS Lambda 콘솔에서 "Test" 버튼을 눌러 미리 실행해볼 수 있다. 다만 테스트 시에는 event["CodePipeline.job"]가 없어서 에러가 발생할 것이다. 테스트할 때는 이 부분을 주석 처리하거나, 테스트용 이벤트를 직접 만들어서 사용하면 된다.

// 테스트 시 사용할 수 있는 더미 이벤트
const testEvent = {
  "CodePipeline.job": {
    "id": "test-job-id-123",
    "data": {
      "actionConfiguration": {
        "configuration": {
          "UserParameters": JSON.stringify({ environment: "production" })
        }
      }
    }
  }
};

여기서 한 가지 주의할 점이 있다. Lambda를 선택할 때 "배포"와 "호출" 두 가지 옵션이 있는데, 반드시 "호출"을 선택해야 한다. "배포"는 Lambda 함수 자체를 배포하는 옵션이고, 우리는 이미 배포된 Lambda 함수를 실행만 하면 되기 때문이다.

{"environment": "production"}

혹은 개발 서버라면

{"environment": "development"}

export const handler = async (event) => {
  const userParameters = JSON.parse(
    event["CodePipeline.job"]?.data?.actionConfiguration?.configuration?.UserParameters
  );
  const { environment } = userParameters;

  // 환경에 따라 다른 처리
  const webhookUrl = environment === 'production'
    ? PRODUCTION_WEBHOOK_URL
    : DEVELOPMENT_WEBHOOK_URL;

  const deploymentUrl = environment === 'production'
    ? 'https://production.bombom.com'
    : 'https://dev.bombom.com';

  // ... 나머지 로직
};

export const handler = async (event) => {
  // 테스트 중에는 이 부분을 주석 처리
  // const jobId = event["CodePipeline.job"].id;
  // const cp = new CodePipelineClient({ region: "ap-northeast-2" });
  // await cp.send(new PutJobSuccessResultCommand({ jobId }));

  await sendSlackNotification(); // 알림만 테스트
};

export const handler = async (event) => {
  await fetch(SLACK_WEBHOOK_URL, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ 
      text: "디버그 정보",
      blocks: [{
        type: "section",
        text: {
          type: "mrkdwn",
          text: "```" + JSON.stringify(event, null, 2) + "```"
        }
      }]
    })
  });
};

export const handler = async (event) => {
  console.log('event:', JSON.stringify(event, null, 2));

  const userParameters = event["CodePipeline.job"]?.data?.actionConfiguration?.configuration?.UserParameters;
  console.log('User parameters:', userParameters);

  // ... 나머지 로직
};