[#.x] - health and 404 middleware

Author: niden

src/Domain/Middleware/AbstractMiddleware.php

@@ -0,0 +1,45 @@
+<?php
+
+/**
+ * This file is part of the Phalcon API.
+ *
+ * (c) Phalcon Team <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Phalcon\Api\Domain\Middleware;
+
+use Phalcon\Api\Domain\Services\Container;
+use Phalcon\Api\Domain\Services\Http\Response;
+use Phalcon\Mvc\Micro;
+use Phalcon\Mvc\Micro\MiddlewareInterface;
+
+abstract class AbstractMiddleware implements MiddlewareInterface
+{
+    protected function halt(
+        Micro $application,
+        int $code,
+        string $message = '',
+        array $data = [],
+        array $errors = []
+    ): void {
+        /** @var Response $response */
+        $response = $application->getSharedService(Container::RESPONSE);
+
+        $application->stop();
+
+        $response->withCode($code, $message);
+
+        if (true === empty($errors)) {
+            $response->withPayloadData($data);
+        } else {
+            $response->withPayloadErrors($errors);
+        }
+
+        $response->render()->send();
+    }
+}

src/Domain/Middleware/HealthMiddleware.php

@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * This file is part of the Phalcon API.
+ *
+ * (c) Phalcon Team <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Phalcon\Api\Domain\Middleware;
+
+use Phalcon\Api\Domain\Services\Container;
+use Phalcon\Api\Domain\Services\Http\HttpCodesEnum;
+use Phalcon\Events\Exception as EventsException;
+use Phalcon\Http\Request;
+use Phalcon\Http\Response\Exception;
+use Phalcon\Mvc\Micro;
+
+final class HealthMiddleware extends AbstractMiddleware
+{
+    /**
+     * @param Micro $application
+     *
+     * @return true
+     * @throws EventsException
+     * @throws Exception
+     */
+    public function call(Micro $application): bool
+    {
+        /** @var Request $request */
+        $request = $application->getSharedService(Container::REQUEST);
+
+        if (
+            '/health' === $request->getURI() &&
+            true === $request->isGet()
+        ) {
+            $payload = [
+                'status'  => 'ok',
+                'message' => 'service operational',
+            ];
+
+            $this->halt(
+                $application,
+                HttpCodesEnum::OK->value,
+                HttpCodesEnum::OK->text(),
+                $payload
+            );
+        }
+
+        return true;
+    }
+}

src/Domain/Middleware/NotFoundMiddleware.php

@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * This file is part of the Phalcon API.
+ *
+ * (c) Phalcon Team <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Phalcon\Api\Domain\Middleware;
+
+use Phalcon\Api\Domain\Services\Http\HttpCodesEnum;
+use Phalcon\Events\Event;
+use Phalcon\Events\Exception as EventsException;
+use Phalcon\Http\Response\Exception;
+use Phalcon\Mvc\Micro;
+
+final class NotFoundMiddleware extends AbstractMiddleware
+{
+    public function beforeNotFound(Event $event, Micro $application): bool
+    {
+        $this->halt(
+            $application,
+            HttpCodesEnum::NotFound->value,
+            'error',
+            [],
+            HttpCodesEnum::AppResourceNotFound->error()
+        );
+
+        return false;
+    }
+
+    /**
+     * @param Micro $application
+     *
+     * @return true
+     * @throws EventsException
+     * @throws Exception
+     */
+    public function call(Micro $application): bool
+    {
+        return true;
+    }
+}