Add lazy events for the Node API

Right now if you want to get events via the Node API you have to have a
real instance of the Root. Which in turns sets up the whole FS.

We should make sure this is done lazy. Else enabling the preview
generator for example makes you setup the whole FS on each and every
authenticated call.

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>

1 files changed, 97 insertions, 38 deletions

diff --git a/tests/lib/Files/Node/HookConnectorTest.php b/tests/lib/Files/Node/HookConnectorTest.php
index 4c747a562b8..004b74e755c 100644
--- a/tests/lib/Files/Node/HookConnectorTest.php
+++ b/tests/lib/Files/Node/HookConnectorTest.php
@@ -15,9 +15,25 @@ use OC\Files\Storage\Temporary;
 use OC\Files\View;
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\GenericEvent as APIGenericEvent;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\Files\Events\Node\AbstractNodeEvent;
+use OCP\Files\Events\Node\AbstractNodesEvent;
+use OCP\Files\Events\Node\BeforeNodeCopiedEvent;
+use OCP\Files\Events\Node\BeforeNodeCreatedEvent;
+use OCP\Files\Events\Node\BeforeNodeDeletedEvent;
+use OCP\Files\Events\Node\BeforeNodeRenamedEvent;
+use OCP\Files\Events\Node\BeforeNodeTouchedEvent;
+use OCP\Files\Events\Node\BeforeNodeWrittenEvent;
+use OCP\Files\Events\Node\NodeCopiedEvent;
+use OCP\Files\Events\Node\NodeCreatedEvent;
+use OCP\Files\Events\Node\NodeDeletedEvent;
+use OCP\Files\Events\Node\NodeRenamedEvent;
+use OCP\Files\Events\Node\NodeTouchedEvent;
+use OCP\Files\Events\Node\NodeWrittenEvent;
 use OCP\Files\Node;
 use OCP\ILogger;
 use OCP\IUserManager;
+use PHPUnit\Framework\MockObject\MockObject;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\GenericEvent;
 use Test\TestCase;
