snapshot of https://github.com/espocrm/espocrm.git (master, 2026-09-18; blobs > 131072B omitted)
Some checks failed
Test / Test on PHP 8.3 (push) Failing after 5s
Test / Test on PHP 8.4 (push) Failing after 4s
Test / Test on PHP 8.5 (push) Failing after 3s
TypeScript static analysis / TypeScript check (push) Failing after 14s
Test Integration on MySQL / Test on PHP 8.3 (push) Failing after 2s
Test Integration on MySQL / Test on PHP 8.5 (push) Failing after 0s
Test Integration on PostgreSQL / Test on PHP 8.4 fix (push) Failing after 1s
Test Integration on PostgreSQL / Test on PHP 8.4 master (push) Failing after 1s

This commit is contained in:
upstream-mirror
2026-09-18 04:19:15 +05:00
commit 7cc7e6b4f3
10077 changed files with 900756 additions and 0 deletions

View File

@@ -0,0 +1,44 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
use Closure;
class BypassEventTransport implements EventTransport
{
public function subscribe(Closure $callback): void
{}
public function publish(Envelope $envelope): void
{}
public function tick(): void
{}
}

View File

@@ -0,0 +1,55 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
/**
* @internal
*/
class Configuration
{
public function __construct(
private bool $subscribeToCrossInstanceEvents = false,
) {}
public function subscribeToCrossInstanceEvents(): bool
{
return $this->subscribeToCrossInstanceEvents;
}
/**
* @internal
*/
public function setSubscribeToCrossInstanceEvents(bool $value): self
{
$this->subscribeToCrossInstanceEvents = $value;
return $this;
}
}

View File

@@ -0,0 +1,44 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
/**
* @since 10.1.0
*/
readonly class Context
{
/**
* @internal
*/
public function __construct(
public bool $isLocal,
public string $origin,
) {}
}

View File

@@ -0,0 +1,39 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
use stdClass;
interface CrossInstanceEvent extends Event
{
public static function fromPayload(stdClass $payload): self;
public function toPayload(): stdClass;
}

View File

@@ -0,0 +1,138 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
use Closure;
use RuntimeException;
use Throwable;
class CrossInstanceEventDispatcher
{
/**
* @var array<class-string<Event>, (Closure(CrossInstanceEvent, Context): void)[]>
*/
private array $callbacks = [];
private bool $isTransportSubscribed = false;
public function __construct(
private EventTransport $transport,
private OriginProvider $originProvider,
) {}
/**
* @param class-string<CrossInstanceEvent> $className
* @param Closure(CrossInstanceEvent, Context): void $callback
*/
public function subscribe(string $className, Closure $callback): void
{
$this->ensureSubscribeTransport();
$this->callbacks[$className] ??= [];
$this->callbacks[$className][] = $callback;
}
/**
* @param class-string<CrossInstanceEvent> $className
* @param Closure(CrossInstanceEvent, Context): void $callback
*/
public function unsubscribe(string $className, Closure $callback): void
{
if (!array_key_exists($className, $this->callbacks)) {
return;
}
$list = &$this->callbacks[$className];
$index = array_search($callback, $list);
if ($index !== false) {
unset($list[$index]);
$list = array_values($list);
}
}
public function dispatch(CrossInstanceEvent $event): void
{
$envelope = new Envelope(
eventClassName: $event::class,
payload: $event->toPayload(),
origin: $this->originProvider->get(),
);
$this->transport->publish($envelope);
}
private function ensureSubscribeTransport(): void
{
if ($this->isTransportSubscribed) {
return;
}
$this->transport->subscribe(fn (Envelope $envelope) => $this->transportCallback($envelope));
$this->isTransportSubscribed = true;
}
private function transportCallback(Envelope $envelope): void
{
if ($envelope->origin === $this->originProvider->get()) {
return;
}
$className = $envelope->eventClassName;
if (!is_subclass_of($className, CrossInstanceEvent::class)) {
throw new RuntimeException("Non-valid event class name.");
}
$callbacks = $this->callbacks[$className] ?? [];
if ($callbacks === []) {
return;
}
try {
$event = $className::fromPayload($envelope->payload);
} catch (Throwable $e) {
throw new RuntimeException("Could not hydrate event '$className'.", previous: $e);
}
$context = new Context(
isLocal: false,
origin: $envelope->origin,
);
foreach ($callbacks as $callback) {
$callback($event, $context);
}
}
}

