bug #53960 [Messenger] the 'use_notify' option is on the factory, not on the postgres connection (dbu)

nicolas-grekas · nicolas-grekas · commit 208f6d927704 · 2024-02-22T13:39:14.000-05:00
This PR was merged into the 5.4 branch. Discussion ---------- [Messenger] the 'use_notify' option is on the factory, not on the postgres connection | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes (documentation bug) | New feature? | no | Deprecations? | yes/no i think not - or do we consider removing the unused `use_notify` from PostgreSqlConnection::DEFAULT_OPTIONS a BC break? then we would have to leave it there but comment that it is unused | Issues | - | License | MIT I was debugging messenger not seeing updates and stumbled over this. I guess things changed before release or had been different in older versions. (side note: listen/notify does not work for me when using the symfony skeleton setup, so i had to disable the mechanism. i assume it is cheaper to try to install the listener on each `get` than querying the messages table? a little bit of documentation as to why the functionality is used would not hurt) Commits ------- 2b82b4a the 'use_notify' option is on the factory, not on the postgres connection class
diff --git a/src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/DoctrineTransportFactory.php b/src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/DoctrineTransportFactory.php
@@ -35,6 +35,9 @@ public function __construct($registry)
         $this->registry = $registry;
     }
 
+    /**
+     * @param array $options You can set 'use_notify' to false to not use LISTEN/NOTIFY with postgresql
+     */
     public function createTransport(string $dsn, array $options, SerializerInterface $serializer): TransportInterface
     {
         $useNotify = ($options['use_notify'] ?? true);
diff --git a/src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/PostgreSqlConnection.php b/src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/PostgreSqlConnection.php
@@ -16,19 +16,19 @@
 /**
  * Uses PostgreSQL LISTEN/NOTIFY to push messages to workers.
  *
+ * If you do not want to use the LISTEN mechanism, set the `use_notify` option to `false` when calling DoctrineTransportFactory::createTransport.
+ *
  * @internal
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
 final class PostgreSqlConnection extends Connection
 {
     /**
-     * * use_notify: Set to false to disable the use of LISTEN/NOTIFY. Default: true
      * * check_delayed_interval: The interval to check for delayed messages, in milliseconds. Set to 0 to disable checks. Default: 60000 (1 minute)
      * * get_notify_timeout: The length of time to wait for a response when calling PDO::pgsqlGetNotify, in milliseconds. Default: 0.
      */
     protected const DEFAULT_OPTIONS = parent::DEFAULT_OPTIONS + [
-        'use_notify' => true,
         'check_delayed_interval' => 60000,
         'get_notify_timeout' => 0,
     ];

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,9 @@ public function __construct($registry)`
`35`	`35`	`$this->registry = $registry;`
`36`	`36`	`}`
`37`	`37`
	`38`	`+ /**`
	`39`	`+ * @param array $options You can set 'use_notify' to false to not use LISTEN/NOTIFY with postgresql`
	`40`	`+ */`
`38`	`41`	`public function createTransport(string $dsn, array $options, SerializerInterface $serializer): TransportInterface`
`39`	`42`	`{`
`40`	`43`	`$useNotify = ($options['use_notify'] ?? true);`