-
Notifications
You must be signed in to change notification settings - Fork 3
feat: add backend endpoint to set wiki DB version #1012
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 all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
eda2406
add backend route setWikiDbVersion
deer-wmde 8aaae5d
add WikiDbVersionControllerTest
deer-wmde ae99512
Add Backend/WikiDbVersionController
deer-wmde e472fab
formatting
deer-wmde 46f22d4
add link to duplication
deer-wmde 0d6fe70
comments
deer-wmde 99b9fb4
test successful change of wikiDb version string
deer-wmde 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,44 @@ | ||
| <?php | ||
|
|
||
| namespace App\Http\Controllers\Backend; | ||
|
|
||
| use App\Http\Controllers\Controller; | ||
| use App\Wiki; | ||
| use Illuminate\Http\Request; | ||
|
|
||
| class WikiDbVersionController extends Controller { | ||
| // keep in sync with App\Services\MediaWikiHostResolver | ||
| private const DB_VERSION_TO_MW_VERSION = [ | ||
| 'mw1.39-wbs1' => '139', | ||
| 'mw1.43-wbs1' => '143', | ||
| ]; | ||
|
|
||
| public function updateWikiDbVersion(Request $request): \Illuminate\Http\JsonResponse { | ||
| $validated = $request->validate([ | ||
| 'domain' => 'required|string', | ||
| 'dbVersion' => 'required|string', | ||
| ]); | ||
|
|
||
| $domain = $validated['domain']; | ||
| $targetDbVersion = $validated['dbVersion']; | ||
|
|
||
| try { | ||
| $wiki = Wiki::with('wikiDb')->firstWhere('domain', $domain); | ||
|
|
||
| if (!$wiki) { | ||
| return response()->json(['error' => "No wiki found with domain: '{$domain}'"], 404); | ||
| } | ||
|
|
||
| if (!array_key_exists($targetDbVersion, self::DB_VERSION_TO_MW_VERSION)) { | ||
| return response()->json(['error' => "Invalid database version string: '{$targetDbVersion}'"], 400); | ||
| } | ||
|
|
||
| $wiki->wikiDb->version = $targetDbVersion; | ||
| $wiki->wikiDb->save(); | ||
| } catch (\Exception $e) { | ||
| return response()->json($e->getMessage(), 500); | ||
| } | ||
|
|
||
| return response()->json(['result' => 'success'], 200); | ||
| } | ||
| } | ||
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 |
|---|---|---|
|
|
@@ -11,6 +11,9 @@ | |
| $router->get('healthz', fn () => "It's Alive"); | ||
| $router->get('getWikiHostsForDomain', ['uses' => 'MediaWikiHostsController@getWikiHostsForDomain']); | ||
|
|
||
| // PUT | ||
| $router->put('setWikiDbVersion', ['uses' => 'WikiDbVersionController@updateWikiDbVersion']); | ||
|
Contributor
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. I think it's good this isn't in |
||
|
|
||
| $router->group(['prefix' => 'ingress'], function () use ($router) { | ||
| // GET | ||
| $router->get('getWikiVersionForDomain', ['uses' => 'IngressController@getWikiVersionForDomain']); | ||
|
|
||
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,86 @@ | ||
| <?php | ||
|
|
||
| namespace Tests\Routes\Backend; | ||
|
|
||
| use App\Wiki; | ||
| use App\WikiDb; | ||
| use Illuminate\Foundation\Testing\RefreshDatabase; | ||
| use Tests\TestCase; | ||
|
|
||
| class WikiDbVersionControllerTest extends TestCase { | ||
| use RefreshDatabase; | ||
|
|
||
| const VALID_WIKI_DB_VERSION_STRING_139 = 'mw1.39-wbs1'; | ||
|
|
||
| const VALID_WIKI_DB_VERSION_STRING_143 = 'mw1.43-wbs1'; | ||
|
|
||
| protected $route = '/backend/setWikiDbVersion'; | ||
|
|
||
| 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, | ||
| ]); | ||
|
|
||
| return $wiki; | ||
| } | ||
|
|
||
| public function testSetWikiDbVersionSuccess() { | ||
| $targetDbVersion = self::VALID_WIKI_DB_VERSION_STRING_143; | ||
| $wikiDomain = 'coffeebase.wikibase.cloud'; | ||
|
|
||
| $wiki = $this->createWiki($wikiDomain, self::VALID_WIKI_DB_VERSION_STRING_139); | ||
|
|
||
| $this->putJson("{$this->route}?domain={$wikiDomain}&dbVersion={$targetDbVersion}") | ||
| ->assertStatus(200) | ||
| ->assertJson([ | ||
| 'result' => 'success', | ||
| ]); | ||
deer-wmde marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| $newDbVersion = Wiki::with('wikiDb')->firstWhere('id', $wiki->id)->wikiDb->version; | ||
|
|
||
| $this->assertSame($targetDbVersion, $newDbVersion); | ||
| } | ||
|
|
||
| public function testSetWikiDbVersionWikiNotfound() { | ||
| $targetDbVersion = self::VALID_WIKI_DB_VERSION_STRING_143; | ||
| $wikiDomain = 'notFound.wikibase.cloud'; | ||
|
|
||
| $this->putJson("{$this->route}?domain={$wikiDomain}&dbVersion={$targetDbVersion}") | ||
| ->assertStatus(404); | ||
| } | ||
|
|
||
| public function testSetWikiDbVersionUnknownDbVersion() { | ||
| $targetDbVersion = 'unknownVersion'; | ||
| $wikiDomain = 'coffeebase.wikibase.cloud'; | ||
|
|
||
| $this->createWiki($wikiDomain, self::VALID_WIKI_DB_VERSION_STRING_139); | ||
|
|
||
| $this->putJson("{$this->route}?domain={$wikiDomain}&dbVersion={$targetDbVersion}") | ||
| ->assertStatus(400); | ||
| } | ||
|
|
||
| public function testSetWikiDbVersionMissingDbVersion() { | ||
| $wikiDomain = 'coffeebase.wikibase.cloud'; | ||
|
|
||
| $this->createWiki($wikiDomain, self::VALID_WIKI_DB_VERSION_STRING_139); | ||
|
|
||
| $this->putJson("{$this->route}?domain={$wikiDomain}") | ||
| ->assertStatus(422); | ||
| } | ||
|
|
||
| public function testSetWikiDbVersionMissingWikiDomain() { | ||
| $targetDbVersion = self::VALID_WIKI_DB_VERSION_STRING_143; | ||
| $wikiDomain = 'coffeebase.wikibase.cloud'; | ||
|
|
||
| $this->createWiki($wikiDomain, self::VALID_WIKI_DB_VERSION_STRING_139); | ||
|
|
||
| $this->putJson("{$this->route}?dbVersion={$targetDbVersion}") | ||
| ->assertStatus(422); | ||
| } | ||
| } | ||
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.
I like this light validation; I think we don't want to reuse the domain validation logic from Wiki creation because overtime it may become stricter and then requests here might start failing.