@@ -34,23 +50,20 @@ use Test\Traits\UserTrait;
 class HookConnectorTest extends TestCase {
 	use UserTrait;
 	use MountProviderTrait;
-	/** @var \PHPUnit\Framework\MockObject\MockObject */
-	/** @var EventDispatcherInterface  */
+
+	/** @var EventDispatcherInterface|MockObject  */
+	protected $legacyDispatcher;
+
+	/** @var IEventDispatcher  */
 	protected $eventDispatcher;
 
-	/**
-	 * @var View
-	 */
+	/** @var View */
 	private $view;
 
-	/**
-	 * @var Root
-	 */
+	/** @var Root */
 	private $root;
 
-	/**
-	 * @var string
-	 */
+	/** @var string */
 	private $userId;
 
 	protected function setUp(): void {
@@ -68,7 +81,8 @@ class HookConnectorTest extends TestCase {
 			$this->createMock(ILogger::class),
 			$this->createMock(IUserManager::class)
 		);
-		$this->eventDispatcher = \OC::$server->getEventDispatcher();
+		$this->legacyDispatcher = \OC::$server->getEventDispatcher();
+		$this->eventDispatcher = \OC::$server->query(IEventDispatcher::class);
 	}
 
 	protected function tearDown(): void {
@@ -81,50 +95,50 @@ class HookConnectorTest extends TestCase {
 		return [
 			[function () {
 				Filesystem::file_put_contents('test.txt', 'asd');
-			}, 'preWrite', '\OCP\Files::preWrite'],
+			}, 'preWrite', '\OCP\Files::preWrite', BeforeNodeWrittenEvent::class],
 			[function () {
 				Filesystem::file_put_contents('test.txt', 'asd');
-			}, 'postWrite', '\OCP\Files::postWrite'],
+			}, 'postWrite', '\OCP\Files::postWrite', NodeWrittenEvent::class],
 			[function () {
 				Filesystem::file_put_contents('test.txt', 'asd');
-			}, 'preCreate', '\OCP\Files::preCreate'],
+			}, 'preCreate', '\OCP\Files::preCreate', BeforeNodeCreatedEvent::class],
 			[function () {
 				Filesystem::file_put_contents('test.txt', 'asd');
-			}, 'postCreate', '\OCP\Files::postCreate'],
+			}, 'postCreate', '\OCP\Files::postCreate', NodeCreatedEvent::class],
 			[function () {
 				Filesystem::mkdir('test.txt');
-			}, 'preCreate', '\OCP\Files::preCreate'],
+			}, 'preCreate', '\OCP\Files::preCreate', BeforeNodeCreatedEvent::class],
 			[function () {
 				Filesystem::mkdir('test.txt');
-			}, 'postCreate', '\OCP\Files::postCreate'],
+			}, 'postCreate', '\OCP\Files::postCreate', NodeCreatedEvent::class],
 			[function () {
 				Filesystem::touch('test.txt');
-			}, 'preTouch', '\OCP\Files::preTouch'],
+			}, 'preTouch', '\OCP\Files::preTouch', BeforeNodeTouchedEvent::class],
 			[function () {
 				Filesystem::touch('test.txt');
-			}, 'postTouch', '\OCP\Files::postTouch'],
+			}, 'postTouch', '\OCP\Files::postTouch', NodeTouchedEvent::class],
 			[function () {
 				Filesystem::touch('test.txt');
-			}, 'preCreate', '\OCP\Files::preCreate'],
+			}, 'preCreate', '\OCP\Files::preCreate', BeforeNodeCreatedEvent::class],
 			[function () {
 				Filesystem::touch('test.txt');
-			}, 'postCreate', '\OCP\Files::postCreate'],
+			}, 'postCreate', '\OCP\Files::postCreate', NodeCreatedEvent::class],
 			[function () {
 				Filesystem::file_put_contents('test.txt', 'asd');
 				Filesystem::unlink('test.txt');
-			}, 'preDelete', '\OCP\Files::preDelete'],
+			}, 'preDelete', '\OCP\Files::preDelete', BeforeNodeDeletedEvent::class],
 			[function () {
 				Filesystem::file_put_contents('test.txt', 'asd');
 				Filesystem::unlink('test.txt');
-			}, 'postDelete', '\OCP\Files::postDelete'],
+			}, 'postDelete', '\OCP\Files::postDelete', NodeDeletedEvent::class],
 			[function () {
 				Filesystem::mkdir('test.txt');
 				Filesystem::rmdir('test.txt');
-			}, 'preDelete', '\OCP\Files::preDelete'],
+			}, 'preDelete', '\OCP\Files::preDelete', BeforeNodeDeletedEvent::class],
 			[function () {
 				Filesystem::mkdir('test.txt');
 				Filesystem::rmdir('test.txt');
-			}, 'postDelete', '\OCP\Files::postDelete'],
+			}, 'postDelete', '\OCP\Files::postDelete', NodeDeletedEvent::class],
 		];
 	}
 
