Cloud Run에서 Node.js로 Slack 봇 빌드

1. 개요

이 Codelab에서는 Botkit 도구를 사용하여 Slack 봇을 빌드하고 Google Cloud에서 실행하는 방법을 알아봅니다. 실제 Slack 채널에서 봇과 대화할 수 있습니다.

학습할 내용

• Slack에서 봇 맞춤 통합을 만드는 방법
• Secret Manager로 Slack 보안 비밀을 보호하는 방법
• 스테이트리스(Stateless) 컨테이너를 자동으로 확장하는 완전 관리형 컴퓨팅 플랫폼인 Cloud Run에 Slack 봇을 배포하는 방법

필요한 항목

• Google Cloud 프로젝트
• 브라우저(Chrome, Firefox 등)

본 가이드를 어떻게 사용하실 계획인가요?

읽기만 할 계획입니다 읽은 다음 연습 활동을 완료할 계획입니다

Google Cloud 사용 경험을 평가해 주세요.

초급 중급 고급

2. 설정 및 요건

자습형 환경 설정

1. Google Cloud Console에 로그인하여 새 프로젝트를 만들거나 기존 프로젝트를 재사용합니다. 아직 Gmail이나 Google Workspace 계정이 없는 경우 계정을 만들어야 합니다.

• 프로젝트 이름은 이 프로젝트 참가자의 표시 이름입니다. 이는 Google API에서 사용하지 않는 문자열이며 언제든지 업데이트할 수 있습니다.
• 프로젝트 ID는 모든 Google Cloud 프로젝트에서 고유하며, 변경할 수 없습니다(설정된 후에는 변경할 수 없음). Cloud 콘솔은 고유한 문자열을 자동으로 생성합니다. 일반적으로는 신경 쓰지 않아도 됩니다. 대부분의 Codelab에서는 프로젝트 ID (일반적으로 PROJECT_ID로 식별됨)를 참조해야 합니다. 생성된 ID가 마음에 들지 않으면 다른 임의 ID를 생성할 수 있습니다. 또는 직접 시도해 보고 사용 가능한지 확인할 수도 있습니다. 이 단계 이후에는 변경할 수 없으며 프로젝트 기간 동안 유지됩니다.
• 참고로 세 번째 값은 일부 API에서 사용하는 프로젝트 번호입니다. 이 세 가지 값에 대한 자세한 내용은 문서를 참고하세요.

주의: 프로젝트 ID는 전역적으로 고유하며 선택한 후에는 다른 사람이 사용할 수 없습니다. 해당 ID의 유일한 사용자입니다. 프로젝트가 삭제되더라도 ID는 다시 사용할 수 없습니다.

참고: Gmail 계정을 사용하는 경우 기본 위치를 조직 없음으로 설정된 그대로 둘 수 있습니다. Google Workspace 계정을 사용하는 경우 조직에 적합한 위치를 선택하세요.

2. 다음으로 Cloud 리소스/API를 사용하려면 Cloud 콘솔에서 결제를 사용 설정해야 합니다. 이 Codelab 실행에는 많은 비용이 들지 않습니다. 이 튜토리얼이 끝난 후에 요금이 청구되지 않도록 리소스를 종료하려면 만든 리소스 또는 프로젝트를 삭제하면 됩니다. Google Cloud 신규 사용자는 300달러(USD) 상당의 무료 체험판 프로그램에 참여할 수 있습니다.

Cloud Shell 시작

Google Cloud를 노트북에서 원격으로 실행할 수 있지만, 이 튜토리얼에서는 Cloud에서 실행되는 명령줄 환경인 Cloud Shell을 사용합니다.

Cloud Shell 활성화

1. Cloud Console에서 Cloud Shell 활성화를 클릭합니다.

Cloud Shell을 처음 시작하는 경우 설명이 포함된 중간 화면이 제공됩니다. 중간 화면이 표시되면 계속을 클릭합니다.

Cloud Shell을 프로비저닝하고 연결하는 작업은 몇 분이면 끝납니다.

이 가상 머신에는 필요한 개발 도구가 모두 로드되어 있습니다. 영구적인 5GB 홈 디렉터리를 제공하고 Google Cloud에서 실행되므로 네트워크 성능과 인증이 크게 개선됩니다. 이 Codelab에서 대부분의 작업은 브라우저로 수행할 수 있습니다.

