messaging: Delay applying exchange/queue name prefix config

Exchanges are defined as module level vars initialized on import.
But, oslo_config is not setup yet at import time, so delay applying the
new prefix setting until just before they get created in RabbitMQ.

Luckily, Exchange() objects are lightweight objects that just
hold the exchange name and type. They could do more, but we
don't bind them to a channel. Because the exchange objects
merely hold strings, and because they are basically singletons
(module-level vars), we can safely update the exchange name
just before declaring it in RabbitMQ. From that point on,
everything that uses a singleton exchange object will get
the updated name.

Author: cognifloyd

st2common/st2common/config.py

@@ -408,7 +408,6 @@ def register_opts(ignore_errors=False):
             "prefix",
             default="st2",
             help="Prefix for all exchange and queue names.",
-            advanced=True,
         ),
     ]
 

st2common/st2common/services/sensor_watcher.py

@@ -21,7 +21,6 @@
 
 import six
 from kombu.mixins import ConsumerMixin
-from oslo_config import cfg
 
 from st2common import log as logging
 from st2common.transport import reactor, publishers
@@ -127,7 +126,7 @@ def stop(self):
     @staticmethod
     def _get_queue(queue_suffix):
         queue_name = queue_utils.get_queue_name(
-            queue_name_base=f"{cfg.CONF.messaging.prefix}.sensor.watch",
+            queue_name_base="st2.sensor.watch",
             queue_name_suffix=queue_suffix,
             add_random_uuid_to_suffix=True,
         )

st2common/st2common/services/triggerwatcher.py

@@ -18,7 +18,6 @@
 
 import six
 from kombu.mixins import ConsumerMixin
-from oslo_config import cfg
 
 from st2common import log as logging
 from st2common.persistence.trigger import Trigger
@@ -164,7 +163,7 @@ def _load_triggers_from_db(self):
     @staticmethod
     def _get_queue(queue_suffix, exclusive):
         queue_name = queue_utils.get_queue_name(
-            queue_name_base=f"{cfg.CONF.messaging.prefix}.trigger.watch",
+            queue_name_base="st2.trigger.watch",
             queue_name_suffix=queue_suffix,
             add_random_uuid_to_suffix=True,
         )

st2common/st2common/transport/actionalias.py

@@ -16,7 +16,6 @@
 
 from __future__ import absolute_import
 from kombu import Exchange, Queue
-from oslo_config import cfg
 
 from st2common.transport import publishers
 
@@ -25,7 +24,7 @@
     "get_queue",
 ]
 
-ACTIONALIAS_XCHG = Exchange(f"{cfg.CONF.messaging.prefix}.actionalias", type="topic")
+ACTIONALIAS_XCHG = Exchange("st2.actionalias", type="topic")
 
 
 class ActionAliasPublisher(publishers.CUDPublisher):

st2common/st2common/transport/actionexecutionstate.py

@@ -18,15 +18,12 @@
 from __future__ import absolute_import
 
 from kombu import Exchange, Queue
-from oslo_config import cfg
 
 from st2common.transport import publishers
 
 __all__ = ["ActionExecutionStatePublisher"]
 
-ACTIONEXECUTIONSTATE_XCHG = Exchange(
-    f"{cfg.CONF.messaging.prefix}.actionexecutionstate", type="topic"
-)
+ACTIONEXECUTIONSTATE_XCHG = Exchange("st2.actionexecutionstate", type="topic")
 
 
 class ActionExecutionStatePublisher(publishers.CUDPublisher):

st2common/st2common/transport/announcement.py

@@ -16,7 +16,6 @@
 from __future__ import absolute_import
 
 from kombu import Exchange, Queue
-from oslo_config import cfg
 
 from st2common import log as logging
 from st2common.constants.trace import TRACE_CONTEXT
@@ -28,7 +27,7 @@
 LOG = logging.getLogger(__name__)
 
 # Exchange for Announcements
-ANNOUNCEMENT_XCHG = Exchange(f"{cfg.CONF.messaging.prefix}.announcement", type="topic")
+ANNOUNCEMENT_XCHG = Exchange("st2.announcement", type="topic")
 
 
 class AnnouncementPublisher(object):

st2common/st2common/transport/bootstrap_utils.py

