Выполнение задания

Justfile

@@ -28,17 +28,17 @@ dev: _env
 up: _env
     {{ compose }} up -d
     @echo "ожидание бэкенда {{ base }}"
-    @for i in $(seq 1 90); do curl -sf {{ base }}/stats >/dev/null 2>&1 && break || sleep 1; done
+    @for i in $(seq 1 90); do if curl -sf {{ base }}/health >/dev/null 2>&1; then exit 0; fi; sleep 1; done; echo "бэкенд не ответил за 90 секунд" >&2; exit 1
     @echo "ожидание фронтенда {{ front }}"
-    @for i in $(seq 1 90); do curl -sf {{ front }} >/dev/null 2>&1 && break || sleep 1; done
+    @for i in $(seq 1 90); do if curl -sf {{ front }} >/dev/null 2>&1; then exit 0; fi; sleep 1; done; echo "фронтенд не ответил за 90 секунд" >&2; exit 1
 
 # Остановить приложение и удалить его тома.
 down:
     {{ compose }} down -v
 
 # API-приёмка — приложение уже должно быть запущено (см. `just up`).
 acceptance:
-    hurl --variable base={{ base }} --test spec/acceptance/*.hurl
+    hurl --variable base={{ base }} --variable frontend={{ front }} --variable username=acceptance-$(date +%s%N) --test spec/acceptance/*.hurl
 
 # Браузерные сценарии — приложение уже должно быть запущено (см. `just up`).
 e2e:

LOGBOOK.md

@@ -2,16 +2,36 @@
 
 ## Решения
 
--
+- В проекте уже используется алгоритм SM-2, оставил его, т.к он соответствует цели пользователя;
+- Вопрос и ответ в карточке показаны одновременно, что неинтутивно для цели пользователя - скрыл ответ до клика;
+- После оценки карточки пользователем пересчитываю ее новое состояние: интервал, легкость и дату ее следующего показа;
+- Новое состояние карточки сохраняется в БД;
+- Добавил отдельную страницу с общими статистиками за всё время и за неделю;
+- В публичной странице не показаны заметки, теги и другие личные данные, как требует заказчик;
+- Обложки книг реализованы - их можно получать с помощью API OpenLibrary;
+- Добавил авторизацию - без нее вовсе не секьюрно. Хотя добавлять ее намного увеличивает объем работы, это необходимо для подобного приложения;
+- Решил сделать регистрацию доступной для нескольких аккаунтов - то есть, приложение не однопользовательское;
+- Каждая заметка, карточка, и запись повторения принадлежит конкретному пользователю;
+- При переходе на страницу другого пользователя показан только его публичный профиль;
+- Добавил связи заметок для упрощенной навигации;
+- Добавил постраничный просмотр заметок, чтобы не перегружать рабочее пространство;
+- Поиск книг сделал необязательным при создании/редактировании заметки;
+- Добавил ссылку на заметку, связанную с карточкой, чтобы пользователь мог повторить материал при необходимости.
 
 ## Допущения
 
--
+- Под требованием "сделать красиво" понял современный, но не перегруженный дизайн - выполнил;
+- Требование заказчика о "напоминаниях" понял как простое появление карточек в очереди, т.е без уведомлений вне приложения.
 
 ## С чем поспорил / что отклонил
 
--
+- Решил не добавлять ИИ-конспекты из-за высокого шанса галлюцинаций при работе с большими объемами данных книг, а также лишней сложности/зависимости от сторонних ИИ-сервисов;
+- Считаю, что автоматическое удаление заметок после 30 дней может привести к неожиданной потере собранной базы знаний, поэтому отклонил;
+- Интеграция со словарём требует очередной интеграции со сторонним API, что раздувает функционал приложения и не необходимо к основному сценарию использования;
+- Цитата дня не относится к цели приложения - отклонил.
 
 ## Мнение
 
--
+- Пытался максимально отполировать реализацию, постарался уделить побольше внимания секьюрности - устранил возможные уязвимости и т.п;
+- Проект очень интересный, задание более полезно, чем многое, чему меня учили в университете;
+- Разрешение на пользование агентами очень ценю, т.к в текущих реалиях без них на самом деле никак.

app/backend/public/index.php

@@ -6,19 +6,30 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 use Psr\Log\LoggerAwareInterface;
+use Recall\Http\AuthenticationMiddleware;
+use Recall\Http\Controller\AuthController;
+use Recall\Http\Controller\BooksController;
 use Recall\Http\Controller\CardsController;
+use Recall\Http\Controller\HealthController;
 use Recall\Http\Controller\NotesController;
+use Recall\Http\Controller\ProfileController;
 use Recall\Http\Controller\ReviewsController;
 use Recall\Http\Controller\StatsController;
 use Recall\Http\Json;
+use Recall\Http\OriginProtectionMiddleware;
 use Recall\Http\Serializer;
+use Recall\Http\SessionCookie;
 use Recall\Http\ValidationException;
+use Recall\Infrastructure\OpenLibraryClient;
+use Recall\Infrastructure\Persistence\BookRepository;
 use Recall\Infrastructure\Persistence\CardRepository;
+use Recall\Infrastructure\Persistence\DatabaseContext;
 use Recall\Infrastructure\Persistence\NoteRepository;
-use Recall\Infrastructure\Persistence\Orm;
 use Recall\Infrastructure\Persistence\QueryCounter;
 use Recall\Infrastructure\Persistence\ReviewRepository;
 use Recall\Infrastructure\Persistence\Seeder;
+use Recall\Infrastructure\Persistence\SessionRepository;
+use Recall\Infrastructure\Persistence\UserRepository;
 use Slim\Exception\HttpMethodNotAllowedException;
 use Slim\Exception\HttpNotFoundException;
 use Slim\Factory\AppFactory;
@@ -29,33 +40,61 @@
 $databasePath = $envDb === false || $envDb === '' ? dirname(__DIR__) . '/var/recall.sqlite' : $envDb;
 $now = new DateTimeImmutable('now');
 
-$boot = Orm::boot($databasePath);
+$boot = DatabaseContext::boot($databasePath);
 $queries = new QueryCounter();
 $driver = $boot->dbal->driver('sqlite');
 if ($driver instanceof LoggerAwareInterface) {
     $driver->setLogger($queries);
 }
 
 $noteRepo = new NoteRepository($boot->orm);
+$bookRepo = new BookRepository($boot->orm);
 $cardRepo = new CardRepository($boot->orm);
 $reviewRepo = new ReviewRepository($boot->orm);
+$sessionRepo = new SessionRepository($boot->orm);
+$userRepo = new UserRepository($boot->orm);
 
 (new Seeder($noteRepo, $cardRepo))->seedIfEmpty($now);
 
 $serializer = new Serializer();
-$notes = new NotesController($noteRepo, $serializer, $now);
+$notes = new NotesController($noteRepo, $bookRepo, $serializer, $now);
+$books = new BooksController($bookRepo, $serializer, new OpenLibraryClient());
 $cards = new CardsController($cardRepo, $noteRepo, $serializer, $now);
 $reviews = new ReviewsController($cardRepo, $reviewRepo, $serializer, $now);
-$stats = new StatsController($cardRepo, $serializer);
+$stats = new StatsController($cardRepo, $reviewRepo, $serializer, $now);
+$profiles = new ProfileController($userRepo, $cardRepo, $reviewRepo, $serializer, $now);
+$auth = new AuthController($userRepo, $sessionRepo, new SessionCookie(), $now);
+$health = new HealthController($boot->dbal->database('default'));
 
 $app = AppFactory::create();
 $app->addBodyParsingMiddleware();
+$app->add(new AuthenticationMiddleware(
+    new SessionCookie(),
+    $sessionRepo,
+    $userRepo,
+    $now,
+    $app->getResponseFactory(),
+));
 
 // CORS — фронтенд-дев-сервер ходит к нам с другого источника.
-$app->add(static fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => $handler->handle($request)
-    ->withHeader('Access-Control-Allow-Origin', '*')
-    ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS')
-    ->withHeader('Access-Control-Allow-Headers', 'Content-Type'));
+$configuredOrigin = getenv('RECALL_FRONTEND_ORIGIN');
+$frontendOrigin = is_string($configuredOrigin) && $configuredOrigin !== ''
+    ? $configuredOrigin
+    : 'http://localhost:5173';
+$app->add(new OriginProtectionMiddleware(new SessionCookie(), $frontendOrigin, $app->getResponseFactory()));
+$app->add(static function (ServerRequestInterface $request, RequestHandlerInterface $handler) use ($frontendOrigin): ResponseInterface {
+    $response = $handler->handle($request);
+    if ($request->getHeaderLine('Origin') !== $frontendOrigin) {
+        return $response;
+    }
+
+    return $response
+        ->withHeader('Access-Control-Allow-Origin', $frontendOrigin)
+        ->withHeader('Access-Control-Allow-Credentials', 'true')
+        ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS')
+        ->withHeader('Access-Control-Allow-Headers', 'Content-Type')
+        ->withHeader('Vary', 'Origin');
+});
 
 // Метрики: время запроса и число запросов к БД (наблюдение, не гейт).
 $app->add(static function (ServerRequestInterface $request, RequestHandlerInterface $handler) use ($queries): ResponseInterface {
@@ -73,32 +112,57 @@
 $app->put('/notes/{id}', $notes->update(...));
 $app->delete('/notes/{id}', $notes->delete(...));
 
+$app->get('/books/search', $books->search(...));
+$app->get('/books', $books->index(...));
+$app->post('/books', $books->create(...));
+$app->get('/books/{id}', $books->show(...));
+$app->delete('/books/{id}', $books->delete(...));
+
 $app->get('/cards', $cards->index(...));
 $app->post('/cards', $cards->create(...));
 $app->get('/cards/{id}', $cards->show(...));
+$app->put('/cards/{id}', $cards->update(...));
 $app->delete('/cards/{id}', $cards->delete(...));
 
 $app->get('/reviews/queue', $reviews->queue(...));
 $app->post('/reviews/{id}', $reviews->grade(...));
 
 $app->get('/stats', $stats->index(...));
+$app->get('/users/{username}', $profiles->show(...));
+$app->get('/health', $health->show(...));
+
+$app->post('/auth/register', $auth->register(...));
+$app->post('/auth/login', $auth->login(...));
+$app->get('/auth/me', $auth->currentUser(...));
+$app->post('/auth/logout', $auth->logout(...));
 
 $app->options('/{routes:.+}', static fn(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface => $response->withStatus(204));
 
 $app->addRoutingMiddleware();
 
 $errors = $app->addErrorMiddleware(false, false, false);
 $errors->setDefaultErrorHandler(
-    static function (ServerRequestInterface $request, Throwable $exception) use ($app): ResponseInterface {
+    static function (ServerRequestInterface $request, Throwable $exception) use ($app, $frontendOrigin): ResponseInterface {
         $response = $app->getResponseFactory()->createResponse();
 
-        return match (true) {
+        $response = match (true) {
             $exception instanceof HttpNotFoundException => Json::error($response, 'route not found', 404),
             $exception instanceof HttpMethodNotAllowedException => Json::error($response, 'method not allowed', 405),
             $exception instanceof ValidationException => Json::error($response, $exception->getMessage(), 422, $exception->details()),
             $exception instanceof InvalidArgumentException => Json::error($response, $exception->getMessage(), 422),
             default => Json::error($response, 'internal error', 500),
         };
+
+        if ($request->getHeaderLine('Origin') !== $frontendOrigin) {
+            return $response;
+        }
+
+        return $response
+            ->withHeader('Access-Control-Allow-Origin', $frontendOrigin)
+            ->withHeader('Access-Control-Allow-Credentials', 'true')
+            ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS')
+            ->withHeader('Access-Control-Allow-Headers', 'Content-Type')
+            ->withHeader('Vary', 'Origin');
     },
 );
 

app/backend/src/Domain/Book.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Recall\Domain;
+
+use DateTimeImmutable;
+use InvalidArgumentException;
+use Recall\Domain\ValueObject\BookId;
+use Recall\Domain\ValueObject\Title;
+use Recall\Domain\ValueObject\UserId;
+
+/** Книга-источник заметок и её обложка из внешнего каталога. */
+class Book
+{
+    private const int MAX_AUTHOR_LENGTH = 200;
+    private const int MAX_OPEN_LIBRARY_KEY_LENGTH = 200;
+
+    public function __construct(
+        public BookId $id,
+        public Title $title,
+        public string $author,
+        public ?string $openLibraryKey,
+        public ?int $coverId,
+        public ?UserId $userId = null,
+    ) {
+        $this->author = $this->author($author);
+        $this->openLibraryKey = $this->openLibraryKey($openLibraryKey);
+        $this->coverId = $this->coverId($coverId);
+    }
+
+    public static function create(
+        Title $title,
+        string $author,
+        ?string $openLibraryKey,
+        ?int $coverId,
+    ): self {
+        return new self(BookId::generate(), $title, $author, $openLibraryKey, $coverId);
+    }
+
+    /** Момент создания берётся из UUIDv7 — отдельного поля не держим. */
+    public function createdAt(): DateTimeImmutable
+    {
+        return $this->id->createdAt();
+    }
+
+    private function author(string $author): string
+    {
+        $author = trim($author);
+        if (mb_strlen($author) > self::MAX_AUTHOR_LENGTH) {
+            throw new InvalidArgumentException('имя автора длиннее ' . self::MAX_AUTHOR_LENGTH . ' символов');
+        }
+
+        return $author;
+    }
+
+    private function openLibraryKey(?string $key): ?string
+    {
+        if ($key === null) {
+            return null;
+        }
+
+        $key = trim($key);
+        if ($key === '') {
+            return null;
+        }
+        if (mb_strlen($key) > self::MAX_OPEN_LIBRARY_KEY_LENGTH) {
+            throw new InvalidArgumentException(
+                'идентификатор Open Library длиннее ' . self::MAX_OPEN_LIBRARY_KEY_LENGTH . ' символов',
+            );
+        }
+
+        return $key;
+    }
+
+    private function coverId(?int $coverId): ?int
+    {
+        if ($coverId === null) {
+            return null;
+        }
+        if ($coverId < 1) {
+            throw new InvalidArgumentException('идентификатор обложки должен быть положительным');
+        }
+
+        return $coverId;
+    }
+}

