rollun-lc / rollun-openapi Goto Github PK

Якщо винести enum в окремий об'єкт, наприклад

    EntityType:
      type: string
      enum:
        - deal
        - client
        - offer

а потім використати його в параметрах запиту, наприклад

    parameters:
        - name: entityType
          in: path
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/EntityType'

то валідація відбуватись не буде (пройде запит з будь яким значенням entityType).

Якщо ж просто вказати entityType як enum, наприклад

     parameters:
        - name: entityType
          in: path
          required: true
          schema:
            type: string
            enum:
              - deal
              - client
              - offer

то валідація буде відбуватись коректно, і будуть доступні тільки перелічені значення, а на решту буде падати помилка.

При попытке get запроса с клиента:

$this->rest->get();

Получаем ошибку

Class 'TestingCollection\OpenAPI\V1\DTO\QueryParamsGETQueryData' not found

Манифест

openapi: 3.0.0
info:
  version: "1"
  title: "TestingCollection"
  description: Collection of various rest resources for testing purposes
servers:
  - url: http://rollun-openapi-nginx/openapi/TestingCollection/v1
tags:
  - name: QueryParams
paths:
  "/queryParams":
    get:
      tags:
        - QueryParams
      summary: "Get list of items"
      responses:
        "200":
          description: "Success"
          content:
            aplication/json:
              schema:
                $ref: "#/components/schemas/QueryParamsListResult"
        '500':
          description: "Internal error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'

Происходит потому что перед отправкой запроса в Rest объекте массив превращается в объект (с query параметрами), для валидации. А такой объект не сгенерировался, потому что нету никаких query параметров

В случае передачи параметра вида

$client->get([
    'id' => [1,2,3]
]);

строка запроса выглядит следующим образом '0=21-07142-82213&1=17-07143-13568&2=05-07145-38679'.
Соответственно, при разборе на стороне сервера параметр numbers не определяется.

Согласно спецификации, если style = form и explode = true, строка запроса должна выглядить следущим образом ?id=1&id=2&id=3

RestInterface has method delete be like:

public function delete($queryData = null);

but NoDelete trait has another interface:

public function delete($queryData = [])
{
    throw new \Exception('Not implemented method');
}

Same problem with NoGet

Если в тексте исключения есть перенос строки, например throw new \Exception("Exception \n with new line.");, то страница отобразиться в html (вместо json) с ошибкой:
Warning: Header may not contain more than a single header, new line detected in /app/vendor/zendframework/zend-httphandlerrunner/src/Emitter/SapiEmitterTrait.php on line 65.

Происходит это потому что в Articus\PathHandler\Middleware в 291й строке текст исключения записывается в response reasonPhrase:

protected function populateResponseWithException(
		Exception\HttpCode $exception, Response $response, ?Producer\ProducerInterface $producer
	): Response
{
	$response = $this->populateResponseWithData($exception->getPayload(), $response, $producer);
	if ($exception instanceof Exception\HeaderInterface)
	{
		foreach ($exception->getHeaders() as $name => $value)
		{
			$response = $response->withHeader($name, $value);
		}
	}
	$response = $response->withStatus($exception->getCode(), $exception->getMessage()); // line 291
	return $response;
}

А потом в Zend\HttpHandlerRunner\Emitter\SapiEmitterTrait эта reasonPhrase с response записывается в headers.

private function emitStatusLine(ResponseInterface $response) : void
{
       $reasonPhrase = $response->getReasonPhrase();
       $statusCode   = $response->getStatusCode();

       header(sprintf(
              'HTTP/%s %d%s',
              $response->getProtocolVersion(),
              $statusCode,
              ($reasonPhrase ? ' ' . $reasonPhrase : '')
       ), true, $statusCode);
}

Из-за того что пакет nette/php-generator, который нужен для генерации, перемещен в require-dev. А composer не устанавливает require-dev зависимости вложенных пакетов, то генерация не работает.

Решение 1 (рекомендуемое): обновиться к версии выше, где этот баг исправлен
Решение 2: прописать "nette/php-generator": "^3.4" в require-dev зависимости сервиса

Example:

public function testResetFunction(): void
{
    $this->markTestIncomplete('Indirect modification of overloaded property ClientTest\OpenAPI\V1\DTO\ResourceResult::$messages has no effect');
    $message = new \ClientTest\OpenAPI\V1\DTO\Message();
    $message->level = Message::ERROR;
    $message->type = Message::UNDEFINED_TYPE;
    $message->text = 'Some error details.';
    $result = new ResourceResult();
    $result->messages = [$message];

    $firstMessage = reset($result->messages);
    self::assertEquals($firstMessage, $message);
}

Branch for this issue: https://github.com/rollun-lc/rollun-openapi/tree/reset-bug

Пример манифеста:

components:
  schemas:
    Message:
      type: object
      properties:
        level:
          type: string
          enum:
            - info
            - warning
            - error

Сгенерированный код (нету проверки, что значение попадает в перечень доступных):

<?php
declare(strict_types=1);

namespace Shipment\OpenAPI\V1\DTO;

use Articus\DataTransfer\Annotation as DTA;

/**
 */
class Message
{
    /**
     * @DTA\Data(field="level", nullable=true)
     * @DTA\Validator(name="Type", options={"type":"string"})
     * @var string
     */
    public $level;
}

1. Тут может стоить уточнить, важна ли версия генератора? Если они все обратно совместимы, то все равно
   https://github.com/rollun-com/rollun-openapi/blob/410ee5877698daf189d49499011bb607000b096b/README.md#L6

2. Как я понимаю, перед тем, как устанавливать php-либу генератора, нужно сначала скачать скелетон? Наверное это нужно указать. (улучшение) И так же, если я нахожусь в папке только с composer.json и установленным генератором, может нужно дополнительно скачивать скелетон с гита?
   https://github.com/rollun-com/rollun-openapi/blob/410ee5877698daf189d49499011bb607000b096b/README.md#L10

