Changeset 59001

Timestamp:

09/09/2024 10:10:09 PM (4 weeks ago)

Author:

dmsnell

Message:

HTML API: Add sentinels for unreachable code.

There are places in the HTML API code where some tools get confused and flag invalid types for the return of a function because they are unable to detect that the end of the function is unreachable.

Since PHP doesn't provide a way to encode total matching in the source code, this patch adds a few extra lines in those unreachable locations to satisfy any tooling which isn't able to fully analyze the code.

Additionally this serves as extra guarding in case someone changes these functions in a way which would break them and the existing test suite doesn't catch those breakages.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/7315
Discussed in https://core.trac.wordpress.org/ticket/62018

Props dlh, dmsnell.
Fixes #62018.

Location:

trunk/src/wp-includes/html-api

Files:

• class-wp-html-processor.php (modified) (3 diffs)
• class-wp-html-tag-processor.php (modified) (1 diff)

trunk/src/wp-includes/html-api/class-wp-html-processor.php

@@ -2771 +2771 @@
             }
         }
+
+        $this->bail( 'Should not have been able to reach end of IN BODY processing. Check HTML API code.' );
+        // This unnecessary return prevents tools from inaccurately reporting type errors.
+        return false;
     }
 
@@ -4646 +4650 @@
             }
         }
+
+        $this->bail( 'Should not have been able to reach end of IN FOREIGN CONTENT processing. Check HTML API code.' );
+        // This unnecessary return prevents tools from inaccurately reporting type errors.
+        return false;
     }
 
@@ -5879 +5887 @@
             );
         }
+
+        $this->bail( 'Should not have reached end of HTML Integration Point detection: check HTML API code.' );
+        // This unnecessary return prevents tools from inaccurately reporting type errors.
+        return false;
     }
 

trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

@@ -2966 +2966 @@
             }
         }
+
+        // This unnecessary return prevents tools from inaccurately reporting type errors.
+        return $tag_name;
     }