MongoDB support (#2144)

* Add mongodb ItemProvider

* Fix pagination extension

* FIx propertymetadatafactory

* Fix query extension compiler pass

* #460 Fix fatal error: 'phpDocumentor\Reflection\DocBlockFactory' not found

* Small fixes

* Remove @todo

* Refactor bundle configuration

* Add mongodb filter and abstraction

* Add mongodb filter extension

* Fix ItemDataProvider using only one id

Remove idea

* Apply StyleCI patch file

* Declare  variable in AbstractFilter to fix Scrutinizer warning

* Add missing AbstractFilter namespace

* Change DataProviderInterface's namespace to use new DataProvider location

* Tag mongodb data providers

* Remove old dataprovider definitions from doctrine_mongodb.xml

* Use correct PaginatorInterface namespace

* hotfix: add mongodb to ci && fix unit test

* add composer.json

* ignore platform reqs

* ignore platform reqs

* - add behat on mongo
- add symfony mongo test
- add mongo on travis & appveyor

* - add behat on mongo
- add symfony mongo test
- add mongo on travis & appveyor

* Merge branch 'odm-support' of https://github.com/samvdb/DunglasApiBundle into samvdb-odm-support

# Conflicts:
#	appveyor.yml
#	composer.json
#	src/Bridge/Doctrine/Filter/AbstractFilter.php
#	src/Bridge/Symfony/Bundle/DependencyInjection/Compiler/DoctrineQueryExtensionPass.php
#	src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php
#	tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php
#	tests/Bridge/Symfony/Bundle/DependencyInjection/Compiler/DoctrineQueryExtensionPassTest.php
#	tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

* Fix phpunit and behat tests

* Mongodb behat tests first step

* Fix tests

* Refactoring of the filters and working boolean filter

* Use PropertyHelper and working search filter

* Changes for PropertyHelper

* Private and final

* Use trait instead of service for propertyHelper

* Add date filter

* Add exists filter

* Uniformize filters

* Fix autowiring in ApiFilter compiler pass for MongoDB filters

* Add numeric filter and remove references of DBAL in Common

* Add order filter

* Add range filter and fix some tests

* Fix some tests

* Subresources management and better interfaces

* Fix lookups and pagination

* Add DoctrineEctractor for MongoDB

* Fix some tests and item data provider

* Fix more tests (fos-user)

* More tests

* Fix more tests

* Add OrderExtension and fix tests

* Fix more tests and fix the paginator

* Fix last Behat tests + use context as reference to solve sort issue + some cleaning

* Fix some CS

* Fix exists filter unit test

* Replace MongoDB with MongoDbOdm

* Fix last unit test

* Add a unit test for the boolean filter

* Add a unit test for the date filter

* Unit tests for exists filter

* Unit tests for numerci filter

* Unit tests for order filter

* Remove unused tags

* Unit tests for range and search filters

* Fix MongoDB CustomActionController

* Add unit tests for extensions

* Unit tests for PropertyMetadataFactory

* Tests for DoctrineExtractor

* Fix CS + test

* Add unit test for CollectionDataProvider

* Add unit tests for ItemDataProvider and move IdentifierManagerTrait to Common

* Fixes in Paginator and unit tests for it

* Add subresource unit tests

* Fix @vincentchalamon reported issue

* Fix CS

* Use MongoDB ODM 2.0

* Add no-api to repositories

* Fix paginator

* Fix phpstan

* Traits more usable and add experimental annotation

* Better handling of configuration

* Fix PHP 7.1

* Fix providers issue when item is not found

* Fix relation issues and HAL normalizer

* Fix phpunit vendor failure

* Allow nested lookups

* Fix tests and CS

* Ensure BC in AbstractFilter

* CS

* Fix broken test

* Fix routing

* Fix alcaeus' comments

* Fix the pagination

* Minor fixes

* Add tests for date filter and simplify code

Author: alanpoulain

.circleci/config.yml

@@ -13,6 +13,12 @@ reusable-steps:
     run:
       name: Disable Xdebug PHP extension
       command: sudo rm /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+  - &install-php-extensions
+    run:
+      name: Install PHP extensions
+      command: |
+        sudo pecl install mongodb
+        echo 'extension=mongodb.so' | sudo tee /usr/local/etc/php/conf.d/mongodb.ini
   - &restore-composer-cache
     restore_cache:
       keys:
@@ -106,6 +112,7 @@ jobs:
       - *restore-composer-cache
       - *disable-xdebug-php-extension
       - *disable-php-memory-limit
+      - *install-php-extensions
       - *update-composer
       - *update-project-dependencies
       - run:
@@ -132,6 +139,7 @@ jobs:
       - *restore-npm-cache
       - *disable-xdebug-php-extension
       - *disable-php-memory-limit
+      - *install-php-extensions
       - *update-composer
       - *update-project-dependencies
       - *save-composer-cache-by-revision
@@ -177,6 +185,7 @@ jobs:
       - *restore-npm-cache
       - *disable-xdebug-php-extension
       - *disable-php-memory-limit
+      - *install-php-extensions
       - *update-composer
       - *update-project-dependencies
       - *save-composer-cache-by-revision

.travis.yml

@@ -8,6 +8,10 @@ cache:
 jobs:
   include:
     - php: '7.1'
+      env: NO_UNIT_TESTS=true
+      before_install:
+        - composer remove --dev ext-mongodb doctrine/mongodb-odm doctrine/mongodb-odm-bundle
+        - sed -i '26,32d' tests/Fixtures/app/config/config_common.yml
     - php: '7.2'
     - php: '7.3'
     - php: '7.3'
@@ -26,6 +30,10 @@ jobs:
       before_script:
         - mysql -e 'CREATE DATABASE api_platform_test;'
       env: APP_ENV=mysql
+    - php: '7.3'
+      services:
+        - mongodb
+      env: APP_ENV=mongodb
     - php: '7.3'
       services:
         - elasticsearch
@@ -40,6 +48,7 @@ before_install:
     fi
   - phpenv config-rm xdebug.ini || echo "xdebug not available"
   - echo "memory_limit=-1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
+  - echo "extension=mongodb.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
   - export PATH="$PATH:$HOME/.composer/vendor/bin"
 
 install:
@@ -51,10 +60,17 @@ install:
 
 script:
   - tests/Fixtures/app/console cache:clear
-  - vendor/bin/phpunit
+  - if [[ $NO_UNIT_TESTS != true ]]; then
+      vendor/bin/phpunit;
+    fi
+  - if [[ $APP_ENV = 'mongodb' ]]; then
+      vendor/bin/phpunit -c phpunit.mongo.xml;
+    fi
   - tests/Fixtures/app/console cache:clear
   - if [[ $APP_ENV = 'postgres' ]]; then
       vendor/bin/behat --suite=postgres --format=progress;
+    elif [[ $APP_ENV = 'mongodb' ]]; then
+      vendor/bin/behat --suite=mongodb --format=progress;
     elif [[ $APP_ENV = 'elasticsearch' ]]; then
       vendor/bin/behat --suite=elasticsearch --format=progress;
     else

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 2.4.0
 
+* MongoDB: full support
 * Elasticsearch: add reading support (including pagination, sort filter and term filter)
 * Mercure: automatically push updates to clients using the [Mercure](https://mercure.rocks) protocol
 * CQRS support and async message handling using the Symfony Messenger Component

appveyor.yml

@@ -9,17 +9,27 @@ install:
   - ps: Set-Service wuauserv -StartupType Manual
   - cinst -y php composer
   - refreshenv
-  - cd c:\tools\php73
+  - cd c:\tools\php73\ext
+  - ps: |
+      $web = New-Object Net.WebClient
+      $web.Headers.Add('user-agent', 'AppVeyor')
+      $web.DownloadFile('https://windows.php.net/downloads/pecl/releases/mongodb/1.5.3/php_mongodb-1.5.3-7.3-nts-vc15-x64.zip', 'c:\tools\php73\ext\php_mongodb.zip')
+  - 7z x php_mongodb.zip -y >nul
+  - cd ..
   - copy php.ini-production php.ini /Y
   - echo date.timezone="UTC" >> php.ini
   - echo extension_dir=ext >> php.ini
   - echo extension=php_openssl.dll >> php.ini
   - echo extension=php_mbstring.dll >> php.ini
   - echo extension=php_intl.dll >> php.ini
   - echo extension=php_pdo_sqlite.dll >> php.ini
+  - echo extension=php_mongodb.dll >> php.ini
   - echo memory_limit=3G >> php.ini
   - cd %APPVEYOR_BUILD_FOLDER%
-  - composer install --no-interaction --no-progress --no-suggest
+  - composer install --no-interaction --no-progress --no-suggest --ignore-platform-reqs
+
+services:
+  - mongodb
 
 test_script:
   - cd %APPVEYOR_BUILD_FOLDER%

behat.yml.dist

@@ -38,6 +38,25 @@ default:
         - 'Behatch\Context\RestContext'
       filters:
         tags: '~@sqlite&&~@elasticsearch'
+    mongodb:
+      contexts:
+        - 'DoctrineContext':
+            doctrine: '@doctrine_mongodb'
+        - 'HttpHeaderContext'
+        - 'GraphqlContext'
+        - 'JsonContext'
+        - 'HydraContext'
+        - 'SwaggerContext'
+        - 'HttpCacheContext'
+        - 'JsonApiContext':
+            doctrine: '@doctrine_mongodb'
+            jsonApiSchemaFile: '%paths.base%/tests/Fixtures/JsonSchema/jsonapi.json'
+        - 'JsonHalContext':
+            schemaFile: '%paths.base%/tests/Fixtures/JsonHal/jsonhal.json'
+        - 'Behat\MinkExtension\Context\MinkContext'
+        - 'Behatch\Context\RestContext'
+      filters:
+        tags: '~@sqlite&&~@elasticsearch&&~@!mongodb'
     elasticsearch:
       paths:
         - '%paths.base%/features/elasticsearch'

composer.json

@@ -33,11 +33,13 @@
         "behat/symfony2-extension": "^2.1.1",
         "behatch/contexts": "3.1.0",
         "doctrine/annotations": "^1.2",
-        "doctrine/doctrine-cache-bundle": "^1.3.5",
         "doctrine/doctrine-bundle": "^1.8",
+        "doctrine/doctrine-cache-bundle": "^1.3.5",
+        "doctrine/mongodb-odm": "^2.0.0@beta",
+        "doctrine/mongodb-odm-bundle": "^4.0.0@beta",
         "doctrine/orm": "^2.6.3",
         "elasticsearch/elasticsearch": "^6.0",
-        "friendsofsymfony/user-bundle": "^2.1",
+        "friendsofsymfony/user-bundle": "dev-fix-mongodb-mapping",
         "guzzlehttp/guzzle": "^6.0",
         "justinrainbow/json-schema": "^5.0",
         "nelmio/api-doc-bundle": "^2.13.3",
@@ -77,6 +79,7 @@
         "doctrine/common": "<2.7"
     },
     "suggest": {
+        "doctrine/mongodb-odm-bundle": "To support MongoDB.",
         "elasticsearch/elasticsearch": "To support Elasticsearch.",
         "friendsofsymfony/user-bundle": "To use the FOSUserBundle bridge.",
         "guzzlehttp/guzzle": "To use the HTTP cache invalidation system.",
@@ -104,5 +107,12 @@
     },
     "config": {
         "sort-packages": true
-    }
+    },
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/alanpoulain/FOSUserBundle",
+            "no-api": true
+        }
+    ]
 }