Start date and end date added to Service Message Banner

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hmcts/rpx-xui-common-lib",
-  "version": "2.0.17",
+  "version": "2.0.18-message-banner-start-end-date",
   "engines": {
     "node": ">=18.17.0"
   },

projects/exui-common-lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hmcts/rpx-xui-common-lib",
-  "version": "2.0.17",
+  "version": "2.0.18-message-banner-start-end-date",
   "peerDependencies": {
     "launchdarkly-js-client-sdk": "^2.15.2",
     "ngx-pagination": "^3.2.1",

projects/exui-common-lib/src/lib/components/service-message/service-message.component.html

@@ -7,7 +7,8 @@
 
     <div class="hmcts-banner__message">
         <span class="hmcts-banner__assistive">{{'Warning' | rpxTranslate}}</span>
-        <h2 class="govuk-heading-s" [innerHTML]="message | rpxTranslate"></h2>
+        <h2 class="govuk-heading-s" [innerHTML]="message_en | rpxTranslate"></h2>
+        <h2 *ngIf="message_cy" class="govuk-heading-s" [innerHTML]="message_cy | rpxTranslate"></h2>
         <a [routerLink]="" class="govuk-link--no-visited-state" (click)="onHideMessageEvent(key)">{{'Hide message' | rpxTranslate}}</a>
     </div>
 

projects/exui-common-lib/src/lib/components/service-message/service-message.component.scss

@@ -0,0 +1,3 @@
+.govuk-link--no-visited-state {
+    cursor: pointer;
+}

projects/exui-common-lib/src/lib/components/service-message/service-message.component.spec.ts

@@ -2,6 +2,7 @@ import { Pipe, PipeTransform } from '@angular/core';
 import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
 import { RouterTestingModule } from '@angular/router/testing';
 import { ServiceMessageComponent } from './service-message.component';
+import { ServiceMessages } from '../../models/service-message.model';
 
 @Pipe({ name: 'rpxTranslate' })
 class RpxTranslateMockPipe implements PipeTransform {
@@ -35,7 +36,14 @@ describe('ServiceMessageComponent', () => {
 
   describe('onHideMessageEvent()', () => {
     it('should emit the id of the message to hide', () => {
-      const hideKey = 'caseworker-probate';
+      const hideKey: ServiceMessages = {
+        roles: 'caseworker-probate',
+        index: 1,
+        message_en: 'New message',
+        message_cy: 'Anyyu',
+        begin: '2024-04-18T00:00:00',
+        end: '2024-04-19T00:00:00'
+      };
       const hideMessageSpy = spyOn(component.hideMessage, 'emit');
       component.onHideMessageEvent(hideKey);
       expect(hideMessageSpy).toHaveBeenCalledWith(hideKey);

projects/exui-common-lib/src/lib/components/service-message/service-message.component.ts

@@ -1,16 +1,19 @@
 import { Component, EventEmitter, Input, Output } from '@angular/core';
+import { ServiceMessages } from '../../models/service-message.model';
 
 @Component({
   selector: 'xuilib-service-message',
-  templateUrl: './service-message.component.html'
+  templateUrl: './service-message.component.html',
+  styleUrls: ['./service-message.component.scss']
 })
 export class ServiceMessageComponent {
-  @Input() public message: string;
-  @Input() public key: string;
-  @Output() public hideMessage = new EventEmitter<string>();
+  @Input() public message_en: string;
+  @Input() public message_cy?: string;
+  @Input() public key: ServiceMessages;
+  @Output() public hideMessage = new EventEmitter<ServiceMessages>();
   constructor() { }
 
-  public onHideMessageEvent(key: string) {
+  public onHideMessageEvent(key: ServiceMessages) {
     this.hideMessage.emit(key);
   }
 }

projects/exui-common-lib/src/lib/components/service-messages/service-messages.component.html

@@ -1,4 +1,7 @@
-<div *ngIf="filteredMessages?.size > 0" class="govuk-width-container govuk-!-margin-top-6">
-    <xuilib-service-message *ngFor="let message of filteredMessages | keyvalue" [key]="message.key"
-        [message]="message.value | rpxTranslate" (hideMessage)="hideMessage($event)"></xuilib-service-message>
+<div *ngIf="filteredMessages?.length > 0" class="govuk-width-container govuk-!-margin-top-6">
+    <xuilib-service-message *ngFor="let message of filteredMessages" [key]="message"
+        [message_en]="message?.message_en | rpxTranslate" 
+        [message_cy]="message?.message_cy | rpxTranslate" 
+        (hideMessage)="hideMessage($event)">
+    </xuilib-service-message>
 </div>

projects/exui-common-lib/src/lib/components/service-messages/service-messages.component.spec.ts

@@ -4,6 +4,7 @@ import { RpxTranslationConfig, RpxTranslationService } from 'rpx-xui-translation
 import { of } from 'rxjs';
 import { FeatureToggleService } from '../../services/feature-toggle/feature-toggle.service';
 import { ServiceMessagesComponent } from './service-messages.component';
+import { ServiceMessages } from '../../models/service-message.model';
 
 @Pipe({ name: 'rpxTranslate' })
 class RpxTranslateMockPipe implements PipeTransform {
@@ -17,14 +18,24 @@ describe('ServiceMessagesComponent', () => {
   let fixture: ComponentFixture<ServiceMessagesComponent>;
   const mockFeatureToggleService = jasmine.createSpyObj('FeatureToggleService', ['getValue']);
 
-  const serviceMessagesFake = {
-    'caseworker-divorce': 'Divorce users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
-    'caseworker-divorce|caseworker-probate': 'Divorce and probate users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
-    'caseworker-notfound': 'Not found users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
-    'caseworker-probate': 'Probate users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
-    'caseworker-probate|caseworker-withanotherscript': 'Probate and script users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.<scr<script>Ha!</script>ipt> alert("WOW");</script>*',
-    'caseworker-probate|caseworker-withscript': 'Probate and script users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.<script>alert("security alert");</script>*<link rel=\"stylesheet\" href=\"styles.css\">*'
-  };
+  const serviceMessagesFake: ServiceMessages[] = [
+    {
+      roles: 'caseworker-divorce',
+      index: 2,
+      message_en: 'Divorce and probate users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
+      message_cy: 'Anyyu',
+      begin: '2024-04-18T00:00:00',
+      end: '2034-05-19T00:00:00'
+    },
+    {
+      roles: 'caseworker-probate',
+      index: 3,
+      message_en: 'Divorce and probate users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
+      message_cy: 'Anyyu',
+      begin: '2024-04-18T00:00:00',
+      end: '2044-04-20T00:00:00'
+    }
+  ];
 
   beforeEach(waitForAsync(() => {
     TestBed.configureTestingModule({
@@ -53,19 +64,115 @@ describe('ServiceMessagesComponent', () => {
     expect(component).toBeTruthy();
   });
 
-  describe('getServiceMessages()', () => {
+  describe('call createFilteredMessages on getServiceMessages() call', () => {
     it('should get the service messages and filter according to roles', () => {
+      const serveMsgSpy = spyOn<any>(component, 'createFilteredMessages');
       component.getServiceMessages();
-      expect(component.filteredMessages.size).toBe(5);
+      expect(serveMsgSpy).toHaveBeenCalled();
     });
   });
+  describe('call compareDates on createFilteredMessages call', () => {
+    it('should get the service messages and filter according to roles', () => {
+      const dateSpy = spyOn<any>(component, 'compareDates');
+      component['createFilteredMessages'](serviceMessagesFake);
+      fixture.autoDetectChanges();
+      expect(dateSpy).toHaveBeenCalled();
+    });
+  });
+
+  it('should filter out message if start date is in the future', () => {
+    const serviceMessagesFake: ServiceMessages[] = [
+      {
+        roles: 'caseworker-divorce',
+        index: 2,
+        message_en: 'Divorce and probate users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
+        message_cy: 'Anyyu',
+        begin: '2034-04-18T00:00:00',
+        end: '2034-05-19T00:00:00'
+      },
+      {
+        roles: 'caseworker-probate',
+        index: 3,
+        message_en: 'Divorce and probate users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
+        message_cy: 'Anyyu',
+        begin: '2024-04-18T00:00:00',
+        end: '2044-04-20T00:00:00'
+      }
+    ];
+    component['createFilteredMessages'](serviceMessagesFake);
+    fixture.autoDetectChanges();
+    expect(component.filteredMessages.length).toBe(1);
+  });
+
+  it('should show message when no start date or end date provided', () => {
+    const serviceMessagesFake: ServiceMessages[] = [
+      {
+        roles: 'caseworker-divorce',
+        index: 2,
+        message_en: 'Divorce and probate users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
+        message_cy: 'Anyyu',
+        begin: '',
+        end: ''
+      }
+    ];
+    component['createFilteredMessages'](serviceMessagesFake);
+    fixture.autoDetectChanges();
+    expect(component.filteredMessages.length).toBe(1);
+  });
+
+  it('should filter out message if end date is in the past', () => {
+    const serviceMessagesFake: ServiceMessages[] = [
+      {
+        roles: 'caseworker-divorce',
+        index: 2,
+        message_en: 'Divorce and probate users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
+        message_cy: 'Anyyu',
+        begin: '2024-03-18T00:00:00',
+        end: '2024-03-19T00:00:00'
+      }
+    ];
+    component['createFilteredMessages'](serviceMessagesFake);
+    fixture.autoDetectChanges();
+    expect(component.filteredMessages.length).toBe(0);
+  });
+
+  it('should filter out message if start date is greater than end date', () => {
+    const serviceMessagesFake: ServiceMessages[] = [
+      {
+        roles: 'caseworker-divorce',
+        index: 2,
+        message_en: 'Divorce and probate users may experience longer loading times than usual in the system.<br />Click <a href="#">here</a> to find out more.',
+        message_cy: 'Anyyu',
+        begin: '2024-04-25T00:00:00',
+        end: '2024-04-24T00:00:00'
+      }
+    ];
+    component['createFilteredMessages'](serviceMessagesFake);
+    fixture.autoDetectChanges();
+    expect(component.filteredMessages.length).toBe(0);
+  });
+
+  it('should filter out message if date format is wrong', () => {
+    const serviceMessagesFake: ServiceMessages[] = [
+      {
+        roles: 'caseworker-divorce',
+        index: 2,
+        message_en: 'Date is in WRONG format',
+        message_cy: 'Anyyu',
+        begin: '04-04-2024T19:00:00',
+        end: '2024-04-24T00:00:00'
+      }
+    ];
+    component['createFilteredMessages'](serviceMessagesFake);
+    fixture.autoDetectChanges();
+    expect(component.filteredMessages.length).toBe(0);
+  });
 
   describe('hideMessage()', () => {
     it('should add an item to the hidden message list', () => {
       component.hiddenBanners = [];
-      const testRole = 'test-message-1';
-      component.hideMessage(testRole);
+      component.hideMessage(serviceMessagesFake[0]);
       expect((component.hiddenBanners).length).toBe(1);
     });
   });
-});
+});

projects/exui-common-lib/src/lib/components/service-messages/service-messages.component.ts

@@ -1,17 +1,15 @@
 import { Component, Input, OnInit } from '@angular/core';
 import { FeatureToggleService } from '../../services/feature-toggle/feature-toggle.service';
+import { ServiceMessages } from '../../models/service-message.model';
 
-export interface ServiceMessages {
-  [key: string]: string;
-}
 
 @Component({
   selector: 'xuilib-service-messages',
   templateUrl: './service-messages.component.html'
 })
 export class ServiceMessagesComponent implements OnInit {
   public hiddenBanners: string[];
-  public filteredMessages = new Map<string, string>();
+  public filteredMessages: ServiceMessages[] = [];
 
   @Input() public userRoles: string[];
   @Input() public featureToggleKey: string;
@@ -24,27 +22,47 @@ export class ServiceMessagesComponent implements OnInit {
   }
 
   public getServiceMessages(): void {
-    this.featureToggleService.getValue<ServiceMessages>(this.featureToggleKey, null)
+    this.featureToggleService.getValue<ServiceMessages[]>(this.featureToggleKey, null)
       .subscribe(messages => {
         if (!!messages) {
           this.createFilteredMessages(messages);
         }
       });
   }
 
-  private createFilteredMessages(messages: ServiceMessages): void {
+  private createFilteredMessages(messages: ServiceMessages[]): void {
     this.hiddenBanners = JSON.parse(window.sessionStorage.getItem(this.serviceMessageCookie)) || [];
-    Object.keys(messages).forEach(key => {
-      const regEx = new RegExp(key);
-      if (this.userRoles.some(e => regEx.test(e)) && this.hiddenBanners.indexOf(key) === -1) {
-        this.filteredMessages.set(key, messages[key]);
+
+    messages.forEach(key => {
+      const regEx = new RegExp(key.roles);
+      if (this.userRoles.some(e => regEx.test(e))) {
+        this.filteredMessages = messages.filter(msg => !this.hiddenBanners.includes(msg.message_en)
+          && this.compareDates(msg));
       }
     });
   }
 
-  public hideMessage(key: string): void {
-    this.filteredMessages.delete(key);
-    this.hiddenBanners.push(key);
+  private compareDates(msg: ServiceMessages): boolean {
+    let currentDateTime = new Date();
+    let beginDate = null;
+    let endDate = null;
+
+    if (!isNaN(Date.parse(msg.begin))) {
+      beginDate = new Date(msg.begin);
+    }
+    if (!isNaN(Date.parse(msg.end))) {
+      endDate = new Date(msg.end);
+    }
+
+    const beginDateOK = !msg.begin || (beginDate && beginDate < currentDateTime);
+    const endDateOK = !msg.end || (endDate && endDate >= currentDateTime);
+    return beginDateOK && endDateOK
+  }
+
+
+  public hideMessage(msg: ServiceMessages): void {
+    this.filteredMessages = this.filteredMessages.filter(f => f.index !== msg.index)
+    this.hiddenBanners.push(msg.message_en);
     window.sessionStorage.setItem(this.serviceMessageCookie, JSON.stringify(this.hiddenBanners));
   }
 }

projects/exui-common-lib/src/lib/models/service-message.model.ts

@@ -0,0 +1,8 @@
+export interface ServiceMessages {
+    index: number;
+    roles: string;
+    message_en: string;
+    message_cy: string;
+    begin?: string;
+    end?: string;
+  }