Cloud Shell에 연결되면 인증이 완료되었고 프로젝트가 해당 프로젝트 ID로 설정된 것을 확인할 수 있습니다.

2. Cloud Shell에서 다음 명령어를 실행하여 인증되었는지 확인합니다.

gcloud auth list

명령어 결과

 Credentialed Accounts
ACTIVE  ACCOUNT
*       <my_account>@<my_domain.com>

To set the active account, run:
    $ gcloud config set account `ACCOUNT`

참고: gcloud 명령줄 도구는 Google Cloud의 강력한 통합 명령줄 도구입니다. 이 도구는 Cloud Shell에 사전 설치되어 있습니다. 탭 완성 기능이 지원되는 것을 확인할 수 있습니다. 자세한 내용은 gcloud 명령줄 도구 개요를 참고하세요.

3. Cloud Shell에서 다음 명령어를 실행하여 gcloud 명령어가 프로젝트를 알고 있는지 확인합니다.

gcloud config list project

명령어 결과

[core]
project = <PROJECT_ID>

또는 다음 명령어로 설정할 수 있습니다.

gcloud config set project <PROJECT_ID>

명령어 결과

Updated property [core/project].

참고: Cloud Shell 외부에서 이 튜토리얼을 완료하는 경우 애플리케이션 기본 사용자 인증 정보 설정을 따르세요.

3. API 사용 설정

Cloud Shell에서 Artifact Registry, Cloud Build, Cloud Run, Secret Manager API를 사용 설정합니다.

gcloud services enable \
  artifactregistry.googleapis.com \
  cloudbuild.googleapis.com \
  run.googleapis.com \
  secretmanager.googleapis.com

그러면 다음과 비슷한 성공 메시지가 출력됩니다.

Operation "operations/..." finished successfully.

백그라운드에서 애플리케이션을 배포하기 위해 Cloud Run은 컨테이너 생태계와 페어링됩니다.

• Cloud Build는 소스 코드에서 컨테이너 이미지를 자동으로 빌드하고 이를 Artifact Registry에 푸시합니다.
• Artifact Registry에서 컨테이너 이미지를 관리합니다.

이제 애플리케이션을 준비하고 배포할 수 있습니다.

4. Slack 작업공간 만들기

맞춤 통합을 만들 수 있는 Slack 작업공간이 필요합니다. 이 가이드에 사용할 작업공간이 아직 없다면 무료로 작업공간을 만들 수 있습니다.

5. Slack 봇 사용자 만들기

봇 사용자는 Slack의 메시지를 수신하고 메시지를 게시하며 파일을 업로드할 수 있습니다. 이 Codelab에서는 간단한 인사말 메시지를 게시하는 봇을 만듭니다.

새 Slack 앱 만들기

• Slack 앱 관리 페이지로 이동합니다.
• 오른쪽 상단의 새 앱 만들기 버튼을 클릭합니다.
• 앱에 'Kittenbot'과 같은 이름을 지정합니다.
• 앱을 설치할 Slack팀을 선택합니다.

봇 사용자 만들기

• 왼쪽 패널의 기능 아래에 있는 앱 홈으로 이동합니다.

• 추가할 범위 검토를 클릭하여 봇 토큰에 범위를 할당합니다.
• Bot Token Scopes(봇 토큰 범위)까지 아래로 스크롤한 다음 Add an OAuth Scope(OAuth 범위 추가)를 클릭합니다. chat:write을 선택하여 'Kittenbot으로 메시지 보내기'

• 위로 스크롤하여 작업공간에 앱 설치 버튼을 클릭합니다.
• 이렇게 하면 앱이 팀에 설치되고, 방금 만든 봇 사용자가 추가되며, 봇 토큰이 생성됩니다.
• 메시지가 표시되면 '허용'을 클릭하여 봇이 작업공간에서 채팅할 수 있도록 승인합니다.

메시지 및 명령어 사용 설정하기

• 탭 표시까지 아래로 스크롤하여 다음 두 옵션이 모두 사용 설정되어 있는지 확인합니다.

클라이언트 서명 비밀번호 가져오기

• 설정에서 기본 정보로 이동합니다.
• 서명 보안 비밀까지 아래로 스크롤하고 표시를 클릭한 다음 보안 비밀을 클립보드에 복사합니다.

