Telegram бот для записи на переобувку

[Nelfimov]

С чем связан запрос на фичу?

Необходимо разработать Telegram бота, через которого можно было бы записываться на переобувку

Расскажите как вы это себе видите

• [x] стек
  • [x] nestjs
  • [x] https://github.com/tgsnake/core
• [ ] бот должен работать в виде опросника
  • [x] кузов автомобиля
  • [x] диаметр колес
  • [x] тип ремонта
  • [x] домментарий
  • [ ] из контекста сообщения взять номер телефона и имя пользователя
• [x] бот должен предлагать на выбор ближайшие 7 дней на переобувку
• [x] бот должен давать окна для записи с временным интервалом в 30 минут начиная со времени открытия
• [ ] при подтверждении записи бот делает запись в БД. Запись при этом отмечает как неподтвержденную со стороны шиномонтажки
• [ ] когда шиномонтажка подтверждает запись - бот отправляет сообщение пользователю с подтверждением
• [ ] должен быть эндпоинт для записи через REST API с сайта (форма "Записаться")

Архитектура: clean - https://github.com/atls/serverless-yandex

Приложите пример реализаций

https://github.com/atls/migration-bot/tree/refactor/promise-to-wizard

[Nelfimov]

@TorinAsakura проверь пожалуйста задачу.

Для шиномонтажки бота с мониторингом записей делаем отдельного?

[TorinAsakura]

@TorinAsakura проверь пожалуйста задачу.

Для шиномонтажки бота с мониторингом записей делаем отдельного?

каким мониторингом? каких записей?

[Nelfimov]

@TorinAsakura мы проговаривали - запись пользователя должна быть подтверждаемой со стороны монтажки. Для этого делаем отдельного бота?

[TorinAsakura]

@TorinAsakura мы проговаривали - запись пользователя должна быть подтверждаемой со стороны монтажки. Для этого делаем отдельного бота?

конечно, бот оператора и бот записи

[kirill-ivanovvv]

@Nelfimov, подскажи пожалуйста

• не понимаю, почему в candify applicant вынесен в отдельный сервис
• если делать по аналогии с текущим приложением, то слой для этого бота я должен назвать booking-telegram-bot
• а если делать по аналогии с candify, то выделить сущность клиента/заказчика
• в каком направлении мне читать про это?

[Nelfimov]

• не понимаю, почему в candify applicant вынесен в отдельный сервис

Микросервисная архитектура. Бэкенд разделен по DDD

Для твоей задачи это не нужно.

• если делать по аналогии с текущим приложением, то слой для этого бота я должен назвать booking-telegram-bot

Делаем так

[Nelfimov]

@effektivnayarabota1 обрати внимание - добавил еще требование:

• [ ] должен быть эндпоинт для записи через REST API с сайта (форма "Записаться")

[kirill-ivanovvv]

Текущий статус

• провел ентрипоинты
• настроил бота
• запустил бота
• на сообщения отвечает

  Дальнейшие планы

• разобратся как разнести функции бота по модулям (сервисам)

  Актуальная ветка

  https://github.com/torin-asakura/shdvor/tree/feat/booking-telegram-bot

[TorinAsakura]

• если делать по аналогии с текущим приложением, то слой для этого бота я должен назвать booking-telegram-bot

telegram-bot это твой контекст, это никак не может быть слоем

booking - выглядит как домен, если вы по DDD собираетесь работать

[kirill-ivanovvv]

Текущий статус

• разбирал доки nest - в большинстве вопросов разобрался
• искал способы сделать кастомный контроллер, чтобы работало как в nestjs-telegraf (@Update) - сделать не удалось
• искал как повесить обработчик tgsnake-событий - сделать не удалось.
• изучал исходный код nestjs-telegraf - в сроки не уложусь если еще посвящу время этому, поэтому оставлю.

  Дальнейшие планы

• буду делать без контроллера, просто сервисы-conversations внутри сервиса-ентрипонта https://tgsnake.js.org/en/guide/conversation

  Актуальная ветка

• https://github.com/torin-asakura/shdvor/tree/feat/booking-telegram-bot

[kirill-ivanovvv]

@Nelfimov нужна помощь

1. связал порты в infrastructure.providers - дает ошибку, предлагает импортиовать порт в один из модулей. насколько понимаю, так они рабоать не будут?

