Repository navigation
fix(summit-order): add indexes for the member-order association job and the exclusive-lock lookups #653
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
romanetar
wants to merge
2
commits into
main
Choose a base branch
from
fix/summit-order-indexes
base: main
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.
Open
fix(summit-order): add indexes for the member-order association job and the exclusive-lock lookups #653
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| <?php namespace Database\Migrations\Model; | ||
| /** | ||
| * Copyright 2026 OpenStack Foundation | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| **/ | ||
|
|
||
| use Database\Utils\DBHelpers; | ||
| use Doctrine\Migrations\AbstractMigration; | ||
| use Doctrine\DBAL\Schema\Schema as Schema; | ||
| use Illuminate\Support\Facades\DB; | ||
|
|
||
| /** | ||
| * Class Version20261022120000 | ||
| * | ||
| * - IDX_SummitOrder_OwnerEmail_Owner supports DoctrineSummitOrderRepository::getAllByOwnerEmailAndOwnerNotSet() | ||
| * (WHERE OwnerEmail = ? AND OwnerID IS NULL); OwnerEmail is only the third column of | ||
| * IDX_SummitOrder_OwnerFields_Summit, so the optimizer scanned every ownerless order through the OwnerID index. | ||
| * - IDX_SummitOrder_Hash and IDX_SummitOrder_PaymentGatewayCartId support getByHashLockExclusive() and | ||
| * getByPaymentGatewayCartIdExclusiveLock(); without them the PESSIMISTIC_WRITE lookups scan (and lock) the whole table. | ||
| * | ||
| * @package Database\Migrations\Model | ||
| */ | ||
| class Version20261022120000 extends AbstractMigration | ||
| { | ||
| private const Indexes = [ | ||
| 'IDX_SummitOrder_OwnerEmail_Owner' => '`OwnerEmail`, `OwnerID`', | ||
| 'IDX_SummitOrder_Hash' => '`Hash`', | ||
| 'IDX_SummitOrder_PaymentGatewayCartId' => '`PaymentGatewayCartId`', | ||
| ]; | ||
|
|
||
| /** | ||
| * @param Schema $schema | ||
| */ | ||
| public function up(Schema $schema): void | ||
| { | ||
| $db = DB::connection("model")->getDatabaseName(); | ||
| foreach (self::Indexes as $name => $columns) { | ||
| if (!DBHelpers::existsIDX($db, 'SummitOrder', $name)) { | ||
| $this->addSql("ALTER TABLE `SummitOrder` ADD INDEX `{$name}` ({$columns}) USING BTREE, ALGORITHM=INPLACE, LOCK=NONE;"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public function down(Schema $schema): void | ||
| { | ||
| $db = DB::connection("model")->getDatabaseName(); | ||
| foreach (self::Indexes as $name => $columns) { | ||
| if (DBHelpers::existsIDX($db, 'SummitOrder', $name)) { | ||
| $this->addSql("ALTER TABLE `SummitOrder` DROP INDEX `{$name}`;"); | ||
| } | ||
| } | ||
| } | ||
| } | ||
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 namespace Tests; | ||
| /** | ||
| * Copyright 2026 OpenStack Foundation | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| **/ | ||
|
|
||
| use LaravelDoctrine\ORM\Facades\Registry; | ||
| use models\utils\SilverstripeBaseModel; | ||
|
|
||
| /** | ||
| * Covers the SummitOrder indexes behind getAllByOwnerEmailAndOwnerNotSet(), getByHashLockExclusive() | ||
| * and getByPaymentGatewayCartIdExclusiveLock(). The index columns are checked in | ||
| * INFORMATION_SCHEMA and the predicates are explained to check the optimizer can pick them (possible_keys). | ||
| * | ||
| * Class DoctrineSummitOrderRepositoryIndexesTest | ||
| */ | ||
| final class DoctrineSummitOrderRepositoryIndexesTest extends TestCase | ||
| { | ||
| private function connection() | ||
| { | ||
| return Registry::getManager(SilverstripeBaseModel::EntityManager)->getConnection(); | ||
| } | ||
|
|
||
| private function indexColumns(string $index): array | ||
| { | ||
| $rows = $this->connection()->fetchAllAssociative( | ||
| "SELECT COLUMN_NAME FROM INFORMATION_SCHEMA.STATISTICS | ||
| WHERE TABLE_SCHEMA = DATABASE() AND TABLE_NAME = 'SummitOrder' AND INDEX_NAME = ? | ||
| ORDER BY SEQ_IN_INDEX", | ||
| [$index] | ||
| ); | ||
| return array_column($rows, 'COLUMN_NAME'); | ||
| } | ||
|
|
||
| private function explainPossibleKeys(string $sql, array $params): string | ||
| { | ||
| $rows = $this->connection()->fetchAllAssociative("EXPLAIN " . $sql, $params); | ||
| return (string)($rows[0]['possible_keys'] ?? ''); | ||
| } | ||
|
|
||
| public function testOwnerEmailOwnerIndexExists(): void | ||
| { | ||
| $this->assertSame(['OwnerEmail', 'OwnerID'], $this->indexColumns('IDX_SummitOrder_OwnerEmail_Owner')); | ||
| } | ||
|
|
||
| public function testHashIndexExists(): void | ||
| { | ||
| $this->assertSame(['Hash'], $this->indexColumns('IDX_SummitOrder_Hash')); | ||
| } | ||
|
|
||
| public function testPaymentGatewayCartIdIndexExists(): void | ||
| { | ||
| $this->assertSame(['PaymentGatewayCartId'], $this->indexColumns('IDX_SummitOrder_PaymentGatewayCartId')); | ||
| } | ||
|
|
||
| public function testAssociationLookupCanUseOwnerEmailOwnerIndex(): void | ||
| { | ||
| $keys = $this->explainPossibleKeys( | ||
| "SELECT ID FROM SummitOrder WHERE OwnerEmail = ? AND OwnerID IS NULL", ['a@b.com']); | ||
| $this->assertStringContainsString('IDX_SummitOrder_OwnerEmail_Owner', $keys); | ||
| } | ||
|
|
||
| public function testHashLookupCanUseHashIndex(): void | ||
| { | ||
| $keys = $this->explainPossibleKeys("SELECT ID FROM SummitOrder WHERE Hash = ?", ['x']); | ||
| $this->assertStringContainsString('IDX_SummitOrder_Hash', $keys); | ||
| } | ||
|
|
||
| public function testCartIdLookupCanUseCartIdIndex(): void | ||
| { | ||
| $keys = $this->explainPossibleKeys("SELECT ID FROM SummitOrder WHERE PaymentGatewayCartId = ?", ['x']); | ||
| $this->assertStringContainsString('IDX_SummitOrder_PaymentGatewayCartId', $keys); | ||
| } | ||
| } |
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.