APIP 2024 - All the Challenges of Sylius Migration to API Platform 3.pdf

Migrating Sylius to API Platform 3 is no small feat. In this presentation, we will discuss the many challenges we faced during this complex transition and the innovative solutions we used to overcome them. This journey began with a clear goal: to leverage the robust capabilities of API Platform 3 to improve the performance and scalability of Sylius. In this talk, I will share the critical steps we took, the obstacles we encountered, and the strategies we used to overcome these challenges.

We will address the following questions:

What were the key technical hurdles in migrating Sylius to API Platform 3?
How did we ensure compatibility and maintain data integrity throughout the migration?
What were our key takeaways and best practices from this experience?
Join us to gain insights from our experience, learn about common pitfalls in such migrations, and discover how to navigate them effectively. Whether you are planning a similar migration or looking to optimize your current setup, this session will provide valuable lessons and practical tips to help you succeed.

1. SEPTEMBER 19 -20, 2024 - LILLE, FRANCE & ONLINE
All the Challenges of Sylius
migration
to API Platform 3

2. Tests
01
02
03
04
05
Commands
Open API
Conclusion
Subresources

3. About me
Łukasz Chruściel

✔Co-owner at Commerce Weavers
✔Core Team Lead at Sylius
✔I’m involved in 3 Sylius & API Platform
eCommerce projects

4. You don’t have to remind me every year…
API Platform Conference 2022
What we’ve learned
designing the new Sylius API

5. About team
✔Grzegorz - as an effort lead
✔Developers: Jan, Kuba, Kamil, Michał,
Rafał, Karol
Internal Sylius Team
@Sylius
sylius.com

6. Scale of the migration
v2.7.18 v3.4.0
Where we were? Where we go?

7. We have it!

8. 752 commits
Migration statistics
1712 files changed

9. 73 shop endpoints
Sylius API statistics
188 admin endpoints
40808 lines of code
across 562 files

10. Main problems
✔New metadata class
✔New configuration reference
✔New architecture of Providers/Processors
✔New subresource architecture
✔Sylius is not a typical use-case

11. 01
02
03
04
05
Tests
Commands
Serialization
Open API
Conclusion

12. Command 101

✔Decouples infrastructure from application
✔Holds customer intention
✔Commands never contain entities
✔Handlers are stateless
✔Maintains the same behaviour even
if framework has changed
API Platform Con 2021
Sylius & API Platform: the
story of integration

13. Architecture 101

14. Request is like
Says more than a 1000 words

15. Mapping of request body
to command is not
enough

16. Channel Order
Language
User

17. Request is not only the body
Request data Translates to
✔Hostname
✔Language Header
✔Authorization Header
✔URI attributes
✔Channel code
✔Local code
✔Shop User ID
✔Order token

18. Command enrichment

19. Serializer context enrichment

20. Serializer context enrichment
/api/v2/shop/orders/{tokenValue}/items

{
"productVariant": "string",
"quantity": 1
}

21. Result?
✔Better design
✔Command immutability
✔Better decoupling from framework

22. 01
02
03
04
05
Tests
Commands
Subresources
Open API
Conclusion

23. Tests 101

✔BDD for behaviour
✔Behat for BDD

✔Contract testing for API design
✔PHPUnit for contract testing
API Platform Con 2021
Sylius & API Platform: the
story of integration

24. @shopping_cart
Feature: Adding a simple product to the cart
In order to select products for purchase
As a Visitor
I want to be able to add simple products to cart

Background:
Given the store operates on a single channel in "United States"
And the store has a product "T-Shirt banana" priced at "$12.54"
And the store ships everywhere for free

@api @ui @javascript
Scenario: Adding a simple product to the cart
When I add this product to the cart
Then I should be on my cart summary page
And I should be notified that the product has been successfully added
And there should be one item in my cart
And this item should have name "T-Shirt banana"
Behaviour Driven
Development

