From 47024f060c7f718fa1bd017bca885ca5196a5ce3 Mon Sep 17 00:00:00 2001
From: Kianna <30884335+kiannaquach@users.noreply.github.com>
Date: Mon, 5 Feb 2024 09:08:10 -0800
Subject: [PATCH] UI: Fix bugs in custom messages (#25169)

* Fix bugs in custom messages

* Add new line split helper file

* Fix multiple banner issue

* Code cleanup

* Add tests

* Add more tests

* Remove empty state action

* Remove test
---
 ui/app/templates/vault/cluster.hbs            | 19 +++++++++++---
 .../page/create-and-edit-message-form.hbs     | 10 +++++++-
 .../page/create-and-edit-message-form.js      |  8 +++++-
 .../addon/components/messages/page/list.hbs   | 12 +--------
 .../components/messages/preview-image.hbs     |  8 +++---
 ui/lib/core/addon/helpers/new-line-split.js   | 12 +++++++++
 ui/lib/core/app/helpers/new-line-split.js     |  6 +++++
 .../page/create-and-edit-message-test.js      |  1 -
 .../config-ui/messages/page/list-test.js      |  1 -
 .../helpers/new-line-split-test.js            | 25 +++++++++++++++++++
 10 files changed, 80 insertions(+), 22 deletions(-)
 create mode 100644 ui/lib/core/addon/helpers/new-line-split.js
 create mode 100644 ui/lib/core/app/helpers/new-line-split.js
 create mode 100644 ui/tests/integration/helpers/new-line-split-test.js

diff --git a/ui/app/templates/vault/cluster.hbs b/ui/app/templates/vault/cluster.hbs
index 51bc94daa0..a6f1c299c0 100644
--- a/ui/app/templates/vault/cluster.hbs
+++ b/ui/app/templates/vault/cluster.hbs
@@ -13,9 +13,11 @@
       as |A|
     >
       <A.Title data-test-custom-alert-title={{bannerMessage.id}}>{{bannerMessage.title}}</A.Title>
-      <A.Description data-test-custom-alert-description={{bannerMessage.id}}>
-        {{bannerMessage.message}}
-      </A.Description>
+      {{#each (new-line-split bannerMessage.message) as |msg|}}
+        <A.Description data-test-custom-alert-description={{bannerMessage.id}}>
+          {{msg}}
+        </A.Description>
+      {{/each}}
       {{#unless (is-empty-value bannerMessage.link)}}
         {{#each-in bannerMessage.link as |title href|}}
           <A.Link::Standalone
@@ -38,13 +40,22 @@
       {{modalMessage.title}}
     </M.Header>
     <M.Body data-test-modal-body={{modalMessage.id}}>
-      {{modalMessage.message}}
+      {{#each (new-line-split modalMessage.message) as |msg|}}
+        {{#if (eq msg "")}}
+          <br />
+        {{else}}
+          <div>
+            {{msg}}
+          </div>
+        {{/if}}
+      {{/each}}
       {{#unless (is-empty-value modalMessage.link)}}
         {{#each-in modalMessage.link as |title href|}}
           <Hds::Link::Inline @icon="external-link" @isHrefExternal={{true}} @href={{href}}>{{title}}</Hds::Link::Inline>
         {{/each-in}}
       {{/unless}}
     </M.Body>
+
     <M.Footer as |F|>
       <Hds::Button @text="Confirm" {{on "click" F.close}} data-test-modal-button={{modalMessage.id}} />
     </M.Footer>
diff --git a/ui/lib/config-ui/addon/components/messages/page/create-and-edit-message-form.hbs b/ui/lib/config-ui/addon/components/messages/page/create-and-edit-message-form.hbs
index f59e996d82..e4806fcf90 100644
--- a/ui/lib/config-ui/addon/components/messages/page/create-and-edit-message-form.hbs
+++ b/ui/lib/config-ui/addon/components/messages/page/create-and-edit-message-form.hbs
@@ -94,7 +94,15 @@
         {{@message.title}}
       </M.Header>
       <M.Body data-test-modal-body={{@message.title}}>
-        {{@message.message}}
+        {{#each (new-line-split @message.message) as |msg|}}
+          {{#if (eq msg "")}}
+            <br />
+          {{else}}
+            <div>
+              {{msg}}
+            </div>
+          {{/if}}
+        {{/each}}
         {{#unless (is-empty-value @message.link)}}
           {{#each-in @message.link as |title href|}}
             <Hds::Link::Inline @icon="external-link" @isHrefExternal={{true}} @href={{href}}>{{title}}</Hds::Link::Inline>
diff --git a/ui/lib/config-ui/addon/components/messages/page/create-and-edit-message-form.js b/ui/lib/config-ui/addon/components/messages/page/create-and-edit-message-form.js
index 1f2059e884..6740b9c551 100644
--- a/ui/lib/config-ui/addon/components/messages/page/create-and-edit-message-form.js
+++ b/ui/lib/config-ui/addon/components/messages/page/create-and-edit-message-form.js
@@ -10,6 +10,7 @@ import errorMessage from 'vault/utils/error-message';
 import { inject as service } from '@ember/service';
 import { action } from '@ember/object';
 import Ember from 'ember';
+import { isAfter } from 'date-fns';
 
 /**
  * @module Page::CreateAndEditMessageForm
@@ -58,8 +59,13 @@ export default class MessagesList extends Component {
       this.userConfirmation = '';
 
       const isValid = this.validate();
+      const modalMessages = this.args.messages?.filter((message) => message.type === 'modal') || [];
+      const hasExpiredModalMessages = modalMessages.every((message) => {
+        if (!message.endTime) return false;
+        return isAfter(new Date(), new Date(message.endTime));
+      });
 
-      if (this.args.hasSomeActiveModals && this.args.message.type === 'modal') {
+      if (!hasExpiredModalMessages && this.args.hasSomeActiveModals && this.args.message.type === 'modal') {
         this.showMultipleModalsMessage = true;
         const isConfirmed = yield this.getUserConfirmation.perform();
         if (!isConfirmed) return;
diff --git a/ui/lib/config-ui/addon/components/messages/page/list.hbs b/ui/lib/config-ui/addon/components/messages/page/list.hbs
index e43bd519bc..fe8a4da454 100644
--- a/ui/lib/config-ui/addon/components/messages/page/list.hbs
+++ b/ui/lib/config-ui/addon/components/messages/page/list.hbs
@@ -100,17 +100,7 @@
   <EmptyState
     @title="No messages yet"
     @message="Add a custom message for all users after they log into Vault. Create message to get started."
-  >
-    <Hds::Link::Standalone
-      @icon="plus"
-      @iconPosition="leading"
-      @text="Create message"
-      @route="messages.create"
-      @query={{hash authenticated=@authenticated}}
-      class="is-no-underline"
-      data-test-action-text="Create message"
-    />
-  </EmptyState>
+  />
 {{/if}}
 
 {{#if this.showMaxMessageModal}}
diff --git a/ui/lib/config-ui/addon/components/messages/preview-image.hbs b/ui/lib/config-ui/addon/components/messages/preview-image.hbs
index 1cea191def..e1e709a087 100644
--- a/ui/lib/config-ui/addon/components/messages/preview-image.hbs
+++ b/ui/lib/config-ui/addon/components/messages/preview-image.hbs
@@ -20,9 +20,11 @@
       as |A|
     >
       <A.Title data-test-custom-alert-title={{@message.title}}>{{@message.title}}</A.Title>
-      <A.Description data-test-custom-alert-description={{@message.title}}>
-        {{@message.message}}
-      </A.Description>
+      {{#each (new-line-split @message.message) as |msg|}}
+        <A.Description data-test-custom-alert-description={{@message.title}}>
+          {{msg}}
+        </A.Description>
+      {{/each}}
       {{#unless (is-empty-value @message.link)}}
         {{#each-in @message.link as |title href|}}
           <A.Link::Standalone
diff --git a/ui/lib/core/addon/helpers/new-line-split.js b/ui/lib/core/addon/helpers/new-line-split.js
new file mode 100644
index 0000000000..e456895b4b
--- /dev/null
+++ b/ui/lib/core/addon/helpers/new-line-split.js
@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
+import { helper } from '@ember/component/helper';
+
+export function newLineSplit([lines]) {
+  return lines.split('\n');
+}
+
+export default helper(newLineSplit);
diff --git a/ui/lib/core/app/helpers/new-line-split.js b/ui/lib/core/app/helpers/new-line-split.js
new file mode 100644
index 0000000000..47d53ccc81
--- /dev/null
+++ b/ui/lib/core/app/helpers/new-line-split.js
@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
+export { default } from 'core/helpers/new-line-split';
diff --git a/ui/tests/integration/components/config-ui/messages/page/create-and-edit-message-test.js b/ui/tests/integration/components/config-ui/messages/page/create-and-edit-message-test.js
index 7b1a7411a2..a746c67d1e 100644
--- a/ui/tests/integration/components/config-ui/messages/page/create-and-edit-message-test.js
+++ b/ui/tests/integration/components/config-ui/messages/page/create-and-edit-message-test.js
@@ -79,7 +79,6 @@ module('Integration | Component | messages/page/create-and-edit-message', functi
     );
     await fillIn('[data-test-kv-key="0"]', 'Learn more');
     await fillIn('[data-test-kv-value="0"]', 'www.learn.com');
-
     await click(PAGE.button('create-message'));
   });
 
diff --git a/ui/tests/integration/components/config-ui/messages/page/list-test.js b/ui/tests/integration/components/config-ui/messages/page/list-test.js
index 5bcbd42b1e..fdcc0bbf17 100644
--- a/ui/tests/integration/components/config-ui/messages/page/list-test.js
+++ b/ui/tests/integration/components/config-ui/messages/page/list-test.js
@@ -79,7 +79,6 @@ module('Integration | Component | messages/page/list', function (hooks) {
       .hasText(
         'Add a custom message for all users after they log into Vault. Create message to get started.'
       );
-    assert.dom('[data-test-empty-state-actions] a').hasText('Create message');
   });
 
   test('it should show the list of custom messages', async function (assert) {
diff --git a/ui/tests/integration/helpers/new-line-split-test.js b/ui/tests/integration/helpers/new-line-split-test.js
new file mode 100644
index 0000000000..fa5f5635e1
--- /dev/null
+++ b/ui/tests/integration/helpers/new-line-split-test.js
@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
+import { module, test } from 'qunit';
+import { setupRenderingTest } from 'vault/tests/helpers';
+import { newLineSplit } from 'core/helpers/new-line-split';
+
+module('Integration | Helper | new-line-split', function (hooks) {
+  setupRenderingTest(hooks);
+
+  test('it splits the string by new line characters', async function (assert) {
+    const lines = newLineSplit(['First new line.\nSecond new line.\nThird new line.']);
+    assert.deepEqual(lines, ['First new line.', 'Second new line.', 'Third new line.']);
+  });
+  test('it checks for some non-new line characters', async function (assert) {
+    let lines = newLineSplit(['First new line.<br />\nSecond new line.\nThird new line.']);
+    assert.deepEqual(lines, ['First new line.<br />', 'Second new line.', 'Third new line.']);
+    lines = newLineSplit(['First new line./n\nSecond new line.\nThird new line.']);
+    assert.deepEqual(lines, ['First new line./n', 'Second new line.', 'Third new line.']);
+    lines = newLineSplit(['First new line.\n\nSecond new line.\n\nThird new line.']);
+    assert.deepEqual(lines, ['First new line.', '', 'Second new line.', '', 'Third new line.']);
+  });
+});