Skip to content

Surface checks that failed to run #1457

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.

Sign up for GitHub

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

Open
sanketio wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Surface checks that failed to run #1457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 38 additions & 24 deletions assets/js/plugin-check-admin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -756,6 +756,7 @@
) {
let isSuccessMessage = true;
let aiStats = null;
const failedChecks = [];
for ( let i = 0; i < checks.length; i++ ) {
try {
const results = await runCheck(
Expand Down Expand Up @@ -812,14 +813,15 @@
}
}
} catch {
// Ignore for now.
failedChecks.push( checks[ i ] );
}
}

renderFalsePositiveResults();
const resultsMessage = renderResultsMessage(
isSuccessMessage,
aiStats
aiStats,
failedChecks
);

// Announce the check results summary so screen-reader users know
Expand All @@ -830,16 +832,35 @@
}
}

/**
* Substitutes printf-style placeholders in a translated string.
* Handles both simple (%d, %s) and positional (%1$d, %2$s) placeholders.
*
* @since 2.1.0
*
* @param {string} template The translated format string.
* @param {...string} args Replacement values.
* @return {string} Formatted string with placeholders replaced.
*/
function sprintfReplace( template, ...args ) {
let i = 0;
return template.replace( /%(\d+\$)?[ds]/g, function ( _match, pos ) {
const index = pos ? parseInt( pos, 10 ) - 1 : i++;
return args[ index ] !== undefined ? args[ index ] : _match;
} );
}

/**
* Renders result message.
*
* @since 1.0.0
*
* @param {boolean} isSuccessMessage Whether the message is a success message.
* @param {Object} aiStats AI statistics.
* @param {Array} failedChecks Slugs of checks whose request did not complete.
* @return {string} The rendered results message.
*/
function renderResultsMessage( isSuccessMessage, aiStats ) {
function renderResultsMessage( isSuccessMessage, aiStats, failedChecks ) {
// Count errors and warnings to determine notice severity and compose the message.
const { errorCount, warningCount } = isSuccessMessage
? { errorCount: 0, warningCount: 0 }
Expand All @@ -860,27 +881,6 @@
if ( isSuccessMessage ) {
messageText = pluginCheck.successMessage;
} else {
/**
* Substitutes printf-style placeholders in a translated string.
* Handles both simple (%d, %s) and positional (%1$d, %2$s) placeholders.
*
* @param {string} template The translated format string.
* @param {...string} args Replacement values.
* @return {string} Formatted string with placeholders replaced.
*/
function sprintfReplace( template, ...args ) {
let i = 0;
return template.replace(
/%(\d+\$)?[ds]/g,
function ( _match, pos ) {
const index = pos ? parseInt( pos, 10 ) - 1 : i++;
return args[ index ] !== undefined
? args[ index ]
: _match;
}
);
}

// Build the individual count parts with proper plural/singular forms.
let errorPart = '';
if ( errorCount > 0 ) {
Expand Down Expand Up @@ -926,6 +926,20 @@
}
}

// A check whose request did not complete has no results, so the counts above cannot speak for it.
if ( failedChecks && failedChecks.length ) {
messageType = 'error';

const failedText = sprintfReplace(
pluginCheck.failedChecksMessage,
failedChecks.join( ', ' )
);

messageText = isSuccessMessage
? failedText
: messageText + ' ' + failedText;
}

if ( aiStats ) {
const aiParts = [];
const modelsUsed = [
Expand Down
2 changes: 2 additions & 0 deletions includes/Admin/Admin_Page.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,8 @@ public function enqueue_scripts() {
'summaryBothTemplate' => __( '%1$s and %2$s found.', 'plugin-check' ),
/* translators: %s: Formatted issue count string (e.g. "3 errors" or "2 warnings"). */
'summarySingleTemplate' => __( '%s found.', 'plugin-check' ),
/* translators: %s: Comma-separated list of check slugs. */
'failedChecksMessage' => __( 'These checks could not be completed and their results are unknown: %s.', 'plugin-check' ),
'strings' => array(
'checkingPlugin' => __( 'Running plugin checks…', 'plugin-check' ),
'exportCsv' => __( 'Export CSV', 'plugin-check' ),
Expand Down
Loading