From 2ddd5217d3c84c59c5a2ddcc7f733e34c3d5ef2e Mon Sep 17 00:00:00 2001
From: Kevin Boyd <kevin.boyd@gmail.com>
Date: Wed, 6 Mar 2019 21:17:37 -0800
Subject: [PATCH] Fix BC Break with services tagged kernel.event_subscriber
 (#410)

* Add a test to demonstrate a problem with custom bundle event subscribers

* Add a new compiler pass to make kernel.event_subscriber services public

* Apply code sniffer suggestion and add an exclude pattern.
---
 .gitignore                                    |  1 +
 phpcs.xml                                     |  1 +
 .../Compiler/EventSubscriberOverridePass.php  | 35 +++++++++++++++++++
 .../Bundle/SculpinBundle/SculpinBundle.php    |  2 ++
 .../Functional/EventListenerExtensionTest.php | 31 ++++++++++++++++
 .../EventListenerTestFixtureExtension.php     | 20 +++++++++++
 .../EventListenerTestFixtureBundle.php        |  9 +++++
 .../Listener.php                              | 29 +++++++++++++++
 .../Resources/config/services.xml             | 15 ++++++++
 .../app/SculpinKernel.php                     | 11 ++++++
 .../app/config/sculpin_kernel.yml             |  3 ++
 .../app/config/sculpin_site.yml               |  4 +++
 .../source/_views/default.html                |  6 ++++
 .../__EventListenerFixture__/source/index.md  |  5 +++
 14 files changed, 172 insertions(+)
 create mode 100644 src/Sculpin/Bundle/SculpinBundle/DependencyInjection/Compiler/EventSubscriberOverridePass.php
 create mode 100644 src/Sculpin/Tests/Functional/EventListenerExtensionTest.php
 create mode 100644 src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/DependencyInjection/EventListenerTestFixtureExtension.php
 create mode 100644 src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/EventListenerTestFixtureBundle.php
 create mode 100644 src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/Listener.php
 create mode 100644 src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/Resources/config/services.xml
 create mode 100644 src/Sculpin/Tests/Functional/__EventListenerFixture__/app/SculpinKernel.php
 create mode 100644 src/Sculpin/Tests/Functional/__EventListenerFixture__/app/config/sculpin_kernel.yml
 create mode 100644 src/Sculpin/Tests/Functional/__EventListenerFixture__/app/config/sculpin_site.yml
 create mode 100644 src/Sculpin/Tests/Functional/__EventListenerFixture__/source/_views/default.html
 create mode 100644 src/Sculpin/Tests/Functional/__EventListenerFixture__/source/index.md

diff --git a/.gitignore b/.gitignore
index 73225476..0afc2aa8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,4 +2,5 @@ vendor
 cache
 __BlankSculpinProject__/
 __SculpinTestProject__/
+output_test/
 clover.xml
diff --git a/phpcs.xml b/phpcs.xml
index f27ab45d..f99c7bcd 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -8,6 +8,7 @@
  <file>./src/</file>
 
  <exclude-pattern>*/__BlankSculpinProject__/*</exclude-pattern>
+ <exclude-pattern>*/__EventListenerFixture__/*</exclude-pattern>
 
  <rule ref="PSR2"/>
  <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
diff --git a/src/Sculpin/Bundle/SculpinBundle/DependencyInjection/Compiler/EventSubscriberOverridePass.php b/src/Sculpin/Bundle/SculpinBundle/DependencyInjection/Compiler/EventSubscriberOverridePass.php
new file mode 100644
index 00000000..40ae1ad2
--- /dev/null
+++ b/src/Sculpin/Bundle/SculpinBundle/DependencyInjection/Compiler/EventSubscriberOverridePass.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is a part of Sculpin.
+ *
+ * (c) Dragonfly Development Inc.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sculpin\Bundle\SculpinBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * Override default visibility of services tagged with kernel.event_subscriber
+ */
+class EventSubscriberOverridePass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container): void
+    {
+        $services = $container->findTaggedServiceIds('kernel.event_subscriber');
+        foreach ($services as $id => $tags) {
+            $definition = $container->getDefinition($id);
+            $definition->setPublic(true);
+        }
+    }
+}
diff --git a/src/Sculpin/Bundle/SculpinBundle/SculpinBundle.php b/src/Sculpin/Bundle/SculpinBundle/SculpinBundle.php
index 04ea0dfb..9e7d5c50 100644
--- a/src/Sculpin/Bundle/SculpinBundle/SculpinBundle.php
+++ b/src/Sculpin/Bundle/SculpinBundle/SculpinBundle.php
@@ -16,6 +16,7 @@
 use Sculpin\Bundle\SculpinBundle\DependencyInjection\Compiler\ConverterManagerPass;
 use Sculpin\Bundle\SculpinBundle\DependencyInjection\Compiler\DataSourcePass;
 use Sculpin\Bundle\SculpinBundle\DependencyInjection\Compiler\DataProviderManagerPass;
