@ministryofjustice/hmpps-digital-prison-reporting-frontend 3.19.2 → 3.19.4

package/dpr/components/async-filters/types.d.ts

@@ -43,3 +43,18 @@ interface RequestedReportStateItem {
     failed?: string
   }
 }
+
+export interface RenderFiltersReturnValue {
+  reportData: {
+    reportName: string
+    variantName: string
+    description: string
+    reportId: string
+    variantId: string
+    definitionPath: string | string[] | ParsedQs | ParsedQs[]
+    csrfToken: string
+    template: string
+  }
+  filters: FilterValue[]
+  sortBy: FilterValue[]
+}

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

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateStore = void 0;
 const moment_1 = __importDefault(require("moment"));
 const utils_1 = __importDefault(require("../filters/utils"));
 const enum_1 = require("../filter-input/enum");
@@ -10,17 +11,45 @@ const sortByTemplate_1 = __importDefault(require("./sortByTemplate"));
 const definitionUtils_1 = __importDefault(require("../../utils/definitionUtils"));
 const reportSummaryHelper_1 = require("../../utils/reportSummaryHelper");
 /**
- * Initialises the filters from the definition data
+ * Initialises the filters & Sort from the definition data
  *
  * @param {components['schemas']['VariantDefinition']} definition
  * @return {*}
  */
 const initFiltersFromDefinition = (definition) => {
+    return {
+        filters: getFiltersFromDefinition(definition),
+        sortBy: getSortByFromDefinition(definition),
+    };
+};
+/**
+ * Initialises the sortData from the definition
+ *
+ * @param {components['schemas']['VariantDefinition']} definition
+ * @return {*}
+ */
+const getSortByFromDefinition = (definition) => {
     const sortBy = sortByTemplate_1.default.sortByTemplate();
-    const filters = definition.specification.fields
+    sortBy[0].options = definition.specification.fields
+        .filter((f) => f.sortable)
+        .map((f) => {
+        if (f.defaultsort)
+            sortBy[0].value = f.name;
+        return { value: f.name, text: f.display };
+    });
+    return sortBy;
+};
+/**
+ * Initialises the filters from the definition
+ *
+ * @param {components['schemas']['VariantDefinition']} definition
+ * @return {*}
+ */
+const getFiltersFromDefinition = (definition) => {
+    return definition.specification.fields
         .filter((f) => f.filter)
         .map((f) => {
-        const { display: text, name, filter, sortable, defaultsort } = f;
+        const { display: text, name, filter } = f;
         const { type, staticOptions, dynamicOptions, defaultValue, mandatory, pattern } = filter;
         let filterData = {
             text,
@@ -59,16 +88,8 @@ const initFiltersFromDefinition = (definition) => {
                 max,
             };
         }
-        if (sortable)
-            sortBy[0].options.push({ value: name, text });
-        if (defaultsort)
-            sortBy[0].value = name;
         return filterData;
     });
-    return {
-        filters,
-        sortBy,
-    };
 };
 /**
  * Updates the store with the request details
@@ -105,6 +126,7 @@ const updateStore = async (req, services, fields, querySummaryData, executionId,
         await setTimestamps(refreshId, services, 'refresh');
     return reportData.url.polling.pathname;
 };
+exports.updateStore = updateStore;
 const setTimestamps = async (id, services, type) => {
     await services.asyncReportsStore.setReportTimestamp(id, type);
     await services.recentlyViewedStoreService.setReportTimestamp(id, type);
@@ -171,7 +193,7 @@ exports.default = {
      * @param {AsyncReportUtilsParams} { req, res, dataSources }
      * @return {*}
      */
