Mission (Im)possible: Quality Decoupled Code with Drupal 7 (DrupalCamp Scotland)

Slide 1

Slide 1 text

Marek Matulka

Slide 2

Slide 2 text

at @super_marek

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

No content

Slide 7

Slide 7 text

http://photobucket.com/user/marcrobinsone/media/Drupal%20Comics/marcrobinsonegmailcom__drupalNinja.png.html

Slide 8

Slide 8 text

No content

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

In order to create a good software, you have to know what the software is all about. – Eric Evans

Slide 11

Slide 11 text

How do we learn?

Slide 12

Slide 12 text

Stakeholders

Slide 13

Slide 13 text

Ask for examples... ...write stories!

Slide 14

Slide 14 text

Vocabulary

Slide 15

Slide 15 text

Ubiquitous Language Ubiquitous Language

Slide 16

Slide 16 text

Ubiquitous Language Ubiquitous Language Domain Expert Analyst Tester Developer Developer

Slide 17

Slide 17 text

Ubiquitous Language Ubiquitous Language Domain Expert Analyst Tester Developer Developer Application Code Acceptance Criteria Specs and documentation

Slide 18

Slide 18 text

Example?

Slide 19

Slide 19 text

Example Feature: In order to see correct prices As a visitor I need to be able to locate the nearest depot Scenario: Given I am visiting a product page for the first time And I got prompted to locate my nearest depot When I enter my post code Then I should see my local depot information

Slide 20

Slide 20 text

Slide 21

Slide 21 text

Domain namespace Acme\Depot; interface DepotLocator { /** * @param string $postcode * * @return Depot */ public function locateDepot($postcode); }

Slide 22

Slide 22 text