• 보안 비밀을 환경 변수에 저장합니다.

CLIENT_SIGNING_SECRET=PASTE_THE_SIGNING_SECRET

봇 토큰 가져오기

• 기능에서 OAuth 및 권한으로 이동합니다.
• Copy(복사) 버튼을 클릭하여 Bot User OAuth Access Token(봇 사용자 OAuth 액세스 토큰) 텍스트를 클립보드로 복사합니다.

• 환경 변수에 봇 토큰을 저장합니다.

BOT_TOKEN=PASTE_THE_BOT_TOKEN

걱정하지 마세요. 앱 관리 페이지에서 이 설정 페이지로 돌아올 수 있습니다.

봇 사용자 OAuth 액세스 토큰과 서명 비밀번호를 주의해서 관리해야 합니다. 다른 보안 비밀 토큰과 마찬가지로 취급하세요. 토큰을 버전 관리에 저장하거나 공개적으로 공유해서는 안 됩니다.

6. 비밀을 지켜 주세요

봇 토큰과 클라이언트 서명 비밀번호가 안전하게 저장되도록 해야 합니다. 소스 코드에 하드코딩하면 이러한 보안 비밀을 버전 관리에 게시하거나 Docker 이미지에 삽입하여 실수로 노출할 가능성이 높아집니다.

Secret Manager는 API 키, 비밀번호, 인증서, 기타 민감한 정보를 안전하고 편리하게 저장하는 방법을 제공합니다. Secret Manager는 Google Cloud에서 보안 비밀을 관리, 액세스, 감사하는 중앙의 단일 정보 소스를 제공합니다.

보안 비밀 만들기

다음 명령어를 사용하여 클라이언트 서명 보안 비밀과 봇 토큰을 저장합니다.

• 클라이언트 서명 비밀번호

echo -n $CLIENT_SIGNING_SECRET | gcloud secrets create client-signing-secret \
  --replication-policy automatic \
  --data-file -

• 봇 토큰

echo -n $BOT_TOKEN | gcloud secrets create bot-token \
  --replication-policy automatic \
  --data-file -

보안 비밀 액세스

보안 비밀이 올바르게 생성되었고 권한이 작동하는지 확인해 보겠습니다. 다음 명령어를 사용하여 보안 비밀에 액세스합니다.

echo $(gcloud secrets versions access 1 --secret client-signing-secret)
echo $(gcloud secrets versions access 1 --secret bot-token)

Google Cloud 콘솔에서 보안 비밀을 보고 관리할 수도 있습니다.

7. 샘플 코드 가져오기

Cloud Shell의 명령줄에서 다음 명령어를 실행하여 GitHub 저장소를 클론합니다.

git clone https://github.com/googlecodelabs/cloud-slack-bot.git

디렉터리를 cloud-slack-bot/start로 변경합니다.

cd cloud-slack-bot/start

코드 이해하기

원하는 명령줄 편집기 (nano, vim, emacs 등)를 사용하여 kittenbot.js 파일을 열거나 다음 명령어를 사용하여 Cloud Shell 편집기에서 현재 폴더를 직접 엽니다.

cloudshell workspace .

kittenbot 코드에는 두 가지 주요 기능이 있습니다. 하나는 보안 비밀을 가져오는 것이고 다른 하나는 봇을 실행하는 것입니다.

먼저 종속 항목을 가져옵니다.

kittenbot.js

const { Botkit } = require('botkit');
const {
  SlackAdapter,
  SlackEventMiddleware,
} = require('botbuilder-adapter-slack');
const { SecretManagerServiceClient } = require('@google-cloud/secret-manager');

SlackAdapter와 SlackEventMiddleware는 Botkit을 확장하고 봇이 Slack API와 주고받는 메시지를 쉽게 변환할 수 있도록 지원하는 패키지입니다. Secret Manager 클라이언트를 사용하면 이전 단계에서 저장한 보안 비밀에 액세스할 수 있습니다.

다음은 보안 비밀을 가져오는 함수입니다.

/**
 * Returns the secret string from Google Cloud Secret Manager
 * @param {string} name The name of the secret.
 * @return {Promise<string>} The string value of the secret.
 */
