misc: support email and ui plugin configuration through helm values

Author: aarthy-dk

cli/entry_points/init.py

@@ -168,7 +168,7 @@ def initialize_database(self) -> None:
                         description="This key is utilized by the product demo",
                     )
 
-                    action_args = {"from_address": "notify@example.com", "recipients": [], "template": "NotifyTemplate"}
+                    action_args = {"recipients": [], "template": "NotifyTemplate"}
                     action = Action.create(
                         name="Send Email", action_impl="SEND_EMAIL", company=company, action_args=action_args
                     )

common/actions/send_email_action.py

@@ -19,7 +19,7 @@
 
 
 class SendEmailAction(BaseAction):
-    required_arguments = {"from_address", "recipients", "template"}
+    required_arguments = {"recipients", "template"}
     requires_action_template = True
 
     def _run(self, event: EVENT_TYPE, rule: Rule, journey_id: Optional[UUID]) -> ActionResult:
@@ -29,8 +29,8 @@ def _run(self, event: EVENT_TYPE, rule: Rule, journey_id: Optional[UUID]) -> Act
             return ActionResult(False, None, e)
         try:
             response = EmailService.send_email(
-                self.arguments["smtp_config"],
-                self.arguments["from_address"],
+                self.arguments.get("smtp_config", {}),
+                self.arguments.get("from_address"),
                 self.arguments["recipients"],
                 self.arguments["template"],
                 context,

common/email/email_service.py

@@ -17,12 +17,13 @@ class EmailService:
     @staticmethod
     def send_email(
         smtp_config: dict,
-        from_address: str,
+        from_address: str | None,
         recipients: list[str],
         template_name: str,
         template_context_vars: Mapping,
     ) -> dict:
         try:
+            from_address = from_address or settings.SMTP["from_address"]
             content, subject = HandlebarsEmailRenderer.render(template_name, template_context_vars)
             context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
             message = MIMEMultipart("alternative")

common/schemas/action_schemas.py

@@ -16,7 +16,7 @@ class SMTPConfigSchema(Schema):
 
 
 class EmailActionArgsSchema(Schema):
-    from_address = Str(validate=not_empty(max=255))
+    from_address = Str(required=False, validate=not_empty(max=255))
     template = Str(validate=not_empty(max=255))
     recipients = List(Email(), required=True, validate=Length(max=50))
     smtp_config = Nested(SMTPConfigSchema(), required=False)

common/tests/unit/actions/test_send_email_action.py

@@ -58,7 +58,7 @@ def test_send_email_constructor(action):
 
 
 @pytest.mark.unit
-@pytest.mark.parametrize("argument", ("template", "from_address", "recipients"))
+@pytest.mark.parametrize("argument", ("template", "recipients"))
 def test_send_email_constructor_missing_action_argument(argument, action):
     rule_action_args = {"template": "TestTemplateNested", "recipients": ["a@example.com"]}
     action.action_args = {"from_address": "test@domain.com", "recipients": ["success@example.com"]}

conf/cloud.py

@@ -32,5 +32,6 @@ class ReconnectingPooledMySQLDatabase(ReconnectMixin, PooledMySQLDatabase):
     "password": os.environ.get("SMTP_PASSWORD"),
     "endpoint": os.environ.get("SMTP_ENDPOINT"),
     "port": int(os.environ.get("SMTP_PORT", 465)),
+    "from_address": os.environ.get("SMTP_FROM_ADDRESS"),
 }
 """Settings for connecting to the SMTP email server."""

conf/minikube.py

@@ -28,3 +28,13 @@ class ReconnectingPooledMySQLDatabase(ReconnectMixin, PooledMySQLDatabase):
 
 RULE_REFRESH_SECONDS = 1
 """Number of seconds to cache rules in rules engine"""
+
+
+SMTP: dict[str, object] = {
+    "username": os.environ.get("SMTP_USER"),
+    "password": os.environ.get("SMTP_PASSWORD"),
+    "endpoint": os.environ.get("SMTP_ENDPOINT"),
+    "port": int(os.environ.get("SMTP_PORT", 465)),
+    "from_address": os.environ.get("SMTP_FROM_ADDRESS"),
+}
+"""Settings for connecting to the SMTP email server."""

conf/test.py

@@ -16,5 +16,6 @@
     "password": "",
     "endpoint": "",
     "port": 25,
+    "from_address": "",
 }
 """Dummy SMTP parameters to please unit tests."""

deploy/charts/observability-app/templates/_environments.tpl

@@ -82,5 +82,22 @@ Environment
     secretKeyRef:
       name: {{ .Values.observability.services_secrets_name | quote }}
       key: SMTP_PASSWORD
