[bundle] Set null transport as default. Prevent errors on bundle install.

Author: makasim

DependencyInjection/EnqueueExtension.php

@@ -4,6 +4,8 @@
 
 use Enqueue\Client\TraceableProducer;
 use Enqueue\JobQueue\Job;
+use Enqueue\Null\Symfony\NullTransportFactory;
+use Enqueue\Symfony\DefaultTransportFactory;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Resource\FileResource;
@@ -23,6 +25,9 @@ class EnqueueExtension extends Extension implements PrependExtensionInterface
     public function __construct()
     {
         $this->factories = [];
+
+        $this->addTransportFactory(new DefaultTransportFactory());
+        $this->addTransportFactory(new NullTransportFactory());
     }
 
     /**
@@ -47,6 +52,14 @@ public function addTransportFactory(TransportFactoryInterface $transportFactory)
      */
     public function load(array $configs, ContainerBuilder $container)
     {
+        // enable null transport by default.
+        array_unshift($configs, [
+            'transport' => [
+                'default' => 'null',
+                'null' => [],
+            ]
+        ]);
+
         $config = $this->processConfiguration(new Configuration($this->factories), $configs);
 
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));

EnqueueBundle.php

@@ -44,8 +44,6 @@ public function build(ContainerBuilder $container)
 
         /** @var EnqueueExtension $extension */
         $extension = $container->getExtension('enqueue');
-        $extension->addTransportFactory(new DefaultTransportFactory());
-        $extension->addTransportFactory(new NullTransportFactory());
 
         if (class_exists(StompContext::class)) {
             $extension->addTransportFactory(new StompTransportFactory());

Tests/Unit/DependencyInjection/EnqueueExtensionTest.php

@@ -9,6 +9,7 @@
 use Enqueue\Client\TraceableProducer;
 use Enqueue\Symfony\DefaultTransportFactory;
 use Enqueue\Null\Symfony\NullTransportFactory;
+use Enqueue\Symfony\TransportFactoryInterface;
 use Enqueue\Test\ClassExtensionTrait;
 use Enqueue\Null\NullContext;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -30,6 +31,25 @@ public function testCouldBeConstructedWithoutAnyArguments()
         new EnqueueExtension();
     }
 
+    public function testShouldRegisterDefaultAndNullTransportFactoriesInConstructor()
+    {
+        $extension = new EnqueueExtension();
+
+        /** @var TransportFactoryInterface[] $factories */
+        $factories = $this->readAttribute($extension, 'factories');
+
+        $this->assertInternalType('array', $factories);
+        $this->assertCount(2, $factories);
+
+        $this->assertArrayHasKey('default', $factories);
+        $this->assertInstanceOf(DefaultTransportFactory::class, $factories['default']);
+        $this->assertEquals('default', $factories['default']->getName());
+
+        $this->assertArrayHasKey('null', $factories);
+        $this->assertInstanceOf(NullTransportFactory::class, $factories['null']);
+        $this->assertEquals('null', $factories['null']->getName());
+    }
+
     public function testThrowIfTransportFactoryNameEmpty()
     {
         $extension = new EnqueueExtension();
@@ -52,31 +72,32 @@ public function testThrowIfTransportFactoryWithSameNameAlreadyAdded()
         $extension->addTransportFactory(new FooTransportFactory('foo'));
     }
 
-    public function testShouldConfigureNullTransport()
+    public function testShouldEnabledNullTransportAndSetItAsDefault()
     {
         $container = new ContainerBuilder();
 
         $extension = new EnqueueExtension();
-        $extension->addTransportFactory(new NullTransportFactory());
 
         $extension->load([[
             'transport' => [
+                'default' => 'null',
                 'null' => true,
             ],
         ]], $container);
 
+        self::assertTrue($container->hasAlias('enqueue.transport.default.context'));
+        self::assertEquals('enqueue.transport.null.context', (string) $container->getAlias('enqueue.transport.default.context'));
+
         self::assertTrue($container->hasDefinition('enqueue.transport.null.context'));
         $context = $container->getDefinition('enqueue.transport.null.context');
         self::assertEquals(NullContext::class, $context->getClass());
     }
 