View File

@@ -0,0 +1,44 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
use stdClass;
readonly class Envelope
{
/**
* @param class-string<CrossInstanceEvent> $eventClassName
*/
public function __construct(
public string $eventClassName,
public stdClass $payload,
public string $origin,
) {}
}

View File

@@ -0,0 +1,36 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
/**
* @since 10.1.0
*/
interface Event
{}

View File

@@ -0,0 +1,118 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
use Closure;
/**
* @since 10.1.0
*/
class EventDispatcher
{
/**
* @var array<class-string<Event>, (Closure(Event, Context): void)[]>
*/
private array $callbacks = [];
public function __construct(
private OriginProvider $originProvider,
private CrossInstanceEventDispatcher $crossInstanceDispatcher,
private Configuration $configuration,
) {}
/**
* @template T of Event
* @param class-string<T> $className
* @param Closure(T, Context): void $callback
*/
public function subscribe(string $className, Closure $callback): void
{
/** @var Closure(Event, Context): void $callback */
$this->callbacks[$className] ??= [];
$this->callbacks[$className][] = $callback;
if (
$this->configuration->subscribeToCrossInstanceEvents() &&
is_subclass_of($className, CrossInstanceEvent::class)
) {
$this->crossInstanceDispatcher->subscribe($className, $callback);
}
}
/**
* @template T of Event
* @param class-string<T> $className
* @param Closure(T, Context): void $callback
*/
public function unsubscribe(string $className, Closure $callback): void
{
/** @var Closure(Event, Context): void $callback */
if (!array_key_exists($className, $this->callbacks)) {
return;
}
$list = &$this->callbacks[$className];
$index = array_search($callback, $list);
if ($index !== false) {
unset($list[$index]);
$list = array_values($list);
}
if (
$this->configuration->subscribeToCrossInstanceEvents() &&
is_subclass_of($className, CrossInstanceEvent::class)
) {
$this->crossInstanceDispatcher->unsubscribe($className, $callback);
}
}
public function dispatch(Event $event): void
{
$callbacks = $this->callbacks[$event::class] ?? [];
$localContext = new Context(
isLocal: true,
origin: $this->originProvider->get(),
);
foreach ($callbacks as $callback) {
$callback($event, $localContext);
}
if ($event instanceof CrossInstanceEvent) {
$this->crossInstanceDispatcher->dispatch($event);
}
}
}

View File

@@ -0,0 +1,51 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
use Closure;
use Espo\Core\Utils\Event\Exceptions\TransportNotConnected;
/**
* @since 10.1.0
*/
interface EventTransport
{
/**
* @param Closure(Envelope): void $callback
*/
public function subscribe(Closure $callback): void;
public function publish(Envelope $envelope): void;
/**
* @throws TransportNotConnected
*/
public function tick(): void;
}

View File

@@ -0,0 +1,55 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
use Espo\Core\Container\Loader;
use Espo\Core\InjectableFactory;
use Espo\Core\Utils\Config;
use Espo\Core\Utils\Event\Redis\RedisEventTransport;
/**
* @noinspection PhpUnused
*/
class EventTransportLoader implements Loader
{
public function __construct(
private InjectableFactory $injectableFactory,
private Config $config,
) {}
public function load(): EventTransport
{
if ($this->config->get('eventTransport') === 'Redis') {
return $this->injectableFactory->create(RedisEventTransport::class);
}
return $this->injectableFactory->create(BypassEventTransport::class);
}
}

View File

@@ -0,0 +1,35 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event\Exceptions;
use Exception;
class TransportNotConnected extends Exception
{}

View File

@@ -0,0 +1,47 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event;
use Espo\Core\Utils\Util;
/**
* @since 10.1.0
*/
class OriginProvider
{
private ?string $value = null;
public function get(): string
{
$this->value ??= Util::generateId();
return $this->value;
}
}

View File

