Fix modal trigger not opening modals on MediaWiki 1.43+

The deferred-content mechanism (ParserOutput::setExtensionData on the
parse side, ParserOutput::getExtensionData in the OutputPageParserOutput
hook) no longer preserves data across the parser hook -> render hook
transition under MediaWiki 1.43's ParserOutputAccess lifecycle changes.
The set-side and get-side operate on different ParserOutput instances,
so the modal container markup never reaches the page. The modal trigger
still renders but has nothing to open.

Switch to inline emission: ModalBuilder::parse() returns the trigger
HTML and the modal container HTML concatenated. The modal container is
position: fixed and addressed via data-target="#id", so its DOM
placement is no longer significant. This works identically on every
supported MediaWiki version because the underlying Bootstrap behaviour
is the same and RemexHtml (default since MW 1.36) cleanly handles a
block element inside a wikitext paragraph.

Removes the now-unused ParserOutputHelper::injectLater() helper and
the EXTENSION_DATA_DEFERRED_CONTENT_KEY constant. Updates the four
parallel test files (ModalBuilderTest, ImageModalTest, ModalTest,
OutputPageParserOutputTest) to assert the new concatenated return
shape and drop the deferred-content mock expectations.

Verified on a MW 1.39 + Vector + BC stack: modal opens identically
pre- and post-patch (no regression on the oldest supported MW
version). PHPUnit unit suite stays green relative to baseline; the
6 pre-existing ImageModalTriggerTest failures are present in both
runs and unrelated to this change.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

Author: malberts

src/ApplicationFactory.php

@@ -107,7 +107,7 @@ public function getNewAttributeManager( array $validAttributes, array $aliases )
 	 * @param string             $id
 	 * @param string             $trigger must be safe raw html (best run through {@see Parser::recursiveTagParse})
 	 * @param string             $content must be safe raw html (best run through {@see Parser::recursiveTagParse})
-	 * @param ParserOutputHelper $parserOutputHelper
+	 * @param ParserOutputHelper $parserOutputHelper @deprecated unused since the inline-emission modal fix; will be removed in the next major release.
 	 *
 	 * @see ModalBuilder::__construct
 	 *

src/BootstrapComponents.php