25. public function it_adds_item_to_order_as_guest (): void
{
$this?lsetUpDefaultPostHeaders ();

$this?lloadFixturesFromFiles ([
'channel/channel.yaml' ,
'cart.yaml',
'country.yaml',
'shipping_method.yaml' ,
'payment_method.yaml' ,
]);

$tokenValue = $this?lpickUpCart();

$this?lrequestPost(
uri: sprintf('/api/v2/shop/orders/%s/items' , $tokenValue),
body: [
'productVariant' ?? '/api/v2/shop/product-variants/MUG_BLUE' ,
'quantity' ?? 4,
],
);

$this?lassertResponseCreated ('shop/checkout/cart/add_item' );
}
Contract testing

26. {
"@context": "\/api\/v2\/contexts\/Order",
"@id": "\/api\/v2\/shop\/orders\/token",
"@type": "Order",
"channel": "\/api\/v2\/shop\/channels\/WEB",
"currencyCode": "USD",
"localeCode": "en_US",
"state": "cart",
"checkoutState": "cart",
"paymentState": "cart",
"shippingState": "cart",
"tokenValue": "token",
"number": null,
"items": [
{
"@id": "\/api\/v2\/shop\/orders\/token\/items\/@integer@",
"@type": "OrderItem",
"variant": "\/api\/v2\/shop\/product-variants\/MUG_BLUE",
"productName": "Mug",
"id": "@integer@",
"quantity": 4,
"unitPrice": 2000,
"originalUnitPrice": 2000,
"total": 8000,
"discountedUnitPrice" : 2000,
"subtotal": 8000
}
],
"itemsTotal": 8000,
"total": 8500,
}
Contract testing

27. How did it help us?

28. How did it help us?
✔Safety net
✔Easy to determine changes in contact
✔Way to do it one by one

29. 01
02
03
04
05
Tests
Commands
Open API
Conclusion
Subresources

30. Why do we need it?

31. Auto increments…


Insecure Direct Object Reference (IDOR)
https://cheatsheetseries.owasp.org/cheatsheets/Insecure
_Direct_Object_Reference_Prevention_Cheat_Sheet.html

32. Back in the days
wild west / horror / hell
It was wild

33. <resource class="%sylius.model.order.class%" shortName="Order">
<attribute name="validation_groups" >sylius?$attribute>

<itemOperations>
<itemOperation name="shop_add_item">
<attribute name="method">POST?$attribute>
<attribute name="path">/shop/orders/{tokenValue}/items?$ attribute>
<attribute name="messenger">input?$attribute>
<attribute name="input">Sylius\Bundle\ApiBundle\Command\Cart\AddItemToCart?$ attribute>
<attribute name="normalization_context" >
<attribute name="groups">
< attribute>shop:cart:show?$attribute>
< attribute>sylius:shop:cart:show?$attribute>
444444444444444?$attribute>
44444444444?$attribute>
<attribute name="denormalization_context" >
<attribute name="groups">
< attribute>shop:cart:add_item?$attribute>
< attribute>sylius:shop:cart:add_item?$attribute>
444444444444444?$attribute>
44444444444?$attribute>
<attribute name="openapi_context">
<attribute name="summary">Adds Item to cart.?$attribute>
44444444444?$attribute>
4444444?$itemOperation>
?$resource>
Before

34. Nowadays
image of modern, nice country with not obvious
issues

35. <resource class="Sylius\Component\Core\Model\OrderItem" uriTemplate="/shop/orders/{tokenValue}/items" >
<uriVariables>
<uriVariable
parameterName ="tokenValue"
fromClass ="Sylius\Component\Core\Model\Order"
fromProperty ="items"
??
444?$uriVariables>
<operations>
<operation class="ApiPlatform\Metadata\GetCollection" >
<normalizationContext >
<values>
< value name="groups">
< values>
< value>sylius:shop:cart:show?$value>
44444444444444444444444?$values>
4444444444444444444?$value>
444444444444444?$values>
44444444444?$normalizationContext >
4444444?$operation>
444?$operations>
?$resource>
After