+use Sculpin\Bundle\SculpinBundle\DependencyInjection\Compiler\EventSubscriberOverridePass;
 use Sculpin\Bundle\SculpinBundle\DependencyInjection\Compiler\FormatterManagerPass;
 use Sculpin\Bundle\SculpinBundle\DependencyInjection\Compiler\GeneratorManagerPass;
 use Sculpin\Bundle\SculpinBundle\DependencyInjection\Compiler\PathConfiguratorPass;
@@ -48,5 +49,6 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new WriterPass);
         $container->addCompilerPass(new AddConsoleCommandPass);
         $container->addCompilerPass(new DirectoryOverridePass);
+        $container->addCompilerPass(new EventSubscriberOverridePass);
     }
 }
diff --git a/src/Sculpin/Tests/Functional/EventListenerExtensionTest.php b/src/Sculpin/Tests/Functional/EventListenerExtensionTest.php
new file mode 100644
index 00000000..21ba81d4
--- /dev/null
+++ b/src/Sculpin/Tests/Functional/EventListenerExtensionTest.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sculpin\Tests\Functional;
+
+use Symfony\Component\Finder\Finder;
+
+class EventListenerExtensionTest extends FunctionalTestCase
+{
+    protected const PROJECT_DIR = '/__EventListenerFixture__';
+
+    public function setUp(): void
+    {
+        $outputDir = $this->projectDir() . '/output_test';
+        if (static::$fs->exists($outputDir)) {
+            static::$fs->remove($outputDir);
+        }
+    }
+
+    public function testEventListenerExtensionBundle(): void
+    {
+        $expectedFile = 'sculpin.core.after_run.event';
+
+        $this->assertProjectLacksFile('/output_test/' . $expectedFile);
+
+        $this->executeSculpin('generate');
+
+        $this->assertProjectHasGeneratedFile('/' . $expectedFile);
+    }
+}
diff --git a/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/DependencyInjection/EventListenerTestFixtureExtension.php b/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/DependencyInjection/EventListenerTestFixtureExtension.php
new file mode 100644
index 00000000..d499e6a0
--- /dev/null
+++ b/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/DependencyInjection/EventListenerTestFixtureExtension.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Sculpin\Tests\Functional\EventListenerTestFixtureBundle\DependencyInjection;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+
+class EventListenerTestFixtureExtension extends Extension
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
+        $loader->load('services.xml');
+    }
+}
diff --git a/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/EventListenerTestFixtureBundle.php b/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/EventListenerTestFixtureBundle.php
new file mode 100644
index 00000000..4fe0c0f5
--- /dev/null
+++ b/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/EventListenerTestFixtureBundle.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Sculpin\Tests\Functional\EventListenerTestFixtureBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class EventListenerTestFixtureBundle extends Bundle
+{
+}
diff --git a/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/Listener.php b/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/Listener.php
new file mode 100644
index 00000000..508c3e96
--- /dev/null
+++ b/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/Listener.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Sculpin\Tests\Functional\EventListenerTestFixtureBundle;
+
+use Sculpin\Core\Event\SourceSetEvent;
+use Sculpin\Core\Sculpin;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+class Listener implements EventSubscriberInterface
+{
+    protected $outputDir;
+
+    public function __construct($outputDir)
+    {
+        $this->outputDir = $outputDir;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            Sculpin::EVENT_AFTER_RUN => 'createSuccessFile',
+        ];
+    }
+
+    public function createSuccessFile(SourceSetEvent $event, $eventName): void
+    {
+        file_put_contents($this->outputDir . '/' . $eventName . '.event', $eventName);
+    }
+}
diff --git a/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/Resources/config/services.xml b/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/Resources/config/services.xml
new file mode 100644
index 00000000..5b107dfa
--- /dev/null
+++ b/src/Sculpin/Tests/Functional/EventListenerTestFixtureBundle/Resources/config/services.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+
+        <service id="sculpin.tests.event_listener_test_fixture" class="\Sculpin\Tests\Functional\EventListenerTestFixtureBundle\Listener">
+            <argument>%sculpin.output_dir%</argument>
+            <tag name="kernel.event_subscriber" />
+        </service>
+
+    </services>
+
+</container>
diff --git a/src/Sculpin/Tests/Functional/__EventListenerFixture__/app/SculpinKernel.php b/src/Sculpin/Tests/Functional/__EventListenerFixture__/app/SculpinKernel.php
new file mode 100644
index 00000000..07459e55
--- /dev/null
+++ b/src/Sculpin/Tests/Functional/__EventListenerFixture__/app/SculpinKernel.php
@@ -0,0 +1,11 @@
+<?php
+
+class SculpinKernel extends \Sculpin\Bundle\SculpinBundle\HttpKernel\AbstractKernel
+{
+    protected function getAdditionalSculpinBundles(): array
+    {
+        return [
+            \Sculpin\Tests\Functional\EventListenerTestFixtureBundle\EventListenerTestFixtureBundle::class,
+        ];
+    }
+}
diff --git a/src/Sculpin/Tests/Functional/__EventListenerFixture__/app/config/sculpin_kernel.yml b/src/Sculpin/Tests/Functional/__EventListenerFixture__/app/config/sculpin_kernel.yml
new file mode 100644
index 00000000..0be89f2c
--- /dev/null
+++ b/src/Sculpin/Tests/Functional/__EventListenerFixture__/app/config/sculpin_kernel.yml
@@ -0,0 +1,3 @@
+sculpin_content_types:
+    posts:
+      enabled: false
diff --git a/src/Sculpin/Tests/Functional/__EventListenerFixture__/app/config/sculpin_site.yml b/src/Sculpin/Tests/Functional/__EventListenerFixture__/app/config/sculpin_site.yml
new file mode 100644
index 00000000..f9aa7406
--- /dev/null
+++ b/src/Sculpin/Tests/Functional/__EventListenerFixture__/app/config/sculpin_site.yml
@@ -0,0 +1,4 @@
+title: "My Custom Title"
+subtitle: "Custom Subtitle"
+google_analytics_tracking_id: ''
+url: ''
diff --git a/src/Sculpin/Tests/Functional/__EventListenerFixture__/source/_views/default.html b/src/Sculpin/Tests/Functional/__EventListenerFixture__/source/_views/default.html
new file mode 100644
index 00000000..26fd8fd2
--- /dev/null
+++ b/src/Sculpin/Tests/Functional/__EventListenerFixture__/source/_views/default.html
@@ -0,0 +1,6 @@
+<html>
+<head><title>{{site.title}}</title></head>
+<body>
+{% block content_wrapper %}{% block content '' %}{% endblock content_wrapper %}
+</body>
+</html>
diff --git a/src/Sculpin/Tests/Functional/__EventListenerFixture__/source/index.md b/src/Sculpin/Tests/Functional/__EventListenerFixture__/source/index.md
new file mode 100644
index 00000000..7662ead3
--- /dev/null
+++ b/src/Sculpin/Tests/Functional/__EventListenerFixture__/source/index.md
@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+<h1>Welcome to {{site.title}}</h1>