Learning the PHP-FIG HTTP Stack (Midwest PHP 2019)

Slide 1

Slide 1 text

Learning the PHP-FIG HTTP Stack Beau Simensen Technical Strategy Consultant beausimensen.com • astrocasts.com • thatpodcast.io

Slide 2

Slide 2 text

No content

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 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 5

Slide 5 text

interface ClientInterface { /** * @return ResponseInterface */ public function request($method, $url, array $headers = [], $content = null); }

Slide 6

Slide 6 text

–Kris Wallsmith, 2012-03-24 "[...] I think we should take a step back and start with interfaces for an HTTP request and an HTTP response. Once those are done, then we can move on to an HTTP client."

Slide 7

Slide 7 text

interface ClientInterface { /** * @return ResponseInterface */ public function sendRequest(RequestInterface $request); }

Slide 8

Slide 8 text

–Beau Simensen, 2012-06-17 "Either the client needs to construct the request itself (factory) or we need to provide a PSR request implementation that anyone can use."

Slide 9

Slide 9 text

interface ClientInterface { /** * @return RequestInterface */ public function createRequest($method, $url, array $headers = [], $content = null); }

Slide 10

Slide 10 text

–Benjamin Eberlei, 2012-03-24 "Just realized I forgot cookies."

Slide 11

Slide 11 text

–Evert Pot, 2012-03-24 "If you're taking this approach, you will ﬁnd that you probably forgot a lot of HTTP features :)"

Slide 12

Slide 12 text

–Evert Pot, 2012-03-24 "If you want to keep things simple, I'd strongly suggest focusing on the following..." - http method - url - http version - headers - stream for body - http status code - human-readable status - http version - headers - stream for body Request Response

Slide 13

Slide 13 text

Modeling HTTP Or "How PSR-7 happened"

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