async function accessSecretVersion(name) {
  const client = new SecretManagerServiceClient();
  const projectId = process.env.PROJECT_ID;
  const [version] = await client.accessSecretVersion({
    name: `projects/${projectId}/secrets/${name}/versions/1`,
  });

  // Extract the payload as a string.
  const payload = version.payload.data.toString('utf8');

  return payload;
}

이 함수는 봇을 인증하는 데 필요한 비밀의 문자열 값을 반환합니다.

다음 함수는 봇을 초기화합니다.

/**
 * Function to initialize kittenbot.
 */
async function kittenbotInit() {
  const adapter = new SlackAdapter({
    clientSigningSecret: await accessSecretVersion('client-signing-secret'),
    botToken: await accessSecretVersion('bot-token'),
  });

  adapter.use(new SlackEventMiddleware());

  const controller = new Botkit({
    webhook_uri: '/api/messages',
    adapter: adapter,
  });

  controller.ready(() => {
    controller.hears(
      ['hello', 'hi', 'hey'],
      ['message', 'direct_message'],
      async (bot, message) => {
        await bot.reply(message, 'Meow. :smile_cat:');
      }
    );
  });
}

함수의 첫 번째 부분은 비밀을 사용하여 SlackAdapter를 구성한 다음 메시지를 수신할 엔드포인트를 지정합니다. 그런 다음 컨트롤러가 켜지면 봇이 'hello', 'hi', 'hey'가 포함된 메시지에 'Meow. 😺'.

앱 매니페스트에서 다음 특정 부분을 확인하세요.

package.json

{
  // ...
  "scripts": {
    "start": "node kittenbot.js",
    // ...
  },
  "engines": {
    "node": "16"
  },
  // ...
}

Cloud Run을 사용하면 소스에서 직접 Node.js 앱을 배포할 수 있습니다. 내부적으로 다음과 같은 일이 발생합니다.

• Cloud Run은 Cloud Build를 호출하여 컨테이너 이미지를 빌드합니다 (소스 코드에서 배포 참고).
• 소스 코드 디렉터리에 Dockerfile가 있으면 Cloud Build에서 이를 사용하여 컨테이너 이미지를 빌드합니다.
• Dockerfile이 없으므로 Cloud Build는 빌드팩을 호출하여 소스를 분석하고 프로덕션에 즉시 사용 가능한 이미지를 자동 생성합니다.
• 빌드팩은 package.json 매니페스트를 감지하고 Node.js 이미지를 빌드합니다.
• scripts.start 필드는 앱이 시작되는 방식을 결정합니다.
• engines.node 필드는 컨테이너 기본 이미지의 Node.js 버전을 결정합니다.
• 배포 시 알려진 보안 수정사항이 자동으로 적용됩니다.

이제 앱을 배포할 수 있습니다.

8. 앱 배포

Slack Events API는 웹훅을 사용하여 이벤트에 관한 발신 메시지를 전송합니다. Slack 앱을 구성할 때 Slack API가 핑할 수 있는 공개적으로 액세스 가능한 URL을 제공해야 합니다.

Cloud Run은 웹훅 대상을 호스팅하기에 적합한 솔루션입니다. 원하는 언어나 런타임을 사용할 수 있으며 동시성을 제공하므로 애플리케이션에서 훨씬 더 많은 양을 처리할 수 있습니다.

프로젝트 ID 가져오기

PROJECT_ID 환경 변수를 정의합니다.

PROJECT_ID=$(gcloud config get-value core/project)

Cloud Run 리전 정의

Cloud Run은 리전을 기반으로 합니다. 즉, Cloud Run 서비스를 실행하는 인프라가 특정 리전에 위치해 있으며, 해당 리전 내의 모든 영역에서 중복으로 사용할 수 있도록 Google이 관리합니다. 배포에 사용할 리전을 정의합니다. 예를 들면 다음과 같습니다.

REGION="us-central1"

현재 지원되는 리전 목록은 Cloud Run (완전 관리형) 위치를 참고하세요.

권한 업데이트

Secret Manager의 보안 비밀에 액세스하려면 Cloud Run 서비스 계정에 roles/secretmanager.secretAccessor 역할이 부여되어야 합니다.

먼저 기본 서비스 계정을 환경 변수에 저장합니다.

