Add sourceURL comments for inline scripts

westonruter · westonruter · commit c51de8b20401 · 2025-09-09T17:52:16.000-07:00
diff --git a/plugins/embed-optimizer/helper.php b/plugins/embed-optimizer/helper.php
@@ -351,6 +351,14 @@ function embed_optimizer_get_lazy_load_script(): string {
 		return '';
 	}
 
+	$script .= sprintf(
+		"\n//# sourceURL=%s",
+		add_query_arg(
+			array( 'ver' => EMBED_OPTIMIZER_VERSION ),
+			plugins_url( embed_optimizer_get_asset_path( 'lazy-load.js' ), __FILE__ )
+		)
+	);
+
 	return $script;
 }
 
diff --git a/plugins/image-prioritizer/helper.php b/plugins/image-prioritizer/helper.php
@@ -400,8 +400,16 @@ function image_prioritizer_get_asset_path( string $src_path, ?string $min_path =
  * @return string Lazy load script.
  */
 function image_prioritizer_get_video_lazy_load_script(): string {
-	$path = image_prioritizer_get_asset_path( 'lazy-load-video.js' );
-	return (string) file_get_contents( __DIR__ . '/' . $path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- It's a local filesystem path not a remote request.
+	$path    = image_prioritizer_get_asset_path( 'lazy-load-video.js' );
+	$script  = (string) file_get_contents( __DIR__ . '/' . $path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- It's a local filesystem path not a remote request.
+	$script .= sprintf(
+		"\n//# sourceURL=%s",
+		add_query_arg(
+			array( 'ver' => IMAGE_PRIORITIZER_VERSION ),
+			plugins_url( $path, __FILE__ )
+		)
+	);
+	return $script;
 }
 
 /**
@@ -415,8 +423,16 @@ function image_prioritizer_get_video_lazy_load_script(): string {
  * @return string Lazy load script.
  */
 function image_prioritizer_get_lazy_load_bg_image_script(): string {
-	$path = image_prioritizer_get_asset_path( 'lazy-load-bg-image.js' );
-	return (string) file_get_contents( __DIR__ . '/' . $path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- It's a local filesystem path not a remote request.
+	$path    = image_prioritizer_get_asset_path( 'lazy-load-bg-image.js' );
+	$script  = (string) file_get_contents( __DIR__ . '/' . $path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- It's a local filesystem path not a remote request.
+	$script .= sprintf(
+		"\n//# sourceURL=%s",
+		add_query_arg(
+			array( 'ver' => IMAGE_PRIORITIZER_VERSION ),
+			plugins_url( $path, __FILE__ )
+		)
+	);
+	return $script;
 }
 
 /**
@@ -428,6 +444,14 @@ function image_prioritizer_get_lazy_load_bg_image_script(): string {
  * @return string Lazy load stylesheet.
  */
 function image_prioritizer_get_lazy_load_bg_image_stylesheet(): string {
-	$path = image_prioritizer_get_asset_path( 'lazy-load-bg-image.css' );
-	return (string) file_get_contents( __DIR__ . '/' . $path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- It's a local filesystem path not a remote request.
+	$path   = image_prioritizer_get_asset_path( 'lazy-load-bg-image.css' );
+	$style  = (string) file_get_contents( __DIR__ . '/' . $path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- It's a local filesystem path not a remote request.
+	$style .= sprintf(
+		"\n/*# sourceURL=%s */",
+		add_query_arg(
+			array( 'ver' => IMAGE_PRIORITIZER_VERSION ),
+			plugins_url( $path, __FILE__ )
+		)
+	);
+	return $style;
 }
diff --git a/plugins/image-prioritizer/tests/test-cases/common-lcp-background-image-and-lazy-loaded-background-image-outside-viewport-with-fully-populated-sample-data/expected.html b/plugins/image-prioritizer/tests/test-cases/common-lcp-background-image-and-lazy-loaded-background-image-outside-viewport-with-fully-populated-sample-data/expected.html
diff --git a/plugins/image-prioritizer/tests/test-cases/only-mobile-and-desktop-groups-are-populated/expected.html b/plugins/image-prioritizer/tests/test-cases/only-mobile-and-desktop-groups-are-populated/expected.html
diff --git a/plugins/optimization-detective/detection.php b/plugins/optimization-detective/detection.php
@@ -151,10 +151,14 @@ static function ( OD_URL_Metric_Group $group ): array {
 
 	return wp_get_inline_script_tag(
 		sprintf(
-			'( %s )( %s, %s );',
+			"( %s )( %s, %s );\n//# sourceURL=%s",
 			file_get_contents( __DIR__ . '/' . od_get_asset_path( 'detect-loader.js' ) ), // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- It's a local filesystem path not a remote request.
 			wp_json_encode( plugins_url( add_query_arg( 'ver', OPTIMIZATION_DETECTIVE_VERSION, od_get_asset_path( 'detect.js' ) ), __FILE__ ) ),
-			wp_json_encode( $detect_args )
+			wp_json_encode( $detect_args ),
+			add_query_arg(
+				array( 'ver' => OPTIMIZATION_DETECTIVE_VERSION ),
+				plugins_url( od_get_asset_path( 'detect-loader.js' ), __FILE__ )
+			)
 		),
 		array( 'type' => 'module' )
 	);
diff --git a/plugins/optimization-detective/optimization.php b/plugins/optimization-detective/optimization.php
@@ -118,11 +118,12 @@ function_exists( 'perflab_server_timing_use_output_buffer' )
  * @param string[] $reasons Reason messages.
  */
 function od_print_disabled_reasons( array $reasons ): void {
-	foreach ( $reasons as $reason ) {
+	foreach ( $reasons as $i => $reason ) {
 		wp_print_inline_script_tag(
 			sprintf(
-				'console.info( %s );',
-				wp_json_encode( '[Optimization Detective] ' . $reason )
+				"console.info( %s );\n//# sourceURL=od-print-disabled-reasons-%d",
+				wp_json_encode( '[Optimization Detective] ' . $reason ),
+				$i + 1
 			),
 			array( 'type' => 'module' )
 		);
diff --git a/plugins/optimization-detective/tests/class-optimization-detective-test-helpers.php b/plugins/optimization-detective/tests/class-optimization-detective-test-helpers.php
@@ -279,6 +279,7 @@ public function assert_snapshot_equals( string $directory ): void {
 		$buffer = od_optimize_template_output_buffer( $buffer );
 
 		// Normalize script module content so changes do not impact snapshots.
+		// TODO: Once WP 6.7 is the minimum-supported version, replace this with WP_HTML_Tag_Processor::set_modifiable_text().
 		$buffer = preg_replace_callback(
 			'#(<script type="module">)(.+?)(</script>)#s',
 			static function ( $matches ) {
@@ -290,9 +291,42 @@ static function ( $matches ) {
 				$text = trim( $text );
 				if ( 1 === preg_match( '/^(import|const) \w+/', $text, $matches ) ) {
 					$text = '/* ' . $matches[0] . ' ... */';
-				} elseif ( 1 === preg_match( '/^\( async function load.+\);$/s', $text ) ) {
+				} elseif ( 1 === preg_match( ':^\( async function load.+\);(\n//# sourceURL=.*)?$:s', $text ) ) {
 					$text = '/* detect loader */';
 				}
+
+				// Normalize versions which occur in sourceURL.
+				$text = preg_replace( '/ver=\d+\.\d+\.\d+(-\w+)?/', 'ver=__VERSION__', $text );
+
+				// Ensure any home URLs are normalized to account for variations in the testing environment.
+				$text = str_replace(
+					array( home_url( '/', 'http' ), home_url( '/', 'https' ) ),
+					'https://example.com/',
+					$text
+				);
+
+				return $start_tag . $text . $end_tag;
+			},
+			$buffer
+		);
+
+		// TODO: Once WP 6.7 is the minimum-supported version, replace this with WP_HTML_Tag_Processor::set_modifiable_text().
+		$buffer = preg_replace_callback(
+			'#(<style[^>]*?>)(.+?)(</style>)#s',
+			static function ( $matches ) {
+				array_shift( $matches );
+				list( $start_tag, $text, $end_tag ) = $matches;
+
+				// Normalize versions which occur in sourceURL.
+				$text = preg_replace( '/ver=\d+\.\d+\.\d+(-\w+)?/', 'ver=__VERSION__', $text );
+
+				// Ensure any home URLs are normalized to account for variations in the testing environment.
+				$text = str_replace(
+					array( home_url( '/', 'http' ), home_url( '/', 'https' ) ),
+					'https://example.com/',
+					$text
+				);
+
 				return $start_tag . $text . $end_tag;
 			},
 			$buffer
diff --git a/plugins/speculation-rules/settings.php b/plugins/speculation-rules/settings.php
@@ -340,6 +340,7 @@ function plsr_render_settings_field( array $args ): void {
 				}
 JS;
 			// 👆 This 'JS;' line can only be indented two tabs when minimum PHP version is increased to 7.3+.
+			$js .= "\n//# sourceURL=speculation-rules-auth-admin-notice";
 			wp_print_inline_script_tag( $js, array( 'type' => 'module' ) );
 			?>
 		<?php endif; ?>

Original file line number	Diff line number	Diff line change
`@@ -351,6 +351,14 @@ function embed_optimizer_get_lazy_load_script(): string {`
`351`	`351`	`return '';`
`352`	`352`	`}`
`353`	`353`
	`354`	`+ $script .= sprintf(`
	`355`	`+ "\n//# sourceURL=%s",`
	`356`	`+ add_query_arg(`
	`357`	`+ array( 'ver' => EMBED_OPTIMIZER_VERSION ),`
	`358`	`+ plugins_url( embed_optimizer_get_asset_path( 'lazy-load.js' ), __FILE__ )`
	`359`	`+ )`
	`360`	`+ );`
	`361`	`+`
`354`	`362`	`return $script;`
`355`	`363`	`}`
`356`	`364`
Original file line number	Diff line number	Diff line change
`@@ -340,6 +340,7 @@ function plsr_render_settings_field( array $args ): void {`
`340`	`340`	`}`
`341`	`341`	`JS;`
`342`	`342`	`// 👆 This 'JS;' line can only be indented two tabs when minimum PHP version is increased to 7.3+.`
	`343`	`+ $js .= "\n//# sourceURL=speculation-rules-auth-admin-notice";`
`343`	`344`	`wp_print_inline_script_tag( $js, array( 'type' => 'module' ) );`
`344`	`345`	`?>`
`345`	`346`	`<?php endif; ?>`