preload modules, do not preload defer and async scripts

Author: indykoning

.github/workflows/analyse.yml

@@ -0,0 +1,29 @@
+name: PHPStan
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: analyse
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          extensions: dom, curl, libxml, mbstring, zip, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-interaction
+
+      - name: Analyse
+        run: composer run analyse

.github/workflows/pint.yml

@@ -0,0 +1,29 @@
+name: Pint
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: pint
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          extensions: dom, curl, libxml, mbstring, zip, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-interaction
+
+      - name: Analyse
+        run: composer run style

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: tests
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          extensions: dom, curl, libxml, mbstring, zip, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-interaction
+
+      - name: Analyse
+        run: composer run test

README.md

@@ -15,6 +15,7 @@ $ composer require justbetter/laravel-http3earlyhints
 ```
 
 Next you must add the `\JustBetter\Http3EarlyHints\Middleware\AddHttp3EarlyHints`-middleware to the kernel. Adding it to the web group is recommeneded as API's do not have assets to push.
+### Laravel <11
 ```php
 // app/Http/Kernel.php
 
@@ -29,6 +30,23 @@ protected $middlewareGroups = [
 ];
 ```
 
+### Laravel >=11
+```php
+// bootstrap/app.php
+
+...
+->withMiddleware(function (Middleware $middleware) {
+    ...
+    $middleware->appendToGroup('web', [
+        \JustBetter\Http3EarlyHints\Middleware\AddHttp3EarlyHints::class,
+    ]);
+    // Or
+    // $middleware->append(\JustBetter\Http3EarlyHints\Middleware\AddHttp3EarlyHints::class);
+    ...
+})
+...
+```
+
 ## Publish config
 
 ```php