log

```ts ➤ YN0000: ┌ Service Development ➤ YN0000: │ Starting server... ➤ YN0000: │ nestjs:NestFactory Starting Nest application... ➤ YN0000: │ Welcome to tgsnake! ➤ YN0000: │ Using version: 3.3.1 - Stable ➤ YN0000: │ Thanks for using tgsnake ➤ YN0000: │ (tgsnake) warning - If you use the experimental option, we strongly do not recommend using this function. 19/9/2024 13:38:5.353 ➤ YN0000: │ [Nest] 149776 - 09/19/2024, 1:38:05 PM LOG [InstanceLoader] BotServiceEntrypointModule dependencies initialized ➤ YN0000: │ [Nest] 149776 - 09/19/2024, 1:38:05 PM LOG [InstanceLoader] TgsnakeAdapterModule dependencies initialized +1ms ➤ YN0000: │ nestjs:ExceptionHandl Nest can't resolve dependencies of the SendMessageUseCase (?). Please make sure that the argument TelegramClientPort at index [0] is ➤ YN0000: │ er available in the TelegramBotApplicationModule context. ➤ YN0000: │ ➤ YN0000: │ Potential solutions: ➤ YN0000: │ - Is TelegramBotApplicationModule a valid NestJS module? ➤ YN0000: │ - If TelegramClientPort is a provider, is it part of the current TelegramBotApplicationModule? ➤ YN0000: │ - If TelegramClientPort is exported from a separate @Module, is that module imported within TelegramBotApplicationModule? ➤ YN0000: │ @Module({ ➤ YN0000: │ imports: [ /* the Module containing TelegramClientPort */ ] ➤ YN0000: │ }) ➤ YN0000: │ ```

2. где инициировать клиент tgsnake. через порты мы передаем инициированный клиент, верно?
3. useCase используется Processor. В serveless-yandex этот Processor вызывается в handler. у нас ентрипоинт сделан по-другому - bootstrap через NestFactory.create. Пробовал сделать также, как в serverless-yandex - не получилось, была бесконечная загрузка. как использовать useCase в нашем случае? если инициировать его в адаптере, будет ли возможно вызывать useCase из адаптера?

[Nelfimov]

@effektivnayarabota1 технически ошибка была на очевидном месте, любая нормальная IDE тебе подсветила бы. Оставил в ревью комменты с деталями

[kirill-ivanovvv]

Текущий статус

• разобрался, подключил application-module
• разобрался, подключил infrastructure-module
• разобрался, подключил processor. бот отвечате на сообщения

  Дальнейшие планы

• работа над conversation https://tgsnake.js.org/en/guide/conversation

  Актуальная ветка

  https://github.com/torin-asakura/shdvor/tree/feat/booking-telegram-bot

[kirill-ivanovvv]

@Nelfimov а hmr должен нормально работать? у меня на модули жалуется HMR is not implemented for module chunk format yet в сети нашел вот такую инфу: https://github.com/webpack/webpack/issues/17636

[kirill-ivanovvv]

• когда шиномонтажка подтверждает запись

• шиномонтажка будет подтверждать запись тоже через бота?

[Nelfimov]

@Nelfimov а hmr должен нормально работать? у меня на модули жалуется HMR is not implemented for module chunk format yet в сети нашел вот такую инфу: webpack/webpack#17636

Забирай из мастера новый бандл

• когда шиномонтажка подтверждает запись

• шиномонтажка будет подтверждать запись тоже через бота?

https://github.com/torin-asakura/shdvor/issues/70#issuecomment-2323292352

[kirill-ivanovvv]

@Nelfimov в опроснике дублирую поля с формы на сайте, или вывожу только эти два вопроса?

• какая машина
• [ ] какой диаметр колес

[Nelfimov]

дублируешь

[kirill-ivanovvv]

Текущий статус

• расчертил диалог (conversation) - псевдокод + продетализировал его немного. пока без данных

• разбирался с интерфейсом tgsnake. у него есть собственный метод sendMessage, без нормальной документации. подумал, что на следующих этапах могут быть затруднения, например, с клавиатурой, поэтому использую телеграммовский SendMessage

• настроил телеграммовский SendMessage. пока пишу в одном файле, разносить буду на следующих этапах.

  Дальнейшие планы

• получение данных

