denisnovac / phonebook

Телефонный справочник на Scala c Http4s, Cats и Doobie

Backend Scala developer

phonebook's Issues

Инициализация БД

Пока непонятно, как инициализировать БД (приходится самому вбивать CREATE TABLE IF NOT EXISTS phonebook (id SERIAL PRIMARY KEY,name VARCHAR(100) NOT NULL,phoneNumber VARCHAR(100) NOT NULL);. Но раньше там вообще был страшный цикл. Нужно придумать, как вернуть функционал.

Аргументы командной строки

Нужно позволить через командную строку выбрать тип хранилища и реквизиты (если это БД).

Избавиться от Waning-ов, связанных с неполной обработкой Pattern Match.

Реализовать возможность удалить из справочника вхождение по ID.

Убрать пакет http4s.example из проекта

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

Определиться со стеком Akka-http + Slick либо Http4s и Doobie.

Добавить поддержку CORS в приложение для работы в Swagger Editor

swagger-api/swagger-ui#1209
https://http4s.org/v0.18/cors/

Выбрать/разработать модель справочника, которую будет удобно переводить в JSON.

Продумать механизм валидации для вводимых данных (телефон и имя).

Реализовать возможность изменить значение телефона или имени по ID.

Реализовать возможность получить список ранее добавленных вхождений в справочник (кортеж id, имя, номер) в виде JSON.

Добавить два общих метода проверки валидности номера телефона и имени.

Начать использовать sbt revolver

Логирование

Реализовать возможность получить значение телефона или имени по ID.

Конфигурационный файл

Покрыть API тестами

Разработать модель для перевода телефонной книги в корректный JSON.

В данный момент конверсия книги в JSON происходит только за счёт того, что у самих записей есть модель (энкодер и декодер, кейз класс). Нужно реализовать то же для книги, чтобы JSON получался корректным.

Написать тесты для созданных методов.

Научиться изменять состояние книги без мутаций.

addContact и updateContact выполняются дважды

Странно работают в новой реализации методы addContact и updateContact выполняются дважды всегда (даже curl-ом из консоли):

phonebook     | [ioapp-compute-0] INFO PhoneBookDoobieModel - INSERT INTO phonebook (name, phoneNumber) VALUES (Jhon Dow, [phone])
phonebook     | [ioapp-compute-2] INFO PhoneBookDoobieModel - INSERT INTO phonebook (name, phoneNumber) VALUES (Jhon Dow, [phone])

Решить, что делать с одинаковыми UUID в книге. Добавить проверку на наличие двух одинаковых UUID в книгах для методов, которые требуют проверки UUID и возвращают Either (иначе PM будет фейлить).

Научиться складывать объекты в реляционную БД и доставать их оттуда.

Валидация записей

Переписать существующие тесты на Pattern Matching с раскладыванием JSON-а по кейз-классам

Сменить имена пакетов для добавления БД.

Асинхронная выгрузка книги

Реализовать возможность поиска всех вхождений по подстроке номера.

Форматирование scalafmt

Привести нижний уровень приложения в соответствие предоставленному yaml.

Хранение in-memory

До переезда на серьёзный дизайн cats без повсеместного вызова unsafeRunSync была возможность не запускать БД. Нужно её вернуть. И не забыть сделать настройку через конфиг.

Изменить коды возврата на те, что документированы в swagger.yaml

Реализовать возможность поиска всех вхождений по подстроке имени.

Возврат ошибок клиенту

В данный момент значения внутри монады F[_] не распаковываются, а передаются пользователю. Нужно понять, как проверять вывод, чтобы кидать InternalServerError.

Формально решить, какие методы могут возвращать ошибку как ошибку, а какие - могут обойтись просто возвратом пустого json.

Реализовать хендлер для справочника, который будет содержать основной функционал - поиск, удаление, добавление и т.п.

Контейнер swagger-editor

Втащить композ, чтобы работать с HTTP сервером через swagger-editor удобнее.

Прикрутить Swagger UI вместо Swagger Editor

Написать IoDbPhoneBookHandler

Хендлер должен поддерживать интерфейс ApiPhoneBookHandler и уметь делать ретраи подключения к БД.

Реализовать возможность добавить телефон (String) и имя (String) в справочник.

Кэширование запросов БД

Разработать модель одной записи справочника.

Изучить спецификацию OpenAPI (ранее - Swagger Specification).

Написать API, реализующее весь функционал Phonebook/projects/1 посредством HTTP.

Научиться принимать JSON на вход HTTP.

Написать базовый HTTP-сервер, который поднимается и отдаёт OK на руте и 404 на запросах несуществующих элементов.

Вынести функции валидации имени и телефона наружу, чтобы затем пользоваться ими как из низкого уровня, так и из уровня БД.

Написать IO-обёртку над классами нижнего уровня, меняющую одну ссылку на результат выполнения иммутабельных методов PhoneBookHandler.