snapshot of https://github.com/espocrm/espocrm.git (master, 2026-09-18; blobs > 131072B omitted)

tests/unit/Espo/Core/Utils/Event/CrossInstanceEventDispatcherTest.php

@@ -0,0 +1,79 @@
+<?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 tests\unit\Espo\Core\Utils\Event;
+
+use Espo\Core\Utils\Event\Context;
+use Espo\Core\Utils\Event\CrossInstanceEventDispatcher;
+use Espo\Core\Utils\Event\OriginProvider;
+use PHPUnit\Framework\TestCase;
+
+class CrossInstanceEventDispatcherTest extends TestCase
+{
+    public function testDispatching(): void
+    {
+        $originProvider = $this->getOriginProvider();
+
+        $transport = new TestTransport();
+
+        $dispatcher = new CrossInstanceEventDispatcher(
+            transport: $transport,
+            originProvider: $originProvider,
+        );
+
+        $value = false;
+
+        $callback1 = function (TestCiEvent1 $event, Context $context) use (&$value) {
+            if (!$context->isLocal && $event->value === 'hello') {
+                $value = true;
+            }
+        };
+
+        $callback2 = function () use (&$value) {
+            $value = false;
+        };
+
+        $dispatcher->subscribe(TestCiEvent1::class, $callback1);
+        $dispatcher->subscribe(TestCiEvent2::class, $callback2);
+
+        $transport->dispatchForTest(TestCiEvent1::class, (object) ['value' => 'hello']);
+
+        $this->assertTrue($value);
+    }
+
+    private function getOriginProvider(): OriginProvider
+    {
+        $originProvider = $this->createMock(OriginProvider::class);
+
+        $originProvider->method('get')
+            ->willReturn('test-id');
+
+        return $originProvider;
+    }
+}

tests/unit/Espo/Core/Utils/Event/EventDispatcherTest.php

@@ -0,0 +1,95 @@
+<?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 tests\unit\Espo\Core\Utils\Event;
+
+use Espo\Core\Utils\Event\Configuration;
+use Espo\Core\Utils\Event\Context;
+use Espo\Core\Utils\Event\CrossInstanceEventDispatcher;
+use Espo\Core\Utils\Event\EventDispatcher;
+use Espo\Core\Utils\Event\OriginProvider;
+use PHPUnit\Framework\TestCase;
+
+class EventDispatcherTest extends TestCase
+{
+    public function testLocalDispatching() : void
+    {
+        $originProvider = $this->getOriginProvider();
+        $crossInstanceDispatcher = $this->createMock(CrossInstanceEventDispatcher::class);
+
+        $dispatcher = new EventDispatcher(
+            originProvider: $originProvider,
+            crossInstanceDispatcher: $crossInstanceDispatcher,
+            configuration: $this->createMock(Configuration::class),
+        );
+
+        //
+
+        $value = false;
+
+        $callback1 = function (TestEvent1 $event, Context $context) use (&$value, $originProvider) {
+            if ($context->isLocal && $context->origin === $originProvider->get()) {
+                $value = true;
+            }
+        };
+
+        $dispatcher->subscribe(TestEvent1::class, $callback1);
+
+        $dispatcher->subscribe(
+            TestEvent2::class,
+            function () use (&$value) {
+                $value = false;
+            }
+        );
+
+        $dispatcher->dispatch(new TestEvent1());
+
+        $this->assertTrue($value);
+
+        //
+
+        $dispatcher->unsubscribe(TestEvent1::class, $callback1);
+
+        $value = false;
+
+        $dispatcher->dispatch(new TestEvent1());
+
+        $this->assertFalse($value);
+    }
+
+    private function getOriginProvider(): OriginProvider
+    {
+        $originProvider = $this->createMock(OriginProvider::class);
+
+        $originProvider->method('get')
+            ->willReturn('test-id');
+
+        return $originProvider;
+    }
+}

tests/unit/Espo/Core/Utils/Event/TestCiEvent1.php

@@ -0,0 +1,52 @@
+<?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 tests\unit\Espo\Core\Utils\Event;
+
+use Espo\Core\Utils\Event\CrossInstanceEvent;
+use stdClass;
+
+class TestCiEvent1 implements CrossInstanceEvent
+{
+    public function __construct(
+        public string $value,
+    ) {}
+
+    public static function fromPayload(stdClass $payload): self
+    {
+        return new self($payload->value ?? '');
+    }
+
+    public function toPayload(): stdClass
+    {
+        return (object) [
+            'value' => $this->value,
+        ];
+    }
+}

tests/unit/Espo/Core/Utils/Event/TestCiEvent2.php

@@ -0,0 +1,46 @@
+<?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 tests\unit\Espo\Core\Utils\Event;
+
+use Espo\Core\Utils\Event\CrossInstanceEvent;
+use stdClass;
+
+class TestCiEvent2 implements CrossInstanceEvent
+{
+    public static function fromPayload(stdClass $payload): self
+    {
+        return new self();
+    }
+
+    public function toPayload(): stdClass
+    {
+        return (object) [];
+    }
+}

tests/unit/Espo/Core/Utils/Event/TestEvent1.php

@@ -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 tests\unit\Espo\Core\Utils\Event;
+
+use Espo\Core\Utils\Event\Event;
+
+class TestEvent1 implements Event
+{}

tests/unit/Espo/Core/Utils/Event/TestEvent2.php

@@ -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 tests\unit\Espo\Core\Utils\Event;
+
+use Espo\Core\Utils\Event\Event;
+
+class TestEvent2 implements Event
+{}

tests/unit/Espo/Core/Utils/Event/TestTransport.php

@@ -0,0 +1,72 @@
+<?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 tests\unit\Espo\Core\Utils\Event;
+
+use Closure;
+use Espo\Core\Utils\Event\Envelope;
+use Espo\Core\Utils\Event\EventTransport;
+use stdClass;
+
+class TestTransport implements EventTransport
+{
+    /**
+     * @var (Closure(Envelope): void)|null
+     */
+    private ?Closure $callback = null;
+
+    /**
+     * @param Closure(Envelope): void $callback
+     */
+    public function subscribe(Closure $callback): void
+    {
+        $this->callback = $callback;
+    }
+
+    public function publish(Envelope $envelope): void
+    {}
+
+    public function tick(): void
+    {}
+
+    public function dispatchForTest(string $eventClassName, stdClass $payload): void
+    {
+        if (!$this->callback) {
+            return;
+        }
+
+        $envelope = new Envelope(
+            eventClassName: $eventClassName,
+            payload: $payload,
+            origin: 'other',
+        );
+
+        ($this->callback)($envelope);
+    }
+}