Link order generation to state machine #283

ehibes · 2022-06-15T06:46:01Z

Moving order generation to state machine transition from doctrine persist event. #281
Solve #174 #235 adding some state configuration :

winzou_state_machine:
    sylius_payment:
        callbacks:
            after:
                sylius_invoicing_plugin_order_placed_producer:
                    on: ['complete']
                    do: ['@sylius_invoicing_plugin.event_producer.order_placed', '__invoke']
                    args: ['object.getOrder()']
                sylius_invoicing_plugin_payment_complete_producer:
                    disabled: true
    sylius_order:
        callbacks:
            after:
                sylius_invoicing_plugin_order_placed_producer:
                    disabled: true

I had to use the identifier instead of the number, because the order number is not yet persisted to the entity at the time of the transition.

…(persist|update)

Prometee

Hello @ehibes !

Why do you change all the orderNumber references to id ?

Changing the moment where the invoice item is created could help.

Prometee · 2022-06-30T12:57:37Z

src/Resources/config/config.yml

+    sylius_order:
+        callbacks:
+            after:
+                sylius_invoicing_plugin_order_placed_producer:
+                    on: ['create']
+                    do: ['@sylius_invoicing_plugin.event_producer.order_placed', '__invoke']
+                    args: ['object']


Reading what the OrderPlacedProducer is doing :

onPostPersist : when order.checkout_state === 'completed' then dispatch creation of sylius_invoicing_plugin_invoice new item

onPostUpdate : when the new value of order.checkout_state === 'completed' then dispatch creation of sylius_invoicing_plugin_invoice new item

Don't you think the new callback should be set on the state machine named : sylius_order_checkout on ['complete'] ?

I'll try this, and check if order_number is available at this time.
All behat tests passed for me... not for you ?

The order number is assigned here : https://github.com/Sylius/Sylius/blob/master/src/Sylius/Bundle/CoreBundle/Resources/config/app/state_machine/sylius_order.yml#L26
If your callback don't have a priority it should be executed after the order number assigner.

ehibes · 2022-06-30T13:20:13Z

Hello @ehibes !

Why do you change all the orderNumber references to id ?

Changing the moment where the invoice item is created could help.

I did it because orderNumber was not yet generated.

Prometee · 2022-06-30T17:48:01Z

