Man 352 persist activity log filters

integration_tests/e2e/activityLog.cy.ts

@@ -2,6 +2,28 @@ import Page from '../pages/page'
 import ActivityLogPage from '../pages/activityLog'
 import errorMessages from '../../server/properties/errorMessages'
 
+const keywords = 'Phone call'
+const dateFrom = '11/1/2025'
+const dateTo = '12/1/2025'
+
+const fillFilters = (page: ActivityLogPage) => {
+  page.getKeywordsInput().type(keywords)
+  page.getDateFromInput().type(dateFrom)
+  page.getDateToInput().type(dateTo)
+  page.getComplianceFilter(1).click()
+  page.getComplianceFilter(2).click()
+  page.getComplianceFilter(3).click()
+}
+
+const filtersAreFilled = (page: ActivityLogPage) => {
+  page.getKeywordsInput().should('have.value', keywords)
+  page.getDateFromInput().should('have.value', dateFrom)
+  page.getDateToInput().should('have.value', dateTo)
+  page.getComplianceFilter(1).should('be.checked')
+  page.getComplianceFilter(2).should('be.checked')
+  page.getComplianceFilter(3).should('be.checked')
+}
+
 context('Activity log', () => {
   const today = new Date()
   const day = today.getDate()
@@ -356,6 +378,7 @@ context('Activity log', () => {
     cy.visit('/case/X000001/activity-log')
     const page = Page.verifyOnPage(ActivityLogPage)
     page.getPaginationLink(3).click()
+    // cy.pause()
     cy.get('.govuk-pagination__link[rel="next"]').click()
     page.getPaginationLink(3).should('not.have.attr', 'aria-current')
     page.getPaginationLink(4).should('have.attr', 'aria-current')
@@ -437,4 +460,29 @@ context('Activity log', () => {
       .find('li:nth-of-type(3)')
       .should('contain.text', 'removing special characters like characters and accent letters')
   })
+  it('should persist the selected filters when a pagination link is clicked', () => {
+    cy.visit('/case/X000001/activity-log')
+    const page = Page.verifyOnPage(ActivityLogPage)
+    fillFilters(page)
+    page.getApplyFiltersButton().click()
+    page.getPaginationItem(2).click()
+    filtersAreFilled(page)
+  })
+  it('should persist the selected filters when a view link is clicked', () => {
+    cy.visit('/case/X000001/activity-log')
+    const page = Page.verifyOnPage(ActivityLogPage)
+    fillFilters(page)
+    page.getApplyFiltersButton().click()
+    cy.get('.toggle-menu__list-item:nth-of-type(2) a').click()
+    filtersAreFilled(page)
+  })
+  it('should persist the selected filters when user clicks on record detail link, then returns to the page via the breadcrumb', () => {
+    cy.visit('/case/X000001/activity-log')
+    const page = Page.verifyOnPage(ActivityLogPage)
+    fillFilters(page)
+    page.getApplyFiltersButton().click()
+    page.getActivity('1').find('h2 a').click()
+    cy.get('.govuk-breadcrumbs__list .govuk-breadcrumbs__list-item:nth-of-type(3) a').click()
+    filtersAreFilled(page)
+  })
 })

integration_tests/e2e/sentence/previous-orders/previous-order.cy.ts

@@ -55,7 +55,6 @@ context('Sentence', () => {
     page.assertPageElementAtIndexWithin('section', 2, 'dd', 1, '1 February 2024')
     page.assertPageElementAtIndexWithin('section', 2, 'dd', 2, '1 November 2024')
     page.assertPageElementAtIndexWithin('section', 2, 'dd', 3, '31 January 2025')
-
     const monthsElapsed = monthsOrDaysElapsed('2024-02-01')
     page.assertPageElementAtIndexWithin('section', 2, 'dd', 4, `${monthsElapsed} elapsed (of 12 months)`)
     page.assertPageElementAtIndexWithin('section', 2, 'dd', 5, 'Pre-sentence report')

server/@types/ActivityLog.type.ts

@@ -7,6 +7,8 @@ export interface ActivityLogFilters {
   dateFrom: string
   dateTo: string
   compliance: string[]
+  clearFilterKey?: string
+  clearFilterValue?: string
 }
 
 export interface ActivityLogRequestBody {
@@ -40,6 +42,6 @@ export interface ActivityLogCacheItem extends ActivityLogFilters {
 }
 
 export interface ActivityLogCache {
-  results: ActivityLogCacheItem[]
+  results?: ActivityLogCacheItem[]
   filters?: ActivityLogFilters
 }

server/middleware/filterActivityLog.ts

@@ -53,6 +53,7 @@ export const filterActivityLog: Route<void> = (req, res, next) => {
         }
         return acc
       }, '')
+
     return queryStr
   }
 

server/middleware/getPersonActivity.ts

@@ -22,7 +22,7 @@ export const getPersonActivity = async (
 
   let personActivity: PersonActivity | null = null
   let tierCalculation: TierCalculation | null = null
-  if (req?.session?.cache?.activityLog) {
+  if (req?.session?.cache?.activityLog?.results) {
     const cache: ActivityLogCacheItem | undefined = req.session.cache.activityLog.results.find(
       cacheItem =>
         crn === cacheItem.crn &&

server/routes/activityLog.ts

@@ -66,14 +66,14 @@ export default function activityLogRoutes(router: Router, { hmppsAuthClient }: S
       res.render('pages/activity-log', {
         personActivity,
         crn,
+        query,
         queryParams,
         page,
         view,
         tierCalculation,
         risksWidget,
         predictorScores,
         url: req.url,
-        query,
         resultsStart,
         resultsEnd,
       })
@@ -146,7 +146,6 @@ export default function activityLogRoutes(router: Router, { hmppsAuthClient }: S
     ])
     const isActivityLog = true
     const queryParams = getQueryString(req.query)
-
     const { category } = req.query
 
     await auditService.sendAuditMessage({
@@ -175,13 +174,17 @@ export default function activityLogRoutes(router: Router, { hmppsAuthClient }: S
 
   function getQueryString(params: Query): string[] {
     const queryParams: string[] = []
-    if (params.view) {
-      queryParams.push(`view=${params.view}`)
+    const usedParams = ['view', 'requirement', 'keywords', 'dateFrom', 'dateTo', 'compliance', 'page']
+    for (const usedParam of usedParams) {
+      if (params[usedParam]) {
+        if (!Array.isArray(params[usedParam])) {
+          queryParams.push(`${usedParam}=${params[usedParam]}`)
+        } else {
+          params[usedParam].forEach(param => queryParams.push(`${usedParam}=${param}`))
+        }
+      }
     }
 
-    if (params.requirement) {
-      queryParams.push(`requirement=${params.requirement}`)
-    }
     return queryParams
   }
 }

server/views/pages/activity-log/_appointment-timeline-entry.njk

@@ -4,7 +4,7 @@
 
 {% set titleHtml %}
   <span class="govuk-heading-s govuk-!-margin-bottom-0">
-    <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=default&requirement={{ requirement }}"">{{ entry.type }} at {{ entry.startDateTime | govukTime }}<span class="govuk-visually-hidden"> on {{ thisDate }}</span></a>
+    <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=default&requirement={{ requirement }}&{{filters.queryStr}}&page={{page}}">{{ entry.type }} at {{ entry.startDateTime | govukTime }}<span class="govuk-visually-hidden"> on {{ thisDate }}</span></a>
   </span>
 {% endset %}
 

server/views/pages/activity-log/_communication-timeline-entry.njk

@@ -1,5 +1,5 @@
 {% set titleHtml %}
-  <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=default&requirement={{ requirement }}" class="govuk-!-font-weight-bold">{% include './_communication-title.njk' %} at&nbsp;{{ entry.startDateTime | govukTime }}<span class="govuk-visually-hidden"> on {{ thisDate }}</span></a>
+  <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=default&requirement={{ requirement }}&{{filters.queryStr}}&page={{page}}" class="govuk-!-font-weight-bold">{% include './_communication-title.njk' %} at&nbsp;{{ entry.startDateTime | govukTime }}<span class="govuk-visually-hidden"> on {{ thisDate }}</span></a>
 {% endset %}
 
 {% set html %}

server/views/pages/activity-log/_compact-timeline-entry.njk

@@ -4,7 +4,7 @@
 
 {% set titleHtml %}
   <p class="govuk-body govuk-!-margin-bottom-1" data-qa="timeline{{ loop.index }}Card">
-    <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=compact&requirement={{ requirement }}"">
+    <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=compact&requirement={{ requirement }}&{{filters.queryStr}}&page={{page}}">
       {% if entry.isAppointment === true %}
         {{ appComplianceTag({ entry: entry, classes: 'govuk-!-margin-left-2', compact: true }) }}
         {{ entry.type }} at&nbsp;{{ entry.startDateTime | govukTime }}

server/views/pages/activity-log/_compact-view.njk

@@ -20,7 +20,7 @@
       <li>
         {% if entry.isSystemContact === true and entry.isAppointment === false and entry.isCommunication === false %}
           <div class="govuk-hint govuk-!-margin-bottom-1">
-            <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=compact&requirement={{ requirement }}"" class="app-!-inherit-colour">{{ entry.type }}<span class="govuk-visually-hidden"> on {{ thisDate }}</span></a>
+            <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=compact&requirement={{ requirement }}&{{filters.queryStr}}&page={{page}}" class="app-!-inherit-colour">{{ entry.type }}<span class="govuk-visually-hidden"> on {{ thisDate }}</span></a>
           </div>
         {% else %}
           {% include "./_compact-timeline-entry.njk" %}

server/views/pages/activity-log/_other-timeline-entry.njk

@@ -2,7 +2,7 @@
 {% set shouldPromptToRecordAnOutcome = entry.hasOutcome === false and entry.wasAbsent === false and hasAppointmentStartTimePassed and not entry.didTheyComply %}
 
 {% set titleHtml %}
-  <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=default&requirement={{ requirement }}"" class="govuk-!-font-weight-bold">
+  <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=default&requirement={{ requirement }}&{{filters.queryStr}}&page={{page}}" class="govuk-!-font-weight-bold">
     {{ entry.type }}<span class="govuk-visually-hidden"> on {{ thisDate }}</span>
   </a>
 {% endset %}

server/views/pages/activity-log/_system-contact-timeline-entry.njk

@@ -1,6 +1,6 @@
 {% set titleHtml %}
  <span class="govuk-heading-s govuk-!-margin-bottom-0">
- <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=default&requirement={{ requirement }}"" class="app-!-inherit-colour">{{ entry.type }}<span class="govuk-visually-hidden"> on {{ thisDate }}</span></a>
+ <a href="/case/{{ crn }}/activity-log/activity/{{ entry.id }}?category={{ category }}&view=default&requirement={{ requirement }}&{{filters.queryStr}}&page={{page}}" class="app-!-inherit-colour">{{ entry.type }}<span class="govuk-visually-hidden"> on {{ thisDate }}</span></a>
  </span>
 {% endset %}