IceHawk Intro @ PHP Usergroup Berlin

Slide 1

Slide 1 text

APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF

Slide 2

Slide 2 text

HOLGER WOLTERSDORF CIO • FATHER • HUSBAND • PHP DEV WITH ♥ github.com/hollodotme github.com/icehawk @hollodotme @F9T3ch

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

HISTORY

Slide 5

Slide 5 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 5 ๏ THE MVC PATTERN VIEW 1 VIEW 2 CONTROLLER MODEL USER INPUT MODIFIES UPDATES

Slide 6

Slide 6 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 6 ๏ THE MVC PATTERN …THE PROBLEM! VIEW 1 VIEW 2 CONTROLLER MODEL USER INPUT MODIFIES UPDATES !

Slide 7

Slide 7 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 7 ๏ THE MVC PATTERN …THE PROBLEM! VIEW 1 VIEW 2 CONTROLLER MODEL USER INPUT MODIFIES HTTP

Slide 8

Slide 8 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 8 ๏ THE MVC PATTERN …THE SOLUTION? VIEW 1 VIEW 2 CONTROLLER MODEL USER INPUT MODIFIES HTTP RESPONDS

Slide 9

Slide 9 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 9 "THE MVC PATTERN SOLVES A PROBLEM THAT DOESN’T EXIST IN THE WEB."

Slide 10

Slide 10 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 10 "THE MVC PATTERN SOLVES A PROBLEM THAT DOESN’T EXIST IN THE WEB."

Slide 11

Slide 11 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 11 CONTROLLER ๏ THE MVC PATTERN …CONTROLLER RESPONSIBILITIES ๏ VALIDATE USER INPUT ๏ FIND MODEL(S), REPO(S)   HELPER(S) OR SERVICE(S) ๏ ISSUE CHANGES ๏ EVALUATE CHANGE RESULT ๏ FIND MODEL(S), REPO(S)  HELPER(S) OR SERVICE(S) ๏ QUERY AND FETCH DATA ๏ RENDER VIEW (2) ๏ RESPOND TO CLIENT

Slide 12

Slide 12 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 12 CONTROLLER ๏ THE MVC PATTERN …CONTROLLER RESPONSIBILITIES ๏ VALIDATE USER INPUT ๏ FIND MODEL(S), REPO(S)   HELPER(S) OR SERVICE(S) ๏ ISSUE CHANGES ๏ EVALUATE CHANGE RESULT ๏ FIND MODEL(S), REPO(S)  HELPER(S) OR SERVICE(S) ๏ QUERY AND FETCH DATA ๏ RENDER VIEW (2) ๏ RESPOND TO CLIENT WRITE READ

Slide 13

Slide 13 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 13 WRITE CONTROLLER ๏ SEGREGATED RESPONSIBILITIES ๏ VALIDATE USER INPUT ๏ FIND MODEL(S), REPO(S)   HELPER(S) OR SERVICE(S) ๏ ISSUE CHANGES ๏ EVALUATE CHANGE RESULT ๏ FIND MODEL(S), REPO(S)  HELPER(S) OR SERVICE(S) ๏ QUERY AND FETCH DATA ๏ RENDER VIEW (2) ๏ RESPOND TO CLIENT WRITE READ READ CONTROLLER

Slide 14

Slide 14 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 14 WRITE CONTROLLER ๏ RESPONSIBILITY SEGREGATION ๏ VALIDATE USER INPUT ๏ FIND MODEL(S), REPO(S)   HELPER(S) OR SERVICE(S) ๏ ISSUE CHANGES ๏ EVALUATE CHANGE RESULT ๏ FIND MODEL(S), REPO(S)  HELPER(S) OR SERVICE(S) ๏ QUERY AND FETCH DATA ๏ RENDER VIEW (2) ๏ RESPOND TO CLIENT COMMAND QUERY READ CONTROLLER

Slide 15

