PDF download and error with maximum limit message (#162)

Author: kcagran

src/backend/api/v1/report/views.py

@@ -336,7 +336,7 @@ def csv(self, request: Request) -> Response:
 
     @action(methods=["post"], detail=False)
     def pdf(self, request: Request) -> WeasyTemplateResponse:
-        table_qs = self.filter_queryset(self.get_base_queryset())
+        table_qs = self.filter_queryset(self.get_base_queryset())[:settings.MAX_PDF_JOB_TEMPLATES]
 
         currency_value = Settings.currency()
         currency_sign = "$"

src/backend/api/v1/template_options/views.py

@@ -28,6 +28,7 @@
     Job,
     Costs, max_minutes_input, min_minutes_input)
 from backend.apps.common.models import Currency, Settings, FilterSet
+from backend.django_config import settings
 
 
 class TemplateOptionsView(AdminOnlyViewSet):
@@ -65,6 +66,7 @@ def list(self, request: Request) -> Response:
             "currency": Settings.currency(),
             "enable_template_creation_time": Settings.enable_template_creation_time(),
             "filter_sets": FilterSetSerializer(filter_sets, many=True).data,
+            "max_pdf_job_templates": settings.MAX_PDF_JOB_TEMPLATES,
         }
 
         return Response(

src/backend/django_config/settings.py

@@ -348,6 +348,10 @@
 # Initial sync date (overrides INITIAL_SYNC_DAYS)
 INITIAL_SYNC_SINCE = '2025-08-08'
 
+
+# PDF Download (Do not exceed the number 4000)
+MAX_PDF_JOB_TEMPLATES = 4000
+
 ### Local settings
 local_config_file = os.path.join(BASE_DIR, "django_config", "local_settings.py")
 try:

src/backend/tests/unit/test_views.py

@@ -14,7 +14,9 @@
 from backend.apps.common.models import FilterSet, Currency, Settings, SettingsChoices
 
 test_template_expected_data = {
-    'clusters': [{'id': 1, 'address': 'localhost'}],
+    'clusters': [
+        {'id': 1, 'address': 'localhost'}
+    ],
     'currencies': [
         {'id': 2, 'name': 'EUR', 'iso_code': 'EUR', 'symbol': '€'},
         {'id': 1, 'name': 'United States Dollar', 'iso_code': 'USD', 'symbol': '$'}
@@ -23,9 +25,9 @@
         {'key': 2, 'value': 'Organization A', 'cluster_id': 1}
     ],
     'labels': [
-        {'cluster_id': 1, 'key': 1, 'value': 'Label A'},
-        {'cluster_id': 1, 'key': 2, 'value': 'Label B'},
-        {'cluster_id': 1, 'key': 3, 'value': 'Label C'}
+        {'key': 1, 'value': 'Label A', 'cluster_id': 1},
+        {'key': 2, 'value': 'Label B', 'cluster_id': 1},
+        {'key': 3, 'value': 'Label C', 'cluster_id': 1}
     ],
     'date_ranges': [
         {'key': 'last_year', 'value': 'Past year'},
@@ -45,14 +47,32 @@
     ],
     'projects': [
         {'key': 1, 'value': 'Project A', 'cluster_id': 1},
-        {'key': 2, 'value': 'Project B', 'cluster_id': 1}],
+        {'key': 2, 'value': 'Project B', 'cluster_id': 1}
+    ],
     'manual_cost_automation': 50.0,
     'automated_process_cost': 20.0,
     'currency': 1,
     'enable_template_creation_time': True,
     'filter_sets': [
-        {'id': 1, 'name': 'Report 1', 'filters': {'date_range': 'last_month', 'organization': [1, 2]}},
-        {'id': 2, 'name': 'Report 2', 'filters': {'date_range': 'last_year', 'template': [1, 2]}}]}
+        {
+            'id': 1,
+            'name': 'Report 1',
+            'filters': {
+                'date_range': 'last_month',
+                'organization': [1, 2]
+            }
+        },
+        {
+            'id': 2,
+            'name': 'Report 2',
+            'filters': {
+                'template': [1, 2],
+                'date_range': 'last_year'
+            }
+        }
+    ],
+    'max_pdf_job_templates': 4000
+}
 
 test_report_expected_data = {
     'count': 1,
@@ -222,6 +242,7 @@ def mock_auth(superuser):
         mock_authenticate.return_value = superuser, None
         yield mock_authenticate
 
+
 @pytest.fixture(scope="function")
 def mock_auth_user(regularuser):
     with mock.patch("backend.apps.aap_auth.authentication.AAPAuthentication.authenticate") as mock_authenticate:
@@ -264,6 +285,7 @@ def test_template_options(self, mock_auth, currencies, projects, jobs, filter_se
         response = client.get("/api/v1/template_options/")
         assert response.status_code == 200
         data = response.json()
+        print(data)
         assert data == expected
 
     @pytest.mark.parametrize('expected', [test_report_expected_data])

src/frontend/app/Dashboard/Dashboard.tsx

@@ -4,7 +4,7 @@ import '@patternfly/react-styles/css/utilities/Spacing/spacing.css';
 import '@patternfly/react-styles/css/utilities/Sizing/sizing.css';
 import '@patternfly/react-styles/css/utilities/Text/text.css';
 import '@patternfly/react-styles/css/utilities/Flex/flex.css';
-import { Alert, Flex, FlexItem, Grid, GridItem, Spinner, Toolbar, ToolbarItem } from '@patternfly/react-core';
+import { Alert, Button, Flex, FlexItem, Grid, GridItem, HelperText, HelperTextItem, Modal, ModalBody, ModalFooter, ModalHeader, Spinner, Toolbar, ToolbarItem } from '@patternfly/react-core';
 import { RestService } from '@app/Services';
 import { deepClone, svgToPng } from '@app/Utils';
 import {
@@ -15,20 +15,20 @@ import {
   RequestFilter,
   TableResponse,
   TableResult,
-  UrlParams,
+  UrlParams
 } from '@app/Types';
 import ErrorState from '@patternfly/react-component-groups/dist/dynamic/ErrorState';
 import {
   DashboardBarChart,
   DashboardLineChart,
   DashboardTable,
   DashboardTopTable,
-  DashboardTotalCards,
+  DashboardTotalCards
 } from '@app/Dashboard';
 import { CurrencySelector } from '@app/Components';
 
 import useFilterStore from '@app/Store/filterStore';
-import useCommonStore  from '@app/Store/commonStore';
+import useCommonStore from '@app/Store/commonStore';
 import {
   useAutomatedProcessCost,
   useFilterRetrieveError,
@@ -51,7 +51,7 @@ const Dashboard: React.FunctionComponent = () => {
   const [requestParams, setRequestParams] = React.useState<RequestFilter>();
   const [paginationParams, setPaginationParams] = React.useState<PaginationParams>({
     page: 1,
-    page_size: 10,
+    page_size: 10
   } as PaginationParams);
   const [ordering, setOrdering] = React.useState<string>('name');
   const hourly_manual_costs = useManualCostAutomation();
@@ -66,6 +66,7 @@ const Dashboard: React.FunctionComponent = () => {
   const saveEnableTemplateCreationTime = useCommonStore((state) => state.saveEnableTemplateCreationTime);
   const setAutomatedProcessCost = useFilterStore((state) => state.setAutomatedProcessCost);
   const setManualProcessCost = useFilterStore((state) => state.setManualProcessCost);
+  const maxPDFJobTemplates = useFilterStore((state) => state.max_pdf_job_templates);
   const reloadData = useFilterStore((state)=>state.reloadData);
   const setReloadData = useFilterStore((state) => state.setReloadData);
   const handelError = (error: unknown) => {
@@ -75,6 +76,7 @@ const Dashboard: React.FunctionComponent = () => {
       setTableLoading(false);
     }
   };
+  const [isPDFWarningModalOpen, setPDFWarningModalOpen] = React.useState<boolean>(false);
 
   const fetchServerReportDetails = (signal: AbortSignal) => {
     if (!requestParams) {
@@ -112,7 +114,7 @@ const Dashboard: React.FunctionComponent = () => {
     RestService.fetchReports(controller.current.signal, {
       ...requestParams,
       ...paginationParams,
-      ...{ ordering: ordering },
+      ...{ ordering: ordering }
     } as UrlParams)
       .then((tableResponse) => {
         setTableData(tableResponse);
@@ -137,7 +139,7 @@ const Dashboard: React.FunctionComponent = () => {
       () => {
         fetchServerTableData(true, false);
       },
-      parseInt(refreshInterval) * 1000,
+      parseInt(refreshInterval) * 1000
     );
   };
 
@@ -244,28 +246,28 @@ const Dashboard: React.FunctionComponent = () => {
     {
       name: 'project_name',
       title: 'Project name',
-      isVisible: true,
+      isVisible: true
     },
     {
       name: 'count',
       title: 'Total no. of jobs',
       type: 'number',
-      isVisible: true,
-    },
+      isVisible: true
+    }
   ];
 
   const topUsersColumns: ColumnProps[] = [
     {
       name: 'user_name',
       title: 'User name',
-      isVisible: true,
+      isVisible: true
     },
     {
       name: 'count',
       title: 'Total no. of jobs',
       type: 'number',
-      isVisible: true,
-    },
+      isVisible: true
+    }
   ];
 
   const onInputFocus = () => {
@@ -293,7 +295,7 @@ const Dashboard: React.FunctionComponent = () => {
     RestService.exportToPDF(
       { ...requestParams, ...{ ordering: ordering } } as RequestFilter & OrderingParams,
       jobsChartPng,
-      hostChartPng,
+      hostChartPng
     )
       .then(() => {
         setPdfLoading(false);
@@ -304,8 +306,12 @@ const Dashboard: React.FunctionComponent = () => {
   };
 
   const onPdfBtnClick = () => {
-    setPdfLoading(true);
-    setTimeout(pdfDownload, 150);
+    if (tableData.count > maxPDFJobTemplates) {
+      setPDFWarningModalOpen(true);
+    } else {
+      setPdfLoading(true);
+      setTimeout(pdfDownload, 150);
+    }
   };
 
   const onEnableTemplateCreationTimeChange = async (checked: boolean) => {
@@ -324,12 +330,42 @@ const Dashboard: React.FunctionComponent = () => {
     <div>
       <div>This section lists the top five users of Ansible Automation Platform, with a breakdown of the total number of jobs run by each user.</div>
       <ul>
-        <br/>
-        <li><strong>○ NOTE:</strong> Scheduled jobs can affect these results, because they do not represent a real, logged-in user. </li>
+        <br />
+        <li><strong>○ NOTE:</strong> Scheduled jobs can affect these results, because they do not represent a real, logged-in user.</li>
       </ul>
     </div>
   );
 
+  const pdfModalTitle = (
+    <HelperText>
+      <HelperTextItem variant="error" style={{fontSize: '20px'}} >PDF Download Failed: Data Volume Exceeded</HelperTextItem>
+    </HelperText>
+  );
+
+  const pdfWarningModal = (
+    <Modal
+      isOpen={isPDFWarningModalOpen}
+      ouiaId="DFWarningModal"
+      aria-labelledby="pdf-warning-modal-title"
+      aria-describedby="pdf-warning-modal-body"
+      variant={'small'}
+    >
+      <ModalHeader title={pdfModalTitle} labelId="pdf-warning-modal-title" />
+      <ModalBody id="pdf-warning-modal-body">
+        <HelperText style={{fontSize: '14px'}}>
+          <HelperTextItem variant={'default'}>We were unable to generate your PDF because the selected report exceeds the maximum record limit.</HelperTextItem>
+          <HelperTextItem variant={'default'}>Please apply additional filters to narrow your data and retry.</HelperTextItem>
+        </HelperText>
+      </ModalBody>
+      <ModalFooter>
+        <Button
+          key="close"
+          variant="link"
+          onClick={() => {setPDFWarningModalOpen(false)}}>Close</Button>
+      </ModalFooter>
+    </Modal>
+  );
+
   // @ts-ignore
   return (
     <div>
@@ -354,13 +390,14 @@ const Dashboard: React.FunctionComponent = () => {
           />
         </div>
       )}
-      {logErrorMessage && 
-      <div className={'main-layout'}>
-        <Alert variant="danger" isInline title={logErrorMessage} />
-      </div>
+      {logErrorMessage &&
+        <div className={'main-layout'}>
+          <Alert variant="danger" isInline title={logErrorMessage} />
+        </div>
       }
       {!loadDataError && !filterError && !logErrorMessage && (
         <div className={'main-layout'}>
+          {pdfWarningModal}
           {(loading || pdfLoading) && (
             <div className={'loader'}>
               <Spinner className={'spinner'} diameter="80px" aria-label="Loader" />

src/frontend/app/Services/RestService.ts

@@ -102,7 +102,15 @@ const exportToPDF = async (
 ): Promise<void> => {
   const queryString = buildQueryString(params);
   return api
-    .post(`api/v1/report/pdf/${queryString}`, { job_chart: jobChart, host_chart: hostChart }, { responseType: 'blob' })
+    .post(`api/v1/report/pdf/${queryString}`,
+      {
+        job_chart: jobChart,
+        host_chart: hostChart
+      },
+      {
+        responseType: 'blob',
+        timeout: 0
+      })
     .then((response) => {
       downloadAttachment(response.data as never, 'AAP_Automation_Dashboard_Report.pdf');
       Promise.resolve();

src/frontend/app/Store/filterStore.ts

@@ -39,6 +39,8 @@ const useFilterStore = create<FilterStoreState & FilterStoreActions>((set) => ({
   loading: 'idle',
   error: false,
   reloadData: false,
+  max_pdf_job_templates: 0,
+
   fetchTemplateOptions: async () => {
     const {
       setCurrencies,
@@ -73,6 +75,7 @@ const useFilterStore = create<FilterStoreState & FilterStoreActions>((set) => ({
         manualCostAutomation: data.manual_cost_automation,
         automatedProcessCost: data.automated_process_cost,
         projectOptions: data.projects,
+        max_pdf_job_templates: data.max_pdf_job_templates
       });
     } catch {
       set({ loading: 'failed', error: true });

src/frontend/app/Types/FilterTypes.ts

@@ -35,6 +35,7 @@ export interface FilterOptionResponse {
   currency: number;
   enable_template_creation_time: boolean;
   filter_sets: FilterSet[];
+  max_pdf_job_templates: number,
 }
 
 export interface Settings {
@@ -55,6 +56,7 @@ export interface FilterState {
   organizationOptions: FilterOption[];
   loading: 'idle' | 'pending' | 'succeeded' | 'failed';
   error: boolean;
+  max_pdf_job_templates: number,
 }
 
 export interface RequestFilter {

tests/playwright/fixtures/templateOptions.json

@@ -756,5 +756,6 @@
                 "date_range": "last_6_month"
             }
         }
-    ]
+    ],
+    "max_pdf_job_templates": 4000
 }

tests/playwright/fixtures/templateOptionsAddReport.json

@@ -763,5 +763,6 @@
                 "date_range": "month_to_date"
             }
         }
-    ]
-}
+    ],
+    "max_pdf_job_templates": 4000
+}