Skip to content
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.

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

[FrameworkBundle] Workflow - Fix LogicException about a wrong configuration of "enabled" node #49682

Merged
merged 1 commit into from Mar 25, 2023

Conversation

adpauly
Copy link
Contributor

@adpauly adpauly commented Mar 14, 2023

Q A
Branch? 5.4
Bug fix? yes
New feature? no
Deprecations? no
Tickets /
License MIT
Doc PR /

When I try to configure the YAML node "enabled" under a workflow configuration:

framework:
    workflows:
        order_approval_state:
            enabled: false # <--- HERE
            type: state_machine 
            supports: 
                - AppBundle\Entity\OrderApproval

The following exception is thrown:

//vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
if (isset($workflow['enabled']) && false === $workflow['enabled']) {
    throw new LogicException(sprintf('Cannot disable a single workflow. Remove the configuration for the workflow "%s" instead.', $workflow['name']));
}

But it actually throws the following PHP error:

In Configuration.php line 262:
                                 
  Notice: Undefined index: name  

I think we should use the $key variable instead of this undefined index.
$key contains the workflow name.

When changing, I get the attempted exception:

In Configuration.php line 262:
                                                                                                               
  Cannot disable a single workflow. Remove the configuration for the workflow "order_approval_state" instead.                                                                                                                                  

(I took a look in 6.2, it doesn't fix yet.)

@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 6.3 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

Copy link
Member

@lyrixx lyrixx left a comment

Choose a reason for hiding this comment

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

Good catch, Can you add a test case? If you can't, I'll, not problem

@fabpot
Copy link
Member

fabpot commented Mar 25, 2023

Thank you @adpauly.

@fabpot fabpot merged commit b181772 into symfony:5.4 Mar 25, 2023
8 of 9 checks passed
This was referenced Mar 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants