HTML API: Add sentinels for unreachable code.

dmsnell · dmsnell · commit ad1db1158c9e · 2024-09-09T22:10:09.000Z
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 #7315 Discussed in https://core.trac.wordpress.org/ticket/62018 Props dlh, dmsnell. Fixes #62018. git-svn-id: https://develop.svn.wordpress.org/trunk@59001 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-includes/html-api/class-wp-html-processor.php b/src/wp-includes/html-api/class-wp-html-processor.php
@@ -2770,6 +2770,10 @@ private function step_in_body(): bool {
 				}
 			}
 		}
+
+		$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;
 	}
 
 	/**
@@ -4645,6 +4649,10 @@ private function step_in_foreign_content(): bool {
 					$this->bail( "Unaware of the requested parsing mode: '{$this->state->insertion_mode}'." );
 			}
 		}
+
+		$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;
 	}
 
 	/*
@@ -5878,6 +5886,10 @@ private function is_html_integration_point(): bool {
 				)
 			);
 		}
+
+		$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;
 	}
 
 	/**
diff --git a/src/wp-includes/html-api/class-wp-html-tag-processor.php b/src/wp-includes/html-api/class-wp-html-tag-processor.php
@@ -2965,6 +2965,9 @@ public function get_qualified_tag_name(): ?string {
 					return $lower_tag_name;
 			}
 		}
+
+		// This unnecessary return prevents tools from inaccurately reporting type errors.
+		return $tag_name;
 	}
 
 	/**

Original file line number	Diff line number	Diff line change
`@@ -2770,6 +2770,10 @@ private function step_in_body(): bool {`
`2770`	`2770`	`}`
`2771`	`2771`	`}`
`2772`	`2772`	`}`
	`2773`	`+`
	`2774`	`+ $this->bail( 'Should not have been able to reach end of IN BODY processing. Check HTML API code.' );`
	`2775`	`+ // This unnecessary return prevents tools from inaccurately reporting type errors.`
	`2776`	`+ return false;`
`2773`	`2777`	`}`
`2774`	`2778`
`2775`	`2779`	`/**`
`@@ -4645,6 +4649,10 @@ private function step_in_foreign_content(): bool {`
`4645`	`4649`	`$this->bail( "Unaware of the requested parsing mode: '{$this->state->insertion_mode}'." );`
`4646`	`4650`	`}`
`4647`	`4651`	`}`
	`4652`	`+`
	`4653`	`+ $this->bail( 'Should not have been able to reach end of IN FOREIGN CONTENT processing. Check HTML API code.' );`
	`4654`	`+ // This unnecessary return prevents tools from inaccurately reporting type errors.`
	`4655`	`+ return false;`
`4648`	`4656`	`}`
`4649`	`4657`
`4650`	`4658`	`/*`
`@@ -5878,6 +5886,10 @@ private function is_html_integration_point(): bool {`
`5878`	`5886`	`)`
`5879`	`5887`	`);`
`5880`	`5888`	`}`
	`5889`	`+`
	`5890`	`+ $this->bail( 'Should not have reached end of HTML Integration Point detection: check HTML API code.' );`
	`5891`	`+ // This unnecessary return prevents tools from inaccurately reporting type errors.`
	`5892`	`+ return false;`
`5881`	`5893`	`}`
`5882`	`5894`
`5883`	`5895`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -2965,6 +2965,9 @@ public function get_qualified_tag_name(): ?string {`
`2965`	`2965`	`return $lower_tag_name;`
`2966`	`2966`	`}`
`2967`	`2967`	`}`
	`2968`	`+`
	`2969`	`+ // This unnecessary return prevents tools from inaccurately reporting type errors.`
	`2970`	`+ return $tag_name;`
`2968`	`2971`	`}`
`2969`	`2972`
`2970`	`2973`	`/**`