3602: Billable unbilled hours report

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+* [PR-195](https://github.com/itk-dev/economics/pull/195)
+  3602: Added billable unbilled hours report.
 * [PR-196](https://github.com/itk-dev/economics/pull/196)
   3624: Correctly handling periods when viewing past workload reports.
 * [PR-194](https://github.com/itk-dev/economics/pull/194)

src/Controller/BillableUnbilledHoursReportController.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace App\Controller;
+
+use App\Form\BillableUnbilledHoursReportType;
+use App\Model\Reports\BillableUnbilledHoursReportFormData;
+use App\Service\BillableUnbilledHoursReportService;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
+
+#[Route('/admin/reports/billable_unbilled_hours_report')]
+#[IsGranted('ROLE_REPORT')]
+class BillableUnbilledHoursReportController extends AbstractController
+{
+    public function __construct(
+        private readonly BillableUnbilledHoursReportService $billableUnbilledHoursReportService,
+    ) {
+    }
+
+    #[Route('/', name: 'app_billable_unbilled_hours_report')]
+    public function index(Request $request): Response
+    {
+        $reportData = null;
+        $error = null;
+        $mode = 'billable_unbilled_hours_report';
+        $reportFormData = new BillableUnbilledHoursReportFormData();
+
+        $form = $this->createForm(BillableUnbilledHoursReportType::class, $reportFormData, [
+            'action' => $this->generateUrl('app_billable_unbilled_hours_report'),
+            'method' => 'GET',
+            'attr' => [
+                'id' => 'sprint_report',
+            ],
+            'years' => [
+                (new \DateTime())->modify('-1 year')->format('Y'),
+                (new \DateTime())->format('Y'),
+            ],
+            'csrf_protection' => false,
+        ]);
+
+        $form->handleRequest($request);
+
+        if ($form->isSubmitted() && $form->isValid()) {
+            $year = $form->get('year')->getData();
+
+            try {
+                $reportData = $this->billableUnbilledHoursReportService->getBillableUnbilledHoursReport($year);
+            } catch (\Exception $e) {
+                $error = $e->getMessage();
+            }
+        }
+
+        return $this->render('reports/reports.html.twig', [
+            'controller_name' => 'BillableUnbilledHoursReportController',
+            'form' => $form,
+            'error' => $error,
+            'data' => $reportData,
+            'mode' => $mode,
+        ]);
+    }
+}

src/Form/BillableUnbilledHoursReportType.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace App\Form;
+
+use App\Model\Reports\BillableUnbilledHoursReportFormData;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\Extension\Core\Type\SubmitType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class BillableUnbilledHoursReportType extends AbstractType
+{
+    public function __construct(
+    ) {
+    }
+
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $yearChoices = [];
+        foreach ($options['years'] as $year) {
+            $yearChoices[$year] = $year;
+        }
+
+        $builder
+            ->add('year', ChoiceType::class, [
+                'label' => 'billable_unbilled_hours_report.year',
+                'label_attr' => ['class' => 'label'],
+                'attr' => ['class' => 'form-element '],
+                'help_attr' => ['class' => 'form-help'],
+                'row_attr' => ['class' => 'form-row'],
+                'required' => false,
+                'data' => $yearChoices[date('Y')],
+                'choices' => $yearChoices,
+                'placeholder' => null,
+            ])
+            ->add('submit', SubmitType::class, [
+                'label' => 'billable_unbilled_hours_report.submit',
+                'attr' => [
+                    'class' => 'hour-report-submit button',
+                ],
+            ]);
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'data_class' => BillableUnbilledHoursReportFormData::class,
+            'attr' => [
+                'data-sprint-report-target' => 'form',
+            ],
+            'years' => null,
+        ]);
+    }
+}

src/Model/Reports/BillableUnbilledHoursReportData.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Model\Reports;
+
+use Doctrine\Common\Collections\ArrayCollection;
+
+class BillableUnbilledHoursReportData
+{
+    public string $id;
+
+    /** @var ArrayCollection<string, mixed> */
+    public ArrayCollection $projectData;
+    public array $projectTotals;
+    public int|float $totalHoursForAllProjects;
+
+    public function __construct()
+    {
+        $this->projectData = new ArrayCollection();
+    }
+}

src/Model/Reports/BillableUnbilledHoursReportFormData.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace App\Model\Reports;
+
+class BillableUnbilledHoursReportFormData
+{
+    public int $year;
+}

src/Repository/WorklogRepository.php

@@ -113,7 +113,7 @@ public function findWorklogsByWorkerAndDateRange(string $workerIdentifier, \Date
             ->getQuery()->getResult();
     }
 