Slide 15 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 15 WRITE CONTROLLER ๏ RESPONSIBILITY SEGREGATION ๏ VALIDATE USER INPUT ๏ FIND MODEL(S), REPO(S)   HELPER(S) OR SERVICE(S) ๏ ISSUE CHANGES ๏ EVALUATE CHANGE RESULT ๏ FIND MODEL(S), REPO(S)  HELPER(S) OR SERVICE(S) ๏ QUERY AND FETCH DATA ๏ RENDER VIEW (2) ๏ RESPOND TO CLIENT COMMAND QUERY READ CONTROLLER RESPONSIBILITY SEGREGATION (CQRS) TA-DA!

Slide 16

Slide 16 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 16 ๏ THE CQRS PATTERN (respecting HTTP) WRITE REQUESTHANDLER APP STATE USER INPUT MODIFIES QUERIES POST CLIENT / BROWSER REDIRECT TO PAGE 2 GET READ REQUESTHANDLER PAGE 1 PAGE 2 RESPONDS

Slide 17

Slide 17 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF PROJECTOR CHANGE PAGE 2 HISTORY 17 ๏ OPTIMISATION FOR READ INTENSIVE APPLICATIONS WRITE REQUESTHANDLER APP STATE USER INPUT MODIFIES POST CLIENT / BROWSER REDIRECT TO PAGE 2 GET PAGE 1 PAGE 2 CHANGE MESSAGE (ASYNC) PROJECTOR PREPARES PUB SUB QUERIES

Slide 18

Slide 18 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 18 […] the convention has been established that the GET and HEAD methods SHOULD NOT have the significance of taking an action other than retrieval. These methods ought to be considered "safe". https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html

Slide 19

Slide 19 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 19 ๏ RULES SUMMARISED (FOR WEBSITES) ๏ A POST request MUST NOT not respond with UI content ๏ A POST request SHOULD change the application state ๏ A POST request SHOULD respond with a redirect ๏ A GET request SHOULD respond with UI content   representing the current application state ๏ A GET request MUST NOT change the application state (read-only)

Slide 20

Slide 20 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF 20 «We need a name!» «Yeah, something cool and fast!» HISTORY

Slide 21

Slide 21 text

ICEHAWK

Slide 22

Slide 22 text

FACTS

Slide 23

Slide 23 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FACTS 23 ๏ COMPONENTS STABLE v2.1.1 STABLE v1.1.1 STABLE v1.0.0 STABLE v1.0.1 ICEHAWK SESSION FORMS PUBSUB COVERAGE 100% COVERAGE 100% COVERAGE 100% COVERAGE 100%

Slide 24

Slide 24 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FACTS 24 ๏ MAIN COMPONENT: icehawk/icehawk 1.533 Logical lines of code (LLOC) 0 composer dependencies 0 third-party php extension dependencies v2.1.1 current stable v7.x.x php compatibility (only) STRICT typed MIT license FULLY documented at icehawk.github.io LOC Lines of code 1965 Logical lines of code 1533 Comment lines of code 433 Average volume 71.86 Average comment weight 21.28 Average intelligent content 21.28 Logical lines of code by class 29 Logical lines of code by method 5 Object oriented programming Classes 52 Interface 33 Methods 279 Methods by class 5.37 Lack of cohesion of methods 0.62 Average afferent coupling 0.66 Average efferent coupling 1.15 Average instability 0.61 Complexity Average Cyclomatic complexity by class 1.65 Average Relative system complexity 17.92 Average Difficulty 2.6

Slide 25

Slide 25 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FACTS 25 ๏ OBJECTIVES ๏ Producing comprehensible and readable code ๏ Avoiding inline comments where possible (includes PHPDoc) ๏ Applying the SOLID and CLEAN CODE principles ๏ Covering all code with tests ๏ Refactoring continuously ๏ Targeting the latest PHP version ๏ Doing open source ๏ APPLICABLE FOR ๏ WEBSITES ๏ (RESTful) APIs ๏ MICRO SERVICES ๏ EVENT SOURCING

Slide 26

Slide 26 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FACTS 26 NAMING CONVENTION interface BypassesRequest {} class RequestBypass {} trait DefaultRequestBypassing {}

Slide 27

Slide 27 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FACTS 27 POST PUT PATCH DELETE GET HEAD OPTIONS WRITE REQUEST HANDLER READ REQUEST HANDLER AUTO-RESPONSE BASIC ROUTING BEHAVIOUR