Implementation namespace Acme\MagentoAdapter; use Acme\Depot\DepotLocator; class MagentoDepotLocator implements DepotLocator { public function locateDepot($postcode) { return $this->entityMapper->mapDepot( $this->clientAdapter->findDepotByPostcode($postcode) );

Slide 23

Slide 23 text

why interface?

Slide 24

Slide 24 text

Layered Architecture “High level modules should not depend on lower level implementation” – Robert C. Martin User Interface Application Domain Infrastructure

Slide 25

Slide 25 text

Dependency Inversion Policy Layer Policy Service Mechanism Layer Mechanism Service Utility Layer

Slide 26

Slide 26 text

Layered Architecture User Interface Application Domain Infrastructure

Slide 27

Slide 27 text

Layered Architecture User Interface Application Domain Infrastructure

Slide 28

Slide 28 text

Clean Architecture Entities Use Cases Controllers Web

Slide 29

Slide 29 text

Clean Architecture Entities Use Cases Controllers Web Framework Drivers Interface Adapters Application Business Rules Enterprise Business Rules

Slide 30

Slide 30 text

Hexagonal Architecture UI Adapter Log Adapter Data Storage Adapter External Data Adapter Application Domain

Slide 31

Slide 31 text

Hexagonal Architecture Acme\Depot\DepotLocator Acme\MagentoAdapter\MagentoDepotLocator

Slide 32

Slide 32 text

Hexagonal Architecture Acme\Depot\DepotLocator Acme\MagentoAdapter\MagentoDepotLocator port adapter

Slide 33

Slide 33 text

Why clean architecture?

Slide 34

Slide 34 text

Why clean architecture? - your code is clean(er) - decoupled from framework - reusable - easy to test - easy to maintain - easy to change

Slide 35

Slide 35 text

No content

Slide 36

Slide 36 text

No content

Slide 37

Slide 37 text

symfony/dependency-injection symfony/config dependency injection

Slide 38

Slide 38 text

Dependency Injection - a standardised and centralised way of constructing objects in our application

Slide 39

Slide 39 text

Kernel public function boot() { $this->container = new ContainerBuilder(); $this->container->compile(); }

Slide 40

Slide 40 text

Slide 41

Slide 41 text

Kernel public function boot() { $this->container = new ContainerBuilder(); $loader = new YamlFileLoader($this->container, new FileLocator('app/config')); $loader->load('parameters.yml'); $loader = new XmlFileLoader($this->container, new FileLocator('app/config')); $loader->load('services.xml'); $this->container->compile(); }

Slide 42

Slide 42 text

Slide 43

Slide 43 text

Kernel public function boot() { $this->container = $this->buildContainer(); } /** * @return ContainerBuilder */ private function buildContainer() { $container = new ContainerBuilder(); $loader = new YamlFileLoader($container, new FileLocator('app/config')); $loader->load('parameters.yml'); $loader = new XmlFileLoader($container, new FileLocator('app/config')); $loader->load('services.xml'); $container->registerExtension(new ApplicationExtension()); $container->compile(); return $container; }

Slide 44

Slide 44 text

Kernel public function boot() { if (file_exists($this->cachedContainerFileName)) { require $this->cachedContainerFileName; $this->container = new ProjectServiceContainer(); } else { $container = $this->buildContainer(); $dumper = new PhpDumper($container); file_put_contents($this->cachedContainerFileName, $dumper->dump()); $this->container = $container; } }

Slide 45

Slide 45 text

Kernel public function boot() { if (file_exists($this->cachedContainerFileName)) { require $this->cachedContainerFileName; $this->container = new ProjectServiceContainer(); } else { $container = $this->buildContainer(); if ('dev' !== $container->getParameter('environment')) { $dumper = new PhpDumper($container); file_put_contents($this->cachedContainerFileName, $dumper->dump()); } $this->container = $container; } }

Slide 46

Slide 46 text

parameters.yml application: database: name: acme-dev username: acme-dev password: S0m3R4nD0mP455 host: localhost port: ~ soap_client: wsdl: https://api.store.local/v1/?wsdl http_auth_username: acme-dev http_auth_password: S0m3R4nD0mP455 username: acme-dev-user api_key: R4nD0mAp1K3y product_hydrator: product_url_snippet: http://store.local/product/{sku} product_image_url: http://store.local/media/catalog/product/uploads/

Slide 47

Slide 47 text

services.xml

Slide 48

Slide 48 text

symfony/console console commands

Slide 49

Slide 49 text

Import Handler class ImportAndPersistActionHandler { /** * @param ProductImporter $importer * @param ProductPersister $persister */ public function __construct(ProductImporter $importer, ProductPersister $persister) { $this->importer = $importer; $this->persister = $persister; } public function importAndPersistProducts() { $productsList = $this->importer->importProducts(); $this->persister->saveAll($productsList); } }

Slide 50

Slide 50 text

Console command class ImportAndPersistCommand extends Command { public function __construct(ImportAndPersistActionHandler $action) { $this->action = $action; parent::__construct(); } protected function configure() { $this->setName('products:import'); } protected function execute(InputInterface $input, OutputInterface $output) { $startTime = microtime(true); $this->action->importAndPersistProducts(); $output->writeln( sprintf("Products import completed in %1.02fs.", microtime(true) - $startTime) ); } }

Slide 51

Slide 51 text

app/console #!/usr/bin/php boot(); $application = new Application(); $application->addCommands([ $kernel->getContainer()->get('acme.command.import_products'), $kernel->getContainer()->get('acme.command.delete_products'), $kernel->getContainer()->get('acme.command.depot_locate'), ]); $application->run();

Slide 52

Slide 52 text

symfony/filesystem persisting products

Slide 53

Slide 53 text

XML Writer class ProductXmlWriter implements ProductPersister { /** * @param Filesystem $filesystem * @param string $fileName */ public function __construct(Filesystem $filesystem, string $fileName) { $this->filesystem = $filesystem; $this->fileName = $fileName; } /** * @param ProductList $productList */ public function saveAll(ProductList $productList) { $this->filesystem->dumpFile($this->fileName, $this->renderXml($productList)); } }

Slide 54

Slide 54 text

Why write XML? - fetching data from Magento and dumping it into xml file is quick - xml can be imported by Drupal’s feed importer

Slide 55

Slide 55 text

Why it didn’t work? - Feed importer was damn slow - 10k products imported in 4.5h - Scheduling import with Elysia Cron module was flaky - Scheduled feed importer would add products all over again - resources hungry!

Slide 56

Slide 56 text

Direct save to the db class DatabaseProductPersister implements ProductPersister { private $repository; /** * @param ProductRepository $repository */ public function __construct(ProductRepository $repository) { $this->repository = $repository; } public function saveAll(ProductList $productList) { foreach ($productList as $product) { $this->repository->save($product); } } }

Slide 57

Slide 57 text

Why direct save to the db? - Drupal promises data structure won’t ever change - It’s fast - 40k products in 2 minutes - It works!

Slide 58

Slide 58 text

composer.json "require": { "php": ">=5.4.0", "symfony/console": "~2.5", "drush/drush": "7.*@dev", "symfony/finder": "~2.5", "symfony/dependency-injection": "~2.5", "symfony/config": "~2.5", "symfony/filesystem": "~2.6", "doctrine/dbal": "~2.5", "rhumsaa/uuid": "~2.8" },

Slide 59

Slide 59 text

container.php boot(); variable_set('di_container', = $kernel->getContainer());

Slide 60

Slide 60 text

database.php $databases = [ 'default' => [ 'default' => [ 'database' => $conf['di_container']->getParameter('database.name'), 'username' => $conf['di_container']->getParameter('database.username'), 'password' => $conf['di_container']->getParameter('database.password'), 'host' => $conf['di_container']->getParameter('database.host'), 'port' => $conf['di_container']->getParameter('database.port'), 'driver' => 'mysql', 'prefix' => '', ], ], ];

Slide 61

Slide 61 text

settings.php

Slide 62

Slide 62 text

depot_locator.module function get_depot_json($postcode) { global $conf; $depotEntity = variable_get('di_container') ->get('acme.depot_locator')->locateDepot($postcode); $depot = $depotEntity->toArray(); set_depot_cookies($depot); return ['depot' => $depot]; }