Hello, PSR-7. (PHPUGFFM)

Slide 1

Slide 1 text

Hello, PSR-7. Beau Simensen @beausimensen • @moniidev • @thatpodcast

Slide 2

Slide 2 text

PSR-7 HTTP Message Interface

Slide 3

Slide 3 text

The Problem Server-Side Edition

Slide 4

Slide 4 text

My background (It is relevant, I promise!)

Slide 5

Slide 5 text

PHP ~2005

Slide 6

Slide 6 text

Spring Framework ~2008

Slide 7

Slide 7 text

class halo_HttpRequest { public function __construct( $method, array $queryParams = null, array $postParams = null, array $fileData = null, array $env = null, $body = null ) { // ... } }

Slide 8

Slide 8 text

class halo_DispatcherUtil { public static function MAKE_HTTP_REQUEST() { return new halo_HttpRequest( $_SERVER['REQUEST_METHOD'], $_GET, $_POST, $_FILES, $_SERVER ); } }

Slide 9

Slide 9 text

namespace Symfony\Component\HttpFoundation; class Request { public function __construct( array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), $content = null ) { // ... } }

Slide 10

Slide 10 text

namespace Symfony\Component\HttpFoundation; class Request { public static function createFromGlobals() { return self::createRequestFromFactory( $_GET, $_POST, array(), $_COOKIE, $_FILES, $server ); } }

Slide 11

Slide 11 text

namespace Zend\Http\PhpEnvironment; class Request extends \Zend\Http\Request { public function __construct() { $this->setEnv(new Parameters($_ENV)); if ($_GET) { $this->setQuery(new Parameters($_GET)); } if ($_POST) { $this->setPost(new Parameters($_POST)); } if ($_COOKIE) { $this->setCookies(new Parameters($_COOKIE)); } if ($_FILES) { $files = $this->mapPhpFiles(); $this->setFiles(new Parameters($files)); } $this->setServer(new Parameters($_SERVER)); } }

Slide 12

Slide 12 text

namespace Aura\Web; class WebFactory { public function newRequest() { return new Request( $this->newRequestClient(), $this->newRequestContent(), $this->newRequestGlobals(), $this->newRequestHeaders(), $this->newRequestMethod(), $this->newRequestParams(), $this->newRequestUrl() ); } public function newRequestGlobals() { return new Request\Globals( $this->newRequestCookies(), $this->newRequestEnv(), $this->newRequestFiles(), $this->newRequestPost(), $this->newRequestQuery(), $this->newRequestServer() ); } }

Slide 13

Slide 13 text

All define similar Responses

Slide 14

Slide 14 text

Abstractions over SAPI

Slide 15

Slide 15 text

Impact on Ecosystem

Slide 16

Slide 16 text

Symfony 2 HttpFoundation + HttpKernel

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

What if we could share code between these applications and frameworks at the HTTP level? — Igor, Beau, and Christoph

Slide 19

Slide 19 text

Stack PHP Conventions for writing framework agnostic* middleware stackphp.com

Slide 20

Slide 20 text

Framework agnostic my foot. — Imagined People

Slide 21

Slide 21 text

No content

Slide 22

Slide 22 text

Slowly and quietly adopted by parts of the Symfony ecosystem

Slide 23

Slide 23 text

The Problem Client-Side Edition

Slide 24

Slide 24 text

Guzzle, Buzz, Requests

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

The Problem for both server-side and client-side: HTTP Messages abstraction should be a commodity Header: value Another-Header: value Message body

Slide 27

Slide 27 text

History of PSR-7

Slide 28

Slide 28 text

PHP-FIG PHP Framework Interoperability Group

Slide 29

Slide 29 text

March 24th, 2012 HTTP Client interface Benjamin Eberlei

Slide 30

Slide 30 text

$client = create_http_client(); // implementation specific $response = $client->request('GET', 'http://www.php.net'); if ($response->getStatusCode() == 200) { $content = $response->getContent(); } $response = $client->request('GET', 'http://api/returning.json'); if ($response->getContentType() == 'application/json') { $json = json_decode($response->getContent()); }

Slide 31

Slide 31 text

December 31st, 2012 HTTP Message Chris Wilkinson

Slide 32

Slide 32 text

There was a proposal to create a HTTP client interface earlier this year. As was noted at the time, the core HTTP message representation part (ie the request/response objects) is probably of more importance: it's used by both HTTP clients and frameworks. — Chris Wilkinson

Slide 33

Slide 33 text

interface MessageInterface { public function __toString(); public function getStartLine(); public function getProtocolVersion(); public function setProtocolVersion($protocolVersion); public function getHeader($header); public function getHeaders(); public function hasHeader($header); public function setHeader($header, $value); public function setHeaders(array $headers); public function addHeaders(array $headers); public function getBody(); public function setBody($body); }

Slide 34

Slide 34 text

interface RequestInterface extends MessageInterface { public function __construct( $method, $url, $protocolVersion = '1.1' ); public function getResponse(); public function setResponse(ResponseInterface $response); public function getMethod(); public function setMethod($method); public function getUrl(); public function setUrl($url); }

Slide 35

Slide 35 text

interface ResponseInterface extends MessageInterface { public function __construct( $statusCode, $reasonPhrase = null, $protocolVersion = '1.1' ); public function getRequest(); public function setRequest(RequestInterface $request); public function getStatusCode(); public function setStatusCode($statusCode); public function getReasonPhrase(); public function setReasonPhrase($reasonPhrase); }

Slide 36

Slide 36 text

January 28th, 2014 PSR-7 HTTP Message - DRAFT Michael Dowling

Slide 37

Slide 37 text

August 29th, 2014 PSR-7 HTTP Message - Retracted Michael Dowling

Slide 38

Slide 38 text

Matthew Weier O'Phinney

Slide 39

Slide 39 text

phly/http http://github.com/phly/http (similar to node's http.Server)

Slide 40

Slide 40 text

phly/conduit http://github.com/phly/conduit (a port of Sencha Connect)

Slide 41

Slide 41 text

September 26th, 2014 PSR-7 HTTP Message Interfaces Matthew Weier O'Phinney

Slide 42

Slide 42 text

accepted May 18th, 2015

Slide 43

Slide 43 text

No content

Slide 44

Slide 44 text

No content

Slide 45

Slide 45 text

Concepts & Interfaces

Slide 46

Slide 46 text

No content

Slide 47

Slide 47 text

Immutability Messages and URIs are modeled as value objects

Slide 48

Slide 48 text

class Request implements RequestInterface { public function withMethod($method) { $new = clone $this; $new->method = $method; return $new; } }

Slide 49

Slide 49 text

use Zend\Diactoros\Request; use Zend\Diactoros\Uri; $request = (new Request()) ->withUri(new Uri('http://example.com')) ->withMethod('GET');

Slide 50

Slide 50 text

use Zend\Diactoros\Request; use Zend\Diactoros\Uri; $request = (new Request()) ->withUri(new Uri('http://example.com')) ->withMethod('GET'); // this does nothing to $request. $request->withAddedHeader( 'Content-Type', 'application/json' );

Slide 51

Slide 51 text

use Zend\Diactoros\Request; use Zend\Diactoros\Uri; $request = (new Request()) ->withUri(new Uri('http://example.com')) ->withMethod('GET'); // this is probably what you want. $request = $request->withAddedHeader( 'Content-Type', 'application/json' );

Slide 52

Slide 52 text

Messages

Slide 53

Slide 53 text

Header: value Another-Header: value Message body

Slide 54

Slide 54 text

Headers

Slide 55

Slide 55 text

$message = $message ->withHeader('foo', 'bar') ->withAddedHeader('foo', 'baz'); if ($message->hasHeader('Accept')) { /* ... */ } // 'bar, baz' $header = $message->getHeaderLine('foo'); // ['bar', 'baz'] $header = $message->getHeader('foo'); // [ 'foo' => ['bar', 'baz'] ] foreach ($message->getHeaders() as $header => $values) { }

Slide 56

Slide 56 text

Host header Calling $request->withUri() updates Host header Unless you pass true to $preserveHost

Slide 57

Slide 57 text

Streams Message Bodies

Slide 58

Slide 58 text

Allows implementations to work with large message bodies

Slide 59

Slide 59 text

Strings? php://memory or php://temp $message = $message->withBody(new Stream('php://temp')); $message->getBody()->write('This is my content!');

Slide 60

Slide 60 text

Immutability cannot be enforced! Use read-only streams for server-side requests and client-side responses

Slide 61

Slide 61 text

Requests

Slide 62

Slide 62 text

URI // https://api.example.com $uri = $uri->withScheme('https')->withHost('api.example.com'); $usersUri = $uri->withPath('/v2/users'); $booksUri = $uri->withPath('/v2/books'); // https://api.example.com/v2/users?limit=10 $getUsersRequest = (new Request()) ->withMethod('GET') ->withUri($usersUri->withQuery('?limit=10')); // https://api.example.com/v2/users $postUsersRequest = (new Request()) ->withMethod('POST') ->withUri($usersUri); // https://api.example.com/v2/books $getBooksRequest = (new Request()) ->withMethod('GET') ->withUri($booksUri);

Slide 63

Slide 63 text

Server Requests

Slide 64

Slide 64 text

CGI + SAPI $_COOKIE • $_GET • $_POST • $_FILES • $_SERVER

Slide 65

Slide 65 text

Attributes

Slide 66

Slide 66 text

$country = $this->resolveCountryForRequest($request); if ($country) { $request = $request->withAttribute( 'geocode.country', $country ); } // ... $country = $request->getAttribute('geocode.country'); if ($country) { // }

Slide 67

Slide 67 text

Uploaded Files

Slide 68

Slide 68 text

Given file input names files[0] and files[1] What you might expect: [ 'files' => [ 0 => [ 'name' => 'file0.txt', 'type' => 'text/plain', /* etc. */ ], 1 => [ 'name' => 'file1.html', 'type' => 'text/html', /* etc. */ ], ], ];

Slide 69

Slide 69 text

Given file input names files[0] and files[1] What you actually get: [ 'files' => [ 'name' => [ 0 => 'file0.txt', 1 => 'file1.html', ], 'type' => [ 0 => 'text/plain', 1 => 'text/html', ], /* etc. */ ], ]

Slide 70

Slide 70 text

PSR-7 enforces a normalized $_FILES

Slide 71

Slide 71 text

$file0 = $request->getUploadedFiles()['files'][0]; $file1 = $request->getUploadedFiles()['files'][1]; printf( "Received the files %s and %s", $file0->getClientFilename(), $file1->getClientFilename() ); // "Received the files file0.txt and file1.html"

Slide 72

Slide 72 text

Underlying "filename" is protected // Move a file to an upload directory $filename = sprintf( '%s.%s', create_uuid(), pathinfo($file0->getClientFilename(), PATHINFO_EXTENSION) ); $file0->moveTo(DATA_DIR . '/' . $filename); // Stream a file to Amazon S3. // Assume $s3wrapper is a PHP stream that will write to S3, and that // Psr7StreamWrapper is a class that will decorate a StreamInterface as a PHP // StreamWrapper. $stream = new Psr7StreamWrapper($file1->getStream()); stream_copy_to_stream($stream, $s3wrapper);

Slide 73

Slide 73 text

Parsed Body

Slide 74

Slide 74 text

application/x-www-form-urlencoded multipart/form-data $_POST

Slide 75

Slide 75 text

function ($request, $response, $next) { $contentType = $request->getHeaderLine('Content-Type'); if ('application/json' === $contentType) { $json = json_decode($request->getBody(), true); $request = $request->withParsedBody($json); } return $next( $request, $response ); }

Slide 76

Slide 76 text

Middleware

Slide 77

Slide 77 text

function ($request, $response, $next) { return $next( $request, $response ); }

Slide 78

Slide 78 text

function ($request, $response, $next) { $response = $next( $request, $response ); return $response->withAddedHeader( 'X-Clacks-Overhead', 'GNU Terry Pratchett' ); }

Slide 79

Slide 79 text

namespace Acme; class ClacksOverhead { public function __invoke($request, $response, $next) { $response = $next( $request, $response ); return $response->withAddedHeader( 'X-Clacks-Overhead', 'GNU Terry Pratchett' ); } }

Slide 80

Slide 80 text

Stratigility use Zend\Stratigility\MiddlewarePipe; $app = new MiddlewarePipe(); // ... $app->pipe(new \Acme\ClacksOverhead()); // ...

Slide 81

Slide 81 text

Relay use Relay\RelayBuilder; $relayBuilder = new RelayBuilder(); $relay = $relayBuilder->newInstance([ // ... new \Acme\ClacksOverhead(), // ... ]); $response = $relay($request, $response);

Slide 82

Slide 82 text

What do we want? Re-use at the web layer! — http://stackphp.com

Slide 83

Slide 83 text

Framework Agnostic HTTP Libraries

Slide 84

Slide 84 text

What about cookies? — people

Slide 85

Slide 85 text

dflydev/fig-cookies

Slide 86

Slide 86 text

use Dflydev\FigCookies\FigRequestCookies; $request = $request->withHeader(Cookies::COOKIE_HEADER, 'theme=red; foo=bar'); $cookie = FigRequestCookies::get($request, 'theme'); $cookie->getValue(); // "red" $request = FigRequestCookies::set($request, $cookie->withValue('blue')); $request = FigRequestCookies::set($request, Cookie::create('name', 'beau')); $request = FigRequestCookies::remove($request, 'foo'); // ["theme=blue; name=beau"] $value = $request->getHeader(Cookies::COOKIE_HEADER);

Slide 87

Slide 87 text

use Dflydev\FigCookies\FigResponseCookies; $response = $response ->withAddedHeader('Set-Cookie', SetCookie::create('theme', 'red')) ->withAddedHeader('Set-Cookie', SetCookie::create('foo', 'bar')) ; $setCookie = FigResponseCookies::get($response, 'theme'); $setCookie->getValue(); // "red" $response = FigResponseCookies::set($response, $setCookie->withValue('blue')); $response = FigResponseCookies::set($response, SetCookie::create('token') ->withValue('a9s87dfz978a9') ->withDomain('example.com') ); // ["theme=blue", "token=a9s87dfz978a9; Domain=example.com"] $value = $response->getHeader('Set-Cookie');

Slide 88

Slide 88 text

dflydev/encrypted-fig-cookies WIP

Slide 89

Slide 89 text

class EncryptedFigCookiesMiddleware { public function __invoke( RequestInterface $request, ResponseInterface $response, callable $next ) { $request = $this->requestCookieDecryptor->decrypt( $request, $this->cookieNames ); $response = $next($request, $response); return $this->responseCookieEncryptor->encrypt( $response, $this->cookieNames ); } }

Slide 90

Slide 90 text

Hey! I'm trying to decide if Glide should use PSR-7 for it's next release. — Jonathan Reinink, June 2015

Slide 91

Slide 91 text

Because let's be honest. That's the future. — Jonathan Reinink, two days later

Slide 92

Slide 92 text

Frameworks

Slide 93

Slide 93 text

Slim 3 (RC1) www.slimframework.com/

Slide 94

Slide 94 text

Zend Expressive github.com/zendframework/zend-expressive Builds on Stratigility to provide a minimalist PSR-7 middleware framework for PHP

Slide 95

Slide 95 text

Radar github.com/radarphp Radar is a PSR-7 compliant Action-Domain-Responder (ADR) system.

Slide 96

Slide 96 text

Nimble monii/nimble-framework A light PSR-7 framework built on top of Laravel's Service Container, nikic/fast-route, and Relay. WIP

Slide 97

Slide 97 text

NikicFastRoute monii/nikic-fast-route-psr7-middleware WIP

Slide 98

Slide 98 text

There were at least two other existing nikic/fast-route middleware implementations jowy/routing-middleware & oscarotero/psr7-middlewares

Slide 99

Slide 99 text

class NikicFastRoute { public function __invoke($request, $response, $next) { $routeInfo = $this->dispatcher->dispatch( $request->getMethod(), $request->getUri()->getPath() ); switch ($routeInfo[0]) { case FastRoute\Dispatcher::NOT_FOUND: return $response->withStatus(404); case FastRoute\Dispatcher::METHOD_NOT_ALLOWED: return $response->withStatus(405); case FastRoute\Dispatcher::FOUND: $action = $routeInfo[1]; $parameters = $routeInfo[2]; $request = $request ->withAttribute('action', $action) ->withAttribute('parameters', $parameters) ; return $next($request, $response, $next); default: return $response->withStatus(500); } } }

Slide 100

Slide 100 text

ActionHandler monii/action-handler-psr7-middleware WIP

Slide 101

Slide 101 text

class ActionHandler { public function __construct(ActionHandlerResolver $actionResolver) { $this->actionResolver = $actionResolver; } function __invoke($request, $response, $next) { $action = $request->getAttribute('action'); if (is_null($action)) { throw new \RuntimeException('No action specified for request.'); } $handler = $this->actionResolver->resolve($action); return $handler($request, $response, $next); } }

Slide 102

Slide 102 text

$container->bind(Relay::class, function (Container $container) { $relayBuilder = $container->make(RelayBuilder::class); return $relayBuilder->newInstance([ $container->make(NikicFastRoute::class), // ... other middleware $container->make(ActionHandler::class), ]); }); $relay = $container->make(Relay::class); $response = $relay( $container->make(ServerRequestInterface::class), $container->make(ResponseInterface::class) ); send_response($response);

Slide 103

Slide 103 text

Middleware In the real world.

Slide 104

Slide 104 text

No content

Slide 105

Slide 105 text

No content

Slide 106

Slide 106 text

Managed Technical Debt

Slide 107

Slide 107 text

class CorsCompletelyOpenForDevelopment { public function __invoke($request, $response, callable $next) { /** @var ResponseInterface $response */ $response = $next($request, $response); if ($response->hasHeader('Access-Control-Allow-Origin')) { // If the response already has an expected header we will // assume that CORS has been handled successfully. return $response; } // This is unsafe and not what people will want in production // unless they really know what they are doing. return $response ->withHeader('Access-Control-Allow-Origin', '*') ->withHeader( 'X-Completely-Open-Cors-For-Development', 'unsafe' ) ; } }

Slide 108

Slide 108 text

Slide 109

Slide 109 text

$container->bind(Relay::class, function (Container $container) { $relayBuilder = $container->make(RelayBuilder::class); return $relayBuilder->newInstance([ $container->make(NikicFastRoute::class), $container->make(CorsCompletelyOpenForDevelopment::class), // ... other middleware $container->make(ActionHandler::class), ]); }); Works for now and buys time to create a better solution closer to launch.

Slide 110

Slide 110 text

Server, Middleware, and Client interfaces are missing Some of us are still working on that...

Slide 111

Slide 111 text

Implementations zend/diactoros (phly/http), Slim, Guzzle, phpixie/http

Slide 112

Slide 112 text

Bridges, Integrations, & Users Stratigility (phly/conduit), Symfony Bridge, Radar, Relay, Drupal 8, Laravel, Stack PSR-7 Bridge, AWS SDK, FIG Cookies, Glide, Arbiter, Expressive, Nimble, and a bunch of middleware (oscarotero/psr7-middlewares)...

Slide 113

Slide 113 text

Questions? @beausimensen • @moniidev • @thatpodcast