Skip to content

Avoid duplicate App container creation #14548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MorrisJobke merged 3 commits into from
Mar 8, 2019
Merged

Avoid duplicate App container creation #14548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5ab743
Avoid duplicate App container creation
nickvergessen Mar 5, 2019
a788da6
Make the file strict
nickvergessen Mar 5, 2019
e13253c
"Fix" the unit tests
nickvergessen Mar 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/dav/lib/AppInfo/Application.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public function setupContactsProvider(IContactsManager $contactsManager, $userID
}

/**
* @param IManager $contactsManager
* @param IContactsManager $contactsManager
*/
public function setupSystemContactsProvider(IContactsManager $contactsManager) {
/** @var ContactsManager $cm */
Expand Down
21 changes: 2 additions & 19 deletions apps/dav/tests/unit/AppInfo/ApplicationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
use OCA\DAV\AppInfo\Application;
use OCA\DAV\CardDAV\CardDavBackend;
use OCA\DAV\CardDAV\ContactsManager;
use OCP\Contacts\IManager;
use Test\TestCase;

/**
Expand All @@ -43,24 +42,8 @@ public function test() {

// assert service instances in the container are properly setup
$s = $c->query(ContactsManager::class);
$this->assertInstanceOf('OCA\DAV\CardDAV\ContactsManager', $s);
$this->assertInstanceOf(ContactsManager::class, $s);
$s = $c->query(CardDavBackend::class);
$this->assertInstanceOf('OCA\DAV\CardDAV\CardDavBackend', $s);
}

public function testContactsManagerSetup() {
$app = new Application();
$c = $app->getContainer();
$c->registerService(CardDavBackend::class, function() {
$service = $this->createMock(CardDavBackend::class);
$service->method('getAddressBooksForUser')->willReturn([]);
return $service;
});

// assert setupContactsProvider() is proper
/** @var IManager|\PHPUnit_Framework_MockObject_MockObject $cm */
$cm = $this->createMock(IManager::class);
$app->setupContactsProvider($cm, 'xxx');
$this->addToAssertionCount(1);
$this->assertInstanceOf(CardDavBackend::class, $s);
}
}
20 changes: 17 additions & 3 deletions lib/private/ServerContainer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
Expand Down Expand Up @@ -57,7 +58,7 @@ public function __construct() {
* @param string $appName
* @param string $appNamespace
*/
public function registerNamespace($appName, $appNamespace) {
public function registerNamespace(string $appName, string $appNamespace): void {
// Cut of OCA\ and lowercase
$appNamespace = strtolower(substr($appNamespace, strrpos($appNamespace, '\\') + 1));
$this->namespaces[$appNamespace] = $appName;
Expand All @@ -67,17 +68,30 @@ public function registerNamespace($appName, $appNamespace) {
* @param string $appName
* @param DIContainer $container
*/
public function registerAppContainer($appName, DIContainer $container) {
public function registerAppContainer(string $appName, DIContainer $container): void {
$this->appContainers[strtolower(App::buildAppNamespace($appName, ''))] = $container;
}

/**
* @param string $appName
* @return DIContainer
* @throws QueryException
*/
public function getRegisteredAppContainer(string $appName): DIContainer {
if (isset($this->appContainers[strtolower(App::buildAppNamespace($appName, ''))])) {
return $this->appContainers[strtolower(App::buildAppNamespace($appName, ''))];
}

throw new QueryException();
}

/**
* @param string $namespace
* @param string $sensitiveNamespace
* @return DIContainer
* @throws QueryException
*/
protected function getAppContainer($namespace, $sensitiveNamespace) {
protected function getAppContainer(string $namespace, string $sensitiveNamespace): DIContainer {
if (isset($this->appContainers[$namespace])) {
return $this->appContainers[$namespace];
}
Expand Down
7 changes: 6 additions & 1 deletion lib/public/AppFramework/App.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,16 @@ public static function buildAppNamespace(string $appId, string $topNamespace='OC


/**
* @param string $appName
* @param array $urlParams an array with variables extracted from the routes
* @since 6.0.0
*/
public function __construct(string $appName, array $urlParams = []) {
$this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName, $urlParams);
try {
$this->container = \OC::$server->getRegisteredAppContainer($appName);
} catch (QueryException $e) {
$this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName, $urlParams);
Copy link
Member

@MorrisJobke MorrisJobke Mar 5, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't the container need to be registered then in the server container to avoid it being instantiated twice again?

Copy link
Member Author

@nickvergessen nickvergessen Mar 5, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's what DIContainer does already.

}
}

/**
Expand Down