Initial commit

application/Espo/Core/Job/JobRunner.php

@@ -0,0 +1,270 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Job;
+
+use Espo\Core\ORM\EntityManager;
+use Espo\Core\ServiceFactory;
+use Espo\Core\Utils\Log;
+use Espo\Core\Utils\System;
+use Espo\Core\Job\Job\Data;
+use Espo\Core\Job\Job\Status;
+use Espo\Entities\Job as JobEntity;
+
+use Espo\ORM\Name\Attribute;
+use LogicException;
+use RuntimeException;
+use Throwable;
+
+class JobRunner
+{
+    public function __construct(
+        private JobFactory $jobFactory,
+        private ScheduleUtil $scheduleUtil,
+        private EntityManager $entityManager,
+        private ServiceFactory $serviceFactory,
+        private Log $log,
+    ) {}
+
+    /**
+     * Run a job entity. Does not throw exceptions.
+     */
+    public function run(JobEntity $jobEntity): void
+    {
+        try {
+            $this->runInternal($jobEntity);
+        } catch (Throwable $e) {
+            throw new LogicException($e->getMessage());
+        }
+    }
+
+    /**
+     * Run a job entity. Throws exceptions.
+     *
+     * @throws Throwable
+     */
+    public function runThrowingException(JobEntity $jobEntity): void
+    {
+        $this->runInternal($jobEntity, true);
+    }
+
+    /**
+     * Run a job by ID. A job must have status 'Ready'.
+     * Used when running jobs in parallel processes.
+     */
+    public function runById(string $id): void
+    {
+        if ($id === '') {
+            throw new RuntimeException("Empty job ID.");
+        }
+
+        /** @var ?JobEntity $jobEntity */
+        $jobEntity = $this->entityManager->getEntityById(JobEntity::ENTITY_TYPE, $id);
+
+        if (!$jobEntity) {
+            throw new RuntimeException("Job '$id' not found.");
+        }
+
+        if ($jobEntity->getStatus() !== Status::READY) {
+            throw new RuntimeException("Can't run job '$id' with not Ready status.");
+        }
+
+        $this->setJobRunning($jobEntity);
+
+        $this->run($jobEntity);
+    }
+
+    /**
+     * @throws Throwable
+     */
+    private function runInternal(JobEntity $jobEntity, bool $throwException = false): void
+    {
+        $isSuccess = true;
+        $exception = null;
+
+        if ($jobEntity->getStatus() !== Status::RUNNING) {
+            $this->setJobRunning($jobEntity);
+        }
+
+        try {
+            if ($jobEntity->getScheduledJobId()) {
+                $this->runScheduledJob($jobEntity);
+            } else if ($jobEntity->getJob()) {
+                $this->runJobNamed($jobEntity);
+            } else if ($jobEntity->getClassName()) {
+                $this->runJobWithClassName($jobEntity);
+            } else if ($jobEntity->getServiceName()) {
+                $this->runService($jobEntity);
+            } else {
+                $id = $jobEntity->getId();
+
+                throw new RuntimeException("Not runnable job '$id'.");
+            }
+        } catch (Throwable $e) {
+            $isSuccess = false;
+
+            $jobId = $jobEntity->hasId() ? $jobEntity->getId() : null;
+
+            $this->log->critical("Failed job {id}. {message}", [
+                'exception' => $e,
+                'message' => $e->getMessage(),
+                Attribute::ID => $jobId,
+            ]);
+
+            if ($throwException) {
+                $exception = $e;
+            }
+        }
+
+        $status = $isSuccess ? Status::SUCCESS : Status::FAILED;
+
+        $jobEntity->setStatus($status);
+
+        if ($isSuccess) {
+            $jobEntity->setExecutedAtNow();
+        }
+
+        $this->entityManager->saveEntity($jobEntity);
+
+        if ($throwException && $exception) {
+            throw new $exception($exception->getMessage());
+        }
+
+        if ($jobEntity->getScheduledJobId()) {
+            $this->scheduleUtil->addLogRecord(
+                $jobEntity->getScheduledJobId(),
+                $status,
+                null,
+                $jobEntity->getTargetId(),
+                $jobEntity->getTargetType()
+            );
+        }
+    }
+
+    private function runJobNamed(JobEntity $jobEntity): void
+    {
+        $jobName = $jobEntity->getJob();
+
+        if (!$jobName) {
+            throw new RuntimeException("No job name.");
+        }
+
+        $job = $this->jobFactory->create($jobName);
+
+        $this->runJob($job, $jobEntity);
+    }
+
+    private function runScheduledJob(JobEntity $jobEntity): void
+    {
+        $jobName = $jobEntity->getScheduledJobJob();
+
+        if (!$jobName) {
+            throw new RuntimeException("Can't run job '{$jobEntity->getId()}'. Not a scheduled job.");
+        }
+
+        $job = $this->jobFactory->create($jobName);
+
+        $this->runJob($job, $jobEntity);
+    }
+
+    private function runJobWithClassName(JobEntity $jobEntity): void
+    {
+        $className = $jobEntity->getClassName();
+
+        if (!$className) {
+            throw new RuntimeException("No className in job {$jobEntity->getId()}.");
+        }
+
+        $job = $this->jobFactory->createByClassName($className);
+
+        $this->runJob($job, $jobEntity);
+    }
+
+    /**
+     * @param Job|JobDataLess $job
+     * @internal Native type is not used for bc.
+     */
+    private function runJob($job, JobEntity $jobEntity): void
+    {
+        if ($job instanceof JobDataLess) {
+            $job->run();
+
+            return;
+        }
+
+        $data = Data::create($jobEntity->getData())
+            ->withTargetId($jobEntity->getTargetId())
+            ->withTargetType($jobEntity->getTargetType());
+
+        $job->run($data);
+    }
+
+    private function runService(JobEntity $jobEntity): void
+    {
+        $serviceName = $jobEntity->getServiceName();
+
+        if (!$serviceName) {
+            throw new RuntimeException("Job with empty serviceName.");
+        }
+
+        if (!$this->serviceFactory->checkExists($serviceName)) {
+            throw new RuntimeException("No service $serviceName.");
+        }
+
+        $service = $this->serviceFactory->create($serviceName);
+
+        $methodName = $jobEntity->getMethodName();
+
+        if (!$methodName) {
+            throw new RuntimeException('Job with empty methodName.');
+        }
+
+        if (!method_exists($service, $methodName)) {
+            throw new RuntimeException("No method '$methodName' in service '$serviceName'.");
+        }
+
+        $service->$methodName(
+            $jobEntity->getData(),
+            $jobEntity->getTargetId(),
+            $jobEntity->getTargetType()
+        );
+    }
+
+    private function setJobRunning(JobEntity $jobEntity): void
+    {
+        if (!$jobEntity->getStartedAt()) {
+            $jobEntity->setStartedAtNow();
+        }
+
+        $jobEntity->setStatus(Status::RUNNING);
+        $jobEntity->setPid(System::getPid());
+
+        $this->entityManager->saveEntity($jobEntity);
+    }
+}