Slide 28

Slide 28 text

FEATURES & CODE (SELECTION)

Slide 29

Slide 29 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 29 INSTALLATION

Slide 30

Slide 30 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 30

Slide 31

Slide 31 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 31 class IceHawk { public function __construct( $config, $delegate ) public function init() {} public function handleRequest() {} }

Slide 32

Slide 32 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 32 init(); $application->handleRequest();

Slide 33

Slide 33 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 33 DELEGATION

Slide 34

Slide 34 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - DELEGATION 34 final class IceHawkDelegate implements SetsUpEnvironment { public function setUpGlobalVars() { # Change your global vars $_SERVER, $_GET, $_POST, etc. # here, before IceHawk will use them. } public function setUpErrorHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default error handling is used unless you set up # something else here. } public function setUpSessionHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default session handling is used unless you set up # something else here. } }

Slide 35

Slide 35 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - DELEGATION 35 final class IceHawkDelegate implements SetsUpEnvironment { public function setUpGlobalVars() { # Change your global vars $_SERVER, $_GET, $_POST, etc. # here, before IceHawk will use them. } public function setUpErrorHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default error handling is used unless you set up # something else here. } public function setUpSessionHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default session handling is used unless you set up # something else here. } }

Slide 36

Slide 36 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - DELEGATION 36 final class IceHawkDelegate implements SetsUpEnvironment { public function setUpGlobalVars() { # Change your global vars $_SERVER, $_GET, $_POST, etc. # here, before IceHawk will use them. } public function setUpErrorHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default error handling is used unless you set up # something else here. } public function setUpSessionHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default session handling is used unless you set up # something else here. } }

Slide 37

Slide 37 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 37 CONFIGURATION

Slide 38

Slide 38 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 38 final class IceHawkConfig implements ConfiguresIceHawk { use Defaults\Traits\DefaultRequestInfoProviding; use Defaults\Traits\DefaultReadRouting; use Defaults\Traits\DefaultWriteRouting; use Defaults\Traits\DefaultRequestBypassing; use Defaults\Traits\DefaultEventSubscribing; use Defaults\Traits\DefaultCookieProviding; use Defaults\Traits\DefaultFinalReadResponding; use Defaults\Traits\DefaultFinalWriteResponding; }

Slide 39

Slide 39 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 39 final class IceHawkConfig implements ConfiguresIceHawk { use Defaults\Traits\DefaultRequestInfoProviding; use Defaults\Traits\DefaultReadRouting; use Defaults\Traits\DefaultWriteRouting; use Defaults\Traits\DefaultRequestBypassing; use Defaults\Traits\DefaultEventSubscribing; use Defaults\Traits\DefaultCookieProviding; use Defaults\Traits\DefaultFinalReadResponding; use Defaults\Traits\DefaultFinalWriteResponding; }

Slide 40

Slide 40 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 40 final class MyHawkConfig extends IceHawkConfig { public function getReadRoutes() { return [ new ReadRoute( new Literal( '/' ), new SayHelloRequestHandler() ), ]; } public function getWriteRoutes() { return [ new WriteRoute( new Literal( '/do-something' ), new DoSomethingRequestHandler() ), ]; } }

Slide 41

Slide 41 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 41 # Literal route new ReadRoute( new Literal( '/' ), new SayHelloRequestHandler() ); # RegExp route with parameters from matches new ReadRoute( new RegExp("#^/post/([0-9]+)/?$#i", ['postId'] ), new ShowBlogPostRequestHandler() ); # NamedRegExp route with named matches new ReadRoute( new NamedRegExp("^/post/(?[0-9]+)/?$", 'i'), new ShowBlogPostRequestHandler() );

Slide 42

Slide 42 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 42 # Literal route new ReadRoute( new Literal( '/' ), new SayHelloRequestHandler() ); # RegExp route with parameters from matches new ReadRoute( new RegExp("#^/post/([0-9]+)/?$#i", ['postId'] ), new ShowBlogPostRequestHandler() ); # NamedRegExp route with named matches new ReadRoute( new NamedRegExp("^/post/(?[0-9]+)/?$", 'i'), new ShowBlogPostRequestHandler() );

Slide 43

Slide 43 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 43 # Literal route new ReadRoute( new Literal( '/' ), new SayHelloRequestHandler() ); # RegExp route with parameters from matches new ReadRoute( new RegExp("#^/post/([0-9]+)/?$#i", ['postId'] ), new ShowBlogPostRequestHandler() ); # NamedRegExp route with named matches new ReadRoute( new NamedRegExp("^/post/(?[0-9]+)/?$", 'i'), new ShowBlogPostRequestHandler() );

Slide 44

Slide 44 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 44 final class MyHawkConfig extends IceHawkConfig { public function getReadRoutes() { $routes = require(__DIR__ . '../config/ReadRoutes.php'); # $routes = [ # "^/post/(?[0-9]+)/?" # => MyVendor\...\ShowPostRequestHandler::class, # ]; foreach ($routes as $pattern => $handlerClass) { yield new ReadRoute( new NamedRegExp($pattern), new $handlerClass() ), } } }

Slide 45

Slide 45 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 45 REQUEST HANDLERS

Slide 46

Slide 46 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - REQUEST HANDLERS 46 final class SayHelloRequestHandler implements HandlesGetRequest { public function handle(ProvidesReadRequestData $request) { $info = $request->getInfo(); $input = $request->getInput(); $cookies = $request->getCookies(); (new Page())->respond('Hello!', HttpCode::OK); } }

Slide 47

Slide 47 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - REQUEST HANDLERS 47 final class DoSomethingRequestHandler implements HandlesPostRequest { public function handle(ProvidesWriteRequestData $request) { $info = $request->getInfo(); $input = $request->getInput(); $cookies = $request->getCookies(); $files = $input->getAllUploadedFiles(); (new Redirect())->respond('/done'); } }

Slide 48

Slide 48 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 48 FINAL RESPONDING

Slide 49

Slide 49 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - FINAL RESPONDING 49 final class IceHawkConfig implements ConfiguresIceHawk { use Defaults\Traits\DefaultRequestInfoProviding; use Defaults\Traits\DefaultReadRouting; use Defaults\Traits\DefaultWriteRouting; use Defaults\Traits\DefaultRequestBypassing; use Defaults\Traits\DefaultEventSubscribing; use Defaults\Traits\DefaultCookieProviding; use Defaults\Traits\DefaultFinalReadResponding; use Defaults\Traits\DefaultFinalWriteResponding; }

Slide 50

Slide 50 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - FINAL RESPONDING 50 final class MyHawkConfig extends IceHawkConfig { public function getFinalReadResponder() : RespondsFinallyToReadRequest { return MyFinalReadResponder(); } }

Slide 51

Slide 51 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - FINAL RESPONDING 51 final class MyFinalReadResponder implements RespondsFinallyToReadRequest { public function handleUncaughtException( \Throwable $throwable, ProvidesReadReqeustData $request ) { try { throw $throwable; } catch (UnresolvedRequest $e) { (new NotFound())->respond(); } catch (\Throwable $e) { (new InternalServerError())->respond(); } } }

Slide 52

Slide 52 text

FULL DOCUMENTATION AT icehawk.github.io

Slide 53

Slide 53 text

QUESTIONS?

Slide 54

Slide 54 text

THANK YOU! github.com/hollodotme @hollodotme / @F9T3ch fortuneglobe.com phpug-dresden.org @phpugdd HOLGER WOLTERSDORF https://hollo.me icehawk.github.io speakerdeck.com/hollodotme Slides available at:

Slide 55

Slide 55 text

ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF LINKS / REFERENCES 55 ๏ MVC-Pattern: http://martinfowler.com/eaaDev/uiArchs.html ๏ CQRS-Pattern: http://martinfowler.com/bliki/CQRS.html ๏ GET/HEAD methods: https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html ๏ SOLID principles https://en.wikipedia.org/wiki/SOLID_(object-oriented_design) ๏ "Clean Code" by Robert C. Martin: http://amzn.to/2dthxQn ๏ "Traitful" Configs: https://hollo.me/php/traitful-configs.html ๏ IceHawk Gitter chat: https://gitter.im/icehawk/Lobby