Skip to content

Symfony 8.0 support #2791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 2.15.x
Choose a base branch
from
+105 −33
Open

Symfony 8.0 support #2791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/workflows/atlas-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,13 @@ jobs:
symfony:
- "stable"
proxy:
- "lazy-ghost"
- "native"
include:
# Test with LazyGhostObject
- php-version: "8.2"
symfony: "7.4"
proxy: "lazy-ghost"
os: "ubuntu-latest"
# Test with ProxyManager
- php-version: "8.1"
symfony: "6.4"
Expand Down
21 changes: 20 additions & 1 deletion .github/workflows/continuous-integration.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,22 @@ jobs:
dependencies: "highest"
symfony-version: "stable"
proxy: "lazy-ghost"
# Test with upcoming Symfony 7.4
- topology: "server"
php-version: "8.2"
mongodb-version: "8.0"
driver-version: "stable"
dependencies: "highest"
symfony-version: "7.4"
proxy: "lazy-ghost"
# Test with upcoming Symfony 8.0
- topology: "server"
php-version: "8.4"
mongodb-version: "8.0"
driver-version: "stable"
dependencies: "highest"
symfony-version: "8.0"
proxy: "native"
# Test with a sharded cluster
# Currently disabled due to a bug where MongoDB reports "sharding status unknown"
# - topology: "sharded_cluster"
Expand Down Expand Up @@ -127,7 +143,6 @@ jobs:
uses: "shivammathur/setup-php@v2"
with:
php-version: "${{ matrix.php-version }}"
tools: "pecl"
extensions: "mongodb-${{ matrix.driver-version }}, bcmath"
coverage: "none"
ini-values: "zend.assertions=1"
Expand All @@ -147,6 +162,10 @@ jobs:
composer require --no-update symfony/console:^${{ matrix.symfony-version }}
composer require --no-update symfony/var-dumper:^${{ matrix.symfony-version }}
composer require --no-update --dev symfony/cache:^${{ matrix.symfony-version }}
if dpkg --compare-versions "${{ matrix.symfony-version }}" lt "8.0"; then
# LazyGhostTrait was removed from symfony/var-exporter >= 8.0
composer require --dev symfony/var-exporter:^${{ matrix.symfony-version }}
fi

- name: "Install dependencies with Composer"
uses: "ramsey/composer-install@v3"
Expand Down
10 changes: 5 additions & 5 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@
"jean85/pretty-package-versions": "^1.3.0 || ^2.0.1",
"mongodb/mongodb": "^1.21.2 || ^2.1.1",
"psr/cache": "^1.0 || ^2.0 || ^3.0",
"symfony/console": "^5.4 || ^6.0 || ^7.0",
"symfony/console": "^5.4 || ^6.4 || ^7.0",
"symfony/deprecation-contracts": "^2.2 || ^3.0",
"symfony/var-dumper": "^5.4 || ^6.0 || ^7.0",
"symfony/var-exporter": "^6.2 || ^7.0"
"symfony/var-dumper": "^5.4 || ^6.4 || ^7.0",
"symfony/var-exporter": "^6.4 || ^7.0"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@doctrine/mongodb-odm-maintainers I think we need a meta package for the proxy implementation.
Currently, we have 3 lazy object implementations:

  • friendsofphp/proxy-manager-lts (conflict with Symfony 8)
  • symfony/var-exporter (not available in Symfony 8)
  • Native (require PHP 8.4)

When using symfony/flex with SYMFONY_REQUIRE=^8, the installation fails because symfony/var-exporter and friendsofphp/proxy-manager-lts cannot be installed.

I propose to create a meta package with 2 versions:

  • v1 require symfony/var-exporter and friendsofphp/proxy-manager-lts
  • v2 require PHP 8.4+

