Skip to content

PHPC-2064: Use register_shutdown_function to disable caching of skipif results #1366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 16, 2022

Conversation

alcaeus
Copy link
Member

@alcaeus alcaeus commented Sep 15, 2022

PHPC-2064
Replaces #1301

As is, using any logic in a SKIPIF block after a previous call to skip_if_not_clean leads to the tests not being skipped. This is due to PHP 8.1+ reading the nocache output and discarding any subsequent output. To resolve this, we can change disable_skipif_caching to register a shutdown function that disables caching by printing nocache to STDOUT. While this can lead to skip messages containing an extra nocache at the end, I believe this is preferable to SKIPIF logic being ignored. I also believe it's not worth adding any logic to not print anything if a previous check resulted in skip ... being printed.

@alcaeus alcaeus requested a review from jmikola September 15, 2022 12:34
@alcaeus alcaeus self-assigned this Sep 15, 2022
@@ -15,11 +15,17 @@
*/
function disable_skipif_caching()
{
static $skipifCachingDisabled;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this can lead to skip messages containing an extra nocache at the end, I believe this is preferable to SKIPIF logic being ignored

I assume that was written before you added this static sentinel value? I don't think we need to worry about duplicate "nocache" lines.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite. Assuming one check exits with the message "skip this test does not work", the shutdown handler would still add "nocache" at the end, changing the message to "skip this test does not worknocache".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it necessary to append nocache to an existing line to avoid a BORK if it were printed on its own line after a skip?

Sorry, it's been quite a while since I thought about any of this.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it's more of a side-effect of how things are done: our skip functions call exit('skip whatever'); without a trailing newline. The shutdown handler then prints "nocache" to the output, meaning that it will be appended to the end of whatever the previous skip functions printed. As the message doesn't have a trailing newline, it's appended in the same line.

Looking at run-tests.php again, I can see that the output of the skip file is run through trim before checking for "nocache", so we could even print a leading newline in the shutdown handler to avoid appending to a previously printed skip message. I'll take another look at that.

@alcaeus alcaeus changed the title Use register_shutdown_function to disable caching of skipif results PHPC-2064: Use register_shutdown_function to disable caching of skipif results Sep 16, 2022
@alcaeus alcaeus merged commit 6db48b8 into mongodb:master Sep 16, 2022
@alcaeus alcaeus deleted the improved-skipif-checking branch September 16, 2022 06:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants