Workload report expansion

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+* [PR-178](https://github.com/itk-dev/economics/pull/178)
+  2597: Workload report expansion.
 * [PR-175](https://github.com/itk-dev/economics/pull/175)
   2617: Added forecast report.
 * [PR-173](https://github.com/itk-dev/economics/pull/173)

migrations/Version20241217124134.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20241217124134 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('CREATE TABLE epic (id INT AUTO_INCREMENT NOT NULL, title VARCHAR(255) NOT NULL, PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB');
+        $this->addSql('CREATE TABLE issue_epic (issue_id INT NOT NULL, epic_id INT NOT NULL, INDEX IDX_412E98BD5E7AA58C (issue_id), INDEX IDX_412E98BD6B71E00E (epic_id), PRIMARY KEY(issue_id, epic_id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB');
+        $this->addSql('ALTER TABLE issue_epic ADD CONSTRAINT FK_412E98BD5E7AA58C FOREIGN KEY (issue_id) REFERENCES issue (id) ON DELETE CASCADE');
+        $this->addSql('ALTER TABLE issue_epic ADD CONSTRAINT FK_412E98BD6B71E00E FOREIGN KEY (epic_id) REFERENCES epic (id) ON DELETE CASCADE');
+        $this->addSql('ALTER TABLE version ADD is_billable TINYINT(1) NOT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE issue_epic DROP FOREIGN KEY FK_412E98BD5E7AA58C');
+        $this->addSql('ALTER TABLE issue_epic DROP FOREIGN KEY FK_412E98BD6B71E00E');
+        $this->addSql('DROP TABLE epic');
+        $this->addSql('DROP TABLE issue_epic');
+        $this->addSql('ALTER TABLE version DROP is_billable');
+    }
+}

src/Command/SyncWorklogsCommand.php

@@ -54,11 +54,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $this->dataSynchronizationService->syncWorklogsForProject($project->getId(), function ($i, $length) use ($io) {
                     if (0 == $i) {
                         $io->progressStart($length);
-                    } elseif ($i >= $length - 1) {
-                        $io->progressFinish();
-                    } else {
+                    }
+
+                    if ($i < $length) {
                         $io->progressAdvance();
                     }
+
+                    if ($i == $length - 1) {
+                        $io->progressFinish();
+                    }
                 }, $dataProvider);
 
                 $io->writeln('');

src/Controller/WorkloadReportController.php

@@ -6,7 +6,6 @@
 use App\Model\Reports\WorkloadReportFormData;
 use App\Model\Reports\WorkloadReportPeriodTypeEnum as PeriodTypeEnum;
 use App\Model\Reports\WorkloadReportViewModeEnum as ViewModeEnum;
-use App\Repository\DataProviderRepository;
 use App\Service\WorkloadReportService;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
@@ -19,7 +18,6 @@
 class WorkloadReportController extends AbstractController
 {
     public function __construct(
-        private readonly DataProviderRepository $dataProviderRepository,
         private readonly WorkloadReportService $workloadReportService,
     ) {
     }
@@ -43,23 +41,14 @@ public function index(Request $request): Response
 
         $form->handleRequest($request);
 
-        $requestData = $request->query->all('workload_report');
+        if ($form->isSubmitted() && $form->isValid()) {
+            $viewPeriodType = $form->get('viewPeriodType')->getData() ?? PeriodTypeEnum::WEEK;
+            $viewMode = $form->get('viewMode')->getData() ?? ViewModeEnum::WORKLOAD;
 
-        if (!empty($requestData['dataProvider'])) {
-            $dataProvider = $this->dataProviderRepository->find($requestData['dataProvider']);
-
-            if ($form->isSubmitted() && $form->isValid()) {
-                $selectedDataProvider = $form->get('dataProvider')->getData() ?? $dataProvider;
-                $viewPeriodType = $form->get('viewPeriodType')->getData() ?? PeriodTypeEnum::WEEK;
-                $viewMode = $form->get('viewMode')->getData() ?? ViewModeEnum::WORKLOAD;
-
-                if ($selectedDataProvider) {
-                    try {
-                        $reportData = $this->workloadReportService->getWorkloadReport($viewPeriodType, $viewMode);
-                    } catch (\Exception $e) {
-                        $error = $e->getMessage();
-                    }
-                }
+            try {
+                $reportData = $this->workloadReportService->getWorkloadReport($viewPeriodType, $viewMode);
+            } catch (\Exception $e) {
+                $error = $e->getMessage();
             }
         }
 

src/Entity/Epic.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace App\Entity;
+
+use App\Repository\EpicRepository;
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity(repositoryClass: EpicRepository::class)]
+class Epic
+{
+    public function __construct()
+    {
+        $this->issues = new ArrayCollection();
+    }
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column]
+    private ?int $id = null;
+
+    #[ORM\Column(length: 255)]
+    private ?string $title = null;
+
+    #[ORM\ManyToMany(targetEntity: Issue::class, mappedBy: 'epics')]
+    private Collection $issues;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getTitle(): ?string
+    {
+        return $this->title;
+    }
+
+    public function setTitle(string $title): static
+    {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    /**
+     * @return Collection<int, Epic>
+     */
+    public function getIssues(): Collection
+    {
+        return $this->issues;
+    }
+
+    public function addIssue(Issue $issue): self
+    {
+        if (!$this->issues->contains($issue)) {
+            $this->issues->add($issue);
+        }
+
+        return $this;
+    }
+
+    public function removeIssue(Issue $issues): self
+    {
+        $this->issues->removeElement($issues);
+
+        return $this;
+    }
+}

src/Entity/Issue.php

@@ -43,6 +43,8 @@ class Issue extends AbstractBaseEntity
     #[ORM\Column(length: 255, nullable: true)]
     private ?string $epicName = null;
 
+    #[ORM\ManyToMany(targetEntity: Epic::class, inversedBy: 'issues')]
+    private Collection $epics;
     #[ORM\ManyToMany(targetEntity: Version::class, inversedBy: 'issues')]
     private Collection $versions;
 
@@ -79,6 +81,7 @@ public function __construct()
         $this->versions = new ArrayCollection();
         $this->worklogs = new ArrayCollection();
         $this->products = new ArrayCollection();
+        $this->epics = new ArrayCollection();
     }
 
     public function getName(): ?string
@@ -201,6 +204,30 @@ public function removeVersion(Version $version): self
         return $this;
     }
 
+    /**
+     * @return Collection<int, Epic>
+     */
+    public function getEpics(): Collection
+    {
+        return $this->epics;
+    }
+
+    public function addEpic(Epic $epic): self
+    {
+        if (!$this->epics->contains($epic)) {
+            $this->epics->add($epic);
+        }
+
+        return $this;
+    }
+
+    public function removeEpic(Epic $epic): self
+    {
+        $this->epics->removeElement($epic);
+
+        return $this;
+    }
+
     /**
      * @return Collection<int, Worklog>
      */

src/Entity/IssueEpic.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+class IssueEpic extends AbstractBaseEntity
+{
+    #[ORM\Column(length: 255)]
+    private ?string $name = null;
+
+    #[ORM\Column(length: 255)]
+    private ?string $value = null;
+
+    #[ORM\Column(length: 255, nullable: true)]
+    private ?string $projectTrackerId = null;
+}

src/Entity/Version.php

@@ -29,6 +29,9 @@ class Version extends AbstractBaseEntity
     #[ORM\ManyToMany(targetEntity: Issue::class, mappedBy: 'versions')]
     private Collection $issues;
 
+    #[ORM\Column]
+    private ?bool $isBillable = true;
+
     public function __construct()
     {
         $this->issues = new ArrayCollection();
@@ -101,4 +104,16 @@ public function removeIssue(Issue $issue): self
 
         return $this;
     }
+
+    public function isBillable(): ?bool
+    {
+        return $this->isBillable;
+    }
+
+    public function setIsBillable(bool $isBillable): static
+    {
+        $this->isBillable = $isBillable;
+
+        return $this;
+    }
 }