SERVICE_ACCOUNT=$(gcloud iam service-accounts list \
  --format "value(email)" \
  --filter "displayName:Compute Engine default service account")

이메일 주소가 저장되어 있는지 확인합니다.

echo $SERVICE_ACCOUNT

서비스 계정에는 [e-mail] 형식이 있습니다.

이메일 주소를 확인한 후 서비스 계정의 역할을 사용 설정합니다.

gcloud projects add-iam-policy-binding $PROJECT_ID \
  --member serviceAccount:$SERVICE_ACCOUNT \
  --role roles/secretmanager.secretAccessor

앱 배포

Cloud Run 서비스는 고유한 엔드포인트를 노출하며 수신 요청을 처리하기 위해 기본 인프라를 자동으로 확장합니다.

Cloud Run에 앱을 배포합니다.

gcloud run deploy kittenbot \
  --source . \
  --platform managed \
  --region $REGION \
  --set-env-vars PROJECT_ID=$PROJECT_ID \
  --allow-unauthenticated

• 그러면 kittenbot이라는 서비스가 생성됩니다.
• --source 옵션은 현재 폴더를 사용하여 Cloud Build로 애플리케이션을 빌드합니다. Cloud Build는 package.json 파일의 존재를 자동으로 감지합니다.
• 또는 gcloud config set run/region $REGION 명령어를 사용하여 기본 리전을 정의할 수 있습니다.
• 다음 명령어를 사용하여 Cloud Run을 기본적으로 관리형으로 설정할 수도 있습니다. gcloud config set run/platform managed
• --set-env-vars 옵션은 서비스 환경 변수를 설정합니다.
• --allow-unauthenticated 옵션을 사용하면 서비스를 공개적으로 사용할 수 있습니다.

모든 옵션을 확인하려면 gcloud run deploy --help를 사용하세요.

처음에는 Artifact Registry 저장소를 만들라는 메시지가 표시됩니다. Enter 키를 눌러 확인합니다.

Deploying from source requires an Artifact Registry Docker repository to store
built containers. A repository named [cloud-run-source-deploy] in region [REGION]
will be created.

Do you want to continue (Y/n)?

이렇게 하면 소스 코드가 Artifact Registry 저장소에 업로드되고 컨테이너 이미지가 빌드됩니다.

Building using Dockerfile and deploying container ...
* Building and deploying new service... Building Container.
  OK Creating Container Repository...
  OK Uploading sources...
  * Building Container... Logs are available at ...

그런 다음 빌드 및 배포가 완료될 때까지 잠시 기다립니다. 성공하면 명령줄에 다음과 같은 서비스 URL이 표시됩니다.

...
OK Building and deploying new service... Done.
  OK Creating Container Repository...
  OK Uploading sources...
  OK Building Container... Logs are available at ...
  OK Creating Revision... Creating Service.
  OK Routing traffic...
  OK Setting IAM Policy...
Done.
Service [SERVICE]... has been deployed and is serving 100 percent of traffic.
Service URL: https://SERVICE-PROJECTHASH-REGIONID.a.run.app

다음 명령어를 사용하여 서비스 URL을 가져올 수 있습니다.

SERVICE_URL=$( \
  gcloud run services describe kittenbot \
  --platform managed \
  --region $REGION \
  --format "value(status.url)" \
)
echo $SERVICE_URL

URL의 형식은 다음과 같습니다.

https://kittenbot-PROJECTHASH-REGIONID.a.run.app

이 URL은 Slack Events API를 사용 설정하는 데 사용되는 기본 URL입니다. 다음 단계에서 사용할 수 있도록 클립보드에 복사합니다.

이제 서비스가 게시되어 공개적으로 제공됩니다. 자세한 내용은 Cloud Run 콘솔을 참고하세요.

최근 버전이 생성된 시점, 트래픽 양, 로그를 확인할 수 있습니다. 로그를 클릭하면 Botkit 컨트롤러가 켜져 있고 메시지를 받을 준비가 되어 있음을 확인할 수 있습니다.

이제 Slack 채널에서 메시지를 보내 보겠습니다.

9. Slack 이벤트 사용 설정

앞에서 본 것처럼 kittenbot 코드는 웹훅 대상의 상대 엔드포인트를 지정합니다.

