Changeset 58321 for trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php

Timestamp:

06/04/2024 07:16:48 AM (2 years ago)

Author:

gziolo

Message:

Interactivity API: Print debug warning when server directives processing encounters errors

Aims to improve the developer experience of the Interactivity API server directives processing.

Props cbravobernal, jonsurrell, westonruter, darerodz, czapla, gziolo.
Fixes #61044.

File:

• trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php (modified) (5 diffs)

trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php

@@ -273 +273 @@
          *
          * @since 6.5.0
+         * @since 6.6.0 The function displays a warning message when the HTML contains unbalanced tags or a directive appears in a MATH or SVG tag.
          *
          * @param string $html            The HTML content to process.
@@ -296 +297 @@
                          */
                         if ( 'SVG' === $tag_name || 'MATH' === $tag_name ) {
+                                if ( $p->get_attribute_names_with_prefix( 'data-wp-' ) ) {
+                                        /* translators: 1: SVG or MATH HTML tag, 2: Namespace of the interactive block. */
+                                        $message = sprintf( __( 'Interactivity directives were detected on an incompatible %1$s tag when processing "%2$s". These directives will be ignored in the server side render.' ), $tag_name, end( $namespace_stack ) );
+                                        _doing_it_wrong( __METHOD__, $message, '6.6.0' );
+                                }
                                 $p->skip_to_tag_closer();
                                 continue;
@@ -383 +389 @@
                         }
                 }
-
                 /*
                  * It returns null if the HTML is unbalanced because unbalanced HTML is
                  * not safe to process. In that case, the Interactivity API runtime will
-                 * update the HTML on the client side during the hydration.
+                 * update the HTML on the client side during the hydration. It will also
+                 * display a notice to the developer to inform them about the issue.
                  */
-                return $unbalanced || 0 < count( $tag_stack ) ? null : $p->get_updated_html();
+                if ( $unbalanced || 0 < count( $tag_stack ) ) {
+                        $tag_errored = 0 < count( $tag_stack ) ? end( $tag_stack )[0] : $tag_name;
+                        /* translators: %1s: Namespace processed, %2s: The tag that caused the error; could be any HTML tag.  */
+                        $message = sprintf( __( 'Interactivity directives failed to process in "%1$s" due to a missing "%2$s" end tag.' ), end( $namespace_stack ), $tag_errored );
+                        _doing_it_wrong( __METHOD__, $message, '6.6.0' );
+                        return null;
+                }
+
+                return $p->get_updated_html();
         }
 
@@ -397 +411 @@
          *
          * @since 6.5.0
+         * @since 6.6.0 The function now adds a warning when the namespace is null, falsy, or the directive value is empty.
          *
          * @param string|true $directive_value   The directive attribute value string or `true` when it's a boolean attribute.
@@ -403 +418 @@
          * @param array|false $context           The current context for evaluating the directive or false if there is no
          *                                       context.
-         * @return mixed|null The result of the evaluation. Null if the reference path doesn't exist.
+         * @return mixed|null The result of the evaluation. Null if the reference path doesn't exist or the namespace is falsy.
          */
         private function evaluate( $directive_value, string $default_namespace, $context = false ) {
                 list( $ns, $path ) = $this->extract_directive_value( $directive_value, $default_namespace );
-                if ( empty( $path ) ) {
+                if ( ! $ns || ! $path ) {
+                        /* translators: %s: The directive value referenced. */
+                        $message = sprintf( __( 'Namespace or reference path cannot be empty. Directive value referenced: %s' ), $directive_value );
+                        _doing_it_wrong( __METHOD__, $message, '6.6.0' );
                         return null;
                 }