@ministryofjustice/hmpps-digital-prison-reporting-frontend 3.12.2 → 3.12.3

package/dpr/assets/js/all.mjs

@@ -792,6 +792,7 @@ class AsyncFilters extends DprQueryParamClass {
 
     const params = new URLSearchParams(search);
     params.delete('retryId');
+    params.delete('refreshId');
     const href = `${origin}${pathname}?${params.toString()}`;
 
     document.getElementById('async-filters-form-href').value = href;
@@ -816,9 +817,13 @@ class AsyncFilters extends DprQueryParamClass {
   initRetryInputFromQueryParams () {
     this.queryParams = new URLSearchParams(window.location.search);
     const retryId = this.queryParams.get('retryId');
+    const refreshId = this.queryParams.get('refreshId');
     if (retryId) {
       document.getElementById('async-filters-retry-id').value = retryId;
     }
+    if (refreshId) {
+      document.getElementById('async-filters-refresh-id').value = refreshId;
+    }
   }
 }
 
@@ -992,7 +997,7 @@ class dprAsyncPolling extends DprClientClass {
 
   async initialise () {
     this.POLLING_STATUSES = ['SUBMITTED', 'STARTED', 'PICKED'];
-    this.POLLING_FREQUENCY = '5000'; // 5 seconds
+    this.POLLING_FREQUENCY = '3000'; // 3 seconds
 
     this.statusSection = document.getElementById('async-request-polling-status');
     this.retryRequestButton = document.getElementById('retry-async-request');

package/dpr/components/async-filters/utils.js

@@ -122,12 +122,16 @@ exports.default = {
             }
         });
         const token = ((_a = res.locals.user) === null || _a === void 0 ? void 0 : _a.token) ? res.locals.user.token : 'token';
-        const { reportId, variantId, retryId } = req.body;
+        const { reportId, variantId, retryId, refreshId } = req.body;
         const response = await dataSources.requestAsyncReport(token, reportId, variantId, query);
         const { executionId, tableId } = response;
         if (retryId) {
-            await asyncReportsStore.setReportRetriedTimestamp(retryId);
-            await recentlyViewedStoreService.setReportRetriedTimestamp(retryId);
+            await asyncReportsStore.setReportTimestamp(retryId, 'retry');
+            await recentlyViewedStoreService.setReportTimestamp(retryId, 'retry');
+        }
+        if (refreshId) {
+            await asyncReportsStore.setReportTimestamp(refreshId, 'refresh');
+            await recentlyViewedStoreService.setReportTimestamp(refreshId, 'refresh');
         }
         if (executionId && tableId) {
             const reportData = await asyncReportsStore.addReport({

package/dpr/components/async-filters/utils.ts

@@ -136,13 +136,18 @@ export default {
       })
 
     const token = res.locals.user?.token ? res.locals.user.token : 'token'
-    const { reportId, variantId, retryId } = req.body
+    const { reportId, variantId, retryId, refreshId } = req.body
     const response = await dataSources.requestAsyncReport(token, reportId, variantId, query)
     const { executionId, tableId } = response
 
     if (retryId) {
-      await asyncReportsStore.setReportRetriedTimestamp(retryId)
-      await recentlyViewedStoreService.setReportRetriedTimestamp(retryId)
+      await asyncReportsStore.setReportTimestamp(retryId, 'retry')
+      await recentlyViewedStoreService.setReportTimestamp(retryId, 'retry')
+    }
+
+    if (refreshId) {
+      await asyncReportsStore.setReportTimestamp(refreshId, 'refresh')
+      await recentlyViewedStoreService.setReportTimestamp(refreshId, 'refresh')
     }
 
     if (executionId && tableId) {

package/dpr/components/async-filters/view.njk

@@ -31,6 +31,7 @@
       <input type="hidden" name="href" id="async-filters-form-href" value="">
       <input type="hidden" name="search" id="async-filters-form-search" value="">
       <input type="hidden" name="retryId" id="async-filters-retry-id" value="">
+      <input type="hidden" name="refreshId" id="async-filters-refesh-id" value="">
 
       <div class="dpr-async-controls__section">
         <h3 class="govuk-heading-s">Filters</h3>

package/dpr/components/async-reports-list/utils/recentlyViewedUtils.js

@@ -9,7 +9,7 @@ const formatCards = async (recentlyViewedStoreService, asyncReportsStore, dataSo
     const requestedReportsData = await recentlyViewedStoreService.getAllReports();
     return Promise.all(requestedReportsData
         .filter((report) => {
-        return !report.timestamp.retried;
+        return !report.timestamp.retried && !report.timestamp.refresh;
     })
         .map((report) => {
         return formatCardData(report, dataSources, token, recentlyViewedStoreService, asyncReportsStore);
@@ -19,15 +19,21 @@ const formatCardData = async (reportData, dataSources, token, recentlyViewedStor
     const { executionId: id, variantName: text, description, query, url, timestamp, executionId, reportId, variantId, dataProductDefinitionsPath, } = reportData;
     let { status } = reportData;
     const statusResponse = await utils_1.default.getStatus(token, reportId, variantId, executionId, status, dataSources, asyncReportsStore, dataProductDefinitionsPath);
-    status = statusResponse.status === AsyncReport_1.RequestStatus.EXPIRED ? statusResponse.status : AsyncReport_1.RequestStatus.READY;
-    const summary = query.summary;
-    const href = status ? `${url.request.fullUrl}&retryId=${executionId}` : url.report.fullUrl;
+    let href;
+    if (statusResponse.status === AsyncReport_1.RequestStatus.EXPIRED) {
+        status = statusResponse.status;
+        href = `${url.request.fullUrl}&retryId=${executionId}`;
+    }
+    else {
+        status = AsyncReport_1.RequestStatus.READY;
+        href = url.report.fullUrl;
+    }
     return {
         id,
         text,
         description,
         tag: 'MIS',
-        summary,
+        summary: query.summary,
         href,
         timestamp: `Last viewed: ${new Date(timestamp.lastViewed).toLocaleString()}`,
         status,

package/dpr/components/async-reports-list/utils/recentlyViewedUtils.ts

@@ -17,7 +17,7 @@ const formatCards = async (
   return Promise.all(
     requestedReportsData
       .filter((report: RecentlyViewedReportData) => {
-        return !report.timestamp.retried
+        return !report.timestamp.retried && !report.timestamp.refresh
       })
       .map((report: RecentlyViewedReportData) => {
         return formatCardData(report, dataSources, token, recentlyViewedStoreService, asyncReportsStore)
@@ -57,16 +57,21 @@ const formatCardData = async (
     dataProductDefinitionsPath,
   )
 
-  status = statusResponse.status === RequestStatus.EXPIRED ? statusResponse.status : RequestStatus.READY
-  const summary = query.summary as { name: string; value: string }[]
-  const href = status ? `${url.request.fullUrl}&retryId=${executionId}` : url.report.fullUrl
+  let href
+  if (statusResponse.status === RequestStatus.EXPIRED) {
+    status = statusResponse.status
+    href = `${url.request.fullUrl}&retryId=${executionId}`
+  } else {
+    status = RequestStatus.READY
+    href = url.report.fullUrl
+  }
 
   return {
     id,
     text,
     description,
     tag: 'MIS',
-    summary,
+    summary: query.summary as { name: string; value: string }[],
     href,
     timestamp: `Last viewed: ${new Date(timestamp.lastViewed).toLocaleString()}`,
     status,

package/dpr/components/icon-button-list/utils.js

@@ -6,7 +6,7 @@ const FULL_BUTTON_LIST = [
         icon: 'refresh',
         disabled: false,
         tooltipText: 'Refresh report',
-        ariaLabelText: 'Print report',
+        ariaLabelText: 'Refresh report',
     },
     {
         id: 'printable',
@@ -59,7 +59,7 @@ exports.default = {
         actions.push({
             type: 'refresh',
             data: {
-                href: reportData.url.request.fullUrl,
+                href: `${reportData.url.request.fullUrl}&refreshId=${reportData.executionId}`,
             },
         });
         // PRINT

package/dpr/components/icon-button-list/utils.ts

@@ -8,7 +8,7 @@ const FULL_BUTTON_LIST = [
     icon: 'refresh',
     disabled: false,
     tooltipText: 'Refresh report',
-    ariaLabelText: 'Print report',
+    ariaLabelText: 'Refresh report',
   },
   {
     id: 'printable',
@@ -64,7 +64,7 @@ export default {
     actions.push({
       type: 'refresh',
       data: {
-        href: reportData.url.request.fullUrl,
+        href: `${reportData.url.request.fullUrl}&refreshId=${reportData.executionId}`,
       },
     })
 

package/dpr/services/recentlyViewedService.js

@@ -82,14 +82,15 @@ class RecentlyViewedStoreService extends userStoreService_1.default {
         this.recentlyViewedReports[index] = report;
         await this.saveRecentlyViewedState();
     }
-    async setReportRetriedTimestamp(id) {
-        const retriedReport = await this.getReportByExecutionId(id);
-        if (retriedReport) {
+    async setReportTimestamp(executionId, type) {
+        const report = await this.getReportByExecutionId(executionId);
+        if (report) {
             const timestamp = {
-                ...retriedReport.timestamp,
-                retried: new Date(),
+                ...report.timestamp,
+                ...(type === 'retry' && { retried: new Date() }),
+                ...(type === 'refresh' && { refresh: new Date() }),
             };
-            await this.updateReport(id, { timestamp });
+            await this.updateReport(executionId, { timestamp });
         }
     }
     async setToExpired(id) {

package/dpr/services/recentlyViewedService.ts

@@ -106,14 +106,15 @@ export default class RecentlyViewedStoreService extends UserStoreService {
     await this.saveRecentlyViewedState()
   }
 
-  async setReportRetriedTimestamp(id: string) {
-    const retriedReport = await this.getReportByExecutionId(id)
-    if (retriedReport) {
+  async setReportTimestamp(executionId: string, type: string) {
+    const report = await this.getReportByExecutionId(executionId)
+    if (report) {
       const timestamp: AsyncReportsTimestamp = {
-        ...retriedReport.timestamp,
-        retried: new Date(),
+        ...report.timestamp,
+        ...(type === 'retry' && { retried: new Date() }),
+        ...(type === 'refresh' && { refresh: new Date() }),
       }
-      await this.updateReport(id, { timestamp })
+      await this.updateReport(executionId, { timestamp })
     }
   }
 

package/dpr/services/requestedReportsService.js

@@ -97,14 +97,15 @@ class AsyncReportStoreService extends userStoreService_1.default {
         this.requestedReports[index] = report;
         await this.saveRequestedReportState();
     }
-    async setReportRetriedTimestamp(id) {
-        const retriedReport = await this.getReportByExecutionId(id);
-        if (retriedReport) {
+    async setReportTimestamp(executionId, type) {
+        const report = await this.getReportByExecutionId(executionId);
+        if (report) {
             const timestamp = {
-                ...retriedReport.timestamp,
-                retried: new Date(),
+                ...report.timestamp,
+                ...(type === 'retry' && { retried: new Date() }),
+                ...(type === 'refresh' && { refresh: new Date() }),
             };
-            await this.updateReport(id, { timestamp });
+            await this.updateReport(executionId, { timestamp });
         }
     }
     async updateLastViewed(id) {

package/dpr/services/requestedReportsService.ts

@@ -129,14 +129,15 @@ export default class AsyncReportStoreService extends UserStoreService {
     await this.saveRequestedReportState()
   }
 
-  async setReportRetriedTimestamp(id: string) {
-    const retriedReport = await this.getReportByExecutionId(id)
-    if (retriedReport) {
+  async setReportTimestamp(executionId: string, type: string) {
+    const report = await this.getReportByExecutionId(executionId)
+    if (report) {
       const timestamp: AsyncReportsTimestamp = {
-        ...retriedReport.timestamp,
-        retried: new Date(),
+        ...report.timestamp,
+        ...(type === 'retry' && { retried: new Date() }),
+        ...(type === 'refresh' && { refresh: new Date() }),
       }
-      await this.updateReport(id, { timestamp })
+      await this.updateReport(executionId, { timestamp })
     }
   }
 

package/dpr/types/AsyncReport.ts

@@ -62,4 +62,5 @@ export interface AsyncReportsTimestamp {
   failed?: Date
   retried?: Date
   aborted?: Date
+  refesh?: Date
 }

package/dpr/types/RecentlyViewed.ts

@@ -12,6 +12,7 @@ export interface RecentlyViewedReportData {
     lastViewed: Date
     expired?: Date
     retried?: Date
+    refresh?: Date
   }
   status?: RequestStatus
   url: AsyncReportUrlData

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ministryofjustice/hmpps-digital-prison-reporting-frontend",
   "description": "The Digital Prison Reporting Frontend contains templates and code to help display data effectively in UI applications.",
-  "version": "3.12.2",
+  "version": "3.12.3",
   "main": "dpr/assets/js/all.mjs",
   "sass": "dpr/all.scss",
   "engines": {