app/backend/src/Domain/BookSearchResult.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Recall\Domain;
+
+/** Нормализованный результат поиска книги во внешнем каталоге. */
+final readonly class BookSearchResult
+{
+    public function __construct(
+        public string $title,
+        public string $author,
+        public string $openLibraryKey,
+        public ?int $coverId,
+    ) {}
+}

app/backend/src/Domain/Card.php

@@ -12,6 +12,7 @@
 use Recall\Domain\ValueObject\Interval;
 use Recall\Domain\ValueObject\NoteId;
 use Recall\Domain\ValueObject\ReviewId;
+use Recall\Domain\ValueObject\UserId;
 
 /** Карточка с текущим расписанием повторения. */
 class Card
@@ -24,6 +25,7 @@ public function __construct(
         public Ease $ease,
         public Interval $interval,
         public Day $due,
+        public ?UserId $userId = null,
     ) {}
 
     public static function create(NoteId $noteId, CardText $front, CardText $back, DateTimeImmutable $now): self

app/backend/src/Domain/Note.php

@@ -5,10 +5,12 @@
 namespace Recall\Domain;
 
 use DateTimeImmutable;
+use Recall\Domain\ValueObject\BookId;
 use Recall\Domain\ValueObject\NoteId;
 use Recall\Domain\ValueObject\NoteIdList;
 use Recall\Domain\ValueObject\TagList;
 use Recall\Domain\ValueObject\Title;