@@ -133,8 +147,8 @@ class HookConnectorTest extends TestCase {
 	 * @param string $expectedHook
 	 * @dataProvider viewToNodeProvider
 	 */
-	public function testViewToNode(callable $operation, $expectedHook, $expectedEvent) {
-		$connector = new HookConnector($this->root, $this->view, $this->eventDispatcher);
+	public function testViewToNode(callable $operation, $expectedHook, $expectedLegacyEvent, $expectedEvent) {
+		$connector = new HookConnector($this->root, $this->view, $this->legacyDispatcher, $this->eventDispatcher);
 		$connector->viewToNode();
 		$hookCalled = false;
 		/** @var Node $hookNode */
@@ -148,12 +162,22 @@ class HookConnectorTest extends TestCase {
 		$dispatcherCalled = false;
 		/** @var Node $dispatcherNode */
 		$dispatcherNode = null;
-		$this->eventDispatcher->addListener($expectedEvent, function ($event) use (&$dispatcherCalled, &$dispatcherNode) {
+		$this->legacyDispatcher->addListener($expectedLegacyEvent, function ($event) use (&$dispatcherCalled, &$dispatcherNode) {
 			/** @var GenericEvent|APIGenericEvent $event */
 			$dispatcherCalled = true;
 			$dispatcherNode = $event->getSubject();
 		});
 
+		$newDispatcherCalled = false;
+		$newDispatcherNode = null;
+		$this->eventDispatcher->addListener($expectedEvent, function ($event) use ($expectedEvent, &$newDispatcherCalled, &$newDispatcherNode) {
+			if ($event instanceof  $expectedEvent) {
+				/** @var AbstractNodeEvent $event */
+				$newDispatcherCalled = true;
+				$newDispatcherNode = $event->getNode();
+			}
+		});
+
 		$operation();
 
 		$this->assertTrue($hookCalled);
@@ -161,6 +185,9 @@ class HookConnectorTest extends TestCase {
 
 		$this->assertTrue($dispatcherCalled);
 		$this->assertEquals('/' . $this->userId . '/files/test.txt', $dispatcherNode->getPath());
+
+		$this->assertTrue($newDispatcherCalled);
+		$this->assertEquals('/' . $this->userId . '/files/test.txt', $newDispatcherNode->getPath());
 	}
 
 	public function viewToNodeProviderCopyRename() {
@@ -168,19 +195,19 @@ class HookConnectorTest extends TestCase {
 			[function () {
 				Filesystem::file_put_contents('source', 'asd');
 				Filesystem::rename('source', 'target');
-			}, 'preRename', '\OCP\Files::preRename'],
+			}, 'preRename', '\OCP\Files::preRename', BeforeNodeRenamedEvent::class],
 			[function () {
 				Filesystem::file_put_contents('source', 'asd');
 				Filesystem::rename('source', 'target');
-			}, 'postRename', '\OCP\Files::postRename'],
+			}, 'postRename', '\OCP\Files::postRename', NodeRenamedEvent::class],
 			[function () {
 				Filesystem::file_put_contents('source', 'asd');
 				Filesystem::copy('source', 'target');
-			}, 'preCopy', '\OCP\Files::preCopy'],
+			}, 'preCopy', '\OCP\Files::preCopy', BeforeNodeCopiedEvent::class],
 			[function () {
 				Filesystem::file_put_contents('source', 'asd');
 				Filesystem::copy('source', 'target');
-			}, 'postCopy', '\OCP\Files::postCopy'],
+			}, 'postCopy', '\OCP\Files::postCopy', NodeCopiedEvent::class],
 		];
 	}
 
