|
| 1 | +<?php |
| 2 | + |
| 3 | +/** |
| 4 | + * This file is part of the package netresearch/nr-textdb. |
| 5 | + * |
| 6 | + * For the full copyright and license information, please read the |
| 7 | + * LICENSE file that was distributed with this source code. |
| 8 | + */ |
| 9 | + |
| 10 | +declare(strict_types=1); |
| 11 | + |
| 12 | +namespace Netresearch\NrTextdb\Tests\Functional\Service; |
| 13 | + |
| 14 | +use Netresearch\NrTextdb\Domain\Repository\ComponentRepository; |
| 15 | +use Netresearch\NrTextdb\Domain\Repository\EnvironmentRepository; |
| 16 | +use Netresearch\NrTextdb\Domain\Repository\TypeRepository; |
| 17 | +use Netresearch\NrTextdb\Service\ImportService; |
| 18 | +use PHPUnit\Framework\Attributes\CoversClass; |
| 19 | +use PHPUnit\Framework\Attributes\Test; |
| 20 | +use TYPO3\CMS\Core\Localization\Parser\XliffParser; |
| 21 | +use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager; |
| 22 | +use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase; |
| 23 | + |
| 24 | +/** |
| 25 | + * Functional test case for ImportService bulk operations. |
| 26 | + * |
| 27 | + * Tests the critical batching logic that processes >1000 records |
| 28 | + * to ensure array_chunk and batch iteration work correctly. |
| 29 | + */ |
| 30 | +#[CoversClass(ImportService::class)] |
| 31 | +final class ImportServiceTest extends FunctionalTestCase |
| 32 | +{ |
| 33 | + protected array $coreExtensionsToLoad = [ |
| 34 | + 'extensionmanager', |
| 35 | + 'scheduler', |
| 36 | + ]; |
| 37 | + |
| 38 | + protected array $testExtensionsToLoad = [ |
| 39 | + 'typo3conf/ext/nr_textdb', |
| 40 | + ]; |
| 41 | + |
| 42 | + private ImportService $subject; |
| 43 | + |
| 44 | + protected function setUp(): void |
| 45 | + { |
| 46 | + parent::setUp(); |
| 47 | + |
| 48 | + $this->subject = new ImportService( |
| 49 | + $this->get(PersistenceManager::class), |
| 50 | + $this->get(XliffParser::class), |
| 51 | + $this->get(ComponentRepository::class), |
| 52 | + $this->get(TypeRepository::class), |
| 53 | + $this->get(EnvironmentRepository::class) |
| 54 | + ); |
| 55 | + } |
| 56 | + |
| 57 | + /** |
| 58 | + * Tests bulk import with >1000 records to validate batching logic. |
| 59 | + * |
| 60 | + * The ImportService uses array_chunk($data, 1000) for both INSERT and UPDATE operations. |
| 61 | + * This test ensures the batching logic correctly handles multiple batches by importing |
| 62 | + * 1500 records, which should trigger 2 batches (1000 + 500). |
| 63 | + */ |
| 64 | + #[Test] |
| 65 | + public function importLargeFileValidatesBatchingLogic(): void |
| 66 | + { |
| 67 | + $tempFile = $this->generateLargeXliffFile(1500); |
| 68 | + |
| 69 | + try { |
| 70 | + $imported = 0; |
| 71 | + $updated = 0; |
| 72 | + $errors = []; |
| 73 | + |
| 74 | + $this->subject->importFile($tempFile, false, $imported, $updated, $errors); |
| 75 | + |
| 76 | + // Verify all records were imported |
| 77 | + self::assertSame(1500, $imported, 'All 1500 records should be imported'); |
| 78 | + self::assertSame(0, $updated, 'No records should be updated on first import'); |
| 79 | + self::assertSame([], $errors, 'No errors should occur during import'); |
| 80 | + |
| 81 | + // Verify records exist in database |
| 82 | + $connection = $this->getConnectionPool()->getConnectionForTable('tx_nrtextdb_domain_model_translation'); |
| 83 | + $count = $connection->count('*', 'tx_nrtextdb_domain_model_translation', []); |
| 84 | + |
| 85 | + self::assertSame(1500, $count, 'Database should contain exactly 1500 translation records'); |
| 86 | + } finally { |
| 87 | + if (file_exists($tempFile)) { |
| 88 | + unlink($tempFile); |
| 89 | + } |
| 90 | + } |
| 91 | + } |
| 92 | + |
| 93 | + /** |
| 94 | + * Tests bulk UPDATE with >1000 records to validate UPDATE batching logic. |
| 95 | + * |
| 96 | + * Tests the CASE expression batching for UPDATE operations by: |
| 97 | + * 1. Importing 1500 records |
| 98 | + * 2. Re-importing with forceUpdate=true |
| 99 | + * 3. Verifying all 1500 records are updated across multiple batches |
| 100 | + */ |
| 101 | + #[Test] |
| 102 | + public function updateLargeFileValidatesBatchingLogic(): void |
| 103 | + { |
| 104 | + $tempFile = $this->generateLargeXliffFile(1500); |
| 105 | + |
| 106 | + try { |
| 107 | + // First import |
| 108 | + $imported = 0; |
| 109 | + $updated = 0; |
| 110 | + $errors = []; |
| 111 | + |
| 112 | + $this->subject->importFile($tempFile, false, $imported, $updated, $errors); |
| 113 | + self::assertSame(1500, $imported); |
| 114 | + |
| 115 | + // Second import with forceUpdate=true to trigger UPDATE batching |
| 116 | + $imported = 0; |
| 117 | + $updated = 0; |
| 118 | + $errors = []; |
| 119 | + |
| 120 | + $this->subject->importFile($tempFile, true, $imported, $updated, $errors); |
| 121 | + |
| 122 | + // Verify all records were updated via batched CASE expression |
| 123 | + self::assertSame(0, $imported, 'No new records should be imported'); |
| 124 | + self::assertSame(1500, $updated, 'All 1500 records should be updated across 2 batches (1000 + 500)'); |
| 125 | + self::assertSame([], $errors, 'No errors should occur during update'); |
| 126 | + } finally { |
| 127 | + if (file_exists($tempFile)) { |
| 128 | + unlink($tempFile); |
| 129 | + } |
| 130 | + } |
| 131 | + } |
| 132 | + |
| 133 | + /** |
| 134 | + * Tests edge case: exactly 1000 records (single batch). |
| 135 | + */ |
| 136 | + #[Test] |
| 137 | + public function importExactlyOneBatchSize(): void |
| 138 | + { |
| 139 | + $tempFile = $this->generateLargeXliffFile(1000); |
| 140 | + |
| 141 | + try { |
| 142 | + $imported = 0; |
| 143 | + $updated = 0; |
| 144 | + $errors = []; |
| 145 | + |
| 146 | + $this->subject->importFile($tempFile, false, $imported, $updated, $errors); |
| 147 | + |
| 148 | + self::assertSame(1000, $imported, 'Exactly 1000 records should be imported in single batch'); |
| 149 | + self::assertSame(0, $updated); |
| 150 | + self::assertSame([], $errors); |
| 151 | + } finally { |
| 152 | + if (file_exists($tempFile)) { |
| 153 | + unlink($tempFile); |
| 154 | + } |
| 155 | + } |
| 156 | + } |
| 157 | + |
| 158 | + /** |
| 159 | + * Tests edge case: 2001 records (3 batches: 1000 + 1000 + 1). |
| 160 | + */ |
| 161 | + #[Test] |
| 162 | + public function importMultipleBatchesPlusOne(): void |
| 163 | + { |
| 164 | + $tempFile = $this->generateLargeXliffFile(2001); |
| 165 | + |
| 166 | + try { |
| 167 | + $imported = 0; |
| 168 | + $updated = 0; |
| 169 | + $errors = []; |
| 170 | + |
| 171 | + $this->subject->importFile($tempFile, false, $imported, $updated, $errors); |
| 172 | + |
| 173 | + self::assertSame(2001, $imported, 'All 2001 records should be imported across 3 batches'); |
| 174 | + self::assertSame(0, $updated); |
| 175 | + self::assertSame([], $errors); |
| 176 | + |
| 177 | + // Verify database count |
| 178 | + $connection = $this->getConnectionPool()->getConnectionForTable('tx_nrtextdb_domain_model_translation'); |
| 179 | + $count = $connection->count('*', 'tx_nrtextdb_domain_model_translation', []); |
| 180 | + |
| 181 | + self::assertSame(2001, $count, 'Database should contain exactly 2001 records'); |
| 182 | + } finally { |
| 183 | + if (file_exists($tempFile)) { |
| 184 | + unlink($tempFile); |
| 185 | + } |
| 186 | + } |
| 187 | + } |
| 188 | + |
| 189 | + /** |
| 190 | + * Generates a large XLIFF file with specified number of translation units. |
| 191 | + * |
| 192 | + * @param int $count Number of translation units to generate |
| 193 | + * |
| 194 | + * @return string Absolute path to generated temporary file |
| 195 | + */ |
| 196 | + private function generateLargeXliffFile(int $count): string |
| 197 | + { |
| 198 | + $tempFile = tempnam(sys_get_temp_dir(), 'xliff_test_'); |
| 199 | + |
| 200 | + $xml = '<?xml version="1.0" encoding="UTF-8"?>' . "\n"; |
| 201 | + $xml .= '<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">' . "\n"; |
| 202 | + $xml .= ' <file source-language="en" target-language="de" datatype="plaintext" original="messages">' . "\n"; |
| 203 | + $xml .= ' <header/>' . "\n"; |
| 204 | + $xml .= ' <body>' . "\n"; |
| 205 | + |
| 206 | + for ($i = 1; $i <= $count; ++$i) { |
| 207 | + $xml .= sprintf( |
| 208 | + ' <trans-unit id="TestComponent|batch_type|test_placeholder_%d" xml:space="preserve">' . "\n" . |
| 209 | + ' <source>Source Text %d</source>' . "\n" . |
| 210 | + ' <target>Batch Test Translation %d</target>' . "\n" . |
| 211 | + ' </trans-unit>' . "\n", |
| 212 | + $i, |
| 213 | + $i, |
| 214 | + $i |
| 215 | + ); |
| 216 | + } |
| 217 | + |
| 218 | + $xml .= ' </body>' . "\n"; |
| 219 | + $xml .= ' </file>' . "\n"; |
| 220 | + $xml .= '</xliff>'; |
| 221 | + |
| 222 | + file_put_contents($tempFile, $xml); |
| 223 | + |
| 224 | + return $tempFile; |
| 225 | + } |
| 226 | +} |
0 commit comments