kittenbot.js

 const controller = new Botkit({
    webhook_uri: '/api/messages',
    adapter: adapter,
  });

즉, 전체 URL은 Cloud Run 서비스의 기본 부분에 /api/messages이 더해진 것입니다.

이벤트 사용 설정

앱 관리 페이지에서 사이드바의 이벤트 구독 섹션으로 이동하여 이벤트 사용 설정을 사용 설정합니다. 서비스 URL을 입력합니다.

PASTE_THE_SERVICE_URL/api/messages

URL을 입력하는 속도에 따라 완료되기 전에 인증을 시도할 수 있습니다. 실패하면 '다시 시도'를 클릭합니다.

구독

모든 메시지 봇 이벤트를 구독합니다.

페이지 하단의 변경사항 저장을 클릭합니다. 앱을 다시 설치하라는 메시지가 표시됩니다. 메시지를 따라 허용을 클릭합니다.

이제 봇이 완전히 통합되었습니다. 워크스페이스의 메시지는 Slack이 Cloud Run 서비스로 메시지를 전송하도록 트리거하며, Cloud Run 서비스는 간단한 인사말로 응답합니다.

10. 봇 테스트

Kittenbot에 채팅 메시지를 보냅니다.

'@kittenbot'을 입력한 다음 '초대'를 클릭하여 kittenbot을 채널에 추가합니다.

이제 채널의 모든 사용자가 Kittenbot과 상호작용할 수 있습니다.

Slack의 각 메시지는 이벤트를 트리거하고 HTTP POST 메시지를 Cloud Run 서비스로 전송합니다. Cloud Run 서비스 로그를 살펴보면 각 메시지가 로그의 POST 항목에 해당함을 알 수 있습니다.

kittenbot은 각 메시지에 '야옹. 😺'.

더 대화형인 봇을 원하시나요? 보너스 다음 단계를 계속 진행하여 봇을 업데이트합니다.

11. 보너스 - 봇 업데이트

이 선택 섹션은 몇 분 정도 걸립니다. 정리 단계로 바로 건너뛰어도 됩니다.

대화형 스레드

봇이 'meow' 외에도 다양하게 응답하게 만들려고 합니다. 하지만 Cloud Run에서 실행 중인 항목의 새 버전을 배포하려면 어떻게 해야 할까요?

디렉터리를 cloud-slack-bot/extra-credit으로 변경합니다.

cd ../extra-credit/

Cloud Shell 편집기에서 현재 폴더를 엽니다.

cloudshell workspace .

Botkit은 대화를 처리하는 기능을 제공합니다. 이 방식을 통해 봇이 더 많은 정보를 요청하고 한 단어로 응답하는 것보다 다양하게 메시지에 반응할 수 있습니다.

대화상자 정의

먼저 파일 끝에 대화형 함수가 어떻게 정의되어 있는지 확인하세요.

// ...
const maxCats = 20;
const catEmojis = [
  ':smile_cat:',
  ':smiley_cat:',
  ':joy_cat:',
  ':heart_eyes_cat:',
  ':smirk_cat:',
  ':kissing_cat:',
  ':scream_cat:',
  ':crying_cat_face:',
  ':pouting_cat:',
  ':cat:',
  ':cat2:',
  ':leopard:',
  ':lion_face:',
  ':tiger:',
  ':tiger2:',
];

/**
 * Function to concatenate cat emojis
 * @param {number} numCats Number of cat emojis.
 * @return {string} The string message of cat emojis.
 */
function makeCatMessage(numCats) {
  let catMessage = '';
  for (let i = 0; i < numCats; i++) {
    // Append a random cat from the list
    catMessage += catEmojis[Math.floor(Math.random() * catEmojis.length)];
  }
  return catMessage;
}

/**
 * Function to create the kitten conversation
 * @param {Object} controller The botkit controller.
 * @return {Object} The BotkitConversation object.
 */
