refactor: batch (#123)

* refactor: batch * namespace reorg * add timing * restore metrics * cosmetic * revert composer.json
rekalogika · Jul 16, 2024 · f637baf · f637baf
1 parent 2e2d412
commit f637baf
Show file tree

Hide file tree

Showing 14 changed files with 394 additions and 176 deletions.
diff --git a/packages/rekapager-core/src/Batch/BatchProcess.php b/packages/rekapager-core/src/Batch/BatchProcess.php
@@ -60,35 +60,37 @@ final public function process(
         ?string $resume = null,
         ?int $pageSize = null
     ): void {
+        // determine start page identifier
+
         if ($resume !== null) {
             $startPageIdentifier = $this->pageableIdentifierResolver
                 ->decode($this->pageable, $resume);
         } else {
             $startPageIdentifier = null;
         }
 
+        // prepare pages
+
         $itemsPerPage = $pageSize ?? $this->batchProcessor->getItemsPerPage();
         $pageable = $this->pageable->withItemsPerPage($itemsPerPage);
+        $pages = $pageable->getPages($startPageIdentifier);
+
+        // emit event
 
         $beforeProcessEvent = new BeforeProcessEvent(
+            pageable: $pageable,
             startPageIdentifier: $resume,
         );
 
         $this->batchProcessor->beforeProcess($beforeProcessEvent);
 
-        $pages = $pageable->getPages($startPageIdentifier);
-
-        $numOfPages = 0;
-        $numOfItems = 0;
-
         foreach ($pages as $page) {
-            $numOfPages++;
-
             $pageIdentifier = $page->getPageIdentifier();
             $pageIdentifierString = $this->pageableIdentifierResolver->encode($pageIdentifier);
 
             if ($this->stopFlag) {
                 $interruptEvent = new InterruptEvent(
+                    pageable: $pageable,
                     nextPageIdentifier: $pageIdentifierString,
                 );
 
@@ -105,8 +107,6 @@ final public function process(
             $this->batchProcessor->beforePage($beforePageEvent);
 
             foreach ($page as $key => $item) {
-                $numOfItems++;
-
                 $itemEvent = new ItemEvent(
                     key: $key,
                     item: $item,
@@ -122,7 +122,9 @@ final public function process(
             $this->batchProcessor->afterPage($afterPageEvent);
         }
 
-        $afterProcessEvent = new AfterProcessEvent();
+        $afterProcessEvent = new AfterProcessEvent(
+            pageable: $pageable,
+        );
 
         $this->batchProcessor->afterProcess($afterProcessEvent);
     }

diff --git a/packages/rekapager-core/src/Batch/BatchProcessorDecorator.php b/packages/rekapager-core/src/Batch/BatchProcessorDecorator.php
@@ -28,42 +28,44 @@
 abstract class BatchProcessorDecorator implements BatchProcessorInterface
 {
     /**
-     * @return BatchProcessorInterface<TKey,T>
+     * @param BatchProcessorInterface<TKey,T> $decorated
      */
-    abstract protected function getDecorated(): BatchProcessorInterface;
+    public function __construct(private BatchProcessorInterface $decorated)
+    {
+    }
 
     public function processItem(ItemEvent $itemEvent): void
     {
-        $this->getDecorated()->processItem($itemEvent);
+        $this->decorated->processItem($itemEvent);
     }
 
     public function getItemsPerPage(): int
     {
-        return $this->getDecorated()->getItemsPerPage();
+        return $this->decorated->getItemsPerPage();
     }
 
     public function beforeProcess(BeforeProcessEvent $event): void
     {
-        $this->getDecorated()->beforeProcess($event);
+        $this->decorated->beforeProcess($event);
     }
 
     public function afterProcess(AfterProcessEvent $event): void
     {
-        $this->getDecorated()->afterProcess($event);
+        $this->decorated->afterProcess($event);
     }
 
     public function beforePage(BeforePageEvent $event): void
     {
-        $this->getDecorated()->beforePage($event);
+        $this->decorated->beforePage($event);
     }
 
     public function afterPage(AfterPageEvent $event): void
     {
-        $this->getDecorated()->afterPage($event);
+        $this->decorated->afterPage($event);
     }
 
     public function onInterrupt(InterruptEvent $event): void
     {
-        $this->getDecorated()->onInterrupt($event);
+        $this->decorated->onInterrupt($event);
     }
 }
diff --git a/packages/rekapager-core/src/Batch/BatchProcessorInterface.php b/packages/rekapager-core/src/Batch/BatchProcessorInterface.php
@@ -36,7 +36,14 @@ public function processItem(ItemEvent $itemEvent): void;
      */
     public function getItemsPerPage(): int;
 
+    /**
+     * @param BeforeProcessEvent<TKey,T> $event
+     */
     public function beforeProcess(BeforeProcessEvent $event): void;
+
+    /**
+     * @param AfterProcessEvent<TKey,T> $event
+     */
     public function afterProcess(AfterProcessEvent $event): void;
 
     /**
@@ -49,5 +56,8 @@ public function beforePage(BeforePageEvent $event): void;
      */
     public function afterPage(AfterPageEvent $event): void;
 
+    /**
+     * @param InterruptEvent<TKey,T> $event
+     */
     public function onInterrupt(InterruptEvent $event): void;
 }
diff --git a/packages/rekapager-core/src/Batch/Event/AfterProcessEvent.php b/packages/rekapager-core/src/Batch/Event/AfterProcessEvent.php
@@ -13,9 +13,27 @@
 
 namespace Rekalogika\Rekapager\Batch\Event;
 
+use Rekalogika\Contracts\Rekapager\PageableInterface;
+
+/**
+ * @template TKey of array-key
+ * @template T
+ */
 final class AfterProcessEvent
 {
-    public function __construct()
+    /**
+     * @param PageableInterface<TKey,T> $pageable
+     */
+    public function __construct(
+        private readonly PageableInterface $pageable,
+    ) {
+    }
+
+    /**
+     * @return PageableInterface<TKey,T>
+     */
+    public function getPageable(): PageableInterface
     {
+        return $this->pageable;
     }
 }
diff --git a/packages/rekapager-core/src/Batch/Event/BeforeProcessEvent.php b/packages/rekapager-core/src/Batch/Event/BeforeProcessEvent.php
@@ -13,9 +13,19 @@
 
 namespace Rekalogika\Rekapager\Batch\Event;
 
+use Rekalogika\Contracts\Rekapager\PageableInterface;
+
+/**
+ * @template TKey of array-key
+ * @template T
+ */
 final class BeforeProcessEvent
 {
+    /**
+     * @param PageableInterface<TKey,T> $pageable
+     */
     public function __construct(
+        private readonly PageableInterface $pageable,
         private readonly ?string $startPageIdentifier,
     ) {
     }
@@ -24,4 +34,12 @@ public function getStartPageIdentifier(): ?string
     {
         return $this->startPageIdentifier;
     }
+
+    /**
+     * @return PageableInterface<TKey,T>
+     */
+    public function getPageable(): PageableInterface
+    {
+        return $this->pageable;
+    }
 }
diff --git a/packages/rekapager-core/src/Batch/Event/InterruptEvent.php b/packages/rekapager-core/src/Batch/Event/InterruptEvent.php
@@ -13,13 +13,31 @@
 
 namespace Rekalogika\Rekapager\Batch\Event;
 
+use Rekalogika\Contracts\Rekapager\PageableInterface;
+
+/**
+ * @template TKey of array-key
+ * @template T
+ */
 final class InterruptEvent
 {
+    /**
+     * @param PageableInterface<TKey,T> $pageable
+     */
     public function __construct(
+        private readonly PageableInterface $pageable,
         private readonly ?string $nextPageIdentifier,
     ) {
     }
 
+    /**
+     * @return PageableInterface<TKey,T>
+     */
+    public function getPageable(): PageableInterface
+    {
+        return $this->pageable;
+    }
+
     public function getNextPageIdentifier(): ?string
     {
         return $this->nextPageIdentifier;

diff --git a/...pager-symfony-bridge/src/BatchCommand.php → ...symfony-bridge/src/Batch/BatchCommand.php b/...pager-symfony-bridge/src/BatchCommand.php → ...symfony-bridge/src/Batch/BatchCommand.php
@@ -11,7 +11,7 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Rekapager\Symfony;
+namespace Rekalogika\Rekapager\Symfony\Batch;
 
 use Rekalogika\Contracts\Rekapager\Exception\InvalidArgumentException;
 use Rekalogika\Contracts\Rekapager\Exception\LogicException;
@@ -20,6 +20,7 @@
 use Rekalogika\Rekapager\Batch\BatchProcess;
 use Rekalogika\Rekapager\Batch\BatchProcessFactoryInterface;
 use Rekalogika\Rekapager\Batch\BatchProcessorInterface;
+use Rekalogika\Rekapager\Symfony\Batch\Internal\CommandBatchProcessorDecorator;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Command\SignalableCommandInterface;
 use Symfony\Component\Console\Input\InputInterface;
@@ -112,7 +113,7 @@ final protected function execute(InputInterface $input, OutputInterface $output)
         $pageable = $this->getPageable($input, $output);
         $this->io = new SymfonyStyle($input, $output);
 
-        $batchProcessor = new BatchProcessorDecorator(
+        $batchProcessor = new CommandBatchProcessorDecorator(
             decorated: $this->getBatchProcessor(),
             io: $this->io,
             progressFile: $progressFile,

diff --git a/packages/rekapager-symfony-bridge/src/Batch/Internal/BatchTimer.php b/packages/rekapager-symfony-bridge/src/Batch/Internal/BatchTimer.php
@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of rekalogika/rekapager package.
+ *
+ * (c) Priyadi Iman Nurcahyo <https://rekalogika.dev>
+ *
+ * For the full copyright and license information, please view the LICENSE file
+ * that was distributed with this source code.
+ */
+
+namespace Rekalogika\Rekapager\Symfony\Batch\Internal;
+
+use Rekalogika\Contracts\Rekapager\Exception\LogicException;
+
+/**
+ * @internal
+ */
+class BatchTimer
+{
+    public const TIMER_PROCESS = 'process';
+    public const TIMER_PAGE = 'page';
+    public const TIMER_ITEM = 'item';
+    public const TIMER_DISPLAY = 'display';
+
+    /**
+     * @var array<BatchTimer::TIMER_*,int|float>
+     */
+    private array $timers = [];
+
+    /**
+     * @param BatchTimer::TIMER_* $timer
+     */
+    public function start(string $timer): void
+    {
+        if (isset($this->timers[$timer])) {
+            throw new LogicException(sprintf('Timer "%s" is already started.', $timer));
+        }
+
+        $this->timers[$timer] = hrtime(true);
+    }
+
+    /**
+     * @param BatchTimer::TIMER_* $timer
+     */
+    public function stop(string $timer): float
+    {
+        $result = $this->getDuration($timer);
+
+        if ($result === null) {
+            throw new LogicException(sprintf('Timer "%s" has not been started yet.', $timer));
+        }
+
+        $this->reset($timer);
+
+        return $result;
+    }
+
+    /**
+     * @param BatchTimer::TIMER_* $timer
+     */
+    public function restart(string $timer): void
+    {
+        $this->reset($timer);
+        $this->start($timer);
+    }
+
+    /**
+     * @param BatchTimer::TIMER_* $timer
+     */
+    public function reset(string $timer): void
+    {
+        unset($this->timers[$timer]);
+    }
+
+    /**
+     * @param BatchTimer::TIMER_* $timer
+     */
+    public function getDuration(string $timer): ?float
+    {
+        if (!isset($this->timers[$timer])) {
+            return null;
+        }
+
+        return (hrtime(true) - $this->timers[$timer]) / 1e9;
+    }
+}