Files
it-smi/README.md
T

215 lines
10 KiB
Markdown

# Тестовое задание
## Бизнес требования
Требуемые сущности:
```mermaid
erDiagram
Profile ||--o{ Skill : Навыки
Profile ||--o{ Link : Ссылки
Profile ||--o{ Experience : "Опыт работы"
Profile ||--o{ Project : "Проекты"
Profile {
string firstName "имя"
string lastName "фамилия"
string description "краткое описание"
}
Link {
string name "название"
string link "адрес ссылки"
}
Skill {
string name "название навыка"
}
Project {
string name "название проекта"
string link "адрес проекта или его репозитория"
string description "описание"
}
Experience {
string company "компания"
string position "должность"
string period "период работы"
string[] achievements "достижения"
}
```
### Требования:
- Автоподготовка базы данных
- Автозаполнение данных при старте
- Доступ по GraphQL
> Требуется уточнить, что бизнес имеет в виду под подготовкой базы данных
### Неявные требования
Особых неявных требований нет
## Решения
### База данных
Конечно, в данном ТЗ данных столько, что достаточно было бы одного JSON файла, но возьмем БД postgres
Postgres - популярная, широкий функционал. Уже есть инфраструктура для нее.
Другие варианты:
- MariaDB - достаточно широкий функционал. Нет под нее инфраструктуры.
- SQLite - небольшая, встраиваемая. Инфраструктуры не требуется
- MongoDB - документная, что тоже подходит. Нет под нее инфраструктуры.
### Подготовка БД
Под подготовкой БД я понял создание базы данных и накатывание на нее миграций.
**Создание БД:**
- локально: вручную созданная БД
- на "проде" использую уже имеющуюся у меня инфраструктуру: БД будет создаваться скриптом на сервере
**Миграции:**
Так как миграция работает с бизнес-данными (а данные терять и повреждать нельзя), то накатывание миграций должно быть
достаточно явным процессом, и сама миграция должна быть однозначной.
Потому просто дать команду "приведи БД в соответствие со схемой" в orm библиотеке небезопасно, требуется именно миграция.
Подходящим считаю накатывать миграцию перед публикацией новой версии приложения прямо в CI.
### Автозаполнение данных на старте
На старте приложения, проверить количество записей в таблицах, и там, где пусто, заполнить данными из кода или JSON.
В реальном приложении это надо обсудить, а здесь достаточно такого решения.
### Остальное
- Выделенного фронта нет, есть Apollo Playground, который доступен из библиотек.
## Архитектура
> Если строго смотреть на потребности, то архитектура должна быть самой простой, большинство ее элементов можно
> посчитать переусложнением для такой задачи.
>
> Потому некоторые компоненты могут быть избыточны для текущей задачи, но полезны в реальном проекте.
### Горизонтальное разделение ответственности
Потребности в разделении на несколько модулей нет: один модуль, один ресолвер, нужные сущности.
Вот кейс по проектированию [биллинга](https://portfolio.arswarog.ru/cases/billing), где разделение ответственности
дает преимущества.
### Вертикальное разделение ответственности
Обычно модуль я делю на такие слои:
- Resolver / Controller: Точки входа, права доступа. Без бизнес логики
- Service: Бизнес логика
- Data Access Layer: Проектно специфичные методы для доступа к данным. Бизнес логика присутствует, только если она нужна
на уровне БД
- Repository: API библиотеки БД
В данном случае Data Access Layer будет явно излишним.
Так же эти слои показывают направление связей:
- Resolver имеет доступ только к Service
- Service имеет доступ только к Repository
### Сущности
Идентификаторы сущностям на уровне API не нужны, поэтому в GraphQL они не отдаются. Внутри БД они есть:
Prisma требует у модели уникальный идентификатор, и `id` (autoincrement) заодно даёт стабильные
связи `profileId` и порядок выдачи. Наружу это не протекает — DTO описывает только бизнес-поля.
Профиль ровно один, но запись профиля оставлю: так вложенность (профиль → навыки/ссылки/опыт/проекты)
выражена отношением в БД, а не соглашением «все строки таблицы принадлежат профилю».
---
---
---
## ТЗ
Смысл тестового задания в том, чтобы Вы продемонстрировали навык использования всех перечисленных технологий. Время на выполнение тестового задания не ограничено.
Упор на качество. Убедительная просьба – либо отнеситесь к тестовому заданию серьезно, либо не беритесь за него вовсе.
Создайте Вашу цифровую визитку (backend-приложение), которая презентует Вас как специалиста, с обязательным использованием следующих технологий:
- Git;
- TypeScript;
- Node.js;
- NestJS;
- Prisma;
- GraphQL;
- Docker.
Приложение должно предоставлять Apollo Sandbox, через которое можно получить информацию о Вас, Вашем опыте работы, навыках и проектах.
Бэкенд должен содержать:
1. Профиль:
- имя;
- краткое описание;
- ссылки на GitHub/LinkedIn или другие профессиональные ресурсы.
2. Список навыков.
3. Опыт работы:
- компания;
- должность;
- период работы;
- Ваши достижения.
4. Проекты:
- название;
- ссылка на проект/репозиторий.
При запуске приложения база данных должна быть автоматически подготовлена и заполнена Вашими данными.
API должно позволять получить профиль и связанные с ним данные, например:
```graphql
query {
profile {
name
description
skills {
name
}
experience {
company
position
}
projects {
name
}
}
}
```
Конкретную структуру GraphQL API, базы данных и архитектуру приложения выберите самостоятельно. Обоснуйте принятые архитектурные решения в README.md файле.
Бизнес-логика, работа с данными и GraphQL API должны иметь разумное разделение ответственности.
Что оценивается:
- в первую очередь оценивается не количество написанного кода, а качество инженерных решений.
Обратите внимание на:
- структуру приложения и разделение ответственности;
- работу GraphQL с вложенными данными для оптимизации запросов к базе данных;
- взаимодействие с базой данных;
- инициализацию и заполнение базы данных;
- читаемость и поддерживаемость кода;
- корректную работу приложения после запуска с нуля.
Просим предоставить:
1. Ссылку на проект (для просмотра). Бэкенд можете попробовать развернуть на Vercel/Render/Railway или любым удобным для Вас способом;
2. Ссылку на Git (для ознакомления с исходным кодом).