Хостинг: Heroku

Ми припускаємо, що у вас є базові знання про створення ботів за допомогою grammY. Якщо ви ще не готові, не соромтеся перейти до нашого дружнього посібника! 🚀

Цей посібник навчить вас, як розгорнути бота Telegram на Heroku за допомогою вебхуків або тривалого опитування. Ми також припускаємо, що у вас вже є обліковий запис Heroku.

Передумови

Спочатку встановіть деякі залежності:

# Створіть каталог проєкту.
mkdir grammy-bot
cd grammy-bot
npm init --y

# Встановіть основні залежності.
npm install grammy express

# Встановіть залежності розробки.
npm install -D typescript @types/express @types/node

# Створіть конфігурацію TypeScript.
npx tsc --init

Ми зберігатимемо файли TypeScript у каталозі src, а скомпільовані файли у каталозі dist. Створіть каталоги у кореневій директорії проєкту. Далі, у каталозі src створіть новий файл з назвою bot.ts. Тепер структура каталогів має виглядати наступним чином:

asciiart

.
├── node_modules/
├── dist/
├── src/
│   └── bot.ts
├── package.json
├── package-lock.json
└── tsconfig.json

Після цього відкрийте tsconfig.json і змініть його, щоб використовувати таку конфігурацію:

json