@@ -31,7 +31,7 @@
 from st2common.transport.actionexecutionstate import ACTIONEXECUTIONSTATE_XCHG
 from st2common.transport.announcement import ANNOUNCEMENT_XCHG
 from st2common.transport.connection_retry_wrapper import ConnectionRetryWrapper
-from st2common.transport.execution import EXECUTION_XCHG
+from st2common.transport.execution import EXECUTION_XCHG, EXECUTION_OUTPUT_XCHG
 from st2common.transport.liveaction import LIVEACTION_XCHG, LIVEACTION_STATUS_MGMT_XCHG
 from st2common.transport.reactor import SENSOR_CUD_XCHG
 from st2common.transport.reactor import TRIGGER_CUD_XCHG, TRIGGER_INSTANCE_XCHG
@@ -67,6 +67,7 @@
     ACTIONEXECUTIONSTATE_XCHG,
     ANNOUNCEMENT_XCHG,
     EXECUTION_XCHG,
+    EXECUTION_OUTPUT_XCHG,
     LIVEACTION_XCHG,
     LIVEACTION_STATUS_MGMT_XCHG,
     TRIGGER_CUD_XCHG,
@@ -94,16 +95,15 @@
     WORKFLOW_EXECUTION_RESUME_QUEUE,
     # Those queues are dynamically / late created on some class init but we still need to
     # pre-declare them for redis Kombu backend to work.
-    reactor.get_trigger_cud_queue(
-        name=f"{cfg.CONF.messaging.prefix}.preinit", routing_key="init"
-    ),
-    reactor.get_sensor_cud_queue(
-        name=f"{cfg.CONF.messaging.prefix}.preinit", routing_key="init"
-    ),
+    reactor.get_trigger_cud_queue(name="st2.preinit", routing_key="init"),
+    reactor.get_sensor_cud_queue(name="st2.preinit", routing_key="init"),
 ]
 
 
 def _do_register_exchange(exchange, connection, channel, retry_wrapper):
+    prefix = cfg.CONF.messaging.prefix
+    if exchange.name and prefix != "st2":
+        exchange.name = exchange.name.replace("st2.", f"{prefix}.", 1)
     try:
         kwargs = {
             "exchange": exchange.name,
@@ -127,6 +127,9 @@ def _do_register_exchange(exchange, connection, channel, retry_wrapper):
 
 
 def _do_predeclare_queue(channel, queue):
+    prefix = cfg.CONF.messaging.prefix
+    if queue.name and prefix != "st2":
+        queue.name = queue.name.replace("st2.", f"{prefix}.", 1)
     LOG.debug('Predeclaring queue for exchange "%s"' % (queue.exchange.name))
 
     bound_queue = None

st2common/st2common/transport/execution.py

@@ -17,7 +17,6 @@
 
 from __future__ import absolute_import
 from kombu import Exchange, Queue
-from oslo_config import cfg
 
 from st2common.transport import publishers
 
@@ -28,10 +27,8 @@
     "get_output_queue",
 ]
 
-EXECUTION_XCHG = Exchange(f"{cfg.CONF.messaging.prefix}.execution", type="topic")
-EXECUTION_OUTPUT_XCHG = Exchange(
-    f"{cfg.CONF.messaging.prefix}.execution.output", type="topic"
-)
+EXECUTION_XCHG = Exchange("st2.execution", type="topic")
+EXECUTION_OUTPUT_XCHG = Exchange("st2.execution.output", type="topic")
 
 
 class ActionExecutionPublisher(publishers.CUDPublisher):

st2common/st2common/transport/liveaction.py

@@ -18,17 +18,14 @@
 from __future__ import absolute_import
 
 from kombu import Exchange, Queue
-from oslo_config import cfg
 
 from st2common.transport import publishers
 
 __all__ = ["LiveActionPublisher", "get_queue", "get_status_management_queue"]
 
 
-LIVEACTION_XCHG = Exchange(f"{cfg.CONF.messaging.prefix}.liveaction", type="topic")
-LIVEACTION_STATUS_MGMT_XCHG = Exchange(
-    f"{cfg.CONF.messaging.prefix}.liveaction.status", type="topic"
-)
+LIVEACTION_XCHG = Exchange("st2.liveaction", type="topic")
+LIVEACTION_STATUS_MGMT_XCHG = Exchange("st2.liveaction.status", type="topic")
 
 
 class LiveActionPublisher(publishers.CUDPublisher, publishers.StatePublisherMixin):

