tao-test/app/tao/models/classes/webhooks/WebhookEventsService.php

<?php

/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2019 (original work) Open Assessment Technologies SA;
 */

namespace oat\tao\model\webhooks;

use oat\oatbox\event\Event;
use oat\oatbox\event\EventManager;
use oat\oatbox\log\LoggerAwareTrait;
use oat\oatbox\service\ConfigurableService;
use oat\tao\model\exceptions\WebhookConfigMissingException;
use oat\tao\model\webhooks\configEntity\WebhookInterface;
use oat\tao\model\webhooks\task\WebhookTaskParams;

class WebhookEventsService extends ConfigurableService implements WebhookEventsServiceInterface
{
    use LoggerAwareTrait;

    /**
     * Option value is array of ['eventName' => true, ... ] of supported events
     * Such array structure is needed to perform quick search by key
     */
    const OPTION_SUPPORTED_EVENTS = 'supportedEvents';

    /**
     * @inheritDoc
     */
    public function registerEvent($eventName)
    {
        $supportedEvents = $this->getRegisteredEvents();
        $supportedEvents[$eventName] = true;
        $this->setOption(self::OPTION_SUPPORTED_EVENTS, $supportedEvents);

        $this->getEventManager()->attach($eventName, $this->getEventHandlerCallback());
    }

    /**
     * @inheritDoc
     */
    public function unregisterEvent($eventName)
    {
        $supportedEvents = $this->getRegisteredEvents();
        unset($supportedEvents[$eventName]);
        $this->setOption(self::OPTION_SUPPORTED_EVENTS, $supportedEvents);

        $this->getEventManager()->detach($eventName, $this->getEventHandlerCallback());
    }

    /**
     * @inheritDoc
     */
    public function isEventRegistered($eventName)
    {
        $supportedEvents = $this->getRegisteredEvents();
        return isset($supportedEvents[$eventName]);
    }

    /**
     * @return string[]
     */
    public function getRegisteredEvents()
    {
        $events = $this->getOption(self::OPTION_SUPPORTED_EVENTS);
        return $events !== null
            ? $events
            : [];
    }

    public function handleEvent(Event $event)
    {
        if (!$this->checkEventIsSupported($event)) {
            return;
        }

        /** @var WebhookSerializableEventInterface $event */

        $webhookConfigIds = $this->getWebhookRegistry()->getWebhookConfigIds($event->getName());
        if (count($webhookConfigIds) === 0) {
            return;
        }

        $tasksParams = $this->prepareTasksParams($event, $webhookConfigIds);
        $this->createWebhookTasks($tasksParams);
    }

    /**
     * @param Event $event
     * @return bool
     */
    private function checkEventIsSupported(Event $event)
    {
        $eventName = $event->getName();

        if (!$this->isEventRegistered($eventName)) {
            $this->logError("Event '$eventName' is not supported by " . self::class);
            return false;
        }

        if (!($event instanceof WebhookSerializableEventInterface)) {
            $this->logError(sprintf(
                'Event "%s" passed to "%s" is not implementing "%s"',
                $eventName,
                self::class,
                WebhookSerializableEventInterface::class
            ));
            return false;
        }

        return true;
    }

    /**
     * @param WebhookSerializableEventInterface $event
     * @param string[] $webhookConfigIds
     * @return WebhookTaskParams[]
     * @throws WebhookConfigMissingException
     */
    private function prepareTasksParams(WebhookSerializableEventInterface $event, $webhookConfigIds)
    {
        try {
            $eventData = $event->serializeForWebhook();
        } catch (\Exception $exception) {
            $this->logError(sprintf(
                'Error during "%s" event serialization for webhook. %s',
                $event->getName(),
                $exception->getMessage()
            ));
            return [];
        }

        $triggeredTimestamp = time();
        $eventId = $this->generateEventId($event->getName());

        $result = [];

        foreach ($webhookConfigIds as $webhookConfigId) {
            if (($webhookConfig = $this->getWebhookRegistry()->getWebhookConfig($webhookConfigId)) === null) {
                throw new WebhookConfigMissingException(sprintf('Webhook config for id %s not found', $webhookConfigId));
            }
            $result[] = new WebhookTaskParams([
                WebhookTaskParams::EVENT_NAME => $event->getWebhookEventName(),
                WebhookTaskParams::EVENT_ID => $eventId,
                WebhookTaskParams::TRIGGERED_TIMESTAMP => $triggeredTimestamp,
                WebhookTaskParams::EVENT_DATA => $this->extendPayload($webhookConfig, $eventData),
                WebhookTaskParams::WEBHOOK_CONFIG_ID => $webhookConfigId,
                WebhookTaskParams::RETRY_COUNT => 1,
                WebhookTaskParams::RETRY_MAX => $webhookConfig->getMaxRetries(),
                WebhookTaskParams::RESPONSE_VALIDATION => $webhookConfig->getResponseValidationEnable(),
            ]);
        }

        return $result;
    }

    /**
     * @param WebhookTaskParams[] $tasksParams
     */
    private function createWebhookTasks($tasksParams)
    {
        foreach ($tasksParams as $taskParams) {
            try {
                $this->getWebhookTaskService()->createTask($taskParams);
            } catch (\Exception $exception) {
                $this->logError(
                    sprintf(
                        "Can't create webhook task for %s. %s",
                        $taskParams[WebhookTaskParams::EVENT_ID],
                        $exception->getMessage()
                    ),
                    (array) $taskParams
                );
                continue;
            }
        }
    }

    /**
     * @param string $eventName
     * @return string
     */
    private function generateEventId($eventName)
    {
        return md5(
            microtime() .
            mt_rand() .
            $eventName .
            gethostname()
        );
    }

    /**
     * @return array|callable
     */
    private function getEventHandlerCallback()
    {
        return [self::SERVICE_ID, 'handleEvent'];
    }

    /**
     * @return WebhookRegistryInterface
     */
    private function getWebhookRegistry()
    {
        /** @noinspection PhpIncompatibleReturnTypeInspection */
        return $this->getServiceLocator()->get(WebhookRegistryInterface::SERVICE_ID);
    }

    /**
     * @return WebhookTaskServiceInterface
     */
    private function getWebhookTaskService()
    {
        /** @noinspection PhpIncompatibleReturnTypeInspection */
        return $this->getServiceLocator()->get(WebhookTaskServiceInterface::SERVICE_ID);
    }

    /**
     * @return EventManager
     */
    private function getEventManager()
    {
        /** @noinspection PhpIncompatibleReturnTypeInspection */
        return $this->getServiceLocator()->get(EventManager::SERVICE_ID);
    }

    private function extendPayload(WebhookInterface $webhookConfig, array $eventData): array
    {
        if (empty($webhookConfig->getExtraPayload())) {
            return $eventData;
        }

        return array_merge($webhookConfig->getExtraPayload(), $eventData);
    }
}