Skip to content

Commit fcf0b98

Browse files
augustjkaugustjk
authored
Cloud build for discord bot deploy (#937)
* Add cloudbuild and deploy for discord bot * Add http server for Cloud Run * Prevent crashing on error * Add build script * Add readme and todo
1 parent fa16b0a commit fcf0b98

File tree

5 files changed

+132
-5
lines changed

5 files changed

+132
-5
lines changed

‎Dockerfile-discord-bot

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Official lightweight Node.js image
2+
# https://hub.docker.com/_/node
3+
FROM node:18-slim
4+
5+
# Arbitrary but conventional working directory
6+
WORKDIR /usr/src/app
7+
8+
# Note we isolate work across sub-packages below, organized from least to most
9+
# likely to change, to maximize Docker filesystem layer cache hits. For
10+
# example, organized this way a site content only change will usually only need
11+
# to execute the final Eleventy build step.
12+
13+
# External dependencies
14+
COPY package*.json tsconfig.base.json ./
15+
COPY packages/lit-dev-tools-cjs/package*.json ./packages/lit-dev-tools-cjs/
16+
COPY packages/lit-dev-tools-esm/package*.json ./packages/lit-dev-tools-esm/
17+
COPY packages/lit-dev-server/package*.json ./packages/lit-dev-server/
18+
COPY packages/lit-dev-discord-bot/package*.json ./packages/lit-dev-discord-bot/
19+
RUN npm ci
20+
21+
# Tooling code
22+
COPY packages/lit-dev-tools-cjs/ ./packages/lit-dev-tools-cjs/
23+
COPY packages/lit-dev-tools-esm/ ./packages/lit-dev-tools-esm/
24+
COPY packages/lit-dev-server/ ./packages/lit-dev-server/
25+
COPY packages/lit-dev-discord-bot/ ./packages/lit-dev-discord-bot/
26+
RUN npm run build:ts -w packages/lit-dev-tools-cjs -w packages/lit-dev-tools-esm -w packages/lit-dev-server -w packages/lit-dev-discord-bot
27+
28+
# Run the web service on container startup.
29+
#
30+
# IMPORTANT: Keep --max-old-space-size in sync with the --memory flag in
31+
# ./cloudbuild-main.yaml. The flag here should be set a little lower than
32+
# --memory (e.g. 75%) to give headroom for other uses [0].
33+
#
34+
# (Node isn't aware of Docker memory limits, so if we don't set this flag we're
35+
# at higher risk for termination and restart. This value determines when V8
36+
# decides to perform garbage collection. Node uses sysinfo totalram as the
37+
# default limit [1], which will be higher than our Docker memory limit.)
38+
#
39+
# [0] https://nodejs.org/api/cli.html#cli_max_old_space_size_size_in_megabytes
40+
# [1] https://github.com/nodejs/node/pull/25576
41+
CMD [ "node", "--max-old-space-size=768", "packages/lit-dev-discord-bot/lib/index.js" ]

‎cloudbuild-discord-bot.yaml

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# lit.dev Cloud Build config for discord bot deployment.
2+
# This is triggered manually.
3+
#
4+
# https://cloud.google.com/cloud-build/docs/build-config
5+
6+
steps:
7+
# Build Docker image.
8+
#
9+
# https://docs.docker.com/engine/reference/commandline/build/
10+
# https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/docker
11+
# https://cloud.google.com/build/docs/kaniko-cache
12+
- id: build
13+
# Kaniko pinned to earlier version due to
14+
# https://github.com/GoogleContainerTools/kaniko/issues/1786
15+
name: gcr.io/kaniko-project/executor:v1.6.0
16+
args:
17+
- --dockerfile=./Dockerfile-discord-bot
18+
- --destination=$_GCR_HOSTNAME/$PROJECT_ID/$REPO_NAME/lit-dev-discord-bot:$COMMIT_SHA
19+
- --cache=true
20+
- --cache-ttl=168h # 1 week
21+
22+
# Create a new Cloud Run revision for the discord bot.
23+
#
24+
# https://cloud.google.com/sdk/gcloud/reference/beta/run/deploy
25+
# https://github.com/GoogleCloudPlatform/cloud-sdk-docker
26+
- id: deploy-discord-bot
27+
name: gcr.io/google.com/cloudsdktool/cloud-sdk
28+
entrypoint: gcloud
29+
args:
30+
- beta
31+
- run
32+
- deploy
33+
- lit-dev-discord-bot # Service name
34+
- '--region=$_DEPLOY_REGION'
35+
- '--platform=managed'
36+
- '--image=$_GCR_HOSTNAME/$PROJECT_ID/$REPO_NAME/lit-dev-discord-bot:$COMMIT_SHA'
37+
- '--quiet'
38+
- '--tag=main-$SHORT_SHA'
39+
# IMPORTANT: If you change --memory, be sure to also change
40+
# --max-old-space-size in ./Dockerfile-discord-bot, and this same flag in
41+
- '--memory=1Gi'
42+
- '--cpu=1'
43+
- '--concurrency=default' # unlimited
44+
- '--min-instances=1'
45+
- '--max-instances=1'
46+
- '--set-secrets=BOT_CLIENT_SECRET=lit-dev-discord-bot-token:1'
47+
48+
# TODO(augustjk) Consider adding a step here to delete the old revision
49+
50+
tags:
51+
- lit-dev
52+
- discord-bot
53+
54+
options:
55+
machineType: 'N1_HIGHCPU_8'
56+
57+
timeout: 45m

‎packages/lit-dev-discord-bot/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# lit-dev-discord-bot
2+
3+
This package contains the code for Lit Bot discord bot that responds to `/docs` command which searches the lit.dev site index for provided query and returns a list of matches. It posts the url to the doc in the chat when an option is selected.
4+
5+
## Deployment
6+
7+
The bot is deployed by Google Cloud Build as a Cloud Run service. The Cloud Build configuration is stored in the root of the monorepo `cloudbuild-discord-bot.yaml`.
8+
9+
The Cloud Build job must be triggered _manually_ to deploy a new version of the bot. Run the trigger from the Google Cloud console after the new code is merged to deploy a new version of the bot. After successful deployment, remove the old revision to prevent multiple bots from trying to handle the same request.

‎packages/lit-dev-discord-bot/package.json

+6
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,16 @@
1010
"module": "lib/index.js",
1111
"scripts": {
1212
"build": "wireit",
13+
"build:ts": "wireit",
1314
"start": "wireit"
1415
},
1516
"wireit": {
1617
"build": {
18+
"dependencies": [
19+
"build:ts"
20+
]
21+
},
22+
"build:ts": {
1723
"command": "tsc --build --pretty",
1824
"files": [
1925
"src/**/*.ts",

‎packages/lit-dev-discord-bot/src/index.ts

+19-5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* SPDX-License-Identifier: BSD-3-Clause
55
*/
66

7+
import http from 'node:http';
78
import {
89
AutocompleteInteraction,
910
ChatInputCommandInteraction,
@@ -138,7 +139,7 @@ const handleDocsSubmissionInteraction = async (
138139
// If the response is not a lit.dev url, then bot responds with an
139140
// ephemeral message that is only visible to the user. This happens when
140141
// there are no results, or if the user hits enter before results show up.
141-
interaction.reply({
142+
await interaction.reply({
142143
ephemeral: true,
143144
content: `value: "${value}" is not a valid lit.dev url. Please select from the autocomplete list.`,
144145
});
@@ -149,25 +150,29 @@ const handleDocsSubmissionInteraction = async (
149150
* Creates a discord bot client, registers the event handlers, and starts the
150151
* client websocket server that listens for events.
151152
*/
152-
const startClientWebsocketServer = async () => {
153+
const startClientWebsocketServer = () => {
153154
const client = new Client({intents: [GatewayIntentBits.Guilds]});
154155

155156
client.on('ready', () => {
156157
console.log(`Logged in as ${client.user?.tag}!`);
157158
});
158159

159-
client.on('interactionCreate', async (interaction) => {
160+
client.on('interactionCreate', (interaction) => {
160161
// handle only the /docs slash command.
161162
if ((interaction as ChatInputCommandInteraction).commandName === 'docs') {
162163
// This happens as the user is typing. Enabled by the
163164
// SlashCommandBuilder's .setAutocomplete(true) option.
164165
if (interaction.type === InteractionType.ApplicationCommandAutocomplete) {
165-
handleDocsAutocompleteInteraction(interaction);
166+
handleDocsAutocompleteInteraction(interaction).catch((error) =>
167+
console.error(error)
168+
);
166169
}
167170

168171
// This is true when the user finally returns a command. (a lit.dev url)
169172
if (interaction.isChatInputCommand()) {
170-
handleDocsSubmissionInteraction(interaction);
173+
handleDocsSubmissionInteraction(interaction).catch((error) =>
174+
console.error(error)
175+
);
171176
}
172177
}
173178
});
@@ -178,3 +183,12 @@ const startClientWebsocketServer = async () => {
178183

179184
publishDiscordCommands([docsSlashCommand]);
180185
startClientWebsocketServer();
186+
187+
/**
188+
* HTTP server for Cloud Run liveness
189+
*/
190+
http
191+
.createServer((_, response) => {
192+
response.end('OK');
193+
})
194+
.listen(process.env.PORT ?? 8080);

0 commit comments

Comments
 (0)