+- name: SMTP_FROM_ADDRESS
+  valueFrom:
+    secretKeyRef:
+      name: {{ .Values.observability.services_secrets_name | quote }}
+      key: SMTP_FROM_ADDRESS
+      optional: true
+{{- else if .Values.observability.smtp -}}
+- name: SMTP_ENDPOINT
+  value: {{ .Values.observability.smtp.endpoint | quote }}
+- name: SMTP_PORT
+  value: {{ .Values.observability.smtp.port | quote }}
+- name: SMTP_USER
+  value: {{ .Values.observability.smtp.user | quote }}
+- name: SMTP_PASSWORD
+  value: {{ .Values.observability.smtp.password | quote }}
+- name: SMTP_FROM_ADDRESS
+  value: {{ .Values.observability.smtp.from_address | quote }}
 {{- end -}}
 {{- end -}}

deploy/charts/observability-app/templates/observability-ui.yaml

@@ -30,14 +30,20 @@ spec:
       serviceAccountName: {{ include "observability.serviceAccountName" . }}
       securityContext:
         {{- toYaml .Values.observability_ui.podSecurityContext | nindent 8 }}
-      {{- if .Values.observability_ui.environmentJson }}
+      {{- if or .Values.observability_ui.environmentJson .Values.observability_ui.manifestJson }}
       volumes:
         - name: {{ include "observability.observability_ui.name" . }}-configmap-volume
           configMap:
             name: {{ include "observability.observability_ui.name" . }}-configmap
             items:
+            {{- if .Values.observability_ui.environmentJson }}
               - key: "environment.json"
                 path: "environment.json"
+            {{- end }}
+            {{- if .Values.observability_ui.manifestJson }}
+              - key: "module-federation.manifest.json"
+                path: "module-federation.manifest.json"
+            {{- end }}
       {{- end }}
       containers:
         - name: {{ include "observability.observability_ui.name" . }}
@@ -51,16 +57,29 @@ spec:
               protocol: TCP
           resources:
             {{- toYaml .Values.observability_ui.resources | nindent 12 }}
-          {{- if .Values.observability_api.hostname }}
           env:
+            {{- if .Values.observability_api.hostname }}
             - name: OBSERVABILITY_API_HOSTNAME
               value: {{ tpl .Values.observability_api.hostname . | quote }}
-          {{- end }}
-          {{- if .Values.observability_ui.environmentJson }}
+            {{- end }}
+            {{- if .Values.observability_ui.csp_extra }}
+            - name: OBSERVABILITY_CSP_EXTRA
+              value: {{ tpl .Values.observability_ui.csp_extra . | quote }}
+            {{- end }}
+          {{- if or .Values.observability_ui.environmentJson .Values.observability_ui.manifestJson }}
           volumeMounts:
-            - mountPath: /observability_ui/shell/environments
+            {{- if .Values.observability_ui.environmentJson }}
+            - mountPath: /observability_ui/shell/environments/environment.json
+              name: {{ include "observability.observability_ui.name" . }}-configmap-volume
+              readOnly: true
+              subPath: environment.json
+            {{- end }}
+            {{- if .Values.observability_ui.manifestJson }}
+            - mountPath: /observability_ui/shell/assets/module-federation.manifest.json
               name: {{ include "observability.observability_ui.name" . }}-configmap-volume
               readOnly: true
+              subPath: module-federation.manifest.json
+            {{- end }}
           {{- end }}
       {{- with .Values.observability_ui.nodeSelector }}
       nodeSelector:
@@ -96,7 +115,7 @@ spec:
       {{- end }}
   selector:
     {{- include "observability.observability_ui.selectorLabels" . | nindent 4 }}
-{{- if .Values.observability_ui.environmentJson }}
+{{- if or .Values.observability_ui.environmentJson .Values.observability_ui.manifestJson }}
 ---
 apiVersion: v1
 kind: ConfigMap
@@ -106,6 +125,11 @@ metadata:
     {{- include "observability.labels" . | nindent 4 }}
     {{- include "observability.observability_ui.selectorLabels" . | nindent 4 }}
 data:
+  {{- if .Values.observability_ui.environmentJson }}
   environment.json: {{ .Values.observability_ui.environmentJson | toPrettyJson | quote }}
+  {{- end }}
+  {{- if .Values.observability_ui.manifestJson }}
+  module-federation.manifest.json: {{ .Values.observability_ui.manifestJson | toPrettyJson | quote }}
+  {{- end }}
 {{- end }}
 {{- end }}