Headless Magento - Meet Magento Poland 2017
3 likes879 views
The document discusses headless architecture and implementing it for Magento. It describes taking business logic and data out of Magento and exposing it via APIs that can then be consumed by various clients like Magento and other systems. This allows isolating domains and insulating systems from future changes. It recommends using lightweight PHP frameworks and standard libraries to build the APIs and services, and addresses issues like data storage, caching, and output formatting.
![#MM17PL
Build on standardised libraries
β There is a solution for everything
already out there
β Use popular libraries, preferably
adhering to a PSR protocol
β Don't overcomplicate dependency
injection
β Think carefully about what you need
and spend time finding the best
option
[...]
"require": {
"php": ">=7.0",
"slim/slim": "^3.1",
"monolog/monolog": "^1.17",
"cache/filesystem-adapter": "^0.4.0",
"guzzlehttp/guzzle": "^6.2",
"cache/array-adapter": "^0.5.0",
"illuminate/database": "^5.4",
"yadakhov/insert-on-duplicate-key": "^1.1",
"symfony/console": "^3.3",
"league/oauth1-client": "^1.7"
}
[...]](https://image.slidesharecdn.com/headless-magento-mmpl-170919132924/85/Headless-Magento-Meet-Magento-Poland-2017-18-320.jpg)
![#MM17PL
Build on standardised libraries
β slimphp - Routing, DI
β monolog - gives insight in what the service does
for monitoring and debugging
β cache/β¦ - stores certain API calls, temporary data
β guzzle - offers a way to consume APIs over http
β illuminate/database - Laravel ORM (personal
preference)
β Insert-on-duplicate.... - not a default option in
illuminate/database but a must for me
β symfony/console - for cronjobs and commandline
tasks
β league/oauth1-client - offers built in Magento 1
REST integration
[...]
"require": {
"php": ">=7.0",
"slim/slim": "^3.1",
"monolog/monolog": "^1.17",
"cache/filesystem-adapter": "^0.4.0",
"guzzlehttp/guzzle": "^6.2",
"cache/array-adapter": "^0.5.0",
"illuminate/database": "^5.4",
"yadakhov/insert-on-duplicate-key": "^1.1",
"symfony/console": "^3.3",
"league/oauth1-client": "^1.7"
}
[...]](https://image.slidesharecdn.com/headless-magento-mmpl-170919132924/85/Headless-Magento-Meet-Magento-Poland-2017-19-320.jpg)
![#MM17PL
Enabling various integrations
protected function _prepareCollection()
{
[...]
try {
$client = new Client();
$res = $client->request('GET', $helper->getBaseUrl(0) . 'quarantine?'.
http_build_query([ 'limit' => $limit, 'page' => $page, 'sort' => $columnId, 'sortdir'
=> $dir, 'filters' => (array)$filter, '', '&'));
} catch (Exception $error) {
Mage::logException($error);
$this->setCollection($collection); // set a dummy empty collection
return $this;
}
$data = json_decode($res->getBody(), true);
$lastPage = $data['to'];
array_walk($data['data'], function($order) use (&$collection) {
$collection->addItem(
new Varien_Object(
[ 'shipping_date' => $order['shipping_date'],
'order_reference' => $order['order_reference'],
'customer_reference' => $order['customer_reference'],
'updated_at' => $order['updated_at'],
'shipping_fullname' => "{$order['shipping_firstname']}
{$order['shipping_middlename']} {$order['shipping_lastname']}",
]
)
);
});
$collection->setCurPage($page);
$collection->setLastPageNumber($lastPage);
$collection->setSize($lastPage * $limit);
$this->setCollection($collection);
β Magento 1 grids
β Ajax calls for smaller values
β Data imports
β Communication between services
β ...](https://image.slidesharecdn.com/headless-magento-mmpl-170919132924/85/Headless-Magento-Meet-Magento-Poland-2017-25-320.jpg)
Headless Magento - Meet Magento Poland 2017
- 2. #MM17PL β’ Magento developer β’ Lead @ FitForMe β’ Co-organiser MMNL, Unconf, MageStackDay, Meetups β’ Avid community member twitter.com/sandermangel linkedin.com/in/sandermangel github.com/sandermangel
- 3. #MM17PL
- 4. #MM17PL What is headless architecture "Headless architecture means an application offering APIs that abstract away business logic for a multitude of clients to consistently and repeatedly execute the same tasks."
- 6. #MM17PL Putting it into practice
- 7. #MM17PL
- 8. #MM17PL
- 9. #MM17PL ?
- 10. #MM17PL Common integrations β ERP β Fulfillment β Logs β Email server β β¦.
- 11. #MM17PL Clients β Magento backend β Magento frontend β Legacy system β Dashboards β Magento 2?
- 12. #MM17PL So we take a different approach β’ Magento will be a client & provide data β’ Implement a basic data warehouse β’ Which is fed by, and queried by various services separated by domains β’ Isolate data & business logic per domain That allows for a smooth integration
- 13. #MM17PL
- 14. #MM17PL Leverage middleware for a stable environment storage source consumer server
- 15. #MM17PL Leverage middleware for a stable environment storage source consumer server β Normalize & combine data β Offer stable APIs for clients β Insulate from future changes
- 16. #MM17PL
- 18. #MM17PL Build on standardised libraries β There is a solution for everything already out there β Use popular libraries, preferably adhering to a PSR protocol β Don't overcomplicate dependency injection β Think carefully about what you need and spend time finding the best option [...] "require": { "php": ">=7.0", "slim/slim": "^3.1", "monolog/monolog": "^1.17", "cache/filesystem-adapter": "^0.4.0", "guzzlehttp/guzzle": "^6.2", "cache/array-adapter": "^0.5.0", "illuminate/database": "^5.4", "yadakhov/insert-on-duplicate-key": "^1.1", "symfony/console": "^3.3", "league/oauth1-client": "^1.7" } [...]
- 19. #MM17PL Build on standardised libraries β slimphp - Routing, DI β monolog - gives insight in what the service does for monitoring and debugging β cache/β¦ - stores certain API calls, temporary data β guzzle - offers a way to consume APIs over http β illuminate/database - Laravel ORM (personal preference) β Insert-on-duplicate.... - not a default option in illuminate/database but a must for me β symfony/console - for cronjobs and commandline tasks β league/oauth1-client - offers built in Magento 1 REST integration [...] "require": { "php": ">=7.0", "slim/slim": "^3.1", "monolog/monolog": "^1.17", "cache/filesystem-adapter": "^0.4.0", "guzzlehttp/guzzle": "^6.2", "cache/array-adapter": "^0.5.0", "illuminate/database": "^5.4", "yadakhov/insert-on-duplicate-key": "^1.1", "symfony/console": "^3.3", "league/oauth1-client": "^1.7" } [...]
- 20. #MM17PL Build on standardised libraries β SlimPHP project as basis β One module in src some basic setup files needed by SlimPHP β Keep it simple and self-contained
- 21. #MM17PL Some learnings β Single purpose β It should feel overly simple β Within the service, separate tasks β Document, document, document β Write integration tests for the API endpoints β Log everything
- 23. #MM17PL Exposing data β Read only β Easy to integrate β Offer sorting, filtering, and a host of other query options β Be very fast (d'oh) β Standardized & easily scalable
- 24. #MM17PL Standardizing? β Output format and syntax β Filtering and sorting β Caching
- 25. #MM17PL Enabling various integrations protected function _prepareCollection() { [...] try { $client = new Client(); $res = $client->request('GET', $helper->getBaseUrl(0) . 'quarantine?'. http_build_query([ 'limit' => $limit, 'page' => $page, 'sort' => $columnId, 'sortdir' => $dir, 'filters' => (array)$filter, '', '&')); } catch (Exception $error) { Mage::logException($error); $this->setCollection($collection); // set a dummy empty collection return $this; } $data = json_decode($res->getBody(), true); $lastPage = $data['to']; array_walk($data['data'], function($order) use (&$collection) { $collection->addItem( new Varien_Object( [ 'shipping_date' => $order['shipping_date'], 'order_reference' => $order['order_reference'], 'customer_reference' => $order['customer_reference'], 'updated_at' => $order['updated_at'], 'shipping_fullname' => "{$order['shipping_firstname']} {$order['shipping_middlename']} {$order['shipping_lastname']}", ] ) ); }); $collection->setCurPage($page); $collection->setLastPageNumber($lastPage); $collection->setSize($lastPage * $limit); $this->setCollection($collection); β Magento 1 grids β Ajax calls for smaller values β Data imports β Communication between services β ...
- 26. #MM17PL Caching β How dynamic is dynamic content β Cache is all about control β Think of a strategy upfront
- 27. #MM17PL Caching β How dynamic is dynamic content β Cache is all about control β Think of a strategy upfront https://github.com/magespecialist/m2-M SP_APIEnhancer Magento 2 API enhancer
- 28. #MM17PL Wish list & ideas
- 29. #MM17PL Database β MariaDB β Relational β Easy to work with β Offers good performance up to 1TB data β Elastic β REST output β Plug and play β Advanced search
- 30. #MM17PL
- 31. #MM17PL Monolithic β Dedicated / VPS server β Offered by all hosting companies β Easy to maintain β Does not scale easily β If one goes down... Distributed β Instances on a cloud β Scales easily β Environments are isolated β Requires more knowledge β Can be harder to administrate
- 32. #MM17PL API gateway β Allow for easy service discovery β Handle authentication, call rate limiting β Routing - http://microservices.io/patterns/apigateway.html - https://www.nginx.com/blog/building-microservic es-using-an-api-gateway/
- 33. #MM17PL API gateway β Allow for easy service discovery β Handle authentication, call rate limiting β Routing - http://microservices.io/patterns/apigateway.html - https://www.nginx.com/blog/building-microservic es-using-an-api-gateway/
- 34. #MM17PL Output format There are great solution for better documenting, discovery and output formatting. However, standardising output across a large set of APIs has it's pitfalls as no implementation is ever perfect
- 35. #MM17PL Summary β By offloading tasks from Magento we keep it fast and lightweight β Storing data in a central place and making it available via REST apis makes for easy integration β Headless can start by adding some of those APIs to the existing back- or frontend β Using lightweight php frameworks with limited features makes for easy to develop and fast applications
- 36. Code: https://github.com/sandermangel/headless-middleware twitter.com/sandermangel github.com/sandermangel Integrating a ReactJS frontend in Magento 2 - Riccardo Tempesta https://www.youtube.com/watch?v=ElZ5UtTXpzQ