use Psr\Http\Message\RequestInterface; use Psr\Http\Message\ResponseInterface; class MyHttpClient { public function send(RequestInterface $request): ResponseInterface { // ... } }

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

No content

Slide 20

Slide 20 text

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

Slide 21

Slide 21 text

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

Slide 22

Slide 22 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 23

Slide 23 text

No content

Slide 24

Slide 24 text

No content

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

No content

Slide 27

Slide 27 text

$request = Zend\Diactoros\ServerRequestFactory ::fromGlobals( $_SERVER, $_GET, $_POST, $_COOKIE, $_FILES );

Slide 28

Slide 28 text

No content

Slide 29

Slide 29 text

HTTP Messages are HTTP Messages

Slide 30

Slide 30 text

No content

Slide 31

Slide 31 text

PSR-7 HTTP Message Interfaces

Slide 32

Slide 32 text

Guzzle http://guzzlephp.org/

Slide 33

Slide 33 text

Zend Diactoros https://github.com/zendframework/zend-diactoros

Slide 34

Slide 34 text

Zend Stratigility https://github.com/zendframework/zend-stratigility

Slide 35

Slide 35 text

Zend Expressive https://github.com/zendframework/zend-expressive

Slide 36

Slide 36 text

Slim http://www.slimframework.com/

Slide 37

Slide 37 text

No content

Slide 38

Slide 38 text

No content

Slide 39

Slide 39 text

The PHP HTTP group https://github.com/php-http

Slide 40

Slide 40 text

HTTP Interop https://github.com/http-interop

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

class ApiTheRightWay { private $client; public function __construct($client) { $this ->client = $client; } public function getStatus() { $request = new GuzzleHttp\Psr7\Request(); $response = $this ->client ->send($request); return json_decode($response ->getBody() ->getContents(), true); } }

Slide 43

Slide 43 text

interface DoublePassHttpMiddleware { public function __invoke( RequestInterface $request, ResponseInterface $response, callable $next ): ResponseInterface; } interface SinglePassHttpMiddleware { public function __invoke( RequestInterface $request, callable $next ): ResponseInterface; }

Slide 44

Slide 44 text

Slide 45

Slide 45 text

__invoke()

Slide 46

Slide 46 text

interface Middleware()

Slide 47

Slide 47 text

No content

Slide 48

Slide 48 text

No content

Slide 49

Slide 49 text

–You might be thinking this “How is this better?”

Slide 50

Slide 50 text

Completing the Stack

Slide 51

Slide 51 text

Slide 52

Slide 52 text

PSR-15 HTTP Handlers

Slide 53

Slide 53 text

Slide 54

Slide 54 text

class ChaosMiddleware implements SinglePassHttpMiddleware { public function __invoke( RequestInterface $request, callable $next ): ResponseInterface { if (rand(0, 99) === 0) { return (new GuzzleHttp\Psr7\Response(404)); } return $next($request); } }

Slide 55

Slide 55 text

class ChaosMiddleware implements DoublePassHttpMiddleware { public function __invoke( RequestInterface $request, ResponseInterface $response, callable $next ): ResponseInterface { if (rand(0, 99) === 0) { return $response ->withStatus(404); } return $next($request); } }

Slide 56

Slide 56 text

Slide 57

Slide 57 text

Slide 58

Slide 58 text

–Beau Simensen, That Podcast Episode 45 “You're going to need the Response.”

Slide 59

Slide 59 text

–Dave Marshall, That Podcast Episode 45 “Are you though?”

Slide 60

Slide 60 text

–Scary Technical Question “But is the ResponseInterface instance even in a usable state?”

Slide 61

Slide 61 text

–My personal soapbox for many, many years... “We either pass the object or we introduce factories.”

Slide 62

Slide 62 text

Spoiler alert They chose factories.

Slide 63

Slide 63 text

Slide 64

Slide 64 text

namespace Psr\Http\Server; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; interface MiddlewareInterface { public function process( ServerRequestInterface $request, RequestHandlerInterface $handler ): ResponseInterface; }

Slide 65

Slide 65 text

namespace Psr\Http\Server; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; interface RequestHandlerInterface { public function handle(ServerRequestInterface $request): ResponseInterface; }

Slide 66

Slide 66 text

No content

Slide 67

Slide 67 text

No content

Slide 68

Slide 68 text

No content

Slide 69

Slide 69 text

No content

Slide 70

Slide 70 text

No content

Slide 71

Slide 71 text

No content

Slide 72

Slide 72 text

No content

Slide 73

Slide 73 text

No content

Slide 74

Slide 74 text

No content

Slide 75

Slide 75 text

No content

Slide 76

Slide 76 text

No content

Slide 77

Slide 77 text

No content

Slide 78

Slide 78 text

PSR-17 HTTP Factories

Slide 79

Slide 79 text

namespace Psr\Http\Message; use Psr\Http\Message\RequestInterface; use Psr\Http\Message\UriInterface; interface RequestFactoryInterface { public function createRequest(string $method, $uri): RequestInterface; }

Slide 80

Slide 80 text

namespace Psr\Http\Message; use Psr\Http\Message\ResponseInterface; interface ResponseFactoryInterface { public function createResponse( int $code = 200, string $reasonPhrase = '' ): ResponseInterface; }

Slide 81

Slide 81 text

namespace Psr\Http\Message; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\UriInterface; interface ServerRequestFactoryInterface { public function createServerRequest( string $method, $uri, array $serverParams = [] ): ServerRequestInterface; }

Slide 82

Slide 82 text

namespace Psr\Http\Message; use Psr\Http\Message\StreamInterface; interface StreamFactoryInterface { public function createStream(string $content = ''): StreamInterface; public function createStreamFromFile( string $filename, string $mode = 'r' ): StreamInterface; public function createStreamFromResource($resource): StreamInterface; }

Slide 83

Slide 83 text

namespace Psr\Http\Message; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UploadedFileInterface; interface UploadedFileFactoryInterface { public function createUploadedFile( StreamInterface $stream, int $size = null, int $error = \UPLOAD_ERR_OK, string $clientFilename = null, string $clientMediaType = null ): UploadedFileInterface; }

Slide 84

Slide 84 text

namespace Psr\Http\Message; use Psr\Http\Message\UriInterface; interface UriFactoryInterface { public function createUri(string $uri = '') : UriInterface; }

Slide 85

Slide 85 text

Slide 86

Slide 86 text

class ApiTheRightWay { private $client; private $requestFactory; public function __construct($client, RequestFactoryInterface $requestFactory) { $this ->client = $client; $this ->requestFactory = $requestFactory; } public function getStatus() { $request = $this ->requestFactory ->createRequest(); $response = $this ->client ->send($request); return json_decode($response ->getBody() ->getContents(), true); } }

Slide 87

Slide 87 text

Slide 88

Slide 88 text

class ChaosMiddleware implements SinglePassHttpMiddleware { private $responseFactory; public function __construct(ResponseFactoryInterface $responseFactory) { $this ->responseFactory = $responseFactory; } public function __invoke( RequestInterface $request, callable $next ): ResponseInterface { if (rand(0, 99) === 0) { return $this ->responseFactory ->createResponse(404); } return $next($request); } }

Slide 89

Slide 89 text

No content

Slide 90

Slide 90 text

No content

Slide 91

Slide 91 text

No content

Slide 92

Slide 92 text

No content

Slide 93

Slide 93 text

PSR-18 HTTP Client

Slide 94

Slide 94 text

namespace Psr\Http\Client; use Psr\Http\Message\RequestInterface; use Psr\Http\Message\ResponseInterface; interface ClientInterface { public function sendRequest(RequestInterface $request): ResponseInterface; }

Slide 95

Slide 95 text

interface ClientInterface { /** * @return ResponseInterface */ public function sendRequest(RequestInterface $request); }

Slide 96

Slide 96 text

Slide 97

Slide 97 text

class ApiTheRightWay { private $client; private $requestFactory; public function __construct( ClientInterface $client, RequestFactoryInterface $requestFactory ) { $this ->client = $client; $this ->requestFactory = $requestFactory; } public function getStatus() { $request = $this ->requestFactory ->createRequest(); $response = $this ->client ->sendRequest($request); return json_decode($response ->getBody() ->getContents(), true); } }

Slide 98

Slide 98 text

No content

Slide 99

Slide 99 text

No content

Slide 100

Slide 100 text

Learning the PHP-FIG HTTP Stack Beau Simensen Technical Strategy Consultant beausimensen.com • astrocasts.com • thatpodcast.io Thanks!