• продетализироваь conversation:

  • добавить в вопросы приходящие данные
  • добавить клавиатуру с вариантами ответа
  • добавить проверку ответа по данным

• рефакторинг:

  1. adapter экспортирует методы типа sendMessage, reply - исключительно взаимодействие с этой библиотекой
  2. use-case подтягивает эти методы и использует их. приводить данные с запросов я буду на этот уровень. весь conversation у меня будет также на этом уровне
  3. в consumer висит и слушает события. если выполняет условие одного события, выполнение кода уходит на уровень в use-case @Nelfimov посмотри пожалуйста этот абзац, все ли я правильно понял. Если есть примеры с consumer - будь добр, поделись 🙏

• потом буду делать запись данных в бд

  Актуальная ветка

  https://github.com/torin-asakura/shdvor/tree/feat/booking-telegram-bot

[Nelfimov]

1. adapter экспортирует методы типа sendMessage, reply - исключительно взаимодействие с этой библиотекой

Да

2. use-case подтягивает эти методы и использует их. приводить данные с запросов я буду на этот уровень. весь conversation у меня будет также на этом уровне

Некорректно сформулировал - use-case находится в application. Это значит что взаимодействовать с адаптерами будет через порты. Имплементация порта - в infrastructure

3. в consumer висит и слушает события. если выполняет условие одного события, выполнение кода уходит на уровень в use-case

cosunmer или processor - отвечает за получение сообщения. Дальше он передает полученное в use-case

https://github.com/atls/serverless-yandex/blob/master/contexts/video-optimizer/infrastructure-module/src/processors/object-created.processor.ts

[kirill-ivanovvv]

Текущий статус

• сделал рефакторинг по этому плану - https://github.com/torin-asakura/shdvor/issues/70#issuecomment-2363945574
• вынес conversation в отдельный сервис на уровне application

  Дальнейшие планы

• сделать первую часть этого плана - https://github.com/torin-asakura/shdvor/issues/70#issuecomment-2363945574
  • запрос данных
  • проверка ответа пользователя
  • написать метод для отправки клавиатуры

@Nelfimov посмотри пожалуйста:

• есть вариант упаковать process в use-case, но я вот сдела так. как лучше? https://github.com/torin-asakura/shdvor/blob/0947cacbc0f53413b81e7744830a5be968fd39df/booking-telegram-bot/contexts/telegram-bot/infrastructure-module/src/processors/bot-listen.processor.ts#L17

Актуальная ветка

https://github.com/torin-asakura/shdvor/tree/feat/booking-telegram-bot

[Nelfimov]

@Nelfimov посмотри пожалуйста:

• есть вариант упаковать process в use-case, но я вот сдела так. как лучше? https://github.com/torin-asakura/shdvor/blob/0947cacbc0f53413b81e7744830a5be968fd39df/booking-telegram-bot/contexts/telegram-bot/infrastructure-module/src/processors/bot-listen.processor.ts#L17

Все правильно - юз кейс обрабатывает уже конкретный случай. А прослушивание надо выделять в отдельный объект в инфраструктуре.

Можешь разделить логически юз кейсы, напр:

• старт приложения
• запись на шиномонтаж
• отмена записи
• просмотр всех записей

[kirill-ivanovvv]

@Nelfimov нам нужно делать graphql - запросы, текущие клиенты не подходят - они только для некста.

1. создам apollo-adapter
2. создам graphql-server контекст
3. у этого контекста на данный момент будет только один useCase - query, в него буду передавать тело запроса, которое буду брать из @globals - они у нас уже готовы.
4. graphql-query-use-case буду вызывать в processor (слушатель, функция в которой прослушиваем), пришедшие данные буду передавать в telegram-bot-use-case аргументом

нашел инструкцию, буду делать по ней - https://docs.nestjs.com/graphql/quick-start

[Nelfimov]

Сделай пока на REST чтобы не усложнять. Потом добавим граф

[Nelfimov]

Ты же понял зачем это?

Нужно чтобы была запись

• либо через бота
• либо через сайт

Только для сайта нужен REST контроллер.

Т.к. и бот и заявка с сайта в конце концов попадут в БД, то можно сделать один юз кейс для них - сохранение в БД

[kirill-ivanovvv]

Т.к. и бот и заявка с сайта в конце концов попадут в БД, то можно сделать один юз кейс для них - сохранение в БД

