feature #35762 [Asset] Allows to download asset manifest over HTTP (GromNaN)

nicolas-grekas · nicolas-grekas · commit cccb5352b831 · 2020-04-05T12:00:14.000+02:00
This PR was merged into the 5.1-dev branch. Discussion ---------- [Asset] Allows to download asset manifest over HTTP | Q | A | ------------- | --- | Branch? | master  | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #35761 Fix #33001 | License | MIT | Doc PR | symfony/symfony-docs#13255 ```yaml framework: assets: json_manifest_path: 'https://cdn.example.com/manifest.json' ``` Commits ------- 4ba12a80e5 [Asset] Allows to download json manifest from a remote url
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.1.0
+-----
+
+ * added `RemoteJsonManifestVersionStrategy` to download manifest over HTTP.
+
 4.2.0
 -----
 
diff --git a/Tests/VersionStrategy/RemoteJsonManifestVersionStrategyTest.php b/Tests/VersionStrategy/RemoteJsonManifestVersionStrategyTest.php
@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Asset\Tests\VersionStrategy;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Asset\VersionStrategy\RemoteJsonManifestVersionStrategy;
+use Symfony\Component\HttpClient\Exception\JsonException;
+use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\HttpClient\Response\MockResponse;
+
+class RemoteJsonManifestVersionStrategyTest extends TestCase
+{
+    public function testGetVersion()
+    {
+        $strategy = $this->createStrategy('https://cdn.example.com/manifest-valid.json');
+
+        $this->assertSame('main.123abc.js', $strategy->getVersion('main.js'));
+    }
+
+    public function testApplyVersion()
+    {
+        $strategy = $this->createStrategy('https://cdn.example.com/manifest-valid.json');
+
+        $this->assertSame('css/styles.555def.css', $strategy->getVersion('css/styles.css'));
+    }
+
+    public function testApplyVersionWhenKeyDoesNotExistInManifest()
+    {
+        $strategy = $this->createStrategy('https://cdn.example.com/manifest-valid.json');
+
+        $this->assertSame('css/other.css', $strategy->getVersion('css/other.css'));
+    }
+
+    public function testMissingManifestFileThrowsException()
+    {
+        $this->expectException('RuntimeException');
+        $this->expectExceptionMessage('HTTP 404 returned for "https://cdn.example.com/non-existent-file.json"');
+        $strategy = $this->createStrategy('https://cdn.example.com/non-existent-file.json');
+        $strategy->getVersion('main.js');
+    }
+
+    public function testManifestFileWithBadJSONThrowsException()
+    {
+        $this->expectException(JsonException::class);
+        $this->expectExceptionMessage('Syntax error');
+        $strategy = $this->createStrategy('https://cdn.example.com/manifest-invalid.json');
+        $strategy->getVersion('main.js');
+    }
+
+    private function createStrategy($manifestUrl)
+    {
+        $httpClient = new MockHttpClient(function ($method, $url, $options) {
+            $filename = __DIR__.'/../fixtures/'.basename($url);
+
+            if (file_exists($filename)) {
+                return new MockResponse(file_get_contents($filename), ['http_headers' => ['content-type' => 'application/json']]);
+            }
+
+            return new MockResponse('{}', ['http_code' => 404]);
+        });
+
+        return new RemoteJsonManifestVersionStrategy($manifestUrl, $httpClient);
+    }
+}
diff --git a/VersionStrategy/RemoteJsonManifestVersionStrategy.php b/VersionStrategy/RemoteJsonManifestVersionStrategy.php
@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Asset\VersionStrategy;
+
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+/**
+ * Reads the versioned path of an asset from a remote JSON manifest file.
+ *
+ * For example, the manifest file might look like this:
+ *     {
+ *         "main.js": "main.abc123.js",
+ *         "css/styles.css": "css/styles.555abc.css"
+ *     }
+ *
+ * You could then ask for the version of "main.js" or "css/styles.css".
+ */
+class RemoteJsonManifestVersionStrategy implements VersionStrategyInterface
+{
+    private $manifestData;
+    private $manifestUrl;
+    private $httpClient;
+
+    /**
+     * @param string $manifestUrl Absolute URL to the manifest file
+     */
+    public function __construct(string $manifestUrl, HttpClientInterface $httpClient)
+    {
+        $this->manifestUrl = $manifestUrl;
+        $this->httpClient = $httpClient;
+    }
+
+    /**
+     * With a manifest, we don't really know or care about what
+     * the version is. Instead, this returns the path to the
+     * versioned file.
+     */
+    public function getVersion(string $path)
+    {
+        return $this->applyVersion($path);
+    }
+
+    public function applyVersion(string $path)
+    {
+        if (null === $this->manifestData) {
+            $this->manifestData = $this->httpClient->request('GET', $this->manifestUrl, [
+                'headers' => ['accept' => 'application/json'],
+            ])->toArray();
+        }
+
+        return $this->manifestData[$path] ?? $path;
+    }
+}
diff --git a/composer.json b/composer.json
@@ -22,6 +22,7 @@
         "symfony/http-foundation": ""
     },
     "require-dev": {
+        "symfony/http-client": "^4.4|^5.0",
         "symfony/http-foundation": "^4.4|^5.0",
         "symfony/http-kernel": "^4.4|^5.0"
     },
