Add debug flag to pdf export

solidtime-io · Dec 3, 2024 · ad49c40 · ad49c40
1 parent d3f2d0a
commit ad49c40
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 4 deletions.
diff --git a/app/Http/Controllers/Api/V1/TimeEntryController.php b/app/Http/Controllers/Api/V1/TimeEntryController.php
@@ -173,6 +173,7 @@ public function indexExport(Organization $organization, TimeEntryIndexExportRequ
         } else {
             $this->checkPermission($organization, 'time-entries:view:all');
         }
+        $debug = $request->getDebug();
         $format = $request->getFormatValue();
         if ($format === ExportFormat::PDF && ! $this->canAccessPremiumFeatures($organization)) {
             throw new FeatureIsNotAvailableInFreePlanApiException;
@@ -195,7 +196,7 @@ public function indexExport(Organization $organization, TimeEntryIndexExportRequ
             $export = new TimeEntriesDetailedCsvExport(config('filesystems.private'), $folderPath, $filename, $timeEntriesQuery, 1000, $timezone);
             $export->export();
         } elseif ($format === ExportFormat::PDF) {
-            if (config('services.gotenberg.url') === null) {
+            if (config('services.gotenberg.url') === null && ! $debug) {
                 throw new PdfRendererIsNotConfiguredException;
             }
             $viewFile = file_get_contents(resource_path('views/reports/time-entry-index/pdf.blade.php'));
@@ -225,6 +226,13 @@ public function indexExport(Organization $organization, TimeEntryIndexExportRequ
                 throw new \LogicException('View file not found');
             }
             $footerHtml = Blade::render($footerViewFile);
+            if ($debug) {
+                return response()->json([
+                    'html' => $html,
+                    'footer_html' => $footerHtml,
+                ]);
+            }
+
             $client = new Client([
                 'auth' => config('services.gotenberg.basic_auth_username') !== null && config('services.gotenberg.basic_auth_password') !== null ? [
                     config('services.gotenberg.basic_auth_username'),
@@ -347,6 +355,7 @@ public function aggregateExport(Organization $organization, TimeEntryAggregateEx
         if ($format === ExportFormat::PDF && ! $this->canAccessPremiumFeatures($organization)) {
             throw new FeatureIsNotAvailableInFreePlanApiException;
         }
+        $debug = $request->getDebug();
         $user = $this->user();
 
         $group = $request->getGroup();
@@ -381,7 +390,7 @@ public function aggregateExport(Organization $organization, TimeEntryAggregateEx
         $path = $folderPath.'/'.$filename;
 
         if ($format === ExportFormat::PDF) {
-            if (config('services.gotenberg.url') === null) {
+            if (config('services.gotenberg.url') === null && ! $debug) {
                 throw new PdfRendererIsNotConfiguredException;
             }
             $client = new Client([
@@ -402,12 +411,19 @@ public function aggregateExport(Organization $organization, TimeEntryAggregateEx
                 'subGroup' => $subGroup,
                 'start' => $request->getStart()->timezone($timezone),
                 'end' => $request->getEnd()->timezone($timezone),
+                'debug' => $debug,
             ]);
             $footerViewFile = file_get_contents(resource_path('views/reports/time-entry-aggregate/pdf-footer.blade.php'));
             if ($footerViewFile === false) {
                 throw new \LogicException('View file not found');
             }
             $footerHtml = Blade::render($footerViewFile);
+            if ($debug) {
+                return response()->json([
+                    'html' => $html,
+                    'footer_html' => $footerHtml,
+                ]);
+            }
             $request = Gotenberg::chromium(config('services.gotenberg.url'))
                 ->pdf()
                 ->waitForExpression("window.status === 'ready'")

diff --git a/app/Http/Requests/V1/TimeEntry/TimeEntryAggregateExportRequest.php b/app/Http/Requests/V1/TimeEntry/TimeEntryAggregateExportRequest.php
@@ -160,9 +160,18 @@ public function rules(): array
                 'string',
                 'in:true,false',
             ],
+            'debug' => [
+                'string',
+                'in:true,false',
+            ],
         ];
     }
 
+    public function getDebug(): bool
+    {
+        return $this->input('debug') === 'true';
+    }
+
     public function getGroup(): TimeEntryAggregationType
     {
         return TimeEntryAggregationType::from($this->input('group'));

diff --git a/app/Http/Requests/V1/TimeEntry/TimeEntryIndexExportRequest.php b/app/Http/Requests/V1/TimeEntry/TimeEntryIndexExportRequest.php
@@ -129,9 +129,18 @@ public function rules(): array
                 'string',
                 'in:true,false',
             ],
+            'debug' => [
+                'string',
+                'in:true,false',
+            ],
         ];
     }
 
+    public function getDebug(): bool
+    {
+        return $this->input('debug', 'false') === 'true';
+    }
+
     public function getStart(): Carbon
     {
         $start = Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $this->input('start'), 'UTC');

diff --git a/resources/pdf-js/echarts.min.js b/resources/pdf-js/echarts.min.js
diff --git a/resources/views/reports/time-entry-aggregate/pdf.blade.php b/resources/views/reports/time-entry-aggregate/pdf.blade.php
@@ -48,7 +48,7 @@
     <script>
         window.status = 'processing';
     </script>
-    <script src="echarts.min.js"></script>
+    <script src="{{ $debug ? 'https://cdn.jsdelivr.net/npm/echarts@5.5.1/dist/echarts.min.js' : 'echarts.min.js' }}"></script>
 </head>
 <body>