{
  "compilerOptions": {
    "target": "ESNEXT",
    "module": "ESNext", // [!code hl] // змінено з CommonJS на ESNext.
    "lib": ["ES2021"],
    "outDir": "./dist/",
    "strict": true,
    "moduleResolution": "node",
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src"]
}

Оскільки опція module вище була змінена з commonjs на esnext, нам потрібно додати "type": "module" до package.json. Тепер package.json має бути подібним до наступного:

json

{
  "name": "grammy-bot",
  "version": "0.0.1",
  "description": "",
  "main": "dist/app.js",
  "type": "module", // [!code hl] // встановлюємо параметр "type": "module"
  "scripts": {
    "dev-build": "tsc"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "grammy": "^1.2.0",
    "express": "^4.17.1"
  },
  "devDependencies": {
    "typescript": "^4.3.5",
    "@types/express": "^4.17.13",
    "@types/node": "^16.3.1"
  },
  "keywords": []
}

Як вже згадувалося раніше, у нас є два варіанти як отримувати дані від Telegram: вебхуки та тривале опитування. Ви можете дізнатися більше про переваги обох методів та вирішити, який з них підходить для вас, перейшовши за цим посиланням до чудових порад!

Вебхуки

Якщо ви вирішили використовувати тривале опитування, ви можете пропустити цей розділ та перейти до розділу про тривале опитування. 🚀

Коротко кажучи, на відміну від тривалого опитування, вебхуки не працюють постійно для перевірки вхідних повідомлень від Telegram. Це зменшує навантаження на сервер та економить нам багато dyno hours, особливо коли ви використовуєте план Eco. 😁

Добре, продовжимо! Памʼятаєте, що ми раніше створили bot.ts? Ми не будемо розміщувати весь код там, а залишимо написання бота на ваш розсуд. Натомість зробимо app.ts точкою входу застосунку. Це означає, що кожного разу, коли Telegram або хто-небудь інший відвідує ваш сайт, express вирішує, яка частина вашого сервера буде відповідальною за обробку запиту. Це корисно, коли ви розгортаєте вебсайт та бота на одному домені. Крім того, розділення коду на різні файли робить ваш код більш організованим. ✨

Express та його проміжний обробник

Створіть зараз файл app.ts у каталозі src та напишіть у ньому наступний код:

import express from "express";
import { webhookCallback } from "grammy";
import { bot } from "./bot.js";

const domain = String(process.env.DOMAIN);
const secretPath = String(process.env.BOT_TOKEN);
const app = express();

app.use(express.json());
app.use(`/${secretPath}`, webhookCallback(bot, "express"));

app.listen(Number(process.env.PORT), async () => {
  // Переконайтеся, що ви використовуєте `https`, а не `http`!
  await bot.api.setWebhook(`https://${domain}/${secretPath}`);
});

Давайте розглянемо код вище:

process.env: памʼятайте, НІКОЛИ не зберігайте дані авторизації у вашому коді! Для створення змінних середовища в Heroku, перейдіть за цим посиланням.
secretPath: це може бути BOT_TOKEN або будь-який випадковий рядок. Краще всього приховати шлях, як це пояснено Telegram.

⚡ Оптимізація (не обовʼязково)

bot.api.setWebhook у 14-му рядку завжди запускатиметься, коли Heroku запускає ваш сервер знову. Для ботів з низьким трафіком це відбуватиметься для кожного запиту. Однак нам не потрібно, щоб цей код виконувався щоразу, як надходить запит. Тому ми можемо повністю видалити цю частину і виконати GET лише один раз вручну. Відкрийте наступне посилання у своєму браузері після розгортання бота:

asciiart

https://api.telegram.org/bot<токен-бота>/setWebhook?url=<адреса>

Зверніть увагу, що деякі браузери вимагають ручного кодування вашого <адреса> перед передачею його. Наприклад, якщо у нас є токен бота abcd:1234 та URL-адреса https://grammybot.herokuapp.com/secret_path, то наше посилання повинно виглядати наступним чином:

asciiart

https://api.telegram.org/botabcd:1234/setWebhook?url=https%3A%2F%2Fgrammybot.herokuapp.com%2Fsecret_path

⚡ Оптимізація (не обовʼязково)

Використовуйте відповідь вебхуку для більшої ефективності.

Створення `bot.ts` (вебхук)

Наступним кроком перейдіть до файлу bot.ts:

import { Bot } from "grammy";

const token = process.env.BOT_TOKEN;
if (!token) throw new Error("BOT_TOKEN не встановлено");

export const bot = new Bot(token);

bot.command("start", (ctx) => ctx.reply("Привіт всім!"));
bot.on("message", (ctx) => ctx.reply("Отримав інше повідомлення!"));

Добре! Наразі ми закінчили написання наших основних файлів. Але перед тим, як перейти до кроків розгортання, ми можемо трішки оптимізувати бота. Як зазвичай, це не обовʼязково.

⚡ Оптимізація (не обовʼязково)

Кожного разу, коли ваш сервер запускається, grammY буде запитувати інформацію про бота з Telegram з метою надання цієї інформації в обʼєкту контексту в ctx.me. Ми можемо встановити інформацію про бота, щоб запобігти надмірним викликам getMe.

Відкрийте посилання https://api.telegram.org/bot<токен-бота>/getMe в вашому улюбленному браузері. Рекомендується Firefox, бо він чудово працює з форматом json.

Змініть код на 4-му рядку вище і заповніть значення відповідно до результатів, отриманих з getMe:

const token = process.env.BOT_TOKEN;
if (!token) throw new Error("BOT_TOKEN не вказано");

export const bot = new Bot(token, {
  botInfo: {
    id: 111111111,
    is_bot: true,
    first_name: "xxxxxxxxx",
    username: "xxxxxxbot",
    can_join_groups: true,
    can_read_all_group_messages: false,
    supports_inline_queries: false,
  },
});

Круто! Настала пора підготувати наше середовище для розгортання! Усі прямуємо до розділу про розгортання! 💪

Тривале опитування

Ваш скрипт буде працювати безперервно при використанні тривалого опитування.

Якщо ви не знаєте, як керувати цією поведінкою, переконайтеся, що у вас є достатньо dyno hours для цього.

Думаєте про використання вебхуків? Перейдіть до розділу про вебхуки. 🚀

Використання тривалого опитування на вашому сервері не завжди є поганою ідеєю. Іноді воно підходить для ботів, що збирають дані і не потребують швидкої відповіді та обробки великої кількості даних. Якщо ви хочете робити це раз на годину, це легко зробити. Але цього не можна контролювати за допомогою вебхуків. Якщо ваш бот буде завалений повідомленнями, вам прийде багато запитів на вебхук, проте за допомогою тривалого опитування ви можете легко обмежити швидкість обробки оновлень.

Створення `bot.ts` (тривале опитування)

Давайте відкриємо файл bot.ts, який ми створили раніше. Він має містити наступний код:

import { Bot } from "grammy";

const token = process.env.BOT_TOKEN;
if (!token) throw new Error("BOT_TOKEN не вказано");

const bot = new Bot(token);

bot.command(
  "start",
  (ctx) =>
    ctx.reply("Я запущений на Heroku з використанням тривалого опитування!"),
);

bot.start();

Ось і все! Ми готові розгорнути його. Досить просто, чи не так? 😃 Якщо ви думаєте, що це занадто просто, перевірте наш контрольний список розгортання! 🚀

Розгортання

Ні… ваш Rocket Bot ще не готовий до запуску. Спочатку завершіть наступні етапи!

Компіляція файлів

Запустіть цей код у терміналі, щоб скомпілювати файли TypeScript в JavaScript:

npx tsc

Якщо він успішно виконається й не видасть жодних помилок, скомпільовані файли з розширенням .js повинні знаходитись у каталозі dist.

Налаштування `Procfile`

Наразі у Heroku є кілька типів dyno. Два з них:

Веб dyno:
Веб dyno процесу “web”, які отримують HTTP трафік від маршрутизаторів. Цей тип dyno має 30-ти секундний тайм-аут для виконання коду. Крім того, він засинає, якщо протягом 30-ти хвилин не було запиту для обробки. Цей тип dyno цілком підходить для вебхуків.
Worker dyno:
Worker dyno зазвичай використовуються для фонових задач. Він НЕ має тайм-ауту і НЕ засинає, якщо не обробляє жодного вебзапиту. Він підходить для тривалого опитування.

Створіть файл з назвою Procfile без розширення в кореневому каталозі проєкту. Наприклад, Procfile.txt і procfile не є дійсними. Далі напишіть цей код одним рядком у такому форматі:

procfile

<тип dyno>: <команда для виконання основного файлу>

У нашому випадку він має бути таким:

ВебхукТривале опитування

procfile

web: node dist/app.js

procfile

worker: node dist/bot.js

Налаштування Git

Ми збираємося розгорнути бота за допомогою Git та Heroku CLI. Ось посилання на інсталяцію:

Припускаємо, що ви вже маєте їх на своєму компʼютері й у вас відкритий термінал в кореневому каталозі проєкту. Тепер ініціалізуйте локальний репозиторій Git, запустивши цей код у вашому терміналі:

git init

Далі нам потрібно запобігти наданню зайвих файлів нашому продакшн серверу, в нашому випадку це Heroku. Створіть файл з назвою .gitignore в кореневому каталозі проєкту. Потім додайте цей список:

text

node_modules/
src/
tsconfig.json

Кінцева структура каталогів повинна виглядати наступним чином:

ВебхукТривале опитування

asciiart

.
├── .git/
├── node_modules/
├── dist/
│   ├── bot.js
│   └── app.js
├── src/
│   ├── bot.ts
│   └── app.ts
├── package.json
├── package-lock.json
├── tsconfig.json
├── Procfile
└── .gitignore

asciiart

.
├── .git/
├── node_modules/
├── dist/
│   └── bot.js
├── src/
│   └── bot.ts
├── package.json
├── package-lock.json
├── tsconfig.json
├── Procfile
└── .gitignore

Збережіть файли у репозиторії Git:

git add .
git commit -m "Мій перший коміт"

Налаштування віддаленого доступу Heroku

Якщо ви вже створили застосунок Heroku, введіть назву вашого існуючого застосунку (Existing app) замість <мій-застосунок> нижче, а потім запустіть код. В іншому випадку запустіть новий застосунок (New app).

Новий застосунокІснуючий застосунок

heroku create
git remote -v

heroku git:remote -a <мій-застосунок>

Розгортання коду

Наостанок, натисніть червону кнопку і стартуємо! 🚀

git push heroku main

Якщо це не працює, можливо, гілка Git називається не main, а master. Тоді натисніть синю кнопку:

git push heroku master

Хостинг: Heroku ​

Передумови ​

Вебхуки ​

Express та його проміжний обробник ​

Створення bot.ts (вебхук) ​

Тривале опитування ​

Створення bot.ts (тривале опитування) ​

Розгортання ​

Компіляція файлів ​

Налаштування Procfile ​

Налаштування Git ​

Налаштування віддаленого доступу Heroku ​

Розгортання коду ​

Хостинг: Heroku

Передумови

Вебхуки

Express та його проміжний обробник

Створення `bot.ts` (вебхук)

Тривале опитування

Створення `bot.ts` (тривале опитування)

Розгортання

Компіляція файлів

Налаштування `Procfile`

Налаштування Git

Налаштування віддаленого доступу Heroku

Розгортання коду