Ensure that api:openapi:export produces JSON with unescaped forward slashes

[Ocramius]

Q	A
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tickets
License	MIT
Doc PR

This ensures that the generated OpenAPI schema JSON dump does not contain forward-slashes, such as "#\/foo\/bar\/MyModel", which confuses tooling relying on direct string match in referenced models (most notably, the IntelliJ OpenAPI/Swagger tooling)

[Ocramius]

Note: a unit test was much simpler and efficient to write - the current integration test is not something I could work with anyway, since I don't run MongoDB on any system I maintain (including my dev environment) by choice

[alanpoulain]

Actually there was a an attempt to remove the hard dev dependency to MongoDB (#2703), but it has been added again by #2843 (an issue with PHPStan it seems).

By default though, the Behat tests are run without MongoDB.

[Ocramius]

I hope that can be achieved again at some point: for now, I'm happy with adding a unit test, and providing more unit tests in future, shall I encounter isolated issues, like this one.

[teohhanhui]

PHP extensions are no longer required to be loaded - thanks to Roave/BetterReflection and PhpStorm stubs!

https://github.com/phpstan/phpstan/releases/tag/0.12.4

We should be able to do this once we upgrade to phpstan ^0.12.4! 😄

[teohhanhui]

Unfortunately, we still can't remove the MongoDB packages, because we'd get errors such as:

 ------ -------------------------------------------------------------------------------------------- 
  Line   src/Bridge/Doctrine/Common/Util/IdentifierManagerTrait.php (in context of anonymous class)  
 ------ -------------------------------------------------------------------------------------------- 
  47     Class Doctrine\ODM\MongoDB\DocumentManager not found.                                       
  86     Call to static method hasType() on an unknown class Doctrine\ODM\MongoDB\Types\Type.        
  87     Call to static method getType() on an unknown class Doctrine\ODM\MongoDB\Types\Type.        
 ------ --------------------------------------------------------------------------------------------

😞

[teohhanhui]

@ondrejmirtes Do you perhaps have any suggestions on how this could be resolved? I see there are MongoDB ODM stubs in https://github.com/phpstan/phpstan-doctrine/tree/master/stubs

Is there a way to tell phpstan that these types "exist" purely based on the stubs?

[teohhanhui]

See #3431 for an attempt.

[ondrejmirtes]

Is there a way to tell phpstan that these types "exist" purely based on the stubs?

You'd have to make the class available for the autoloader. See: https://phpstan.org/user-guide/autoloading

[alanpoulain]

Couldn't this be a BC if the client has been relying on the escaped slashes?

[Ocramius]

Doubt that, but there is indeed a change in dumped definitions. Forward slashes do not impose an escaping sequence risk.

[dunglas]

Thanks @Ocramius!