Adds the ability for signal definitions to be disabled (#3042)

src/dispatch/database/revisions/tenant/versions/2023-03-02_5955ed5f76b4.py

@@ -0,0 +1,27 @@
+"""Adds the ability to toggle signal definitions.
+
+Revision ID: 5955ed5f76b4
+Revises: 20d3801ad5b7
+Create Date: 2023-03-02 11:12:18.168787
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+# revision identifiers, used by Alembic.
+revision = "5955ed5f76b4"
+down_revision = "20d3801ad5b7"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column("signal", sa.Column("enabled", sa.Boolean(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("signal", "enabled")
+    # ### end Alembic commands ###

src/dispatch/signal/flows.py

@@ -19,6 +19,9 @@ def create_signal_instance(
         variant=signal_instance_data.variant,
     )
 
+    if not signal.enabled:
+        raise Exception("Signal definition is not enabled.")
+
     if not signal:
         raise Exception("No signal definition defined.")
 

src/dispatch/signal/models.py

@@ -120,6 +120,7 @@ class Signal(Base, TimeStampMixin, ProjectMixin):
     source_id = Column(Integer, ForeignKey("source.id"))
     variant = Column(String)
     loopin_signal_identity = Column(Boolean, default=False)
+    enabled = Column(Boolean, default=False)
     case_type_id = Column(Integer, ForeignKey(CaseType.id))
     case_type = relationship("CaseType", backref="signals")
     case_priority_id = Column(Integer, ForeignKey(CasePriority.id))
@@ -211,6 +212,7 @@ class SignalBase(DispatchBase):
     case_type: Optional[CaseTypeRead]
     case_priority: Optional[CasePriorityRead]
     external_id: str
+    enabled: Optional[bool] = False
     external_url: Optional[str]
     source: Optional[SourceBase]
     created_at: Optional[datetime] = None

src/dispatch/static/dispatch/src/signal/NewEditDialog.vue

@@ -113,6 +113,13 @@
                     />
                   </ValidationProvider>
                 </v-col>
+                <v-col cols="12">
+                  <v-checkbox
+                    v-model="enabled"
+                    label="Enabled"
+                    hint="Determines whether this signal definition is currently active and should be used to process signals."
+                  />
+                </v-col>
                 <v-col cols="12">
                   <tag-filter-auto-complete
                     label="Tags"
@@ -235,6 +242,7 @@ export default {
       "selected.id",
       "selected.name",
       "selected.description",
+      "selected.enabled",
       "selected.variant",
       "selected.owner",
       "selected.external_id",

src/dispatch/static/dispatch/src/signal/store.js

@@ -15,6 +15,7 @@ const getDefaultSelectedState = () => {
     external_url: null,
     case_type: null,
     case_priority: null,
+    enabled: false,
     filters: null,
     entity_types: null,
     tags: null,