-    public function findBillableWorklogsByWorkerAndDateRange(string $workerIdentifier, \DateTime $dateFrom, \DateTime $dateTo)
+    public function findBillableWorklogsByWorkerAndDateRange(\DateTime $dateFrom, \DateTime $dateTo, ?string $workerIdentifier = null)
     {
         $nonBillableEpics = NonBillableEpicsEnum::getAsArray();
         $nonBillableVersions = NonBillableVersionsEnum::getAsArray();
@@ -125,29 +125,32 @@ public function findBillableWorklogsByWorkerAndDateRange(string $workerIdentifie
             ->leftJoin('issue.epics', 'epic')
             ->leftJoin('issue.versions', 'version');
 
-        return $qb
-            ->where($qb->expr()->between('worklog.started', ':dateFrom', ':dateTo'))
-            ->andWhere('worklog.worker = :worker')
+        $qb->where($qb->expr()->between('worklog.started', ':dateFrom', ':dateTo'))
             ->andWhere($qb->expr()->andX(
-                $qb->expr()->eq('project.isBillable', '1'),
+                $qb->expr()->eq('project.isBillable', '1')
             ))
-            // notIn will only work if the string it is checked against is not null
             ->andWhere($qb->expr()->orX(
                 $qb->expr()->isNull('epic.title'),
-                $qb->expr()->notIn('epic.title', ':nonBillableEpics'),
+                $qb->expr()->notIn('epic.title', ':nonBillableEpics')
             ))
             ->andWhere($qb->expr()->orX(
                 $qb->expr()->isNull('version.name'),
                 $qb->expr()->notIn('version.name', ':nonBillableVersions')
             ))
-            ->setParameters([
-                'worker' => $workerIdentifier,
-                'dateFrom' => $dateFrom,
-                'dateTo' => $dateTo,
-                'nonBillableEpics' => array_values($nonBillableEpics),
-                'nonBillableVersions' => array_values($nonBillableVersions),
-            ])
-            ->getQuery()->getResult();
+            ->andWhere($qb->expr()->isNotNull('worklog.isBilled'));
+
+        // Add the worker condition only when provided
+        if (null !== $workerIdentifier) {
+            $qb->andWhere('worklog.worker = :worker')
+                ->setParameter('worker', $workerIdentifier);
+        }
+
+        return $qb->setParameters([
+            'dateFrom' => $dateFrom,
+            'dateTo' => $dateTo,
+            'nonBillableEpics' => array_values($nonBillableEpics),
+            'nonBillableVersions' => array_values($nonBillableVersions),
+        ])->getQuery()->getResult();
     }
 
     public function findBilledWorklogsByWorkerAndDateRange(string $workerIdentifier, \DateTime $dateFrom, \DateTime $dateTo)

src/Service/BillableUnbilledHoursReportService.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace App\Service;
+
+use App\Model\Reports\BillableUnbilledHoursReportData;
+use App\Repository\WorkerRepository;
+use App\Repository\WorklogRepository;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+class BillableUnbilledHoursReportService
+{
+    private const SECONDS_TO_HOURS = 1 / 3600;
+
+    public function __construct(
+        private readonly WorklogRepository $worklogRepository,
+        private readonly DateTimeHelper $dateTimeHelper,
+        private readonly WorkerRepository $workerRepository,
+        private readonly TranslatorInterface $translator,
+    ) {
+    }
+
+    public function getBillableUnbilledHoursReport(
+        int $year,
+    ): BillableUnbilledHoursReportData {
+        $billableUnbilledHoursReportData = new BillableUnbilledHoursReportData();
+        ['dateFrom' => $dateFrom, 'dateTo' => $dateTo] = $this->dateTimeHelper->getFirstAndLastDateOfYear($year);
+
+        $billableWorklogs = $this->worklogRepository->findBillableWorklogsByWorkerAndDateRange($dateFrom, $dateTo);
+
+        $projectData = [];
+        $projectTotals = [];
+        $totalHoursForAllProjects = 0;
+
+        foreach ($billableWorklogs as $billableWorklog) {
+            if (false === $billableWorklog->isBilled()) {
+                $projectName = $billableWorklog->getProject()->getName();
+                $issueName = $billableWorklog->getIssue()->getName();
+
+                // Initialize issue data if not already set
+                if (!isset($projectData[$projectName][$issueName])) {
+                    $projectData[$projectName][$issueName] = [
+                        'worklogs' => [],
+                        'totalHours' => 0,
+                        'id' => $billableWorklog->getIssue()->getProjectTrackerId(),
+                        'linkToIssue' => $billableWorklog->getIssue()->getLinkToIssue(),
+                    ];
+                }
+
+                $workerIdentifier = $billableWorklog->getWorker();
+                $workerName = $this->workerRepository->findOneBy(['email' => $workerIdentifier])?->getName() ?? '';
+
+                // Add the worklog to the issue
+                $projectData[$projectName][$issueName]['worklogs'][] = [
+                    'worker' => !empty($workerName) ? $workerName : $this->translator->trans('billable_unbilled_hours_report.no_worker'),
+                    'description' => !empty($billableWorklog->getDescription()) ? $billableWorklog->getDescription() : $this->translator->trans('billable_unbilled_hours_report.no_description'),
+                    'hours' => $billableWorklog->getTimeSpentSeconds() * self::SECONDS_TO_HOURS,
+                ];
+
+                // Increment the issue total hours
+                $projectData[$projectName][$issueName]['totalHours'] += $billableWorklog->getTimeSpentSeconds() * self::SECONDS_TO_HOURS;
+
+                // Initialize project total if not already set
+                if (!isset($projectTotals[$projectName])) {
+                    $projectTotals[$projectName] = 0;
+                }
+
+                // Add to the project total hours
+                $projectTotals[$projectName] += $billableWorklog->getTimeSpentSeconds() * self::SECONDS_TO_HOURS;
+
+                // Add to the global total hours
+                $totalHoursForAllProjects += $billableWorklog->getTimeSpentSeconds() * self::SECONDS_TO_HOURS;
+            }
+        }
+
+        // Add project data, project totals, and global total to the report data
+        $billableUnbilledHoursReportData->projectData->add($projectData);
+        $billableUnbilledHoursReportData->projectTotals = $projectTotals;
+        $billableUnbilledHoursReportData->totalHoursForAllProjects = $totalHoursForAllProjects;
+
+        return $billableUnbilledHoursReportData;
+    }
+}

src/Service/InvoicingRateReportService.php

@@ -254,7 +254,7 @@ private function getWorklogs(InvoicingRateReportViewModeEnum $viewMode, string $
         return match ($viewMode) {
             InvoicingRateReportViewModeEnum::SUMMARY => [
                 $this->worklogRepository->findWorklogsByWorkerAndDateRange($workerIdentifier, $dateFrom, $dateTo),
-                $this->worklogRepository->findBillableWorklogsByWorkerAndDateRange($workerIdentifier, $dateFrom, $dateTo),
+                $this->worklogRepository->findBillableWorklogsByWorkerAndDateRange($dateFrom, $dateTo, $workerIdentifier),
                 $this->worklogRepository->findBilledWorklogsByWorkerAndDateRange($workerIdentifier, $dateFrom, $dateTo),
             ],
         };

src/Service/WorkloadReportService.php

@@ -235,7 +235,7 @@ private function getWorklogs(ViewModeEnum $viewMode, string $workerIdentifier, \
     {
         return match ($viewMode) {
             ViewModeEnum::WORKLOAD => $this->worklogRepository->findWorklogsByWorkerAndDateRange($workerIdentifier, $dateFrom, $dateTo),
-            ViewModeEnum::BILLABLE => $this->worklogRepository->findBillableWorklogsByWorkerAndDateRange($workerIdentifier, $dateFrom, $dateTo),
+            ViewModeEnum::BILLABLE => $this->worklogRepository->findBillableWorklogsByWorkerAndDateRange($dateFrom, $dateTo, $workerIdentifier),
             ViewModeEnum::BILLED => $this->worklogRepository->findBilledWorklogsByWorkerAndDateRange($workerIdentifier, $dateFrom, $dateTo),
         };
     }

templates/components/navigation.html.twig

@@ -31,6 +31,7 @@
                 <ul class="navigation-item-submenu">
                   {{ include('components/navigation-item.html.twig', {title: 'navigation.management_report'|trans, role: 'ROLE_REPORT', route: path('app_management_reports_create')}) }}
                     {{ include('components/navigation-item.html.twig', {title: 'navigation.forecast_report'|trans, role: 'ROLE_REPORT', route: path('app_forecast_report')}) }}
+                    {{ include('components/navigation-item.html.twig', {title: 'navigation.billable_unbilled_hours_report'|trans, role: 'ROLE_REPORT', route: path('app_billable_unbilled_hours_report')}) }}
                   {{ include('components/navigation-item.html.twig', {title: 'navigation.hour_report'|trans, role: 'ROLE_REPORT', route: path('app_hour_report')}) }}
                     {{ include('components/navigation-item.html.twig', {title: 'navigation.workload_report'|trans, role: 'ROLE_REPORT', route: path('app_workload_report')}) }}
                     {{ include('components/navigation-item.html.twig', {title: 'navigation.invoicing_rate_report'|trans, role: 'ROLE_REPORT', route: path('app_invoicing_rate_report')}) }}