+use Recall\Domain\ValueObject\UserId;
 
 /** Заметка: заголовок, текст, теги и ссылки на другие заметки. */
 class Note
@@ -20,6 +22,8 @@ public function __construct(
         public TagList $tags,
         public NoteIdList $links,
         public DateTimeImmutable $updatedAt,
+        public ?BookId $bookId = null,
+        public ?UserId $userId = null,
     ) {}
 
     public static function create(
@@ -28,8 +32,9 @@ public static function create(
         TagList $tags,
         NoteIdList $links,
         DateTimeImmutable $now,
+        ?BookId $bookId = null,
     ): self {
-        return new self(NoteId::generate(), $title, $body, $tags, $links, $now);
+        return new self(NoteId::generate(), $title, $body, $tags, $links, $now, $bookId);
     }
 
     /** Момент создания берётся из UUIDv7 — отдельного поля не держим. */
@@ -38,12 +43,19 @@ public function createdAt(): DateTimeImmutable
         return $this->id->createdAt();
     }
 
-    public function revise(Title $title, string $body, TagList $tags, NoteIdList $links, DateTimeImmutable $now): void
-    {
+    public function revise(
+        Title $title,
+        string $body,
+        TagList $tags,
+        NoteIdList $links,
+        DateTimeImmutable $now,
+        ?BookId $bookId = null,
+    ): void {
         $this->title = $title;
         $this->body = $body;
         $this->tags = $tags;
         $this->links = $links;
         $this->updatedAt = $now;
+        $this->bookId = $bookId;
     }
 }