-
Notifications
You must be signed in to change notification settings - Fork 3
Introduce MediaWikiHostResolver #989
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
Merged
Merged
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
ea35d0a
Introduce MediaWikiHostResolver
outdooracorn 268a7f6
run pint
tarrow bb8d713
revert Wiki.php changes
tarrow cf6f384
throw if DB version isn't known
tarrow 3931ea3
Update app/Services/MediaWikiHostResolver.php
tarrow 4f04370
Update app/Services/MediaWikiHostResolver.php
tarrow 93380e7
use relations and accessors
tarrow 9680e42
fix indent
tarrow 560befa
Update app/Services/MediaWikiHostResolver.php
tarrow ed48825
Update app/Services/MediaWikiHostResolver.php
tarrow 1ec7671
move exception above class
tarrow 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| <?php | ||
|
|
||
| namespace App\Services; | ||
|
|
||
| use App\Wiki; | ||
| use Exception; | ||
|
|
||
| class MediaWikiHostResolver { | ||
| // TODO: Move this mapping to a config file that doesn't require updating this code when doing a MW update? | ||
| /** @var array<string, string> Map of DB version strings to MediaWiki backend version strings */ | ||
| private const DB_VERSION_TO_MW_VERSION = [ | ||
| 'mw1.39-wbs1' => '139-app', | ||
| 'mw1.43-wbs1' => '143-app', | ||
| ]; | ||
|
|
||
| // This service could have other methods in future, e.g. getBackendHostForWiki() | ||
| // public function getBackendHostForWiki(Wiki $wiki): string { | ||
| // return $this->getBackendHostForDomain($wiki->domain); | ||
| // } | ||
|
|
||
| public function getBackendHostForDomain(string $domain): string { | ||
| // TODO: should 'backend.default.svc.cluster.local' be an env var e.g. PLATFORM_MW_BACKEND_HOST_SUFFIX? | ||
|
tarrow marked this conversation as resolved.
Outdated
|
||
| return sprintf('mediawiki-%s-backend.default.svc.cluster.local', $this->getMwVersionForDomain($domain)); | ||
| } | ||
|
|
||
| public function getMwVersionForDomain(string $domain): string { | ||
| $dbVersion = Wiki::where('domain', $domain) | ||
| ->first() | ||
| ->wikiDb | ||
| ->version; | ||
|
|
||
| if (array_key_exists($dbVersion, self::DB_VERSION_TO_MW_VERSION)) { | ||
| return self::DB_VERSION_TO_MW_VERSION[$dbVersion]; | ||
| } | ||
| throw new UnknownDBVersionException("Unknown DB version '{$dbVersion}' for domain '{$domain}'."); | ||
| } | ||
| } | ||
|
|
||
|
tarrow marked this conversation as resolved.
Outdated
|
||
| /** | ||
| * Exception thrown when a database version is not recognized in MediaWikiHostResolver. | ||
| */ | ||
| class UnknownDBVersionException extends Exception {} | ||
|
tarrow marked this conversation as resolved.
Outdated
|
||
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,46 @@ | ||
| <?php | ||
|
|
||
| namespace Tests; | ||
|
|
||
| use App\Services\MediaWikiHostResolver; | ||
| use App\Services\UnknownDBVersionException; | ||
| use App\Wiki; | ||
| use App\WikiDb; | ||
| use Faker\Factory; | ||
| use Illuminate\Foundation\Testing\RefreshDatabase; | ||
|
|
||
| class MediaWikiHostResolverTest extends TestCase { | ||
| use RefreshDatabase; | ||
|
|
||
| public function testResolverRoutesToCorrectHost(): void { | ||
| $domain = (new Factory)->create()->unique()->text(30); | ||
| $this->createWiki($domain, 'mw1.39-wbs1'); | ||
| $resolver = new MediaWikiHostResolver; | ||
| $this->assertEquals( | ||
| 'mediawiki-139-app-backend.default.svc.cluster.local', | ||
| $resolver->getBackendHostForDomain($domain) | ||
| ); | ||
| } | ||
|
|
||
| private function createWiki(string $domain, string $version) { | ||
| $wiki = Wiki::factory()->create(['domain' => $domain]); | ||
| WikiDb::create([ | ||
| 'name' => $domain, | ||
| 'user' => 'someUser', | ||
| 'password' => 'somePassword', | ||
| 'version' => $version, | ||
| 'prefix' => 'somePrefix', | ||
| 'wiki_id' => $wiki->id, | ||
| ]); | ||
| } | ||
|
|
||
| public function testResolverThrowsIfUnableToFindHostInMap(): void { | ||
| $domain = (new Factory)->create()->unique()->text(30); | ||
| $this->createWiki($domain, 'mw1.39-unmapped'); | ||
| $resolver = new MediaWikiHostResolver; | ||
| $this->assertThrows( | ||
| fn () => $resolver->getBackendHostForDomain($domain), | ||
| UnknownDBVersionException::class | ||
| ); | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.