@@ -43,11 +61,42 @@ default behaviour is adding the link headers to the 200 response which e.g. [Clo
 When you route a request through the `AddHttp3EarlyHints` middleware, the response is scanned for any `link`, `script` or `img` tags that could benefit from being loaded using Early Hints.
 These assets will be added to the `Link` header before sending the response to the client. Easy!
 
-**Note:** To push an image asset, it must have one of the following extensions: `bmp`, `gif`, `jpg`, `jpeg`, `png`, `tiff` or `svg` and not have `loading="lazy"`
+**Note:** To push an image asset, it must have one of the following extensions: `bmp`, `gif`, `jpg`, `jpeg`, `png`, `svg`, `tiff` or `webp` and not have `loading="lazy"`
 
 ### Advanced usage
 
-If the automatic detection isn't enough for you, you can listen for GenerateEarlyHints events, and manually add new links.
+If the automatic detection isn't enough for you, you can listen for the `GenerateEarlyHints` event, and manually add/remove/change new links.
+
+#### Detailed default behaviour
+
+The information on [usage](#usage) is simplified, there are many checks done to make sure we don't preload the wrong things.
+
+Early hints only support rel=preconnect and rel=preload [source](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/103#browser_compatibility)
+
+We automatically transform any rel that is not `preconnect` or `preload` into `preload`, so your `<link rel="modulepreload" href="app.js">` will get preloaded with early hints. And get more detailed information once your server starts sending it's response.
+
+##### Link
+
+Any link elements which do **not** have rel=
+- icon
+- canonical
+- manifest
+- alternative
+
+##### Script
+
+Script tags will automatically get preloaded **if** it does not have an `async` or `defer` attribute attached to it.
+
+##### Img
+
+Img tags will automatically get preloaded when it does not have `loading="lazy"` and it does not exist within a picture tag.
+
+If it is within a picture tag we may be dealing with mutliple `srcset`s or `type`s, and thus cannot determine which file the browser will need.
+So we will not preload these images.
+
+##### Object
+
+If your html object tag contains `data=""` it will preload it.
 
 ## Testing
 

src/Data/LinkHeaders.php

@@ -15,7 +15,7 @@ class LinkHeaders
 
     public function __construct(?EvolvableLinkProviderInterface $linkProvider = null)
     {
-        $this->linkProvider = $linkProvider ?? new GenericLinkProvider();
+        $this->linkProvider = $linkProvider ?? new GenericLinkProvider;
     }
 
     public function getLinkProvider(): EvolvableLinkProviderInterface
@@ -30,18 +30,20 @@ public function setLinkProvider(EvolvableLinkProviderInterface $linkProvider): s
         return $this;
     }
 
-    public function addLink(EvolvableLinkInterface|string|array $uri, string|array|null $rel = null, null|array $attributes = []): static
+    public function addLink(EvolvableLinkInterface|string|array $uri, string|array|null $rel = null, ?array $attributes = []): static
     {
         if (is_array($uri)) {
             foreach ($uri as $data) {
                 $data = Arr::Wrap($data);
                 $this->addLink(...$data);
             }
+
             return $this;
         }
 
         if ($uri instanceof EvolvableLinkInterface) {
             $this->setLinkProvider($this->getLinkProvider()->withLink($uri));
+
             return $this;
         }
 
@@ -67,21 +69,22 @@ public function addLink(EvolvableLinkInterface|string|array $uri, string|array|n
         return $this;
     }
 
-    public function addFromString(string $link) : static
+    public function addFromString(string $link): static
     {
         $links = explode(',', trim($link));
         foreach ($links as $link) {
             $parts = explode('; ', trim($link));
             $uri = trim(array_shift($parts), '<>');
             $rel = null;
             $attributes = [];
-            foreach($parts as $part) {
+            foreach ($parts as $part) {
                 preg_match('/(?<key>[^=]+)(?:="?(?<value>.*)"?)?/', trim($part), $matches);
                 $key = $matches['key'];
                 $value = $matches['value'] ?? null;
 
-                if($key === 'rel') {
+                if ($key === 'rel') {
                     $rel = $value;
+
                     continue;
                 }
                 $attributes[$key] = $value ?? true;
@@ -99,8 +102,9 @@ public function makeUnique()
 
         foreach ($this->getLinkProvider()->getLinks() as $link) {
             $hash = md5(serialize($link));
-            if (!in_array($hash, $handledHashes)) {
+            if (! in_array($hash, $handledHashes)) {
                 $handledHashes[] = $hash;
+
                 continue;
             }
 
@@ -135,7 +139,7 @@ public static function linkToString(LinkInterface $link)
                 continue;
             }
 
-            if (!\is_bool($value)) {
+            if (! \is_bool($value)) {
                 $attributes[] = sprintf('%s="%s"', $key, $value);
 
                 continue;

src/Listeners/AddDefaultHeaders.php

@@ -9,7 +9,7 @@ class AddDefaultHeaders
 {
     public function handle(GenerateEarlyHints $event)
     {
-        foreach(config('http3earlyhints.default_headers', []) as $header) {
+        foreach (config('http3earlyhints.default_headers', []) as $header) {
             $event->linkHeaders->addFromString($header);
         }
     }

src/Listeners/AddFromBody.php

@@ -45,7 +45,6 @@ public function handle(GenerateEarlyHints $event)
         $event->linkHeaders->addLink($headers->toArray());
     }
 
-
     /**
      * Get the DomCrawler instance.
      */
@@ -61,7 +60,7 @@ protected function fetchLinkableNodes(Response $response): Collection
     {
         $crawler = $this->getCrawler($response);
 
-        return collect($crawler->filter('link:not([rel*="icon"]):not([rel="canonical"]):not([rel="manifest"]):not([rel="alternate"]), script[src], *:not(picture)>img[src]:not([loading="lazy"]), object[data]')->extract(['src', 'href', 'data', 'rel', 'type']));
+        return collect($crawler->filter('link:not([rel*="icon"]):not([rel="canonical"]):not([rel="manifest"]):not([rel="alternate"]), script[src]:not([defer]):not([async]), *:not(picture)>img[src]:not([loading="lazy"]), object[data]')->extract(['src', 'href', 'data', 'rel', 'type']));
     }
 
     /**
@@ -84,7 +83,7 @@ private function buildLinkHeader(string $url, ?string $rel = 'preload'): ?Link
             '.WOFF2' => 'font',
         ];
 
-        if (!$url) {
+        if (! $url) {
             return null;
         }
 
@@ -97,7 +96,7 @@ private function buildLinkHeader(string $url, ?string $rel = 'preload'): ?Link
             $url = rtrim($basePath.ltrim($url, $basePath), '/');
         }
 
-        if (! in_array($rel, ['preload', 'modulepreload', 'preconnect'])) {
+        if (! in_array($rel, ['preload', 'preconnect'])) {
             $rel = 'preload';
         }
 

src/Middleware/AddHttp3EarlyHints.php

@@ -7,7 +7,6 @@
 use Illuminate\Http\Response;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Cache;
-use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Str;
 use JustBetter\Http3EarlyHints\Data\LinkHeaders;
 use JustBetter\Http3EarlyHints\Events\GenerateEarlyHints;
@@ -48,7 +47,7 @@ public function handle(Request $request, Closure $next, ?int $sizeLimit = null):
         }
 
         if (config('http3earlyhints.set_103')) {
-            $response = new Response();
+            $response = new Response;
             $this->addLinkHeaders($response, $linkHeaders);
             $response->sendHeaders(103);
 
@@ -104,7 +103,7 @@ public function handleGeneratingLinkHeaders(Request $request, SymfonyResponse $r
 
     protected function generateLinkHeaders(Request $request, SymfonyResponse $response, ?int $sizeLimit = null): LinkHeaders
     {
-        $this->linkHeaders = new LinkHeaders();
+        $this->linkHeaders = new LinkHeaders;
         GenerateEarlyHints::dispatch($this->linkHeaders, $request, $response);
 
         $this->linkHeaders->makeUnique();
@@ -114,7 +113,7 @@ protected function generateLinkHeaders(Request $request, SymfonyResponse $respon
 
         while (strlen($headersText) > $sizeLimit) {
             $this->linkHeaders->setLinkProvider($this->linkHeaders->getLinkProvider()->withOutLink(Arr::last($this->linkHeaders->getLinkProvider()->getLinks())));
-            $headersText =  $this->linkHeaders->__toString();
+            $headersText = $this->linkHeaders->__toString();
         }
 
         return $this->linkHeaders;
@@ -126,7 +125,7 @@ protected function generateLinkHeaders(Request $request, SymfonyResponse $respon
     private function addLinkHeaders(SymfonyResponse $response, LinkHeaders $linkHeaders): SymfonyResponse
     {
         $link = $linkHeaders->__toString();
-        if (! $link || !$response instanceof Response) {
+        if (! $link || ! $response instanceof Response) {
             return $response;
         }
         if ($response->headers->get('Link')) {

tests/AddHttp3EarlyHintsTest.php

@@ -12,7 +12,7 @@ class AddHttp3EarlyHintsTest extends TestCase
 
     public function setUp(): void
     {
-        $this->middleware = new AddHttp3EarlyHints();
+        $this->middleware = new AddHttp3EarlyHints;
         parent::setUp();
     }
 
@@ -27,7 +27,7 @@ public function it_will_not_exceed_size_limit()
         $request = $this->getNewRequest();
 
         $limit = 75;
-        $response = $this->middleware->handle($request, $this->getNext('pageWithCssAndJs'), $limit, []);
+        $response = $this->middleware->handle($request, $this->getNext('pageWithCssAndJs'), $limit);
 
         $this->assertTrue($this->isServerPushResponse($response));
         $this->assertTrue(strlen($response->headers->get('link')) <= $limit);