Cleanup and resoving deprecated issues in async module.

Author: krulis-martin

app/async/Dispatcher.php

@@ -84,7 +84,7 @@ public function unschedule(AsyncJob $job): bool
 
         try {
             $rows = 0;
-            $this->entityManager->transactional(function ($em) use ($job, &$rows) {
+            $this->entityManager->wrapInTransaction(function ($em) use ($job, &$rows) {
                 $qb = $em->createQueryBuilder();
                 $qb->delete(AsyncJob::class, 'aj')
                     ->where($qb->expr()->isNull("aj.startedAt"))

app/async/IAsyncJobHandler.php

@@ -3,8 +3,6 @@
 namespace App\Async;
 
 use App\Model\Entity\AsyncJob;
-use Nette\Utils\Arrays;
-use Nette;
 
 /**
  * Interface implemented by all asynchronous job handlers.
@@ -25,14 +23,14 @@ public function getId(): string;
     public function checkArgs(array $args): bool;
 
     /**
-     * The main method of the async job does what the job is ment to do.
+     * The main method of the async job does what the job is meant to do.
      * @param AsyncJob $job entity to be executed
      */
     public function execute(AsyncJob $job);
 
     /**
      * Called by signal handler to terminate the job asap (but gracefully).
-     * If the job is not interruptable, this function should be implemented with empty body.
+     * If the job is not interrupt-able, this function should be implemented with empty body.
      */
     public function cancel(): void;
 }

app/async/Notify.php

@@ -19,7 +19,7 @@ class Notify
      */
     public static function isAvailable(): bool
     {
-        $requirements = [ 'inotify_init', 'inotify_add_watch', 'inotify_read', 'inotify_queue_len', 'stream_select' ];
+        $requirements = ['inotify_init', 'inotify_add_watch', 'inotify_read', 'inotify_queue_len', 'stream_select'];
         foreach ($requirements as $reqFnc) {
             if (!function_exists($reqFnc)) {
                 return false;
@@ -118,7 +118,7 @@ public function isNotified(): bool
     }
 
     /**
-     * Wait (block) until a nofitication is risen or timeout is breached.
+     * Wait (block) until a notification is risen or timeout is breached.
      * @param int $timeout maximal waiting time in seconds
      * @return bool true if notifications were collected, false on timeout
      * @throws LogicException
@@ -136,7 +136,7 @@ public function waitForNotification(int $timeout = 1): bool
             );
         }
 
-        $streams = [ $this->inotifyStream ];
+        $streams = [$this->inotifyStream];
         @stream_select($streams, $streams, $streams, $timeout); // will block until event or timeout
         return $this->isNotifiedInternal();
     }

app/async/Worker.php

@@ -56,7 +56,7 @@ class Worker
     private $timeToRestart = null;
 
     /**
-     * @var int number of jobs remainig to process (once it reaches zero, the worker terminates so it can be restarted)
+     * @var int number of jobs remaining to process (once it reaches zero, the worker terminates so it can be restarted)
      */
     private $jobsRemaining = 1;
 
@@ -93,7 +93,7 @@ public function __construct(array $config, Dispatcher $dispatcher, AsyncJobs $as
 
         $this->quiet = (bool)Arrays::get($config, "quiet", false);
 
-        // setup signal handling (try to terminate gracefuly on these signals)
+        // setup signal handling (try to terminate gracefully on these signals)
         if (function_exists('pcntl_async_signals') && function_exists('pcntl_signal')) {
             pcntl_async_signals(true);
             pcntl_signal(SIGINT, [$this, 'terminate']);
@@ -112,7 +112,7 @@ public function terminate(): void
 
     /**
      * Test whether the worker shall process jobs further, or whether it should go for restart.
-     * @return bool true if it shoud continue
+     * @return bool true if it should continue
      */
     private function shallContinue(): bool
     {
@@ -195,7 +195,7 @@ private function dispatchJob(AsyncJob $job)
             );
         }
 
-        // we need to relaod the job since the dispatcher might cleared the caches...
+        // we need to reload the job since the dispatcher might cleared the caches...
         $jobReloaded = $this->asyncJobs->get($id);
         if ($jobReloaded) {
             if ($error) {
@@ -209,12 +209,12 @@ private function dispatchJob(AsyncJob $job)
 
     /**
      * Main method of the worker that actually processes the async job.
-     * This method is blockinig, once it terminates the worker process should also terminate.
+     * This method is blocking, once it terminates the worker process should also terminate.
      * @param string $workerId identifier of the worker (should be gathered from the CLI arguments)
      */
     public function run(string $workerId)
     {
-        $this->notify->init(); // start listeining for notifications
+        $this->notify->init(); // start listening for notifications
 
         while ($this->shallContinue()) { // just a precaution so the worker will not run forever
             // allocate and mark the best suitable job (null = none available)

app/async/handlers/AssignmentNotificationJobHandler.php

@@ -5,11 +5,9 @@
 use App\Model\Entity\AsyncJob;
 use App\Model\Entity\User;
 use App\Model\Entity\Assignment;
-use App\Model\Repository\Assignments;
 use App\Async\IAsyncJobHandler;
 use App\Async\Dispatcher;
 use App\Helpers\Notifications\AssignmentEmailsSender;
-use InvalidArgumentException;
 
 /**
  * Scheduled job that sends email notifications when the assignment becomes visible.

app/async/handlers/PingAsyncJobHandler.php

@@ -44,6 +44,6 @@ public static function dispatchAsyncJob(Dispatcher $dispatcher, ?User $user): As
 
     public function cancel(): void
     {
-        // ping is not interruptable, nothing to do here
+        // ping is not interrupt-able, nothing to do here
     }
 }

app/exceptions/ConfigException.php

@@ -6,7 +6,7 @@
 use Nette\Http\IResponse;
 
 /**
- * Exception concerning core module confugration.
+ * Exception concerning core module configuration.
  */
 class ConfigException extends ApiException
 {

app/exceptions/ExerciseCompilationException.php

@@ -10,7 +10,6 @@
  */
 class ExerciseCompilationException extends ApiException
 {
-
     /**
      * Create instance with further description.
      * @param string $msg description

app/exceptions/ExerciseCompilationSoftException.php

@@ -10,7 +10,6 @@
  */
 class ExerciseCompilationSoftException extends ExerciseCompilationException
 {
-
     /**
      * Constructor.
      * @param string $msg description

app/exceptions/FrontendErrorMappings.php

@@ -19,7 +19,7 @@ class FrontendErrorMappings
     public const E400_004__UPLOADED_FILE_INVALID_SIZE = "400-004";
     /** Per-partes upload is not completed yet */
     public const E400_005__UPLOADED_FILE_PARTIAL = "400-005";
-    /** Entity version is too old (concurrent edits occured) */
+    /** Entity version is too old (concurrent edits occurred) */
     public const E400_010__ENTITY_VERSION_TOO_OLD = "400-010";
 
     /** Invalid credentials */