-    renderFilters: async ({ req, res, services, next }) => {
+    renderFilters: async ({ req, res, services, next, }) => {
         var _a;
         try {
             const token = ((_a = res.locals.user) === null || _a === void 0 ? void 0 : _a.token) ? res.locals.user.token : 'token';
@@ -211,7 +233,7 @@ exports.default = {
         });
         let redirect = '';
         if (executionId && tableId) {
-            redirect = await updateStore(req, services, fields, querySummaryData, executionId, tableId);
+            redirect = await (0, exports.updateStore)(req, services, fields, querySummaryData, executionId, tableId);
         }
         return redirect;
     },

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

@@ -10,19 +10,50 @@ import { AsyncReportUtilsParams } from '../../types/AsyncReportUtils'
 import DefinitionUtils from '../../utils/definitionUtils'
 import { getDuplicateRequestIds } from '../../utils/reportSummaryHelper'
 import { Services } from '../../types/Services'
+import { RenderFiltersReturnValue } from './types'
 
 /**
- * Initialises the filters from the definition data
+ * Initialises the filters & Sort from the definition data
  *
  * @param {components['schemas']['VariantDefinition']} definition
  * @return {*}
  */
 const initFiltersFromDefinition = (definition: components['schemas']['VariantDefinition']) => {
+  return {
+    filters: getFiltersFromDefinition(definition),
+    sortBy: getSortByFromDefinition(definition),
+  }
+}
+
+/**
+ * Initialises the sortData from the definition
+ *
+ * @param {components['schemas']['VariantDefinition']} definition
+ * @return {*}
+ */
+const getSortByFromDefinition = (definition: components['schemas']['VariantDefinition']) => {
   const sortBy = SortHelper.sortByTemplate()
-  const filters = definition.specification.fields
+  sortBy[0].options = definition.specification.fields
+    .filter((f) => f.sortable)
+    .map((f) => {
+      if (f.defaultsort) sortBy[0].value = f.name
+      return { value: f.name, text: f.display }
+    })
+
+  return sortBy
+}
+
+/**
+ * Initialises the filters from the definition
+ *
+ * @param {components['schemas']['VariantDefinition']} definition
+ * @return {*}
+ */
+const getFiltersFromDefinition = (definition: components['schemas']['VariantDefinition']) => {
+  return definition.specification.fields
     .filter((f) => f.filter)
     .map((f) => {
-      const { display: text, name, filter, sortable, defaultsort } = f
+      const { display: text, name, filter } = f
       const { type, staticOptions, dynamicOptions, defaultValue, mandatory, pattern } = filter
 
       let filterData: FilterValue = {
@@ -65,16 +96,8 @@ const initFiltersFromDefinition = (definition: components['schemas']['VariantDef
         }
       }
 
-      if (sortable) sortBy[0].options.push({ value: name, text })
-      if (defaultsort) sortBy[0].value = name
-
       return filterData
     })
-
-  return {
-    filters,
-    sortBy,
-  }
 }
 
 /**
@@ -88,7 +111,7 @@ const initFiltersFromDefinition = (definition: components['schemas']['VariantDef
  * @param {string} tableId
  * @return {*}  {Promise<string>}
  */
-const updateStore = async (
+export const updateStore = async (
   req: Request,
   services: Services,
   fields: components['schemas']['FieldDefinition'][],
@@ -211,7 +234,12 @@ export default {
    * @param {AsyncReportUtilsParams} { req, res, dataSources }
    * @return {*}
    */
-  renderFilters: async ({ req, res, services, next }: AsyncReportUtilsParams) => {
+  renderFilters: async ({
+    req,
+    res,
+    services,
+    next,
+  }: AsyncReportUtilsParams): Promise<RenderFiltersReturnValue | boolean> => {
     try {
       const token = res.locals.user?.token ? res.locals.user.token : 'token'
       const csrfToken = (res.locals.csrfToken as unknown as string) || 'csrfToken'

package/dpr/routes/asyncReports.ts

@@ -7,6 +7,7 @@ import * as AsyncReportUtils from '../utils/renderAsyncReport'
 
 import { Services } from '../types/Services'
 import logger from '../utils/logger'
+import { RenderFiltersReturnValue } from '../components/async-filters/types'
 
 export default function routes({
   router,
@@ -39,7 +40,7 @@ export default function routes({
 
   const getReportFiltersHandler: RequestHandler = async (req, res, next) => {
     try {
-      const filtersRenderData = await AsyncFiltersUtils.renderFilters({
+      const filtersRenderData = <RenderFiltersReturnValue>await AsyncFiltersUtils.renderFilters({
         req,
         res,
         services,

package/dpr/utils/reportStatusHelper.js

@@ -10,11 +10,11 @@ const getStatus = async ({ req, res, services }) => {
     const { reportId, variantId, executionId, status: currentStatus, dataProductDefinitionsPath, requestedAt } = req.body;
     try {
         const timeoutExemptStatuses = [AsyncReport_1.RequestStatus.READY, AsyncReport_1.RequestStatus.EXPIRED, AsyncReport_1.RequestStatus.FAILED];
-        if (timeoutRequest(requestedAt) && !timeoutExemptStatuses.includes(currentStatus)) {
-            throw new Error('Request taking too long. Request Halted');
-        }
         const statusResponse = await services.reportingService.getAsyncReportStatus(token, reportId, variantId, executionId, dataProductDefinitionsPath);
         status = statusResponse.status;
+        if (timeoutRequest(requestedAt) && !timeoutExemptStatuses.includes(status)) {
+            throw new Error('Request taking too long. Request Halted');
+        }
         if (status === AsyncReport_1.RequestStatus.FAILED) {
             errorMessage = statusResponse.error;
         }

package/dpr/utils/reportStatusHelper.ts

@@ -15,10 +15,6 @@ export const getStatus = async ({ req, res, services }: AsyncReportUtilsParams):
 
   try {
     const timeoutExemptStatuses = [RequestStatus.READY, RequestStatus.EXPIRED, RequestStatus.FAILED]
-    if (timeoutRequest(requestedAt) && !timeoutExemptStatuses.includes(currentStatus)) {
-      throw new Error('Request taking too long. Request Halted')
-    }
-
     const statusResponse = await services.reportingService.getAsyncReportStatus(
       token,
       reportId,
@@ -28,6 +24,10 @@ export const getStatus = async ({ req, res, services }: AsyncReportUtilsParams):
     )
     status = statusResponse.status as RequestStatus
 
+    if (timeoutRequest(requestedAt) && !timeoutExemptStatuses.includes(status)) {
+      throw new Error('Request taking too long. Request Halted')
+    }
+
     if (status === RequestStatus.FAILED) {
       errorMessage = statusResponse.error
     }

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.19.2",
+  "version": "3.19.4",
   "main": "dpr/assets/js/all.mjs",
   "sass": "dpr/all.scss",
   "engines": {