bug #2702 [StimulusBundle] Skip mapping .ts controller if .js version is available (phasdev)

This PR was merged into the 2.x branch.

Discussion
----------

[StimulusBundle] Skip mapping .ts controller if .js version is available

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no <!-- please update src/**/CHANGELOG.md files -->
| Docs?         | no <!-- required for new features -->
| Issues        | Fix #2701  <!-- prefix each issue number with "Fix #", no need to create an issue if none exist, explain below instead -->
| License       | MIT

Resolves issue #2701 where an exception is thrown when `.ts` controllers are transpiled to `.js` in the same directory and `.ts` files are excluded from mapped assets. See related issue for details.

Commits
-------

f6737eb [StimulusBundle] Skip mapping .ts controller if .js version is available

Author: Kocal

src/StimulusBundle/src/AssetMapper/ControllersMapGenerator.php

@@ -70,13 +70,22 @@ private function loadCustomControllers(): array
 
         $controllersMap = [];
         foreach ($finder as $file) {
+            // Skip .ts controller if .js version is available
+            if ('ts' === $file->getExtension() && file_exists(substr($file->getRealPath(), 0, -2).'js')) {
+                continue;
+            }
+
             $name = $file->getRelativePathname();
             // use regex to extract 'controller'-postfix including extension
             preg_match(self::FILENAME_REGEX, $name, $matches);
             $name = str_replace(['_'.$matches[1], '-'.$matches[1]], '', $name);
             $name = str_replace(['_', '/', '\\'], ['-', '--', '--'], $name);
 
             $asset = $this->assetMapper->getAssetFromSourcePath($file->getRealPath());
+            if (!$asset) {
+                throw new \RuntimeException(\sprintf('Could not find an asset mapper path that points to the "%s" controller.', $name));
+            }
+
             $content = file_get_contents($asset->sourcePath);
             $isLazy = preg_match('/\/\*\s*stimulusFetch:\s*\'lazy\'\s*\*\//i', $content);
 

src/StimulusBundle/tests/AssetMapper/ControllersMapGeneratorTest.php

@@ -34,6 +34,8 @@ public function testGetControllersMap()
                     $logicalPath = 'fake-vendor/ux-package1/package-controller-second.js';
                 } elseif (str_ends_with($path, 'package-hello-controller.js')) {
                     $logicalPath = 'fake-vendor/ux-package2/package-hello-controller.js';
+                } elseif (str_ends_with($path, 'other-controller.ts') || str_ends_with($path, 'excluded-controller.js')) {
+                    return null;
                 } else {
                     // replace windows slashes
                     $path = str_replace('\\', '/', $path);
@@ -75,15 +77,18 @@ public function testGetControllersMap()
             $autoImportLocator,
         );
 
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage('Could not find an asset mapper path that points to the "excluded" controller.');
         $map = $generator->getControllersMap();
         // + 3 controller.json UX controllers
         // - 1 controllers.json UX controller is disabled
-        // + 10 custom controllers (1 file is not a controller & 1 is overridden)
-        $this->assertCount(12, $map);
+        // + 11 custom controllers (1 file is not a controller, 1 is overridden)
+        $this->assertCount(13, $map);
         $packageNames = array_keys($map);
         sort($packageNames);
         $this->assertSame([
             'bye',
+            'excluded',
             'fake-vendor--ux-package1--controller-second',
             'fake-vendor--ux-package2--hello-controller',
             'hello',

src/StimulusBundle/tests/AssetMapper/StimulusControllerLoaderFunctionalTest.php

@@ -63,7 +63,8 @@ public function testFullApplicationLoad()
                 // 2x from UX packages, which are enabled in controllers.json
                 '/assets/fake-vendor/ux-package1/package-controller-second.js',
                 '/assets/fake-vendor/ux-package2/package-hello-controller.js',
-                // 3x from more-controllers
+                // 4x from more-controllers
+                '/assets/more-controllers/excluded-controller.js',
                 '/assets/more-controllers/hello-controller.js',
                 '/assets/more-controllers/minified-controller.js',
                 '/assets/more-controllers/other-controller.js',

src/StimulusBundle/tests/fixtures/assets/more-controllers/excluded-controller.js

@@ -0,0 +1,6 @@
+// excluded-controller.js
+import { Controller } from '@hotwired/stimulus';
+
+/*    stimulusFetch:    'lazy'   */
+export default class extends Controller {
+}

src/StimulusBundle/tests/fixtures/assets/more-controllers/other-controller.ts

@@ -0,0 +1,7 @@
+// other-controller.js
+// @ts-ignore
+import { Controller } from '@hotwired/stimulus';
+
+/*    stimulusFetch:    'lazy'   */
+export default class extends Controller {
+}