src/Enum/NonBillableEpicsEnum.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Enum;
+
+/*
+ * Kind is a term on a worklog in Leantime:
+ * https://github.com/Leantime/leantime/blob/80c4542e19692e423820bd9030907070d281571e/app/Domain/Timesheets/Services/Timesheets.php#L22
+ * */
+enum NonBillableEpicsEnum: string
+{
+    case UB = 'UB';
+
+    /**
+     * @return array<string,string>
+     */
+    public static function getAsArray(): array
+    {
+        return array_reduce(
+            self::cases(),
+            static fn (array $choices, NonBillableEpicsEnum $type) => $choices + [$type->name => $type->value],
+            [],
+        );
+    }
+}

src/Enum/NonBillableVersionsEnum.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Enum;
+
+enum NonBillableVersionsEnum: string
+{
+    case UB = 'UB';
+
+    /**
+     * @return array<string,string>
+     */
+    public static function getAsArray(): array
+    {
+        return array_reduce(
+            self::cases(),
+            static fn (array $choices, NonBillableVersionsEnum $type) => $choices + [$type->name => $type->value],
+            [],
+        );
+    }
+}

src/Form/WorkloadReportType.php

@@ -2,12 +2,9 @@
 
 namespace App\Form;
 
-use App\Entity\DataProvider;
 use App\Model\Reports\WorkloadReportFormData;
 use App\Model\Reports\WorkloadReportPeriodTypeEnum as PeriodTypeEnum;
 use App\Model\Reports\WorkloadReportViewModeEnum;
