How to make a developer’s life easier – strategy pattern with the help of GrapesBundle
- 1. 1 Make coder’s life easier strategy pattern using Grapes Bundle Jana III Sobieskiego 2, 40-082 Katowice Poland
- 2. 2 Michał ”Mike” Kocztorz Team Lead Software Development @msales About me michal.kocztorz@msales.com Studied in Silesian Institute of Technology in Gliwice In IT for more than 10 years Since IE6 was a modern browser Interested in WEB Good architecture and clear code Searching for best practices I play some acoustic guitar (4 fun only) I love travels I’m a husband and a father
- 3. 3 Basic information (I promise!) Strategy Pattern 1 Dependency Injection with tagged services. Symfony – anything helpful there? 2 What do we have out of the box Strategy in Symfony 3 Strategy using Grapes Bundle 4 Make coder’s life easier Strategy pattern using GrapesBundle There is more… Grapes Bundle extras 5 How we use GrapesBundle in msales Our use cases 6
- 4. 4 Why talk about something as obvious as strategy pattern Is there any need for this? Mariusz Gil @ Boiling Frogs Conference https://youtu.be/_n0s_8JuexI Back to forgotten roots
- 5. 5 Basic information (I promise!) Strategy Pattern
- 6. 6 Recipe for Strategy In a few simple steps The Strategy pattern is to be used where you want to choose the algorithm to use at runtime When to use strategy?
- 7. 7 Define the Interface Define a family of algorythms Implement the interface in several classes Encapsulate each one Code against the Interface, not the implementations. Make them interchangeable Recipe for Strategy In a few simple steps
- 8. 8 Dependency Injection with tagged services. Symfony – helpful features
- 9. 9 Symfony’s generic way of grouping services Tagged services http://symfony.com/doc/current/service_container/tags.html In Symfony documentation the example we will be using is mostly implementing Chain of Responsibility pattern. But it’s also good example to use Strategy. Tagged Services How to work with Service Tags
- 10. 1 0 Tagged Services How to work with Service Tags In the same way that a blog post on the web might be tagged with things such as "Symfony" or "PHP", services configured in your container can also be tagged. In the service container, a tag implies that the service is meant to be used for a specific purpose. “ “ Tags on their own don't actually alter the functionality of your services in any way. But if you choose to, you can ask a container builder for a list of all services that were tagged with some specific tag. This is useful in compiler passes where you can find these services and use or modify them in some specific way. “ “ http://symfony.com/doc/current/service_container/tags.html
- 11. 1 1 Tagged Services How to work with Service Tags http://symfony.com/doc/current/service_container/tags.html
- 12. 1 2 Strategy in Symfony http://symfony.com/doc/current/service_container/tags.html What do we have out of the box
- 13. 1 3 Register the compiler pass Inform Symfony about new compiler pass. Step 5 Prepare interface and the classes that implement your strategy We will have interface that we will code against and some concrete implementations. Step 1 Prepare the service definitions and tag them We need to add service definitions. Then we need to tag the services and add aliases to be able to choose one. Step 2 Strategy in Symfony What do we have out of the box Prepare the compiler pass Add meaning to the tags we just created on the services. Step 4 Build a class that will help us selecting the implementation This class will help in choosing the implementation by alias Step 3
- 14. 1 4 Prepare interface and the classes that implement your strategy We will have interface that we will code against and some concrete implementations. Step 1 Strategy in Symfony What do we have out of the box http://apigen.juzna.cz/doc/swiftmailer/swiftmailer
- 15. 1 5 Prepare the service definitions and tag them We need to add service definitions. Then we need to tag the services and add aliases to be able to choose one. Step 2 Strategy in Symfony What do we have out of the box http://symfony.com/doc/current/service_container/tags.html
- 16. 1 6 Build a class that will help us selecting the implementation This class will help in choosing the implementation by alias Step 3 Strategy in Symfony What do we have out of the box http://symfony.com/doc/current/service_container/tags.html
- 17. 1 7 Prepare the compiler pass Add meaning to the tags we just created on the services. Step 4 Strategy in Symfony What do we have out of the box http://symfony.com/doc/current/service_container/tags.html
- 18. 1 8 Register the compiler pass Inform Symfony about new compiler pass. Step 5 Strategy in Symfony What do we have out of the box http://symfony.com/doc/current/service_container/tags.html
- 19. 1 9 Register the compiler pass Inform Symfony about new compiler pass. Step 5 Prepare interface and the classes that implement your strategy We will have interface that we will code against and some concrete implementations. Step 1 Prepare the service definitions and tag them We need to add service definitions. Then we need to tag the services and add aliases to be able to choose one. Step 2 Strategy in Symfony What do we have out of the box Prepare the compiler pass Add meaning to the tags we just created on the services. Step 4 Build a class that will help us selecting the implementation This class will help in choosing the implementation by alias Step 3 What is wrong in this picture?
- 20. 2 0 Register the compiler pass Inform Symfony about new compiler pass. Step 5 Prepare interface and the classes that implement your strategy We will have interface that we will code against and some concrete implementations. Step 1 Prepare the service definitions and tag them We need to add service definitions. Then we need to tag the services and add aliases to be able to choose one. Step 2 Strategy in Symfony What do we have out of the box Prepare the compiler pass Add meaning to the tags we just created on the services. Step 4 Build a class that will help us selecting the implementation This class will help in choosing the implementation by alias Step 3 What is wrong in this picture?
- 21. 2 1 Strategy using Grapes Bundle
- 22. 2 2 Strategy using Grapes Bundle What is provided by Grapes Bundle? Everything that is just additional work to use Strategy Pattern gets automated. Developer no longer needs to focus on the mechanics of how it’s implemented. Helps removing all the repetitive code In simplest case, after preparing the implementations of the algorithms its all down to appropriate service definitions. Defining new Strategy boils down to adding configuration Like defaults or grouped service provider. Provides some additional functionality
- 23. 2 3 Strategy using Grapes Bundle What is provided by Grapes Bundle?
- 24. 2 4 Prepare interface and the classes that implement your strategy We will have interface that we will code against and some concrete implementations. Step 1 http://apigen.juzna.cz/doc/swiftmailer/swiftmailer Strategy using Grapes Bundle Comparison with original implementation No changes on this step
- 25. 2 5 Prepare the service definitions and tag them We need to add service definitions. Then we need to tag the services and add aliases to be able to choose one. Step 2 Strategy using Grapes Bundle No changes on this step Comparison with original implementation
- 26. 2 6 Strategy using Grapes Bundle Build a class that will help us selecting the implementation This class will help in choosing the implementation by alias Step 3 Comparison with original implementation
- 27. 2 7 Strategy using Grapes Bundle In Grapes there is ServiceProvider class implemented and appropriate abstract service definition exists. Lets create new strategy and register another Grapes Service Provider for it. Lets find all services tagged with this tag name and register those services as implementations of strategy algorithm in this Grapes Service Provider. Add service definition that will help us selecting the implementation Service transport.strategy will help in choosing the implementation from services tagged by app.mail_transport Step 3 Comparison with original implementation
- 28. 2 8 Prepare the compiler pass Add meaning to the tags we just created on the services. Step 4 Step not needed Done automatically by GrapesBundle Strategy using Grapes Bundle Comparison with original implementation
- 29. 2 9 Register the compiler pass Inform Symfony about new compiler pass. Step 5 Step not needed Done automatically by GrapesBundle Strategy using Grapes Bundle Comparison with original implementation
- 30. 3 0 Strategy using Grapes Bundle Comparison with original implementation Use the Service Provider object to select the transport algorithm on runtime.
- 31. 3 1 Strategy using Grapes Bundle Comparison with original implementation
- 32. 3 2 Service implementing concrete implementation is instantiated upon first request Instantiating concreate implementation Strategy using Grapes Bundle Final note
- 33. 3 3 There is more… Grapes Bundle extras
- 34. 3 4 Default service Grapes Bundle extras
- 35. 3 5 Grapes Bundle extras Default service returned by Service Provider Case A Case B Case C Case D Case E Case F Implementation A Implementation B Implementation B Implementation C Implementation B Implementation B
- 36. 3 6 Grapes Bundle extras Default service returned by Service Provider Case A Case B Case C Case D Case E Case F Implementation A Implementation B Implementation B Implementation C Implementation B Implementation B Case G Implementation B
- 37. 3 7 Grapes Bundle extras Default service returned by Service Provider Case A Case B Case C Case D Case E Case F Implementation A Implementation B Implementation B Implementation C Implementation B Implementation B Case G Implementation B
- 38. 3 8 Configurable alias attribute Grapes Bundle extras
- 39. 3 9 Grapes Bundle extras Replacing alias with custom tag attribute
- 40. 4 0 Grouped Service Provider Grapes Bundle extras
- 41. 4 1 Grapes Bundle extras Grouped Service Provider
- 42. 4 2 Case A Case B Case C Grapes Bundle extras Grouped Service Provider Implementation A Implementation B Implementation C Implementation D Implementation E no implementations Let’s try with example
- 43. 4 3 Monitor Subsystem C Grapes Bundle extras Monitoring the system using Grouped Service Provider Monitor Subsystem A Monitor Subsystem B Metric A-1 Metric A-2 Metric A-3 Metric B-1 Metric B-2 no implementations Task: periodically monitor status Ok, this last case is not great for this example J
- 44. 4 4 How we use Grapes Bundle in msales Our use cases
- 45. 4 5 Already tested heavily on production system Already used in 2 systems Hours of dev work saved. More than 40 usages Our use cases How does Grapes Bundle help us in our systems As an example of next candidate of code for public release Msales Forms Bundle
- 46. 4 6 Our use cases Select 2 Grouped Service Provider front back search term, content type “Mike”, “person” Service Provider: Custom data repository response in generic json format get implementation: alias = content type alias = “person” Custom data repository for “person” Generic select 2 data action return data repository by content type return “person” repository get list by search term search term= “Mike” return dataset
- 47. 4 7 Our use cases Select 2 Grouped Service Provider front back search term, content type “Mike”, “person” Service Provider: Custom data repository response in generic json format get implementation: alias = content type alias = “person” Custom data repository for “person” Generic select 2 data action return data repository by content type return “person” repository get list by search term search term= “Mike” return dataset generic only this part needs implementing
- 48. 4 8 Questions?
- 49. 4 9 Thanks for your attention! msales Poland Sp. z o.o. Jana III Sobieskiego 2, 40-082 Katowice Poland info.pl@msales.com www.msales.com +48 32 630 40 76
- 50. 5 0 A picture is worth a thousand words Who doesn’t, right? J By the way, we’re hiring!