function createKittenDialog(controller) {
  const convo = new BotkitConversation('kitten-delivery', controller);

  convo.ask('Does someone need a kitten delivery?', [
    {
      pattern: 'yes',
      handler: async (response, convo, bot) => {
        await convo.gotoThread('yes_kittens');
      },
    },
    {
      pattern: 'no',
      handler: async (response, convo, bot) => {
        await convo.gotoThread('no_kittens');
      },
    },
    {
      default: true,
      handler: async (response, convo, bot) => {
        await convo.gotoThread('default');
      },
    },
  ]);

  convo.addQuestion(
    'How many would you like?',
    [
      {
        pattern: '^[0-9]+?',
        handler: async (response, convo, bot, message) => {
          const numCats = parseInt(response);
          if (numCats > maxCats) {
            await convo.gotoThread('too_many');
          } else {
            convo.setVar('full_cat_message', makeCatMessage(numCats));
            await convo.gotoThread('cat_message');
          }
        },
      },
      {
        default: true,
        handler: async (response, convo, bot, message) => {
          if (response) {
            await convo.gotoThread('ask_again');
          } else {
            // The response '0' is interpreted as null
            await convo.gotoThread('zero_kittens');
          }
        },
      },
    ],
    'num_kittens',
    'yes_kittens'
  );

  // If numCats is too large, jump to start of the yes_kittens thread
  convo.addMessage(
    'Sorry, {{vars.num_kittens}} is too many cats. Pick a smaller number.',
    'too_many'
  );
  convo.addAction('yes_kittens', 'too_many');

  // If response is not a number, jump to start of the yes_kittens thread
  convo.addMessage("Sorry I didn't understand that", 'ask_again');
  convo.addAction('yes_kittens', 'ask_again');

  // If numCats is 0, send a dog instead
  convo.addMessage(
    {
      text:
        'Sorry to hear you want zero kittens. ' +
        'Here is a dog, instead. :dog:',
      attachments: [
        {
          fallback: 'Chihuahua Bubbles - https://youtu.be/s84dBopsIe4',
          text: '<https://youtu.be/s84dBopsIe4|' + 'Chihuahua Bubbles>!',
        },
      ],
    },
    'zero_kittens'
  );

  // Send cat message
  convo.addMessage('{{vars.full_cat_message}}', 'cat_message');

  convo.addMessage('Perhaps later.', 'no_kittens');

  return convo;
}

이 새로운 대화는 대답에 따라 대화목록을 안내합니다. 예를 들어 사용자가 새끼 고양이 질문에 '아니요'라고 대답하면 'no_kittens'라는 라벨이 지정된 메시지로 이동하며, 이는 해당 대화형 스레드의 끝입니다.

컨트롤러에 대화상자 추가

이제 대화가 정의되었으므로 컨트롤러에 추가하는 방법을 알아보세요.

async function kittenbotInit() {
  // ...
  const controller = new Botkit({
    webhook_uri: '/api/messages',
    adapter: adapter,
  });

  // Add Kitten Dialog
  const convo = createKittenDialog(controller);
  controller.addDialog(convo);

  // Controller is ready
  controller.ready(() => {
    // ...
  });
}

대화상자 트리거

이제 컨트롤러에서 사용할 수 있는 대화상자가 있으므로 챗봇이 'kitten', 'kittens', 'cat' 또는 'cats'를 들을 때 대화가 시작되는 방식을 확인하세요.

  // ...

  controller.ready(() => {
    controller.hears(
      ['hello', 'hi', 'hey'],
      ['message', 'direct_message'],
      async (bot, message) => {
        await bot.reply(message, 'Meow. :smile_cat:');
        return;
      }
    );

    // START: listen for cat emoji delivery
    controller.hears(
      ['cat', 'cats', 'kitten', 'kittens'],
      ['message', 'direct_message'],
      async (bot, message) => {
        // Don't respond to self
        if (message.bot_id !== message.user) {
          await bot.startConversationInChannel(message.channel, message.user);
          await bot.beginDialog('kitten-delivery');
          return;
        }
      }
    );
    // END: listen for cat emoji delivery

    // ...
  });

  // ...

앱 업데이트하기

Cloud Run에 애플리케이션을 다시 배포합니다.

gcloud run deploy kittenbot \
  --source . \
  --platform managed \
  --region $REGION \
  --set-env-vars PROJECT_ID=$PROJECT_ID \
  --allow-unauthenticated

사용해 보기

축하합니다. Cloud Run에서 실행되는 Slack 봇을 새 버전으로 업데이트해 보았습니다.

슬래시 명령어

사용자와 대화하고 싶지 않은 경우 어떻게 해야 하나요? 간단한 명령 하나로 작업을 트리거하고 싶다면 어떻게 해야 할까요?