3. Тут нужно решить, мы юзаем наш редактор с плагинами, или сваррег хаб? Если наш, то нужно указать линку на наш сваггер редактор http://swagger-editor.rollun.net/
   https://github.com/rollun-com/rollun-openapi/blob/410ee5877698daf189d49499011bb607000b096b/README.md#L27

4. (улучшение) Возможно это можно делать автоматически?
   https://github.com/rollun-com/rollun-openapi/blob/410ee5877698daf189d49499011bb607000b096b/README.md#L38

5. (Вопрос по видео) почему, если метод не пока реализован, возвращается 500? Есть ведь код 501 специально для этого

6. (Вопрос по видео) может нужно указать, что для генерации клиента нужно находится внутри скелетона?

7. Если просто скачать скелетон, и попробовать запустить composer require rollun-com/rollun-openapi, то установка падает с ошибкой резолва зависимостей (возможно нужно убрать lock файл с скелетона)

8. нужно ext-yaml перенести с зависимостей с дев зависимости, а то после установки оно не подтянулось, и генерация поламалась.

9. Как я понимаю, библиотеки rollun-com/rollun-openapi-client-bridge и rollun-com/rollun-openapi-server-bridge можно удалять, вместе с их репозиториями на гите?

Описание

При объявлении в конфигурации фабрики для контроллера (или rollun\dic\InsideConstruct::init), который в конструкторе принимает OpenAPI\Server\Rest\RestInterface объект появляется ошибка "Service with name "Articus\PathHandler\Router\FastRoute" could not be created. Reason: [Semantical Error] The annotation "@Articus\PathHandler\Annotation\Route" in class Dropshipping\OpenAPI\V1\Server\Handler\CalculatedShippingMethods was never imported. Did you maybe forget to add a "use" statement for this annotation?"

Пример

Сгенерированный контроллер для серверной части

<?php

namespace Dropshipping\OpenAPI\V1\Server\Rest;

use Dropshipping\ShippingMethods\Controller\V1\ShippingMethodsController;
use OpenAPI\Server\Rest\BaseAbstract;
use Psr\Log\LoggerInterface;
use rollun\dic\InsideConstruct;

/**
 * Class CalculatedShippingMethods
 */
class CalculatedShippingMethods extends BaseAbstract
{
    const CONTROLLER_OBJECT = ShippingMethodsController::class;
    
    public function __construct($controllerObject = null, $logger = null)
    {
        InsideConstruct::init(['controllerObject' => self::CONTROLLER_OBJECT, 'logger' => LoggerInterface::class]);
    }

    //...
}

Контроллер

<?php

namespace Dropshipping\ShippingMethods\Controller\V1;

use OpenAPI\Server\Rest\RestInterface;

class ShippingMethodsController
{
    /**
     * @var RestInterface
     */
    private $rest;

    public function __construct(RestInterface $rest)
    {
        $this->rest = $rest;
    }
    
    // ...
}

Конфигурация (фабрика для контроллера)

<?php

use Dropshipping\ShippingMethods\Controller\V1\ShippingMethodsController;
use Psr\Container\ContainerInterface;

return [
    'dependencies' => [
        'factories' => [
            ShippingMethodsController::class => function (ContainerInterface $container) {
                return new ShippingMethodsController(
                    $container->get(\TheSupplierOrders\OpenAPI\V1\Client\Rest\CalculatedShippingMethods::class)
                );
            }
        ]
    ],
];

В итоге при переходу по любому из роутов получим ошибку описанную в начале.

Причины
При создании клиентского Rest объекта, в конструкторе класса Articus\DataTransfer\Service, вызывается статический метод Doctrine\Common\Annotations\AnnotationRegistry::registerFile, который отключает автозагрузку. Из-за этого не создается объект Articus\PathHandler\Annotation\Route, который создавался через автозагрузку и появляется ошибка.

Как можно исправить
rollun-openapi использует версию 0.2 библиотеки Articus/DataTransfer, но начиная с версии 0.3 они убрали вызов Doctrine\Common\Annotations\AnnotationRegistry::registerFile в конструкторе класса Articus\DataTransfer\Service. Так что обновление до версии 0.3, в теории, должно исправить эту ошибку. Но между версиями 0.2 и 0.3 утеряна обратная совместимость, так что нужно обновляться осторожно.

Пример манифеста (явно указан nullable:false):

components:
  schemas:
    Tracker:
      type: object
      properties:
        public_url:
          type: string
          format: url
          nullable: false
          description: URL to a publicly-accessible html page that shows tracking details for this tracker

Сгенерированный код (валидация в анотациях nullable=true):

<?php
declare(strict_types=1);

namespace Shipment\OpenAPI\V1\DTO;

use Articus\DataTransfer\Annotation as DTA;

/**
 */
class Tracker
{
    /**
     * URL to a publicly-accessible html page that shows tracking details for this tracker
     * @DTA\Data(field="public_url", nullable=true)
     * @DTA\Validator(name="Type", options={"type":"string"})
     * @var string
     */
    public $public_url;
}

Стандарт по которому работает OpenApi: https://tools.ietf.org/html/rfc3339#section-5.6
Сейчас генератор работает только с форматом 'Y-m-d\TH:i:s\Z' т.е. миллисекунды не поддерживаются

Проблема в том что валидация происходит чере DateTime::createFromFormat( ... ) форматы которого не поддерживают необязательные поля. Одно из решений проверять на соответствие сразу многим форматам: https://github.com/thephpleague/openapi-psr7-validator/pull/20/files

Похожий issues thephpleague/openapi-psr7-validator#19