-    public function testShouldUseNullTransportAsDefault()
+    public function testShouldUseNullTransportAsDefaultWhenExplicitlyConfigured()
     {
         $container = new ContainerBuilder();
 
         $extension = new EnqueueExtension();
-        $extension->addTransportFactory(new NullTransportFactory());
-        $extension->addTransportFactory(new DefaultTransportFactory());
 
         $extension->load([[
             'transport' => [
@@ -120,7 +141,6 @@ public function testShouldUseFooTransportAsDefault()
 
         $extension = new EnqueueExtension();
         $extension->addTransportFactory(new FooTransportFactory());
-        $extension->addTransportFactory(new DefaultTransportFactory());
 
         $extension->load([[
             'transport' => [
@@ -144,7 +164,6 @@ public function testShouldLoadClientServicesWhenEnabled()
         $container = new ContainerBuilder();
 
         $extension = new EnqueueExtension();
-        $extension->addTransportFactory(new DefaultTransportFactory());
         $extension->addTransportFactory(new FooTransportFactory());
 
         $extension->load([[
@@ -167,7 +186,6 @@ public function testShouldUseProducerByDefault()
         $container->setParameter('kernel.debug', false);
 
         $extension = new EnqueueExtension();
-        $extension->addTransportFactory(new DefaultTransportFactory());
         $extension->addTransportFactory(new FooTransportFactory());
 
         $extension->load([[
@@ -190,7 +208,6 @@ public function testShouldUseMessageProducerIfTraceableProducerOptionSetToFalseE
         $container->setParameter('kernel.debug', false);
 
         $extension = new EnqueueExtension();
-        $extension->addTransportFactory(new DefaultTransportFactory());
         $extension->addTransportFactory(new FooTransportFactory());
 
         $extension->load([[
@@ -215,7 +232,6 @@ public function testShouldUseTraceableMessageProducerIfTraceableProducerOptionSe
         $container->setParameter('kernel.debug', true);
 
         $extension = new EnqueueExtension();
-        $extension->addTransportFactory(new DefaultTransportFactory());
         $extension->addTransportFactory(new FooTransportFactory());
 
         $extension->load([[
@@ -250,7 +266,6 @@ public function testShouldLoadDelayRedeliveredMessageExtensionIfRedeliveredDelay
         $container->setParameter('kernel.debug', true);
 
         $extension = new EnqueueExtension();
-        $extension->addTransportFactory(new DefaultTransportFactory());
         $extension->addTransportFactory(new FooTransportFactory());
 
         $extension->load([[
@@ -276,7 +291,6 @@ public function testShouldNotLoadDelayRedeliveredMessageExtensionIfRedeliveredDe
         $container->setParameter('kernel.debug', true);
 
         $extension = new EnqueueExtension();
-        $extension->addTransportFactory(new DefaultTransportFactory());
         $extension->addTransportFactory(new FooTransportFactory());
 
         $extension->load([[

Tests/Unit/EnqueueBundleTest.php

@@ -84,28 +84,6 @@ public function testShouldRegisterExpectedCompilerPasses()
         $bundle->build($container);
     }
 
-    public function testShouldRegisterDefaultAndNullTransportFactories()
-    {
-        $extensionMock = $this->createEnqueueExtensionMock();
-
-        $container = new ContainerBuilder();
-        $container->registerExtension($extensionMock);
-
-        $extensionMock
-            ->expects($this->at(0))
-            ->method('addTransportFactory')
-            ->with($this->isInstanceOf(DefaultTransportFactory::class))
-        ;
-        $extensionMock
-            ->expects($this->at(1))
-            ->method('addTransportFactory')
-            ->with($this->isInstanceOf(NullTransportFactory::class))
-        ;
-
-        $bundle = new EnqueueBundle();
-        $bundle->build($container);
-    }
-
     public function testShouldRegisterStompAndRabbitMqStompTransportFactories()
     {
         $extensionMock = $this->createEnqueueExtensionMock();
@@ -114,12 +92,12 @@ public function testShouldRegisterStompAndRabbitMqStompTransportFactories()
         $container->registerExtension($extensionMock);
 
         $extensionMock
-            ->expects($this->at(2))
+            ->expects($this->at(0))
             ->method('addTransportFactory')
             ->with($this->isInstanceOf(StompTransportFactory::class))
         ;
         $extensionMock
-            ->expects($this->at(3))
+            ->expects($this->at(1))
             ->method('addTransportFactory')
             ->with($this->isInstanceOf(RabbitMqStompTransportFactory::class))
         ;
@@ -136,12 +114,12 @@ public function testShouldRegisterAmqpAndRabbitMqAmqpTransportFactories()
         $container->registerExtension($extensionMock);
 
         $extensionMock
-            ->expects($this->at(4))
+            ->expects($this->at(2))
             ->method('addTransportFactory')
             ->with($this->isInstanceOf(AmqpTransportFactory::class))
         ;
         $extensionMock
-            ->expects($this->at(5))
+            ->expects($this->at(3))
             ->method('addTransportFactory')
             ->with($this->isInstanceOf(RabbitMqAmqpTransportFactory::class))
         ;
@@ -158,7 +136,7 @@ public function testShouldRegisterFSTransportFactory()
         $container->registerExtension($extensionMock);
 
         $extensionMock
-            ->expects($this->at(6))
+            ->expects($this->at(4))
             ->method('addTransportFactory')
             ->with($this->isInstanceOf(FsTransportFactory::class))
         ;
@@ -175,7 +153,7 @@ public function testShouldRegisterRedisTransportFactory()
         $container->registerExtension($extensionMock);
 
         $extensionMock
-            ->expects($this->at(7))
+            ->expects($this->at(5))
             ->method('addTransportFactory')
             ->with($this->isInstanceOf(RedisTransportFactory::class))
         ;
@@ -192,7 +170,7 @@ public function testShouldRegisterDbalTransportFactory()
         $container->registerExtension($extensionMock);
 
         $extensionMock
-            ->expects($this->at(8))
+            ->expects($this->at(6))
             ->method('addTransportFactory')
             ->with($this->isInstanceOf(DbalTransportFactory::class))
         ;
@@ -209,7 +187,7 @@ public function testShouldRegisterSqsTransportFactory()
         $container->registerExtension($extensionMock);
 
         $extensionMock
-            ->expects($this->at(9))
+            ->expects($this->at(7))
             ->method('addTransportFactory')
             ->with($this->isInstanceOf(SqsTransportFactory::class))
         ;