@@ -0,0 +1,84 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event\Redis;
use Espo\Core\Utils\Config;
use Predis\Client;
use Predis\CommunicationException;
class ClientProvider
{
private ?Client $client = null;
public function __construct(
private Config $config,
) {}
public function get(): Client
{
if (!$this->client) {
$scheme = $this->config->get('redis.scheme') ?? null;
$port = $this->config->get('redis.port') ?? null;
$host = $this->config->get('redis.host') ?? null;
$params = [];
if ($scheme !== null) {
$params['scheme'] = $scheme;
}
if ($host !== null) {
$params['host'] = $host;
}
if ($port !== null) {
$params['port'] = $port;
}
$this->client = new Client($params);
}
return $this->client;
}
/**
* @noinspection PhpRedundantCatchClauseInspection
*/
public function reconnect(): void
{
try {
$this->client?->disconnect();
} catch (CommunicationException) {}
$client = $this->get();
$client->connect();
}
}

View File

@@ -0,0 +1,202 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Utils\Event\Redis;
use Closure;
use Espo\Core\Utils\Event\CrossInstanceEvent;
use Espo\Core\Utils\Event\Envelope;
use Espo\Core\Utils\Event\EventTransport;
use Espo\Core\Utils\Json;
use Espo\Core\Utils\Log;
use LogicException;
use Predis\Connection\ConnectionException;
use RuntimeException;
use stdClass;
use Throwable;
class RedisEventTransport implements EventTransport
{
private const string STREAM_NAME = 'espocrm:events';
private const int COUNT = 50;
private const int MAX_STREAM_LENGTH = 10000;
/**
* @var ?(Closure(Envelope): void) $callback
*/
private ?Closure $callback = null;
private ?string $lastId = null;
public function __construct(
private ClientProvider $clientProvider,
private Log $log,
) {}
public function subscribe(Closure $callback): void
{
$this->callback = $callback;
}
/**
* @noinspection PhpRedundantCatchClauseInspection
*/
public function publish(Envelope $envelope): void
{
$json = Json::encode([
'eventClassName' => $envelope->eventClassName,
'payload' => $envelope->payload,
'origin' => $envelope->origin,
]);
try {
$this->publishRaw($json);
} catch (ConnectionException $e) {
$this->log->info("Redis connection lost, reconnecting.", ['exception' => $e]);
$this->clientProvider->reconnect();
$this->publishRaw($json);
}
}
public function tick(): void
{
$client = $this->clientProvider->get();
if ($this->lastId === null) {
$response = $client->xread(1, null, [self::STREAM_NAME], '+');
$this->lastId = '0';
foreach (($response[self::STREAM_NAME] ?? []) as $item) {
[$messageId] = $this->getMessageData($item);
$this->lastId = $messageId;
break;
}
}
$response = $client->xread(self::COUNT, null, [self::STREAM_NAME], $this->lastId);
$jsonItems = [];
foreach (($response[self::STREAM_NAME] ?? []) as $item) {
[$messageId, $json] = $this->getMessageData($item);
$this->lastId = $messageId;
$jsonItems[] = $json;
}
if (!$this->callback) {
return;
}
foreach ($jsonItems as $json) {
$this->processMessageItem($json);
}
}
private function processMessageItem(string $json): void
{
if (!$this->callback) {
throw new LogicException();
}
$data = Json::decode($json);
/** @var ?class-string<CrossInstanceEvent> $eventClassName */
$eventClassName = $data->eventClassName ?? null;
$payload = $data->payload ?? null;
$origin = $data->origin ?? null;
if (!is_string($eventClassName)) {
throw new RuntimeException();
}
if (!$payload instanceof stdClass) {
throw new RuntimeException();
}
if (!is_string($origin)) {
throw new RuntimeException();
}
$envelope = new Envelope(
eventClassName: $eventClassName,
payload: $payload,
origin: $origin,
);
try {
($this->callback)($envelope);
} catch (Throwable $e) {
$this->log->error("Event callback error, {eventClassName}.", [
'exception' => $e,
'eventClassName' => $eventClassName,
'origin' => $origin,
]);
}
}
private function publishRaw(string $json): void
{
$client = $this->clientProvider->get();
$options = [
'trim' => ['MAXLEN', self::MAX_STREAM_LENGTH],
];
// Magic method is used.
$client->xadd(self::STREAM_NAME, ['data' => $json], '*', $options);
}
/**
* @param array<int, mixed> $item
* @return array{string, string}
*/
private function getMessageData(mixed $item): array
{
$messageId = $item[0] ?? null;
$json = $item[1][1] ?? null;
if ($messageId === null) {
throw new RuntimeException("Bad message data, no ID.");
}
if (!is_string($json)) {
throw new RuntimeException("Bad message data.");
}
return [$messageId, $json];
}
}