@@ -189,8 +216,8 @@ class HookConnectorTest extends TestCase {
 	 * @param string $expectedHook
 	 * @dataProvider viewToNodeProviderCopyRename
 	 */
-	public function testViewToNodeCopyRename(callable $operation, $expectedHook, $expectedEvent) {
-		$connector = new HookConnector($this->root, $this->view, $this->eventDispatcher);
+	public function testViewToNodeCopyRename(callable $operation, $expectedHook, $expectedLegacyEvent, $expectedEvent) {
+		$connector = new HookConnector($this->root, $this->view, $this->legacyDispatcher, $this->eventDispatcher);
 		$connector->viewToNode();
 		$hookCalled = false;
 		/** @var Node $hookSourceNode */
@@ -209,12 +236,26 @@ class HookConnectorTest extends TestCase {
 		$dispatcherSourceNode = null;
 		/** @var Node $dispatcherTargetNode */
 		$dispatcherTargetNode = null;
-		$this->eventDispatcher->addListener($expectedEvent, function ($event) use (&$dispatcherSourceNode, &$dispatcherTargetNode, &$dispatcherCalled) {
+		$this->legacyDispatcher->addListener($expectedLegacyEvent, function ($event) use (&$dispatcherSourceNode, &$dispatcherTargetNode, &$dispatcherCalled) {
 			/** @var GenericEvent|APIGenericEvent $event */
 			$dispatcherCalled = true;
 			list($dispatcherSourceNode, $dispatcherTargetNode) = $event->getSubject();
 		});
 
+		$newDispatcherCalled = false;
+		/** @var Node $dispatcherSourceNode */
+		$newDispatcherSourceNode = null;
+		/** @var Node $dispatcherTargetNode */
+		$newDispatcherTargetNode = null;
+		$this->eventDispatcher->addListener($expectedEvent, function ($event) use ($expectedEvent, &$newDispatcherSourceNode, &$newDispatcherTargetNode, &$newDispatcherCalled) {
+			if ($event instanceof $expectedEvent) {
+				/** @var AbstractNodesEvent$event */
+				$newDispatcherCalled = true;
+				$newDispatcherSourceNode = $event->getSource();
+				$newDispatcherTargetNode = $event->getTarget();
+			}
+		});
+
 		$operation();
 
 		$this->assertTrue($hookCalled);
@@ -224,10 +265,14 @@ class HookConnectorTest extends TestCase {
 		$this->assertTrue($dispatcherCalled);
 		$this->assertEquals('/' . $this->userId . '/files/source', $dispatcherSourceNode->getPath());
 		$this->assertEquals('/' . $this->userId . '/files/target', $dispatcherTargetNode->getPath());
+
+		$this->assertTrue($newDispatcherCalled);
+		$this->assertEquals('/' . $this->userId . '/files/source', $newDispatcherSourceNode->getPath());
+		$this->assertEquals('/' . $this->userId . '/files/target', $newDispatcherTargetNode->getPath());
 	}
 
 	public function testPostDeleteMeta() {
-		$connector = new HookConnector($this->root, $this->view, $this->eventDispatcher);
+		$connector = new HookConnector($this->root, $this->view, $this->legacyDispatcher, $this->eventDispatcher);
 		$connector->viewToNode();
 		$hookCalled = false;
 		/** @var Node $hookNode */
@@ -241,12 +286,23 @@ class HookConnectorTest extends TestCase {
 		$dispatcherCalled = false;
 		/** @var Node $dispatcherNode */
 		$dispatcherNode = null;
-		$this->eventDispatcher->addListener('\OCP\Files::postDelete', function ($event) use (&$dispatcherCalled, &$dispatcherNode) {
+		$this->legacyDispatcher->addListener('\OCP\Files::postDelete', function ($event) use (&$dispatcherCalled, &$dispatcherNode) {
 			/** @var GenericEvent|APIGenericEvent $event */
 			$dispatcherCalled = true;
 			$dispatcherNode = $event->getSubject();
 		});
 
+		$newDispatcherCalled = false;
+		/** @var Node $dispatcherNode */
+		$newDispatcherNode = null;
+		$this->eventDispatcher->addListener(NodeDeletedEvent::class, function ($event) use (&$newDispatcherCalled, &$newDispatcherNode) {
+			if ($event instanceof NodeDeletedEvent) {
+				/** @var AbstractNodeEvent $event */
+				$newDispatcherCalled = true;
+				$newDispatcherNode = $event->getNode();
+			}
+		});
+
 		Filesystem::file_put_contents('test.txt', 'asd');
 		$info = Filesystem::getFileInfo('test.txt');
 		Filesystem::unlink('test.txt');
@@ -256,5 +312,8 @@ class HookConnectorTest extends TestCase {
 
 		$this->assertTrue($dispatcherCalled);
 		$this->assertEquals($dispatcherNode->getId(), $info->getId());
+
+		$this->assertTrue($newDispatcherCalled);
+		$this->assertEquals($newDispatcherNode->getId(), $info->getId());
 	}
 }