So that, depending on the PHP and Symfony version, the correct dependencies are installed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively, Symfony 8 would be only supported by version 3. But we have a lot to do: #2762

},
"require-dev": {
"ext-bcmath": "*",
Expand All @@ -52,8 +52,8 @@
"phpstan/phpstan-phpunit": "^2.0",
"phpunit/phpunit": "^10.5.58",
"squizlabs/php_codesniffer": "^4",
"symfony/cache": "^5.4 || ^6.0 || ^7.0",
"symfony/uid": "^5.4 || ^6.0 || ^7.0"
"symfony/cache": "^5.4 || ^6.0 || ^7.0 || ^8.0",
"symfony/uid": "^5.4 || ^6.0 || ^7.0 || ^8.0"
},
"conflict": {
"doctrine/annotations": "<1.12 || >=3.0"
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/console-commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Console Commands
================

Doctrine MongoDB ODM offers some console commands, which utilize Symfony2's
Doctrine MongoDB ODM offers some console commands, which utilize Symfony's
Console component, to ease your development process:

- ``odm:clear-cache:metadata`` - Clear all metadata cache of the various cache drivers.
Expand Down
1 change: 1 addition & 0 deletions phpcs.xml.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
<rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
<exclude-pattern>src/Mapping/Driver/CompatibilityAnnotationDriver.php</exclude-pattern>
<exclude-pattern>src/Tools/Console/Command/CommandCompatibility.php</exclude-pattern>
<exclude-pattern>src/Tools/Console/Command/Schema/AbstractCommandCompatibility.php</exclude-pattern>
<exclude-pattern>src/Tools/Console/Helper/DocumentManagerHelper.php</exclude-pattern>
<exclude-pattern>tests/*</exclude-pattern>
</rule>
Expand Down
3 changes: 1 addition & 2 deletions src/Tools/Console/Command/ClearCache/MetadataCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ class MetadataCommand extends Command
{
use CommandCompatibility;

/** @return void */
protected function configure()
private function doConfigure(): void
{
$this
->setName('odm:clear-cache:metadata')
Expand Down
30 changes: 29 additions & 1 deletion src/Tools/Console/Command/CommandCompatibility.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,32 @@
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

if ((new ReflectionMethod(Command::class, 'execute'))->hasReturnType()) {
// Symfony 8
if ((new ReflectionMethod(Command::class, 'configure'))->hasReturnType()) {
/** @internal */
trait CommandCompatibility
{
protected function configure(): void
{
$this->doConfigure();
}
Comment on lines +17 to +20
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps I'm missing something but I don't think we need this trait here.
Since we already require PHP 8.1+, we should be able to use void in child classes as per: https://3v4l.org/Mv3oq

I did something similar in https://github.com/IonBazan/composer-diff/blob/8907711f0bf74677041f7b356da2367afea44a53/src/Command/BaseTypedCommand.php#L9-L14 but that's only needed to support different PHP versions.

If the parent does not declare a return type then the child is allowed to declare one.

See: https://wiki.php.net/rfc/return_types

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove it in 2.13.x just to be sure

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue is with older versions of the bundle that don't have the void return type. https://github.com/doctrine/DoctrineMongoDBBundle/blob/4.7.x/Command/CreateSchemaDoctrineODMCommand.php#L21


protected function execute(InputInterface $input, OutputInterface $output): int
{
return $this->doExecute($input, $output);
}
}
// Symfony 7
} elseif ((new ReflectionMethod(Command::class, 'execute'))->hasReturnType()) {
/** @internal */
trait CommandCompatibility
{
/** @return void */
protected function configure()
{
$this->doConfigure();
}

protected function execute(InputInterface $input, OutputInterface $output): int
{
return $this->doExecute($input, $output);
Expand All @@ -22,6 +44,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
/** @internal */
trait CommandCompatibility
{
/** @return void */
protected function configure()
{
$this->doConfigure();
}

/**
* {@inheritDoc}
*
Expand Down
3 changes: 1 addition & 2 deletions src/Tools/Console/Command/GenerateHydratorsCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ class GenerateHydratorsCommand extends Command
{
use CommandCompatibility;

/** @return void */
protected function configure()
private function doConfigure(): void
{
$this
->setName('odm:generate:hydrators')
Expand Down
3 changes: 1 addition & 2 deletions src/Tools/Console/Command/GeneratePersistentCollectionsCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ class GeneratePersistentCollectionsCommand extends Command
{
use CommandCompatibility;

/** @return void */
protected function configure()
private function doConfigure(): void
{
$this
->setName('odm:generate:persistent-collections')
Expand Down
3 changes: 1 addition & 2 deletions src/Tools/Console/Command/GenerateProxiesCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ class GenerateProxiesCommand extends Command
{
use CommandCompatibility;

/** @return void */
protected function configure()
private function doConfigure(): void
{
$this
->setName('odm:generate:proxies')
Expand Down
3 changes: 1 addition & 2 deletions src/Tools/Console/Command/QueryCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ class QueryCommand extends Command
{
use CommandCompatibility;

/** @return void */
protected function configure()
private function doConfigure(): void
{
$this
->setName('odm:query')
Expand Down
7 changes: 3 additions & 4 deletions src/Tools/Console/Command/Schema/AbstractCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,15 @@

abstract class AbstractCommand extends Command
{
use AbstractCommandCompatibility;

public const DB = 'db';
public const COLLECTION = 'collection';
public const INDEX = 'index';
public const SEARCH_INDEX = 'search-index';

/** @return void */
protected function configure()
private function configureCommonOptions(): void
{
parent::configure();

$this
->addOption('maxTimeMs', null, InputOption::VALUE_REQUIRED, 'An optional maxTimeMs that will be used for all schema operations.')
->addOption('w', null, InputOption::VALUE_REQUIRED, 'An optional w option for the write concern that will be used for all schema operations.')
Expand Down
30 changes: 30 additions & 0 deletions src/Tools/Console/Command/Schema/AbstractCommandCompatibility.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Tools\Console\Command\Schema;

use ReflectionMethod;
use Symfony\Component\Console\Command\Command;

// Symfony 8
if ((new ReflectionMethod(Command::class, 'configure'))->hasReturnType()) {
/** @internal */
trait AbstractCommandCompatibility
{
protected function configure(): void
{
$this->configureCommonOptions();
}
}
} else {
/** @internal */
trait AbstractCommandCompatibility
{
/** @return void */
protected function configure()
{
$this->configureCommonOptions();
}
}
}
3 changes: 1 addition & 2 deletions src/Tools/Console/Command/Schema/CreateCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ class CreateCommand extends AbstractCommand
self::SEARCH_INDEX => ['search index(es)', 'search indexes'],
];

/** @return void */
protected function configure()
private function doConfigure(): void
{
parent::configure();

Expand Down
3 changes: 1 addition & 2 deletions src/Tools/Console/Command/Schema/DropCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ class DropCommand extends AbstractCommand
self::SEARCH_INDEX => ['search index(es)', 'search indexes'],
];

/** @return void */
protected function configure()
protected function doConfigure(): void
{
parent::configure();

Expand Down
3 changes: 1 addition & 2 deletions src/Tools/Console/Command/Schema/ShardCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ class ShardCommand extends AbstractCommand
{
use CommandCompatibility;

/** @return void */
protected function configure()
private function doConfigure(): void
{
parent::configure();

Expand Down
3 changes: 1 addition & 2 deletions src/Tools/Console/Command/Schema/UpdateCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ class UpdateCommand extends AbstractCommand
{
use CommandCompatibility;

/** @return void */
protected function configure()
private function doConfigure(): void
{
parent::configure();

Expand Down
3 changes: 1 addition & 2 deletions src/Tools/Console/Command/Schema/ValidateCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ class ValidateCommand extends Command
{
use CommandCompatibility;

/** @return void */
protected function configure()
private function doConfigure(): void
{
$this
->setName('odm:schema:validate')
Expand Down