FORMS-1671: Connect to ESS via NATS protocol (#1547)

* FORMS-1671: Connect to ESS via NATS protocol Signed-off-by: Jason Sherman <[email protected]> * add some ux tests Signed-off-by: Jason Sherman <[email protected]> --------- Signed-off-by: Jason Sherman <[email protected]>
bcgov · Jan 10, 2025 · 0ef4394 · 0ef4394
1 parent 678e5e6
commit 0ef4394
Show file tree

Hide file tree

Showing 11 changed files with 68 additions and 23 deletions.
diff --git a/.devcontainer/chefs_local/test.json b/.devcontainer/chefs_local/test.json
@@ -63,6 +63,8 @@
   },
   "eventStreamService": {
     "servers": "localhost:4222,localhost:4223,localhost:4224",
+    "websockets": "false",
+    "consumerservers": "localhost:4222,localhost:4223,localhost:4224",
     "streamName": "CHEFS",
     "source": "chefs",
     "domain": "forms",

diff --git a/app/config/custom-environment-variables.json b/app/config/custom-environment-variables.json
@@ -61,6 +61,7 @@
   "eventStreamService": {
     "servers": "EVENTSTREAMSERVICE_SERVERS",
     "websockets": "EVENTSTREAMSERVICE_WEBSOCKETS",
+    "consumerservers": "EVENTSTREAMSERVICE_CONSUMERSERVERS",
     "streamName": "EVENTSTREAMSERVICE_STREAMNAME",
     "source": "EVENTSTREAMSERVICE_SOURCE",
     "domain": "EVENTSTREAMSERVICE_DOMAIN",

diff --git a/app/config/default.json b/app/config/default.json
@@ -65,6 +65,7 @@
   "eventStreamService": {
     "servers": "localhost:4222,localhost:4223,localhost:4224",
     "websockets": "false",
+    "consumerservers": "localhost:4222,localhost:4223,localhost:4224",
     "streamName": "CHEFS",
     "source": "chefs-local",
     "domain": "forms",

diff --git a/app/frontend/src/components/designer/settings/FormEventStreamSettings.vue b/app/frontend/src/components/designer/settings/FormEventStreamSettings.vue
@@ -126,16 +126,16 @@ defineExpose({
           <span :lang="locale" class="font-weight-bold"
             >{{ $t('trans.formSettings.serversLabel') }}:
           </span>
-          <span class="ml-2">{{
-            appStore.config?.eventStreamService?.servers
+          <span class="ml-2" data-test="consumerservers">{{
+            appStore.config?.eventStreamService?.consumerservers
           }}</span>
         </span>
         <br />
         <span>
           <span :lang="locale" class="font-weight-bold"
             >{{ $t('trans.formSettings.streamNameLabel') }}:
           </span>
-          <span class="ml-2">{{
+          <span class="ml-2" data-test="streamName">{{
             appStore.config?.eventStreamService?.streamName
           }}</span>
         </span>
@@ -144,7 +144,7 @@ defineExpose({
           <span :lang="locale" class="font-weight-bold"
             >{{ $t('trans.formSettings.sourceLabel') }}:
           </span>
-          <span class="ml-2">{{
+          <span class="ml-2" data-test="source">{{
             appStore.config?.eventStreamService?.source
           }}</span>
         </span>
@@ -153,7 +153,7 @@ defineExpose({
           <span :lang="locale" class="font-weight-bold"
             >{{ $t('trans.formSettings.domainLabel') }}:
           </span>
-          <span class="ml-2">{{
+          <span class="ml-2" data-test="domain">{{
             appStore.config?.eventStreamService?.domain
           }}</span>
         </span>

diff --git a/app/frontend/tests/unit/components/designer/settings/FormEventStreamSettings.spec.js b/app/frontend/tests/unit/components/designer/settings/FormEventStreamSettings.spec.js
@@ -4,6 +4,7 @@ import { setActivePinia } from 'pinia';
 import { beforeEach, describe, expect, it } from 'vitest';
 import { ref } from 'vue';
 
+import { useAppStore } from '~/store/app';
 import { useFormStore } from '~/store/form';
 import FormEventStreamSettings from '~/components/designer/settings/FormEventStreamSettings.vue';
 
@@ -12,11 +13,41 @@ describe('FormEventStreamSettings.vue', () => {
   setActivePinia(pinia);
 
   const formStore = useFormStore(pinia);
+  const appStore = useAppStore(pinia);
 
   beforeEach(() => {
+    appStore.$reset();
     formStore.$reset();
   });
 
+  it('renders eventStreamService configuration', async () => {
+    appStore.config = ref({
+      eventStreamService: {
+        consumerservers: 'http://consumerservers.com',
+        streamName: 'stream',
+        source: 'src',
+        domain: 'domain',
+      },
+    });
+    const wrapper = mount(FormEventStreamSettings, {
+      global: {
+        plugins: [pinia],
+        stubs: {
+          BasePanel: {
+            name: 'BasePanel',
+            template: '<div class="base-panel-stub"><slot /></div>',
+          },
+        },
+      },
+    });
+    expect(wrapper.find('[data-test="consumerservers"]').text()).toContain(
+      'http://consumerservers.com'
+    );
+    expect(wrapper.find('[data-test="streamName"]').text()).toContain('stream');
+    expect(wrapper.find('[data-test="source"]').text()).toContain('src');
+    expect(wrapper.find('[data-test="domain"]').text()).toContain('domain');
+  });
+
   it('generates an encryption key when it has an algorithm', async () => {
     formStore.form = ref({
       eventStreamConfig: {

diff --git a/openshift/README.md b/openshift/README.md
@@ -148,18 +148,14 @@ oc create -n $NAMESPACE secret generic $APP_NAME-encryption-keys \
   --from-literal=proxy=$proxy_key
 ```
 
-We need to store a password for Event Stream Service client. Since the server(s) will change along with the password, we will store the server and credentials in a secret per environment (DEV, TEST, PROD) and whether we connect with WebSockets or NATS protocols Pull requests can use the same as DEV.
+We need to store a username/password for Event Stream Service client. Additional configuration (Stream name, servers, stream limits) is in a Config Map: `chefs-XXX-event-stream-service`.
 
 ```sh
 
-export ess_servers=<comma separated list of event stream servers>
-export ess_websockets=<true/false - true if connection is made via websockets>
 export ess_password=<chefs password from event stream service>
 
 oc create -n $NAMESPACE secret generic $APP_NAME-event-stream-service \
   --type=Opaque \
-  --from-literal=servers=$ess_servers \
-  --from-literal=websockets=$ess_websockets \
   --from-literal=username=chefs \
   --from-literal=password=$ess_password
 ```

diff --git a/openshift/app.dc.yaml b/openshift/app.dc.yaml
@@ -233,16 +233,6 @@ objects:
                     secretKeyRef:
                       key: mailapitoken
                       name: "chefs-${JOB_NAME}-secret"
-                - name: EVENTSTREAMSERVICE_SERVERS
-                  valueFrom:
-                    secretKeyRef:
-                      key: servers
-                      name: "${APP_NAME}-event-stream-service"
-                - name: EVENTSTREAMSERVICE_WEBSOCKETS
-                  valueFrom:
-                    secretKeyRef:
-                      key: websockets
-                      name: "${APP_NAME}-event-stream-service"
                 - name: EVENTSTREAMSERVICE_USERNAME
                   valueFrom:
                     secretKeyRef:

diff --git a/openshift/ess.cm.yaml b/openshift/ess.cm.yaml
@@ -17,6 +17,9 @@ objects:
     metadata:
       name: "${APP_NAME}-${JOB_NAME}-event-stream-service"
     data:
+      EVENTSTREAMSERVICE_SERVERS: ${SERVERS}
+      EVENTSTREAMSERVICE_WEBSOCKETS: ${WEBSOCKETS}
+      EVENTSTREAMSERVICE_CONSUMERSERVERS: ${CONSUMERSERVERS}
       EVENTSTREAMSERVICE_STREAMNAME: ${STREAMNAME}
       EVENTSTREAMSERVICE_SOURCE: ${SOURCE}
       EVENTSTREAMSERVICE_DOMAIN: ${DOMAIN}
@@ -35,6 +38,18 @@ parameters:
     description: Job identifier (i.e. 'pr-5' OR 'master')
     displayName: Job Branch Name
     required: true
+  - name: SERVERS
+    description: Comma separated list of NATS servers for Event Stream Service
+    displayName: Event Stream NATS servers
+    required: true
+  - name: WEBSOCKETS
+    description: Connect to ESS via websockets or NATS protocol
+    displayName: Connect with websockets
+    required: true
+  - name: CONSUMERSERVERS
+    description: ESS Servers for consumer configuration
+    displayName: ESS Servers (consumers)
+    required: true
   - name: STREAMNAME
     description: Name of the CHEFS Event Stream
     displayName: CHEFS Event Stream name

diff --git a/openshift/ess.dev.param b/openshift/ess.dev.param
@@ -6,4 +6,7 @@ MAXBYTES="966367641"
 MAXMSGS="1000"
 MAXMSGSIZE="966367"
 DUPLICATEWINDOW="60000"
-NUMREPLICAS="3"
+NUMREPLICAS="3"
+SERVERS=ess-nats.a191b5-dev.svc.cluster.local
+WEBSOCKETS=false
+CONSUMERSERVERS=stream-dev.apps.silver.devops.gov.bc.ca
diff --git a/openshift/ess.prod.param b/openshift/ess.prod.param
@@ -6,4 +6,7 @@ MAXBYTES="966367641"
 MAXMSGS="1000"
 MAXMSGSIZE="966367"
 DUPLICATEWINDOW="60000"
-NUMREPLICAS="3"
+NUMREPLICAS="3"
+SERVERS=ess-nats.a191b5-prod.svc.cluster.local
+WEBSOCKETS=false
+CONSUMERSERVERS=stream.digital.gov.bc.ca
diff --git a/openshift/ess.test.param b/openshift/ess.test.param
@@ -6,4 +6,7 @@ MAXBYTES="209715200"
 MAXMSGS="500"
 MAXMSGSIZE="419430"
 DUPLICATEWINDOW="60000"
-NUMREPLICAS="3"
+NUMREPLICAS="3"
+SERVERS=ess-nats.a191b5-test.svc.cluster.local
+WEBSOCKETS=false
+CONSUMERSERVERS=stream-test.apps.silver.devops.gov.bc.ca