-use App\Repository\DataProviderRepository;
-use Symfony\Bridge\Doctrine\Form\Type\EntityType;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\EnumType;
 use Symfony\Component\Form\Extension\Core\Type\SubmitType;
@@ -17,32 +14,12 @@
 class WorkloadReportType extends AbstractType
 {
     public function __construct(
-        private readonly DataProviderRepository $dataProviderRepository,
-        private readonly ?string $defaultDataProvider,
     ) {
     }
 
     public function buildForm(FormBuilderInterface $builder, array $options): void
     {
-        $dataProviders = $this->dataProviderRepository->findAll();
-        $defaultProvider = $this->dataProviderRepository->find($this->defaultDataProvider);
-
-        if (null === $defaultProvider && count($dataProviders) > 0) {
-            $defaultProvider = $dataProviders[0];
-        }
-
         $builder
-            ->add('dataProvider', EntityType::class, [
-                'class' => DataProvider::class,
-                'required' => false,
-                'label' => 'workload_report.select_data_provider',
-                'label_attr' => ['class' => 'label'],
-                'attr' => [
-                    'class' => 'form-element',
-                ],
-                'data' => $defaultProvider,
-                'choices' => $dataProviders,
-            ])
             ->add('viewMode', EnumType::class, [
                 'required' => false,
                 'label' => 'workload_report.select_viewmode',

src/Interface/DataProviderServiceInterface.php

@@ -6,7 +6,6 @@
 use App\Model\Invoices\ClientData;
 use App\Model\Invoices\PagedResult;
 use App\Model\Invoices\ProjectDataCollection;
-use App\Model\Invoices\WorklogDataCollection;
 use App\Model\Planning\PlanningData;
 use App\Model\SprintReport\SprintReportData;
 use App\Model\SprintReport\SprintReportProjects;
@@ -36,5 +35,5 @@ public function getSprintReportVersions(string $projectId): SprintReportVersions
 
     public function getProjectDataCollection(): ProjectDataCollection;
 
-    public function getWorklogDataCollection(string $projectId): WorklogDataCollection;
+    public function getWorklogDataForProjectPaged(string $projectId, int $startAt = 0, $maxResults = 50): PagedResult;
 }