Merge pull request #5383 from StackStorm/trigger_name_collission

`core.inject_trigger`: resolve `trigger` payload shadowing by renaming `trigger` param to `trigger_name` (backwards compatible)

Author: cognifloyd

CHANGELOG.rst

@@ -94,6 +94,11 @@ Fixed
 
   Contributed by @guzzijones
 
+* ``core.inject_trigger``: resolve ``trigger`` payload shadowing by deprecating ``trigger`` param in favor of ``trigger_name``.
+  ``trigger`` param is still available for backwards compatibility, but will be removed in a future release. #5335 and #5383
+
+  Contributed by @mjtice
+
 3.5.0 - June 23, 2021
 ---------------------
 

contrib/core/actions/inject_trigger.py

@@ -21,7 +21,7 @@
 
 
 class InjectTriggerAction(Action):
-    def run(self, trigger, payload=None, trace_tag=None):
+    def run(self, trigger=None, trigger_name=None, payload=None, trace_tag=None):
         payload = payload or {}
 
         datastore_service = self.action_service.datastore_service
@@ -32,6 +32,18 @@ def run(self, trigger, payload=None, trace_tag=None):
         # results in a TriggerInstanceDB database object creation or not. The object is created
         # inside rulesengine service and could fail due to the user providing an invalid trigger
         # reference or similar.
+
+        # Raise an error if both trigger and trigger_name are specified
+        if trigger and trigger_name:
+            raise ValueError(
+                "Parameters `trigger` and `trigger_name` are mutually exclusive."
+            )
+
+        # Raise an error if neither trigger nor trigger_name are specified
+        if not trigger and not trigger_name:
+            raise ValueError("You must include the `trigger_name` parameter.")
+
+        trigger = trigger if trigger else trigger_name
         self.logger.debug(
             'Injecting trigger "%s" with payload="%s"' % (trigger, str(payload))
         )

contrib/core/actions/inject_trigger.yaml

@@ -6,9 +6,15 @@ enabled: true
 entry_point: inject_trigger.py
 parameters:
   trigger:
+    type: string
+    description: |
+      Trigger reference (e.g. mypack.my_trigger).
+      This parameter is superceded by `trigger_name` but left for backwards compatibility.
+    required: false
+  trigger_name:
     type: string
     description: Trigger reference (e.g. mypack.my_trigger).
-    required: true
+    required: false
   payload:
     type: object
     description: Trigger payload.