36. Nowadays
image of modern, nice country with not obvious
issues

37. Some issues still exists

38. Double nested structures

39. Double nested structures
What we want is:
{"@id": "\/api\/v2\/shop\/orders\/TOKEN\/items\/ID\/item-units\/ID"},
What we have right now is:
{"@id": "\/api\/v2\/shop\/order-item-units\/ID"},

40. Some issues still exists

41. 01
02
03
04
05
Tests
Commands
Open API
Conclusion
Subresources

42. API Platform
documentation
??????

43. But sometimes it is not
enough

44. Cart pick up

45. final readonly class OpenApiFactory implements OpenApiFactoryInterface
{
public function ??construct(
private OpenApiFactoryInterface $decorated,
/** @var iterable<DocumentationModifierInterface> ??
private iterable $openApiModifiers,
) {
Assert?{allIsInstanceOf($openApiModifiers, DocumentationModifierInterface ?{class);
}

public function ??invoke(array $context = []): OpenApi
{
$openApi = ($this?ldecorated)($context);

foreach ($this?lopenApiModifiers as $openApiModifier) {
$openApi = $openApiModifier?lmodify($openApi);
}

return $openApi;
}
}
Documentation modifiers

46. $acceptLanguageHeaderParameter = new Parameter(
name: 'Accept-Language',
in: 'header',
description: 'Locales in this enum are all locales defined in the shop and only enabled ones
will work in the given channel in the shop.' ,
required: false,
schema: [
'type' ?? 'string',
'enum' ?? array_map(
fn (LocaleInterface $locale): string ?? $locale?lgetCode(),
$this?llocaleRepository?lfindAll(),
),
],
);
Documentation modifiers

47. Documentation modifiers

48. 01
02
03
04
05
Tests
Commands
API structure
Conclusion
Subresources

49. Key take-outs
✔Use commands to decouple from framework
-With a little bit of effort you can map more than just request body to command
✔Tests are a must have for successful migration
✔New operation system rocks
-but we may improve some stuff for more deeply nested classes

50. Thank you!
FOLLOW ME!
@lukaszchrusciel
commerceweavers.com
Any questions?

51. 01 - Interesting
introduction
Some cool stuff

52. {
"@context": "/contexts/ConstraintViolationList" ,
"@type": "ConstraintViolationList" ,
"hydra:title": "An error occurred",
"hydra:description": "isbn: This value is neither a valid ISBN-10 nor a valid
ISBN-13.\ntitle: This value should not be blank." ,
"violations": [
{
"propertyPath": "isbn",
"message": "This value is neither a valid ISBN-10 nor a valid ISBN-13."
},
{
"propertyPath": "title",
"message": "This value should not be blank."
}
]
}

Some code

53. Some title
Add your text here

54. Another example
✔You can add stuff here
✔Or here…
✔Or even here!

55. Another example
✔You can add stuff here
✔Or here…
✔Or even here!
Add something here

56. Another example
✔You can add stuff here
✔Or here…
✔Or even here!

57. Another slide
Example
✔You can add stuff here
✔Or here…
✔Or even here!
Some content you want to
highlight

58. Another example
✔You can add stuff here
✔Or here…
✔Or even here!
Another content
to highlight
Add caption (or not)

59. Some title
Add your text here
Say something (or delete this)

60. Some title
Add your text here

61. Some title
Some interesting
point
Another interesting
point
A final interesting
point

62. Some title
Some interesting
point
A final interesting
point
Another interesting point

63. You can say interesting
things here
✔Large topics discussed on that wonderful
slide
✔You can write something else
Hello!

64. Thank you!
Hello!
Any questions?
@JaneDoeTwitter
jane-doe.com
Follow me on social media

65. Need graphic stuff for your slides?

66. Need graphic stuff for your slides?
Something cool