да, это понял.

я хочу для начала получить список кузовов, диаметр колес и тип ремонта. на сайте мы эти данные получаем через graphql-запрос через apollo

[Nelfimov]

тогда ок

[kirill-ivanovvv]

Текущий статус

• написал адаптер для apollo-client
• написал контекст для graphql-client
• переписал импорты из @globals - из общего импорта убрал apollo - была ошибка при инициализации клиента
• в @globals добавли 2 дополнительных импорта:
  • /apollo - для react-клиентов-apollo
  • /apollo-core - для использования без react
• проверил работоспособность на уровне processor - запрос проходит, данные получаем.

  Дальнейшие планы

• сделать все необходимые запросы для получения даных.
• передать эти данные на conversation-use-case
• добавить клавиатуру (keyboard-buttons) для использования этих данных
• добавить проверку ответов пользователя - детализация диалога

  Актуальная ветка

• https://github.com/torin-asakura/shdvor/tree/feat/booking-telegram-bot

[kirill-ivanovvv]

Текущий статус

• запросил все данные, которые требовались в форме - кузов, диаметр, тип ремонта
• написал метод для отправки сообщений с клавиатурой
• написал все эти сообщения с входящими данными
• написал этап выбора даты (сегодняшняя + семь дней)
• сделал проверку приходящих от пользователя ответов
• на каждом шаге диалога дал юсеру возможнось прервать запись - покачто написал только интерфейс, в логике оставил заглушку.
• вывел результирующее вообщение в конце диалога + подтвердить / отмена

  Дальнейшие планы

• написать логику для "выйти из диалога"
• написать часть с выбором времени, с сервера приходят вот такие данные: workinghours: 'Пн - Пт, 9:00 - 19:00|n|Сб - Вс, 9:00 - 16:00',
  • нужно их обработать, и отправить клиенту время на выбор
  • для этого нужно расширить интерфейс sendMessageWithKeyboard - чтобы можно было отправлять клавиатуру сеткой. сейчас только rows
  • метод будет делать проверку типов на входе.
  • если Array<string> - будет выводить данные в rows
  • если Array<Array<string>> - будет выводить сетку.
• нужен рефакторинг, много повторяющегося кода. все пишу в одном файле
• @Nelfimov подскажи пожалуйста как мы будем расчерчивать таблицу записей в postgress, именно в каком формате мне подводить время. просто milleseconds - подойдут? ну и таблица соответственно с такими колонками - appointmentTime: number, telegramUserId: number, appointmentState: boolean (состояние записи - типо подтвержденно или нет). по наименованиям колонок/таблиц есть конвенция?

  Актуальная ветка

  https://github.com/torin-asakura/shdvor/tree/feat/booking-telegram-bot

[Nelfimov]

Я думаю время можно держать в числовом формате. Можно ограничиться минутами

[kirill-ivanovvv]

Текущий статус

• добавил запрос времени
• расширил клавиатуру, как вчера писал
• если какой-либо из слотов занят - буду выводить заглушку "X". пока просто подвел пропсы из объекта, после написания логики бд - добавлю.

  Дальнейшие планы

• рефакторинг
• запись в бд

  Актуальная ветка

  https://github.com/torin-asakura/shdvor/tree/feat/booking-telegram-bot

screens

  

[kirill-ivanovvv]

Текущий статус

• весь диалог разбил на вопрос-проверка_ответа и каждую пару вынес с собственный файл. назвал их conversation-part
  • к некоторым вопросам есть graphql - запросы. объединил их вместе с логикой диалога
• порефакторить функцию проверки ответа. в рутовом conversation сейчас много повторяющейся логики

  Дальнейшие планы

• закончить рефакторинг
  • сделать родительский класс для conversation-part - вынести общие методы
  • вынести текст сообщений в locals
  • пересмотреть логику входа в диалог - сейчас вход происходит по любому сообщению
  • думаю, что проверку условия выхода из диалога вытащить на самый верх - посмотрю
• бд

  Актуальная ветка

  https://github.com/torin-asakura/shdvor/tree/feat/booking-telegram-bot

[Nelfimov]

Давай в понедельник сделанную часть передашь на промежуточное ревью

[kirill-ivanovvv]

Давай в понедельник сделанную часть передашь на промежуточное ревью

хорошо