src/Creator/InvoiceCreator.php

    {
        /** @var OrderInterface $order */
-        $order = $this->orderRepository->findOneByNumber($orderNumber);
+        $order = $this->orderRepository->find($orderId);


Suggested change

$order = $this->orderRepository->find($orderId);

/** @var OrderInterface|null $order */

$order = $this->orderRepository->findOneBy(['number' => $orderNumber]);

Assert::notNull($order, sprintf('Order with number "%s" does not exist.', $orderNumber));

I tried this before but it didn't work, I'll try again.

The Behat test is maybe missing something, in my current projet I have to prepare my order doing this :

$stateMachine = $this->stateMachineFactory->get($order, OrderTransitions::GRAPH); $stateMachine->apply(OrderTransitions::TRANSITION_CREATE);

save it to the database and complete the order (OrderCheckoutTransitions::TRANSITION_COMPLETE).

ehibes · 2022-06-30T19:52:19Z

I made changes according to you reviews. PhpSpec & behat tests passed. I don't know how to add your behat scenario...

Prometee · 2022-06-30T20:47:12Z

spec/Creator/MassInvoicesCreatorSpec.php

+        $firstOrder->getNumber()->willReturn('000001');
+        $secondOrder->getNumber()->willReturn('000002');
+        $thirdOrder->getNumber()->willReturn('000003');


To ease the reviewing of your PR by Sylius core team members, can you revert it by adding the missing zero ?

Prometee · 2022-06-30T20:47:49Z

spec/Creator/MassInvoicesCreatorSpec.php

+        $invoiceCreator->__invoke('000001', $firstInvoiceDateTime)->shouldBeCalled();
+        $invoiceCreator->__invoke('000002', $secondInvoiceDateTime)->shouldBeCalled();
+        $invoiceCreator->__invoke('000003', $thirdInvoiceDateTime)->shouldBeCalled();


Prometee · 2022-06-30T20:48:35Z

spec/EventListener/CreateInvoiceOnOrderPlacedListenerSpec.php

+        $invoiceCreator->__invoke('000001', $issuedAt)->shouldBeCalled();

-        $this(new OrderPlaced('0000001', $issuedAt));
+        $this(new OrderPlaced('000001', $issuedAt));


And here 😉

Prometee · 2022-06-30T20:49:44Z

src/Creator/InvoiceCreator.php

@@ -38,7 +39,8 @@ public function __construct(
    public function __invoke(string $orderNumber, \DateTimeInterface $dateTime): void
    {
        /** @var OrderInterface $order */


This phpdoc is missing the possibility of null

Prometee · 2022-06-30T20:59:37Z

I made changes according to you reviews. PhpSpec & behat tests passed. I don't know how to add your behat scenario...

Perfect, thank you for your work, I will ping the devs about it to start approving it 😉
Don't worry about the BeHat test, I will setup one elaborate one in an other PR.

ehibes · 2022-06-30T21:05:43Z

Perfect, thank you for your work, I will ping the devs about it to start approving it 😉 Don't worry about the BeHat test, I will setup one elaborate one in an other PR.

Thank you for your reactivity @Prometee.
I should write a Behat scenario too, for my example of the first message.

Prometee · 2022-06-30T21:07:53Z

Yes it will avoid getting the issue again indeed 👌

GSadee · 2022-07-01T05:00:48Z

.php-version

@@ -0,0 +1 @@
+8.0


This file should be removed

GSadee · 2022-07-01T05:01:18Z

src/Creator/InvoiceCreator.php

-        /** @var OrderInterface $order */
-        $order = $this->orderRepository->findOneByNumber($orderNumber);
+        /** @var OrderInterface|null $order */
+        $order = $this->orderRepository->findOneBy(['number' => $orderNumber]);


Why did you change that in this PR?

Because findOneByNumber refers to OrderRepository method, which verify order is not on cart state. So we have a null value using repository method.

public function findOneByNumber(string $number): ?OrderInterface { return $this->createQueryBuilder('o') ->andWhere('o.state != :state') ->andWhere('o.number = :number') ->setParameter('state', OrderInterface::STATE_CART) ->setParameter('number', $number) ->getQuery() ->getOneOrNullResult() ; }

So what is the reason the order is in cart state? Because in the moment of creating an invoice the checkout should be completed and the order shouldn't be in the cart state anymore. I guess, but I'm not sure, there is a difference with the moment of dispatching the event between state machine callback and the doctrine events.

At this moment the order state is new instead of cart in the database.

GSadee · 2022-07-01T05:13:25Z

src/Resources/config/config.yml

+    sylius_order_checkout:
+        callbacks:
+            after:
+                sylius_invoicing_plugin_order_placed_producer:
+                    on: ['complete']
+                    do: ['@sylius_invoicing_plugin.event_producer.order_placed', '__invoke']
+                    args: ['object']


I wonder if it wouldn't be better to put this logic on the callback after create transition on sylius_order state machine 🤔

ping @Prometee

@GSadee yes it will make the same thing, but one issue will happen here if the Order has not been saved yet.
Here is an example :

$order = $this->orderFactory->createNew(); /* add product, address and select payment, shipping etc */ $this->stateMachineFactory ->get($order, OrderCheckoutTransitions::GRAPH) ->apply(OrderCheckoutTransitions::TRANSITION_COMPLETE) ;

The result will be an error on the InvoiceCreator because the doctrine query will fail finding the messaged order number.

To solve this, the InvoiceCreator could be reshaped to be a state machine callback, WDYT ?

I know it's a big change and it will make useless triggering the OrderPlaced event and it will require moving the PDF creation to the OrderPaymentPaid event.

I'm not sure if I correctly understand you, is there a problem with moving the callback to sylius_order state machine, in this implementation or in both cases? What is more, as you probably suggested changing the moment of generating an invoice PDF, IMO it is not possible, it should be generated during invoice generation after the order is placed, not payment paid.

During the @sylius_invoicing_plugin.event_producer.order_placed'->__invoke() the invoice creation is dispatched and cause the error I mentioned. To solve this error we can :

remove the dispatch and simply call the service creating the Invoice with a new method signature for the class
Sylius\InvoicingPlugin\Creator\InvoiceCreator

From :

public function __invoke(string $orderNumber, \DateTimeInterface $dateTime): void

To:

public function __invoke(OrderInterface $order, \DateTimeInterface $dateTime): void // Maybe the argument `$dateTime` can be removed and we can use `$order->getCheckoutCompletedAt()` instead

Move the PDF creation to another moment like when the PDF is sent payment_state === 'paid'

From my point of view the Invoice data stored in the database are the immutable data, the PDF is a view of this data.

David-Crty · 2023-03-10T17:29:40Z

I love this feature.
Can I help with anything on those falling checks? Let me know if I can.

ehibes added 2 commits June 9, 2022 16:42

OrderPlacedProducer linked to state machine in order to Doctrine post…

1b76e14

…(persist|update)

OrderPlaced Event based on orderId in order to orderNumber

a817d69

ehibes requested a review from a team as a code owner June 15, 2022 06:46

Prometee reviewed Jun 30, 2022

View reviewed changes

ehibes added 2 commits June 30, 2022 21:31

Linked to state machine with orderNumber

380941a

Merge branch 'state-machine'

7e36063

Prometee reviewed Jun 30, 2022

View reviewed changes

ehibes added 2 commits June 30, 2022 22:52

Spec order number fix

3ec77e8

Php doc and orderNumber fix

f77bc23

Prometee approved these changes Jun 30, 2022

View reviewed changes

GSadee reviewed Jul 1, 2022

View reviewed changes

GSadee added the DX Issues and PRs aimed at improving Developer eXperience. label Jul 1, 2022

remove php-version

3c3a1fd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Link order generation to state machine #283

Link order generation to state machine #283

ehibes commented Jun 15, 2022

Prometee left a comment •

edited

Loading

Prometee Jun 30, 2022 •

edited

Loading

ehibes Jun 30, 2022

Prometee Jun 30, 2022

ehibes commented Jun 30, 2022

Prometee Jun 30, 2022

ehibes Jun 30, 2022

Prometee Jun 30, 2022

ehibes commented Jun 30, 2022

Prometee Jun 30, 2022

Prometee Jun 30, 2022

Prometee Jun 30, 2022

Prometee Jun 30, 2022

Prometee commented Jun 30, 2022 •

edited

Loading

ehibes commented Jun 30, 2022 •

edited

Loading

Prometee commented Jun 30, 2022

GSadee Jul 1, 2022

GSadee Jul 1, 2022

ehibes Jul 1, 2022

GSadee Jul 27, 2022

Prometee Jul 27, 2022

GSadee Jul 1, 2022

ehibes Jul 1, 2022

Prometee Jul 1, 2022 •

edited

Loading

GSadee Jul 27, 2022

Prometee Jul 27, 2022

Prometee Jul 27, 2022

David-Crty commented Mar 10, 2023

		@@ -0,0 +1 @@
		8.0

Link order generation to state machine #283

Are you sure you want to change the base?

Link order generation to state machine #283

Conversation

ehibes commented Jun 15, 2022

Prometee left a comment • edited Loading

Choose a reason for hiding this comment

Prometee Jun 30, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ehibes commented Jun 30, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ehibes commented Jun 30, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Prometee commented Jun 30, 2022 • edited Loading

ehibes commented Jun 30, 2022 • edited Loading

Prometee commented Jun 30, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Prometee Jul 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

David-Crty commented Mar 10, 2023

Prometee left a comment •

edited

Loading

Prometee Jun 30, 2022 •

edited

Loading

Prometee commented Jun 30, 2022 •

edited

Loading

ehibes commented Jun 30, 2022 •

edited

Loading

Prometee Jul 1, 2022 •

edited

Loading