@@ -56,8 +56,6 @@
  */
 class BootstrapComponents {
 
-	const EXTENSION_DATA_DEFERRED_CONTENT_KEY = 'bsc_deferredContent';
-
 	const EXTENSION_DATA_NO_IMAGE_MODAL = 'bsc_no_image_modal';
 
 

src/Hooks/OutputPageParserOutput.php

@@ -26,7 +26,6 @@
 
 namespace MediaWiki\Extension\BootstrapComponents\Hooks;
 
-use MediaWiki\Extension\BootstrapComponents\BootstrapComponents;
 use MediaWiki\Extension\BootstrapComponents\BootstrapComponentsService;
 /*
  * TODO switch to these, wehen we drop support for mw < 1.40
@@ -41,25 +40,12 @@
  *
  * Called after parse, before the HTML is added to the output.
  *
- * Method delegated to separate class to fix missing (deferred) content in
- * {@see \MediaWiki\Extension\BootstrapComponents\Tests\Integration\BootstrapComponentsJSONScriptTestCaseRunnerTest::assertParserOutputForCase}
- *
  * @see   https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageParserOutput
  *
  * @since 1.2
  */
 class OutputPageParserOutput {
 
-	/**
-	 * @var string
-	 */
-	const INJECTION_PREFIX = '<!-- injected by Extension:BootstrapComponents -->';
-
-	/**
-	 * @var string
-	 */
-	const INJECTION_SUFFIX = '<!-- /injected by Extension:BootstrapComponents -->';
-
 	/**
 	 * @var BootstrapComponentsService
 	 */
@@ -72,14 +58,16 @@ class OutputPageParserOutput {
 
 	/**
 	 * @var ParserOutput $parserOutput
+	 *
+	 * @deprecated unused since the inline-emission modal fix; will be removed in the next major release.
 	 */
 	private ParserOutput $parserOutput;
 
 	/**
 	 * OutputPageParserOutput constructor.
 	 *
 	 * @param OutputPage $outputPage
-	 * @param ParserOutput $parserOutput
+	 * @param ParserOutput $parserOutput @deprecated unused since the inline-emission modal fix; will be removed in the next major release.
 	 * @param BootstrapComponentsService $service
 	 */
 	public function __construct(
@@ -94,36 +82,11 @@ public function __construct(
 	 * @return void
 	 */
 	public function process(): void	{
-		$deferredText = $this->getContentForLaterInjection( $this->getParserOutput() );
-		if ( !empty( $deferredText ) ) {
-			$this->getOutputPage()->addHTML( $deferredText );
-		}
-
 		if ( $this->getBootstrapComponentsService()->vectorSkinInUse() ) {
 			$this->getOutputPage()->addModules( [ 'ext.bootstrapComponents.vector-fix' ] );
 		}
 	}
 
-	/**
-	 * Returns the raw html that is to be inserted at the end of the page.
-	 *
-	 * @param ParserOutput $parserOutput
-	 *
-	 * @return string
-	 */
-	protected function getContentForLaterInjection( ParserOutput $parserOutput ): string {
-		$deferredContent = $parserOutput
-			->getExtensionData(BootstrapComponents::EXTENSION_DATA_DEFERRED_CONTENT_KEY );
-
-		if ( empty( $deferredContent ) || !is_array( $deferredContent ) ) {
-			return '';
-		}
-
-		// clearing extension data for unit and integration tests to work
-		$parserOutput->setExtensionData( BootstrapComponents::EXTENSION_DATA_DEFERRED_CONTENT_KEY, null );
-		return self::INJECTION_PREFIX . implode( array_values( $deferredContent ) ) . self::INJECTION_SUFFIX;
-	}
-
 	protected function getBootstrapComponentsService(): BootstrapComponentsService {
 		return $this->bootstrapComponentService;
 	}
@@ -136,6 +99,8 @@ protected function getOutputPage(): OutputPage {
 	}
 
 	/**
+	 * @deprecated unused since the inline-emission modal fix; will be removed in the next major release.
+	 *
 	 * @return ParserOutput
 	 */
 	protected function getParserOutput(): ParserOutput {

src/ModalBuilder.php

@@ -102,6 +102,8 @@ class ModalBuilder {
 
 	/**
 	 * @var ParserOutputHelper $parserOutputHelper
+	 *
+	 * @deprecated unused since the inline-emission modal fix; will be removed in the next major release.
 	 */
 	private $parserOutputHelper;
 
@@ -146,7 +148,7 @@ public static function wrapTriggerElement( $element, $id ) {
 	 * @param string             $id
 	 * @param string             $trigger must be safe raw html (best run through {@see Parser::recursiveTagParse})
 	 * @param string             $content must be fully parsed html (use {@see Parser::recursiveTagParseFully})
-	 * @param ParserOutputHelper $parserOutputHelper
+	 * @param ParserOutputHelper $parserOutputHelper @deprecated unused since the inline-emission modal fix; will be removed in the next major release.
 	 *
 	 * @see ApplicationFactory::getNewModalBuilder
 	 * @see Components\Modal::generateButton
@@ -163,14 +165,14 @@ public function __construct( $id, $trigger, $content, $parserOutputHelper ) {
 	/**
 	 * Parses the modal.
 	 *
+	 * Emits the trigger followed by the modal container inline. The container is
+	 * `position: fixed` and is addressed via `data-target="#id"`, so its DOM
+	 * placement is not significant.
+	 *
 	 * @return string
 	 */
 	public function parse() {
-		$this->parserOutputHelper->injectLater(
-			$this->getId(),
-			$this->buildModal()
-		);
-		return $this->buildTrigger();
+		return $this->buildTrigger() . $this->buildModal();
 	}
 
 	/**

src/ParserOutputHelper.php

@@ -138,30 +138,6 @@ public function areImageModalsSuppressed() {
 			->getExtensionData( BootstrapComponents::EXTENSION_DATA_NO_IMAGE_MODAL );
 	}
 
-	/**
-	 * Allows for html fragments for a given container id to be stored, so that it can be added to the page at a later time.
-	 *
-	 * @param string $id
-	 * @param string $rawHtml
-	 *
-	 * @return ParserOutputHelper $this (fluid)
-	 */
-	public function injectLater( $id, $rawHtml ) {
-		if ( empty( $this->getParser()->getOutput() ) ) {
-			# fix issues with PageForms file upload (issue #20)
-			return $this;
-		}
-		if ( !empty( $rawHtml ) ) {
-			$deferredContent = $this->getParser()->getOutput()->getExtensionData( BootstrapComponents::EXTENSION_DATA_DEFERRED_CONTENT_KEY );
-			if ( empty( $deferredContent ) ) {
-				$deferredContent = [];
-			}
-			$deferredContent[$id] = $rawHtml;
-			$this->getParser()->getOutput()->setExtensionData( BootstrapComponents::EXTENSION_DATA_DEFERRED_CONTENT_KEY, $deferredContent );
-		}
-		return $this;
-	}
-
 	/**
 	 * Formats a text as error text, so it can be added to the output.
 	 *

tests/phpunit/Unit/Components/ModalTest.php

@@ -49,15 +49,9 @@ public function testCanConstruct() {
 	 */
 	public function testCanRender( $input, $arguments, $expectedTriggerOutput, $expectedModalOutput ) {
 
-		$modalInjection = '';
 		$parserOutputHelper = $this->getMockBuilder( 'MediaWiki\\Extension\\BootstrapComponents\\ParserOutputHelper' )
 			->disableOriginalConstructor()
 			->getMock();
-		$parserOutputHelper->expects( $this->any() )
-			->method( 'injectLater' )
-			->will( $this->returnCallback( function( $id, $text ) use ( &$modalInjection ) {
-				$modalInjection .= $text;
-			} ) );
 		$parserOutputHelper->expects( $this->any() )
 			->method( 'renderErrorMessage' )
 			->will( $this->returnArgument( 0 ) );
@@ -74,11 +68,7 @@ public function testCanRender( $input, $arguments, $expectedTriggerOutput, $expe
 		/** @noinspection PhpParamsInspection */
 		$generatedOutput = $instance->parseComponent( $parserRequest );
 
-		$this->assertEquals( $expectedTriggerOutput, $generatedOutput );
-		$this->assertEquals(
-			$expectedModalOutput,
-			$modalInjection
-		);
+		$this->assertEquals( $expectedTriggerOutput . $expectedModalOutput, $generatedOutput );
 	}
 
 	/**

tests/phpunit/Unit/Hooks/OutputPageParserOutputTest.php

@@ -39,40 +39,43 @@ public function testCanConstruct() {
 		);
 	}
 
-	public function testHookOutputPageParserOutput() {
-		$content = 'CONTENT';
-
+	public function testHookOutputPageParserOutputLoadsVectorFixUnderVector() {
 		$outputPage = $this->createMock( OutputPage::class );
-		$outputPage->expects( $this->once() )
-			->method( 'addHTML' )
-			->will( $this->returnCallback( function( $injection ) use ( &$content ) {
-				$content .= $injection;
-			} ) );
+		$outputPage->expects( $this->never() )->method( 'addHTML' );
 		$outputPage->expects( $this->once() )
 			->method( 'addModules' )
 			->with(
 				$this->equalTo( [ 'ext.bootstrapComponents.vector-fix' ] )
 			);
 
-		$observerParserOutput = $this->createMock( ParserOutput::class );
-		$observerParserOutput->expects( $this->exactly( 1 ) )
-			->method( 'getExtensionData' )
-			->with(
-				$this->stringContains( 'bsc_deferredContent' )
-			)
-			->willReturn( [ 'test' ] );
-
 		$bootstrapService = $this->createMock( BootstrapComponentsService::class );
 		$bootstrapService->expects( $this->once() )
 			->method( 'vectorSkinInUse' )
 			->willReturn( true );
 
-		$instance = new OutputPageParserOutput( $outputPage, $observerParserOutput, $bootstrapService );
+		$instance = new OutputPageParserOutput(
+			$outputPage,
+			$this->createMock( ParserOutput::class ),
+			$bootstrapService
+		);
 		$instance->process();
+	}
 
-		$this->assertEquals(
-			'CONTENT<!-- injected by Extension:BootstrapComponents -->test<!-- /injected by Extension:BootstrapComponents -->',
-			$content
+	public function testHookDoesNothingWhenNotVector() {
+		$outputPage = $this->createMock( OutputPage::class );
+		$outputPage->expects( $this->never() )->method( 'addHTML' );
+		$outputPage->expects( $this->never() )->method( 'addModules' );
+
+		$bootstrapService = $this->createMock( BootstrapComponentsService::class );
+		$bootstrapService->expects( $this->once() )
+			->method( 'vectorSkinInUse' )
+			->willReturn( false );
+
+		$instance = new OutputPageParserOutput(
+			$outputPage,
+			$this->createMock( ParserOutput::class ),
+			$bootstrapService
 		);
+		$instance->process();
 	}
 }

tests/phpunit/Unit/ImageModalTest.php

@@ -254,13 +254,7 @@ function( $component ) {
 				}
 			) );
 
-		$modalInjection = '';
 		$parserOutputHelper = $this->createMock( ParserOutputHelper::class );
-		$parserOutputHelper->expects( $this->any() )
-			->method( 'injectLater' )
-			->will( $this->returnCallback( function( $id, $text ) use ( &$modalInjection ) {
-				$modalInjection .= $text;
-			} ) );
 
 		$instance = $this->createImageModalWithMocks( null, $title, $file, $nestingController, null, $parserOutputHelper );
 		$time = false;
@@ -283,9 +277,9 @@ function( $component ) {
 				. '--  ' . ($resultOfParseCall ?: $res)
 			);
 		}
-		$this->assertEquals(
+		$this->assertStringContainsString(
 			$expectedModal,
-			$modalInjection,
+			$resultOfParseCall ?: $res,
 			'failed modal with test data:' . $this->generatePhpCodeForManualProviderDataOneCase( $fp, $hp )
 		);
 	}

tests/phpunit/Unit/ModalBuilderTest.php

@@ -49,15 +49,9 @@ public function testCanConstruct() {
 	 */
 	public function testCanParse( $id, $trigger, $content, $header, $footer, $outerClass, $outerStyle, $innerClass, $expectedTrigger, $expectedModal ) {
 
-		$modalInjection = '';
 		$parserOutputHelper = $this->getMockBuilder( 'MediaWiki\\Extension\\BootstrapComponents\\ParserOutputHelper' )
 			->disableOriginalConstructor()
 			->getMock();
-		$parserOutputHelper->expects( $this->any() )
-			->method( 'injectLater' )
-			->will( $this->returnCallback( function( $id, $text ) use ( &$modalInjection ) {
-				$modalInjection .= $text;
-			} ) );
 
 		/** @noinspection PhpParamsInspection */
 		$instance = new ModalBuilder( $id, $trigger, $content, $parserOutputHelper );
@@ -77,13 +71,9 @@ public function testCanParse( $id, $trigger, $content, $header, $footer, $outerC
 			$instance->setDialogClass( $innerClass );
 		}
 		$this->assertEquals(
-			$expectedTrigger,
+			$expectedTrigger . $expectedModal,
 			$instance->parse()
 		);
-		$this->assertEquals(
-			$expectedModal,
-			$modalInjection
-		);
 	}
 
 	/**