В этом руководстве мы создадим небольшое бессерверное приложение, которое позволит получать последние курсы обмена GBP на EUR прямо на ваш телефон через SMS.
Этот эксперимент даст вам возможность изучить AWS Lambda, Twilio SMS API и Fixer.io API (открытый API для валютных курсов).
Мы будем использовать JavaScript с Node.js в качестве языка и фреймворка. Я не ожидаю, что у вас есть предварительные знания о бессерверных технологиях, AWS или Twilio, но предполагаю, что вы достаточно уверенно работаете с Node.js, чтобы совершать HTTP-запросы и понимать асинхронную природу языка.
По завершении этого руководства вы узнаете, как создавать подобные автоматизированные задачи с использованием Twilio API и как размещать их в виде бессерверных Lambda-функций в AWS.
Код, который мы напишем в этом руководстве, доступен на GitHub, и вы можете свободно использовать его в качестве отправной точки для вашего следующего крутого бессерверного проекта.
Мы создадим Lambda-функцию, которая проверяет курс обмена GBP на EUR.
Эта бессерверная функция, настроенная на запуск каждый день в 18:00 по Гринвичу, будет выполнять две отдельные операции:
— Получать текущий курс обмена GBP на EUR с помощью Fixer.io API.
— Отправлять курс на выбранный мобильный телефон через SMS с использованием Twilio SMS API.
Чтобы вы могли следовать этому руководству, убедитесь, что у вас есть все необходимые компоненты:
— Node.js версии 6.10 или выше, установленный на вашем компьютере
— Учетная запись AWS с достаточными правами для создания Lambda-функций
— Учетная запись Twilio с API-ключом и зарегистрированным номером телефона для отправки SMS
Вы можете скачать Node.js для любой операционной системы с официального сайта.
Если у вас нет учетной записи AWS, вы можете создать её на сайте AWS. Во время создания учетной записи вам, вероятно, потребуется ввести данные кредитной карты, но не волнуйтесь. Поскольку в течение первого года большинство услуг значительно дисконтируются благодаря программе бесплатного уровня, вы не должны понести никаких расходов при написании и запуске примеров из этого руководства. Если вы не подходите под условия бесплатного уровня, вы все равно заплатите сущие копейки, скорее всего, доли пенни!
Если вам нужна учетная запись Twilio, вы можете создать её здесь.
После этого у вас будет доступ к веб-дашборду со всеми деталями вашей учетной записи. С этого дашборда вам нужно будет записать ваш ACCOUNT SID (1) и AUTH TOKEN (2).
Для отправки SMS нам также нужно приобрести номер телефона Twilio. Вы можете сделать это здесь (включите ссылку на номера телефонов).
Бессерверная архитектура — это подход к разработке программного обеспечения, при котором серверы не явно предоставляются разработчиком.
Бессерверные технологии полагаются на абстракцию времени выполнения, предлагаемую облачным провайдером (например, AWS или Google Cloud), что позволяет разработчику сосредоточиться в основном на написании бизнес-логики в виде «функций». Эти функции затем могут быть легко развернуты в облаке и будут выполняться и автоматически масштабироваться без необходимости заботиться о базовой серверной инфраструктуре.
Если вы хотите узнать больше о бессерверных технологиях, вы можете ознакомиться с очень краткой статьей на Full Stack Python или посмотреть одно из моих выступлений о бессерверных технологиях.
Fixer.io — это бесплатный и открытый JSON API для текущих и исторических курсов иностранных валют, публикуемых Европейским центральным банком.
С помощью этого сервиса вы можете выполнять различные виды запросов. Тот, который нам понадобится для этого примера, — это простой GET-запрос по следующему URL:
Этот запрос вернет JSON-ответ, похожий на следующий:
Таким образом, на момент написания курс обмена GBP на EUR составляет около 1.10.
Попробуйте выполнить cURL-запрос к этому API из командной строки, поэкспериментируйте с изменением параметров и изучите полученный JSON-вывод.
Где `${TWILIO_ACCOUNT_SID}` можно найти в вашей консоли Twilio. Этот API требует аутентификации через Basic Auth, где вы передаете свой Twilio Account SID в качестве имени пользователя и действительный Twilio API Key для этой учетной записи в качестве пароля.
Для успешной отправки текстового сообщения необходимо убедиться, что присутствуют следующие три элемента:
— `From`: Зарегистрированный номер телефона Twilio, который будет использоваться для отправки SMS
— `To`: Номер телефона получателя, который получит SMS
— `Body`: Текст SMS (ограничен 1600 символами)
Более подробная информация об этом API доступна в официальной документации.
Давайте попробуем этот API:
Заполните пропуски вашими параметрами и выполните код в консоли, затем проверьте свой мобильный телефон. Если все прошло хорошо, вы должны вскоре получить новое SMS!
Twilio предлагает вспомогательную библиотеку для Node.js для обработки более сложных случаев, таких как запросы к нескольким конечным точкам.
Lambda-функция в Node.js — это обычная JavaScript-функция (иногда называемая «обработчиком»).
Действительная Node.js Lambda-функция должна иметь предопределенную сигнатуру:
Три важных детали здесь — это `event`, `context` и `callback`.
Lambda-функция обычно запускается внешними событиями, такими как вызов API или задание cron. Вы можете привязать Lambda к одному или нескольким событиям, так что каждый раз, когда происходит событие, оно запускает выполнение кода Lambda.
Параметр `event` будет заполнен объектом, который описывает тип события и предоставляет все соответствующие детали (например, какой API был вызван и с какими параметрами).
`Context` будет содержать некоторые детали о контексте выполнения (например, как долго выполняется эта функция), обычно нам не нужно беспокоиться об этом, если мы не хотим включить некоторые расширенные возможности.
`Callback` — это функция, которую обработчик должен вызвать, когда его работа завершена или когда возникает ошибка и нужно остановить выполнение. Lambda-функции считаются асинхронными, и callback — это распространенный шаблон в асинхронном JavaScript-коде для обозначения завершения асинхронной задачи.
Более подробную информацию можно найти в официальной документации.
Поскольку нам нужно использовать REST API, нам нужно выполнять HTTP-запросы из Node.js. Существует множество способов и библиотек для выполнения HTTP-запросов в Node.js, и одна из моих любимых — request-promise-native, библиотека, которую можно использовать начиная с Node.js версии 4, предлагающая тот же интерфейс и функциональность, что и известный модуль request, но предоставляющая API в виде нативных JavaScript-промисов. Я предпочитаю использовать промисы, когда это возможно, потому что это помогает сделать код более читаемым и понятным.
С таким подходом выполнение API-запроса будет выглядеть следующим образом:
Наконец, у нас есть все необходимые строительные блоки для начала написания нашей Lambda-функции. Мы будем писать её в файле с именем `index.js`.
Прежде чем писать код в этом файле, давайте инициализируем новый проект. Мы можем легко сделать это с помощью NPM, выполнив команду:
Эта команда создаст новый файл package.json. Флаг -y применит настройки по умолчанию без запроса вопросов у пользователя. Вы можете убрать этот флаг, если предпочитаете следовать пошаговой процедуре.
Теперь нам нужно установить зависимости:
Эта команда установит `request-promise-native`, оригинальный модуль request (который требуется для `request-promise-native`) и сохранит их в наш файл `package.json`.
Наконец, давайте посмотрим на код, который нужно поместить в `index.js`.
Я пройдусь по коду шаг за шагом, но если вы предпочитаете, вы можете посмотреть полный код на GitHub.
Первое, что мы делаем, это импортируем библиотеку `request-promise-native`.
Затем мы объявляем нашу функцию-обработчик, соблюдая ожидаемую сигнатуру с `event`, `context` и `callback`, как было описано ранее.
Внутри функции-обработчика мы определяем некоторые константы, которые будем использовать в качестве конфигурации в остальной части кода. Убедитесь, что вы заполнили все значения, специфичные для вашей учетной записи.
На этом этапе мы готовы выполнить первый API-запрос для получения курса обмена с Fixer.io.
Поскольку `request-promise-native` возвращает промис, нам нужно написать методы `.then` и `.catch` для обработки асинхронного потока управления. Внутри `.then` мы получаем данные ответа от API-вызова и можем использовать их для извлечения текущего курса обмена. Мы также логируем результат, что является хорошей практикой отладки.
Продолжая в блоке `then`, мы теперь готовы отправить курс обмена на наш мобильный номер с помощью Twilio API. Мы делаем это снова с помощью request-promise-native. На этот раз это POST-запрос, и нам нужно предоставить данные аутентификации и детали SMS, как мы обсуждали выше.
Опять же, нам нужно работать с промисом, поэтому мы должны добавить еще одну функцию then в цепочку промисов. Обратите внимание, что на предыдущем шаге мы использовали return с результатом запроса. Это позволило нам распространить промис в цепочке, так что мы можем использовать один `catch` для обработки ошибок и управлять каждым асинхронным шагом с помощью выделенных `then` хуков. В этом последнем then хуке нам нужно только залогировать результат и вызвать callback для завершения выполнения Lambda.
В конце цепочки промисов у нас есть наш общий catch хук. Он будет вызван только в том случае, если какой-либо из промисов в цепочке отклоняется (терпит неудачу). В этом случае мы можем только залогировать ошибку и завершить выполнение Lambda, вызвав callback и передав ошибку в AWS в качестве первого параметра callback. Это пометит выполнение как неудачное.
Последнее, что нам нужно сделать, это экспортировать нашу функцию-обработчик, чтобы её можно было загрузить средой выполнения AWS. Мы называем экспорт handler, чтобы позже можно было ссылаться на эту функцию как на `index.handler`.
Код довольно простой, давайте подведем итог, что происходит на каждом шаге:
Это весь код, который нам нужен для нашего проекта. Если вам интересно, код, опубликованный в репозитории GitHub, содержит некоторые незначительные улучшения, такие как передача конфигурационных переменных через переменные окружения и несколько других улучшений. Не стесняйтесь ознакомиться с ним и не забудьте поставить звезду 🙂
Прежде чем развернуть эту Lambda-функцию на AWS, давайте проведем некоторые тесты.
Существуют различные способы тестирования Lambda-функций локально. AWS недавно объявила о бета-версии продвинутого инструмента командной строки под названием AWS SAM Local. Это первый официальный инструмент, выпущенный для предоставления пользователю возможности тестировать Lambda-функции перед их развертыванием в среде AWS. Я рекомендую ознакомиться с SAM Local, но мне кажется, что он немного сложнее, чем мы можем охватить в этой статье.
Поэтому для целей этого руководства мы можем использовать независимый (и гораздо более простой) инструмент под названием lambda-local.
Этот инструмент можно установить с помощью NPM:
Флаг `—global` установит инструмент глобально, чтобы вы могли запускать исполняемый файл в любом проекте Lambda.
Теперь создайте файл с именем `event.json`, содержащий следующее:
Да, просто пустой объект! Это потому, что мы не используем никакие данные из события в нашей Lambda. Это запланированное выполнение, поэтому нас интересует только наличие триггера, который запускает функцию в заданное время, но нам не нужны входные параметры.
Теперь, когда у вас есть lambda-local и event.json, вы можете запустить выполнение Lambda-функции локально, выполнив следующую команду:
Если все прошло гладко, вы должны увидеть вывод об успешном выполнении и получить SMS на свой мобильный телефон.
Войдите в свою учетную запись AWS через веб-консоль и выберите сервис AWS Lambda.
Учтите, что веб-интерфейс AWS постоянно развивается, поэтому фактическая процедура, которую вам нужно выполнить, может немного отличаться от описанной далее.
В правом верхнем углу вы должны увидеть оранжевую кнопку с надписью «Create function» (Создать функцию). Нажмите на неё, чтобы начать пошаговую процедуру.
На первом этапе создания Lambda у вас есть возможность начать с предопределенного шаблона. Поскольку у нас уже написан весь код, мы можем выбрать опцию «Author from scratch» (Создать с нуля) в правом верхнем углу.
На этом этапе нам нужно настроить нашу Lambda-функцию, дав ей имя и роль. Роль — это набор разрешений, необходимых для доступа Lambda к другим ресурсам в вашей учетной записи AWS. В нашем случае все довольно просто, так как нам не нужно обращаться к сервисам хранения данных, базам данных или другим сервисам AWS. По этой причине мы можем выбрать предустановку под названием «Simple Microservice permissions» (Разрешения для простого микросервиса) из доступных шаблонов политик.
На следующем этапе нам нужно загрузить наш код на AWS. Код, необходимый для выполнения нашей функции, должен быть упакован в ZIP-файл, который содержит на верхнем уровне (без вложенных папок) следующие файлы:
— `index.js`
— `package.json`
— `package-lock.json` (если вы используете npm версии 5 или выше)
— `node_modules` (полная папка, которая будет содержать request, request-promise-native и все связанные зависимости)
На следующем экране дашборда нужно выбрать «Upload .ZIP file» (Загрузить ZIP-файл) и выбрать файл, который мы только что создали, содержащий весь наш код и его зависимости.
На этом этапе нам нужно немного прокрутить вниз и открыть блок «Basic settings» (Основные настройки), чтобы открыть соответствующую панель. Там мы можем изменить параметр тайм-аута. По умолчанию Lambda останавливается, если выполняется более 3 секунд. Мы можем немного увеличить этот лимит (я бы сказал, около 10 секунд), чтобы быть уверенными, что выполнение не будет прервано, пока мы все еще ждем завершения наших API-вызовов.
Теперь пришло время определить триггер для Lambda-функции. Для этого нужно выбрать вкладку «trigger» (триггер) в верхней части раздела и затем нажать «Add trigger» (Добавить триггер).
Прежде всего, нам нужно выбрать CloudWatch в качестве источника, затем «Create a new rule» (Создать новое правило) и дать ему имя (я выбрал «twilio-currency-exchange-schedule»). Затем нам нужно определить выражение, которое определяет, когда должно происходить запланированное событие.
Мы будем использовать следующее cron-выражение:
Это гарантирует, что наше событие будет запускаться один раз в день в 18:00 по Гринвичу.
Если вы хотите узнать больше о cron-выражениях, вы можете немного поиграть с crontab guru.
Наконец, давайте включим триггер, установив соответствующий флажок.
Наконец, вы можете сохранить конфигурацию, нажав кнопку «Save» (Сохранить), и приготовиться протестировать функцию.
Но что, если мы хотим запустить её вручную прямо сейчас, чтобы увидеть, все ли работает так, как мы ожидаем? Оказывается, мы можем это сделать! Нам просто нужно нажать на кнопку в правом верхнем углу с надписью «Test» (Тест)!
Как только мы это сделаем, нас попросят создать объект тестового события. Аналогично тому, что мы делали при тестировании функции локально, мы можем просто указать пустой JSON-объект и затем нажать «Save and test» (Сохранить и протестировать).
Если все прошло как ожидалось, через несколько секунд мы должны увидеть сообщение об успехе, подобное следующему:
… И вы должны были получить еще одно SMS!
Что делать, если что-то пошло не так и мы хотим понять почему, или мы просто хотим проверить логи последних автоматических выполнений?
Каждая Lambda-функция автоматически передает вывод выполнения в сервис логирования и мониторинга AWS: CloudWatch. На странице Lambda в дашборде AWS вы можете нажать на ссылку с надписью «View logs in CloudWatch» (Просмотреть логи в CloudWatch), чтобы перейти непосредственно к потокам логов, созданным для этой функции.
Если вы хотите проверить детали самых последних выполнений, вероятно, последний поток логов будет вверху:
Когда вы нажмете на него, вы увидите все логи, сгенерированные Lambda-функцией.
На этом изображении вы видите лог успешного выполнения. Если выполнение не удалось, вы должны были увидеть все детали конкретной ошибки, которая привела к сбою.
Спасибо, что оставались со мной до конца. Я очень надеюсь, что вам было весело и что вы узнали несколько новых трюков, которые могут пригодиться в вашем следующем проекте.
На данный момент вы должны знать, что такое бессерверные технологии, как написать Lambda-функцию на Node.js и как протестировать её локально и развернуть на AWS. Кроме того, вы немного узнали о Twilio API.
Почему бы не попробовать создать другие бессерверные проекты, используя MMS, факс или голосовые сервисы от Twilio? Ваше воображение — это предел… и делиться — значит заботиться, так что не забудьте сообщить мне здесь в комментариях, что вы собираетесь создать дальше, и поделиться этой статьей с вашими друзьями-разработчиками!
Если вы заинтересованы в внедрении бессерверных технологий в вашей компании через обучение внутри компании, ознакомьтесь с serverlesslab.com.
Наконец, если вы довольный клиент Twilio и вас интересуют бессерверные функции, возможно, вы захотите изучить собственную бессерверную платформу Twilio: Twilio Functions.
Я — Лучано Маммино, и вы можете найти меня в Twitter, GitHub, LinkedIn и на моем блоге.
Я инженер-программист, родившийся в 1987 году, в том же году, когда в Европе вышла игра «Super Mario Bros», которая, случайно, является моей любимой игрой!
Я начал программировать рано, в возрасте 12 лет, возясь со старым i386 моего отца, вооруженный только MS-DOS и интерпретатором QBasic, и уже более 10 лет работаю профессиональным разработчиком программного обеспечения.
В настоящее время я работаю главным инженером приложений в Planet 9 Energy в Дублине, где уже более года использую бессерверные технологии для создания нового поколения поставщиков электроэнергии на рынке Великобритании.
Я также увлеченный fullstack-разработчик на Node.js и соавтор книги «Node.js design patterns 2nd edition» (Packt). Чтобы помочь другим fullstack-разработчикам оставаться в курсе событий и мотивированными, я недавно запустил Fullstack Bulletin, полуавтоматический еженедельный информационный бюллетень, также полностью с открытым исходным кодом и построенный на базе бессерверных сервисов.