Slack은 사용자가 메시지 상자에 명령어를 입력하여 애플리케이션을 호출할 수 있는 슬래시 명령어를 통해 이 기능을 제공합니다.

Slack 슬래시 명령어 사용 설정

• 앱 관리 페이지의 기능 아래에 있는 슬래시 명령어 섹션으로 이동합니다.
• 새 명령어 만들기를 클릭합니다.
• kittenbot 서비스 URL로 /cats 명령어를 구성합니다. Events API를 사용 설정하는 데 사용한 것과 동일한 엔드포인트를 사용해야 합니다. URL에 '/api/messages'이 추가됩니다.

• 메시지에 따라 앱과 권한을 업데이트합니다.

컨트롤러에 슬래시 명령어 추가하기

컨트롤러.ready 함수 내에 슬래시 명령어 핸들러가 추가된 방식을 확인하세요.

  // ...

  // Controller is ready
  controller.ready(() => {
    // ...

    // START: slash commands
    controller.on('slash_command', async (bot, message) => {
      const numCats = parseInt(message.text);
      const response = makeCatMessage(numCats);
      bot.httpBody({ text: response });
    });
    // END: slash commands
  });

  // ...

사용해 보기

'/cats'와 숫자를 입력하여 슬래시 명령어를 전송합니다. 예: /cats 8

봇은 나만 볼 수 있는 고양이 8마리로 응답합니다.

12. 삭제

축하합니다. 이제 Cloud Run에서 Slack 봇이 실행됩니다. 비용을 절감하고 클라우드를 효율적으로 사용하기 위해 사용한 리소스를 삭제해 보겠습니다.

프로젝트 삭제

Cloud Shell에서 바로 전체 프로젝트를 삭제할 수 있습니다.

gcloud projects delete $PROJECT_ID

또는 여러 리소스를 하나씩 삭제하려면 다음 섹션으로 진행하세요.

배포 삭제

gcloud run services delete kittenbot --region $REGION

명령어 출력

Service [kittenbot] will be deleted.
Do you want to continue (Y/n)?  y
Deleted service [kittenbot].

클라이언트 서명 비밀번호 삭제하기

gcloud secrets delete client-signing-secret

명령어 출력

You are about to destroy the secret [client-signing-secret] and its
[1] version(s). This action cannot be reversed.
Do you want to continue (Y/n)?  y
Deleted secret [client-signing-secret].

봇 토큰 보안 비밀 삭제

gcloud secrets delete bot-token

명령어 출력

You are about to destroy the secret [bot-token] and its [1]
version(s). This action cannot be reversed.
Do you want to continue (Y/n)?  y
Deleted secret [bot-token].

스토리지 버킷 삭제

먼저 Google Cloud Storage 버킷을 나열하여 버킷 경로를 가져옵니다.

gsutil ls

명령어 출력

gs://[REGION.]artifacts.<PROJECT_ID>.appspot.com/
gs://<PROJECT_ID>_cloudbuild/

이제 아티팩트 버킷을 삭제합니다.

gsutil rm -r gs://[REGION.]artifacts.${PROJECT_ID}.appspot.com/

명령어 출력

Removing gs://[REGION.]artifacts.<PROJECT_ID>.appspot.com/...

마지막으로 cloudbuild 버킷을 삭제합니다.

gsutil rm -r gs://${PROJECT_ID}_cloudbuild/

명령어 출력

Removing gs://<PROJECT_ID>_cloudbuild/...

13. 축하합니다.

이제 Cloud Run에서 Slack 봇을 실행하는 방법을 알게 되었습니다.

여기서는 이 기술의 개략적인 사항만 살펴보았으므로, Cloud Run 배포에 관해 더 자세한 내용을 직접 공부해 보는 것을 권장합니다.

학습한 내용

• Slack에서 봇 맞춤 통합 만들기
• Secret Manager로 Slack 보안 비밀 보호
• Cloud Run에 Slack 봇 배포

다음 단계

• Cloud Run 튜토리얼 더 완료하기

자세히 알아보기

• GitHub의 다른 Google Cloud Slack 통합 예시를 확인합니다.
• 다른 Google Cloud 기능을 직접 사용해보세요. 튜토리얼을 살펴보세요.