Merge pull request #21759 from nextcloud/enh/lazy_subscription

Make the subscription registry lazy

lib/private/Support/Subscription/Registry.php

@@ -27,7 +27,9 @@ declare(strict_types=1);
 
 namespace OC\Support\Subscription;
 
+use OCP\AppFramework\QueryException;
 use OCP\IConfig;
+use OCP\IServerContainer;
 use OCP\Support\Subscription\Exception\AlreadyRegisteredException;
 use OCP\Support\Subscription\IRegistry;
 use OCP\Support\Subscription\ISubscription;
@@ -38,11 +40,30 @@ class Registry implements IRegistry {
 	/** @var ISubscription */
 	private $subscription = null;
 
+	/** @var string */
+	private $subscriptionService = null;
+
 	/** @var IConfig */
 	private $config;
 
-	public function __construct(IConfig $config) {
+	/** @var IServerContainer */
+	private $container;
+
+	public function __construct(IConfig $config, IServerContainer $container) {
 		$this->config = $config;
+		$this->container = $container;
+	}
+
+	private function getSubscription(): ?ISubscription {
+		if ($this->subscription === null && $this->subscriptionService !== null) {
+			try {
+				$this->subscription = $this->container->query($this->subscriptionService);
+			} catch (QueryException $e) {
+				// Ignore this
+			}
+		}
+
+		return $this->subscription;
 	}
 
 	/**
@@ -55,20 +76,29 @@ class Registry implements IRegistry {
 	 * @since 17.0.0
 	 */
 	public function register(ISubscription $subscription): void {
-		if ($this->subscription !== null) {
+		if ($this->subscription !== null || $this->subscriptionService !== null) {
 			throw new AlreadyRegisteredException();
 		}
 		$this->subscription = $subscription;
 	}
 
+	public function registerService(string $subscriptionService): void {
+		if ($this->subscription !== null || $this->subscriptionService !== null) {
+			throw new AlreadyRegisteredException();
+		}
+
+		$this->subscriptionService = $subscriptionService;
+	}
+
+
 	/**
 	 * Fetches the list of app IDs that are supported by the subscription
 	 *
 	 * @since 17.0.0
 	 */
 	public function delegateGetSupportedApps(): array {
-		if ($this->subscription instanceof ISupportedApps) {
+		if ($this->getSubscription() instanceof ISupportedApps) {
-			return $this->subscription->getSupportedApps();
+			return $this->getSubscription()->getSupportedApps();
 		}
 		return [];
 	}
@@ -84,8 +114,8 @@ class Registry implements IRegistry {
 			return true;
 		}
 
-		if ($this->subscription instanceof ISubscription) {
+		if ($this->getSubscription() instanceof ISubscription) {
-			return $this->subscription->hasValidSubscription();
+			return $this->getSubscription()->hasValidSubscription();
 		}
 		return false;
 	}
@@ -96,8 +126,8 @@ class Registry implements IRegistry {
 	 * @since 17.0.0
 	 */
 	public function delegateHasExtendedSupport(): bool {
-		if ($this->subscription instanceof ISubscription && method_exists($this->subscription, 'hasExtendedSupport')) {
+		if ($this->getSubscription() instanceof ISubscription && method_exists($this->subscription, 'hasExtendedSupport')) {
-			return $this->subscription->hasExtendedSupport();
+			return $this->getSubscription()->hasExtendedSupport();
 		}
 		return false;
 	}

lib/public/Support/Subscription/IRegistry.php

@@ -35,16 +35,28 @@ use OCP\Support\Subscription\Exception\AlreadyRegisteredException;
 interface IRegistry {
 
 	/**
-	 * Register a subscription instance. In case it is called multiple times the
+	 * Register a subscription instance. In case it is called multiple times an
-	 * first one is used.
+	 * exception is thrown
 	 *
 	 * @param ISubscription $subscription
 	 * @throws AlreadyRegisteredException
 	 *
 	 * @since 17.0.0
+	 * @deprecated 20.0.0 use registerService
 	 */
 	public function register(ISubscription $subscription): void;
 
+	/**
+	 * Register a subscription handler. The service has to implement the ISubscription interface.
+	 * In case this is called multiple times an exception is thrown.
+	 *
+	 * @param string $subscriptionService
+	 * @throws AlreadyRegisteredException
+	 *
+	 * @since 20.0.0
+	 */
+	public function registerService(string $subscriptionService): void;
+
 	/**
 	 * Fetches the list of app IDs that are supported by the subscription
 	 *

tests/lib/Support/Subscription/DummySubscription.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @author Daniel Kesselberg <mail@danielkesselberg.de>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Test\Support\Subscription;
+
+class DummySubscription implements \OCP\Support\Subscription\ISubscription {
+
+	/** @var bool */
+	private $hasValidSubscription;
+	/** @var bool */
+	private $hasExtendedSupport;
+
+	/**
+	 * DummySubscription constructor.
+	 *
+	 * @param bool $hasValidSubscription
+	 * @param bool $hasExtendedSupport
+	 */
+	public function __construct(bool $hasValidSubscription, bool $hasExtendedSupport) {
+		$this->hasValidSubscription = $hasValidSubscription;
+		$this->hasExtendedSupport = $hasExtendedSupport;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function hasValidSubscription(): bool {
+		return $this->hasValidSubscription;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function hasExtendedSupport(): bool {
+		return $this->hasExtendedSupport;
+	}
+}

tests/lib/Support/Subscription/RegistryTest.php

@@ -24,6 +24,7 @@ namespace Test\Support\Subscription;
 
 use OC\Support\Subscription\Registry;
 use OCP\IConfig;
+use OCP\IServerContainer;
 use OCP\Support\Subscription\ISubscription;
 use OCP\Support\Subscription\ISupportedApps;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -37,11 +38,15 @@ class RegistryTest extends TestCase {
 	/** @var MockObject|IConfig */
 	private $config;
 
+	/** @var MockObject|IServerContainer */
+	private $serverContainer;
+
 	protected function setUp(): void {
 		parent::setUp();
 
 		$this->config = $this->createMock(IConfig::class);
-		$this->registry = new Registry($this->config);
+		$this->serverContainer = $this->createMock(IServerContainer::class);
+		$this->registry = new Registry($this->config, $this->serverContainer);
 	}
 
 	/**
@@ -112,4 +117,14 @@ class RegistryTest extends TestCase {
 
 		$this->assertSame(['abc'], $this->registry->delegateGetSupportedApps());
 	}
+
+	public function testSubscriptionService() {
+		$this->serverContainer->method('query')
+			->with(DummySubscription::class)
+			->willReturn(new DummySubscription(true, false));
+		$this->registry->registerService(DummySubscription::class);
+
+		$this->assertTrue($this->registry->delegateHasValidSubscription());
+		$this->assertFalse($this->registry->delegateHasExtendedSupport());
+	}
 }