-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
feat(federation): implement minimal federation user backend #62471
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.
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
Open
leftybournes
wants to merge
1
commit into
master
Choose a base branch
from
leftybournes/feat/federation-implement-minimal-backend
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+146
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-only | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace OCA\Federation\User; | ||
|
|
||
| use OCP\Federation\ICloudIdManager; | ||
| use OCP\User\Backend\ABackend; | ||
| use OCP\User\Backend\IGetDisplayNameBackend; | ||
|
|
||
| class Backend extends ABackend implements IGetDisplayNameBackend { | ||
| public function __construct( | ||
| private ICloudIdManager $cloudIdManager, | ||
| ) { | ||
| } | ||
|
|
||
| #[\Override] | ||
| public function getBackendName() { | ||
| return 'federation'; | ||
| } | ||
|
|
||
| #[\Override] | ||
| public function deleteUser($uid) { | ||
| return false; | ||
| } | ||
|
|
||
| #[\Override] | ||
| public function getUsers($search = '', $limit = null, $offset = null) { | ||
| return []; | ||
| } | ||
|
|
||
| /** | ||
| * Check if a user exists. Assume that the user with valid cloud id exists since the account is for a remote user | ||
| */ | ||
| #[\Override] | ||
| public function userExists($uid) { | ||
| return $this->cloudIdManager->isValidCloudId($uid); | ||
| } | ||
|
|
||
| #[\Override] | ||
| public function getDisplayName($uid): string { | ||
| return $this->cloudIdManager->resolveCloudId($uid)->getDisplayId(); | ||
| } | ||
|
|
||
| #[\Override] | ||
| public function getDisplayNames($search = '', $limit = null, $offset = null) { | ||
| return []; | ||
| } | ||
|
|
||
| #[\Override] | ||
| public function hasUserListings() { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. need return types for every of these methods and parameter types for the methods where it is defined in IUserBackend/UserInterface |
||
| return false; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-only | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace OCA\Federation\Tests\User; | ||
|
|
||
| use OC\User\Backend as Base; | ||
| use OCA\Federation\User\Backend; | ||
| use OCP\Server; | ||
| use Test\TestCase; | ||
|
|
||
| #[\PHPUnit\Framework\Attributes\Group(name: 'DB')] | ||
| class BackendTest extends TestCase { | ||
| private Backend $backend; | ||
| private string $userId; | ||
|
|
||
| protected function setUp(): void { | ||
| parent::setUp(); | ||
|
|
||
| $this->backend = Server::get(Backend::class); | ||
| $this->userId = 'foo@example.com'; | ||
| } | ||
|
|
||
| protected function tearDown(): void { | ||
| parent::tearDown(); | ||
| } | ||
|
|
||
| public function testGetBackendName(): void { | ||
| $this->assertEquals($this->backend->getBackendName(), 'federation'); | ||
| } | ||
|
|
||
| #[\PHPUnit\Framework\Attributes\DataProvider('dataTestImplementsActions')] | ||
| public function testImplementsActions(int $action, bool $implemented): void { | ||
| $this->assertEquals($this->backend->implementsActions($action), $implemented); | ||
| } | ||
|
|
||
| public static function dataTestImplementsActions(): array { | ||
| return [ | ||
| [Base::CREATE_USER, false], | ||
| [Base::SET_PASSWORD, false], | ||
| [Base::CHECK_PASSWORD, false], | ||
| [Base::GET_HOME, false], | ||
| [Base::GET_DISPLAYNAME, true], | ||
| [Base::SET_DISPLAYNAME, false], | ||
| [Base::PROVIDE_AVATAR, false], | ||
| [Base::COUNT_USERS, false], | ||
| ]; | ||
| } | ||
|
|
||
| public function testDeleteUser(): void { | ||
| $this->assertFalse($this->backend->deleteUser($this->userId)); | ||
| } | ||
|
|
||
| public function testGetUsers(): void { | ||
| $this->assertEquals($this->backend->getUsers(), []); | ||
| } | ||
|
|
||
| public function testUserExists(): void { | ||
| $this->assertTrue($this->backend->userExists($this->userId)); | ||
| $this->assertFalse($this->backend->userExists('foo')); | ||
| } | ||
|
|
||
| public function testGetDisplayName(): void { | ||
| $this->assertEquals($this->backend->getDisplayName($this->userId), $this->userId); | ||
|
|
||
| $this->expectException(\InvalidArgumentException::class); | ||
| $this->backend->getDisplayName('foo'); | ||
| } | ||
|
|
||
| public function testGetDisplayNames(): void { | ||
| $this->assertEquals($this->backend->getDisplayNames(), []); | ||
| } | ||
|
|
||
| public function testHasUserListings(): void { | ||
| $this->assertFalse($this->backend->hasUserListings()); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's better to leave the default implementation from ABackend than returning an empty array
And ideally a proper implementation of this method is implemented based on a new method
ICloudIdManager::resolveCloudIds(array $ids);