st2common/st2common/transport/queues.py

@@ -23,7 +23,6 @@
 from __future__ import absolute_import
 
 from kombu import Queue
-from oslo_config import cfg
 
 from st2common.constants import action as action_constants
 from st2common.transport import actionalias
@@ -56,49 +55,49 @@
 
 # Used by the action scheduler service
 ACTIONSCHEDULER_REQUEST_QUEUE = liveaction.get_status_management_queue(
-    f"{cfg.CONF.messaging.prefix}.actionrunner.req",
+    "st2.actionrunner.req",
     routing_key=action_constants.LIVEACTION_STATUS_REQUESTED,
 )
 
 
 # Used by the action runner service
 ACTIONRUNNER_WORK_QUEUE = liveaction.get_status_management_queue(
-    f"{cfg.CONF.messaging.prefix}.actionrunner.work",
+    "st2.actionrunner.work",
     routing_key=action_constants.LIVEACTION_STATUS_SCHEDULED,
 )
 
 ACTIONRUNNER_CANCEL_QUEUE = liveaction.get_status_management_queue(
-    f"{cfg.CONF.messaging.prefix}.actionrunner.cancel",
+    "st2.actionrunner.cancel",
     routing_key=action_constants.LIVEACTION_STATUS_CANCELING,
 )
 
 ACTIONRUNNER_PAUSE_QUEUE = liveaction.get_status_management_queue(
-    f"{cfg.CONF.messaging.prefix}.actionrunner.pause",
+    "st2.actionrunner.pause",
     routing_key=action_constants.LIVEACTION_STATUS_PAUSING,
 )
 
 ACTIONRUNNER_RESUME_QUEUE = liveaction.get_status_management_queue(
-    f"{cfg.CONF.messaging.prefix}.actionrunner.resume",
+    "st2.actionrunner.resume",
     routing_key=action_constants.LIVEACTION_STATUS_RESUMING,
 )
 
 
 # Used by the notifier service
 NOTIFIER_ACTIONUPDATE_WORK_QUEUE = execution.get_queue(
-    f"{cfg.CONF.messaging.prefix}.notifiers.execution.work",
+    "st2.notifiers.execution.work",
     routing_key=publishers.UPDATE_RK,
 )
 
 
 # Used by the results tracker service
 RESULTSTRACKER_ACTIONSTATE_WORK_QUEUE = actionexecutionstate.get_queue(
-    f"{cfg.CONF.messaging.prefix}.resultstracker.work", routing_key=publishers.CREATE_RK
+    "st2.resultstracker.work", routing_key=publishers.CREATE_RK
 )
 
 
 # Used by the rules engine service
 RULESENGINE_WORK_QUEUE = reactor.get_trigger_instances_queue(
-    name=f"{cfg.CONF.messaging.prefix}.trigger_instances_dispatch.rules_engine",
+    name="st2.trigger_instances_dispatch.rules_engine",
     routing_key="#",
 )
 
@@ -137,16 +136,16 @@
 
 # Used by the workflow engine service
 WORKFLOW_EXECUTION_WORK_QUEUE = workflow.get_status_management_queue(
-    name=f"{cfg.CONF.messaging.prefix}.workflow.work",
+    name="st2.workflow.work",
     routing_key=action_constants.LIVEACTION_STATUS_REQUESTED,
 )
 
 WORKFLOW_EXECUTION_RESUME_QUEUE = workflow.get_status_management_queue(
-    name=f"{cfg.CONF.messaging.prefix}.workflow.resume",
+    name="st2.workflow.resume",
     routing_key=action_constants.LIVEACTION_STATUS_RESUMING,
 )
 
 WORKFLOW_ACTION_EXECUTION_UPDATE_QUEUE = execution.get_queue(
-    f"{cfg.CONF.messaging.prefix}.workflow.action.update",
+    "st2.workflow.action.update",
     routing_key=publishers.UPDATE_RK,
 )