Skip to content
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

Add panel to display registered assets #879

Open
wants to merge 19 commits into
base: develop
Choose a base branch
from
Open

Add panel to display registered assets #879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
9c0888f
save
crstauf May 27, 2024
d46ef3f
save
crstauf Jul 27, 2024
8abb308
Merge branch 'develop' into show-all-assets
crstauf Jul 27, 2024
1897143
save
crstauf Jul 27, 2024
859f390
save
crstauf Jul 27, 2024
7df7f8b
save
crstauf Jul 27, 2024
029ae89
save
crstauf Jul 27, 2024
dd0a55b
remove constant requirement for registered assets
crstauf Jul 27, 2024
be7c721
Merge branch 'develop' into show-all-assets
crstauf Jul 27, 2024
cc41ed0
Sort the list of registered assets.
johnbillion Jul 28, 2024
383f0c7
Fix this label.
johnbillion Jul 28, 2024
bf628d2
No need to show the position column for registered assets.
johnbillion Jul 28, 2024
c898417
fix phpstan error
crstauf Jul 29, 2024
d8edd4a
Merge branch 'develop' into show-all-assets
crstauf Aug 19, 2024
b7ad4ad
Merge branch 'develop' into show-all-assets
crstauf Sep 25, 2024
48ca141
Merge branch 'develop' into show-all-assets
crstauf Nov 18, 2024
e950af5
Merge branch 'develop' into show-all-assets
crstauf Nov 27, 2024
458136d
Merge branch 'develop' into show-all-assets
crstauf Nov 29, 2024
9cf3504
Merge branch 'develop' into show-all-assets
crstauf Jan 10, 2025
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
20 changes: 18 additions & 2 deletions classes/Collector_Assets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ public function process() {
'broken',
'header',
'footer',
'registered',
);

$this->data->counts = array(
Expand All @@ -112,6 +113,7 @@ public function process() {
'header' => 0,
'footer' => 0,
'total' => 0,
'registered' => 0,
);

foreach ( array( 'header', 'footer' ) as $position ) {
Expand All @@ -125,6 +127,10 @@ public function process() {
$broken = array_values( array_diff( $raw->queue, $raw->done ) );
$missing = array_values( array_diff( $raw->queue, array_keys( $raw->registered ) ) );

$this->data->registered = array_keys( $raw->registered );

sort( $this->data->registered );

// A broken asset is one which has been deregistered without also being dequeued
if ( ! empty( $broken ) ) {
foreach ( $broken as $key => $handle ) {
Expand Down Expand Up @@ -159,6 +165,7 @@ public function process() {
$all_dependents = array();

$missing_dependencies = array();
$processed = array();

foreach ( $positions as $position ) {
if ( empty( $this->data->{$position} ) ) {
Expand All @@ -174,6 +181,10 @@ public function process() {
continue;
}

if ( 'registered' === $position && in_array( $handle, $processed ) ) {
continue;
}

$all_dependencies = array_merge( $all_dependencies, $dependency->deps );
$dependents = $this->get_dependents( $dependency, $raw );
$all_dependents = array_merge( $all_dependents, $dependents );
Expand All @@ -186,7 +197,7 @@ public function process() {
$ver = $dependency->ver;
}

$warning = ! in_array( $handle, $raw->done, true );
$warning = ! in_array( $handle, $raw->done, true ) && 'registered' !== $position;

if ( $source instanceof WP_Error ) {
$display = $source->get_error_message();
Expand Down Expand Up @@ -216,7 +227,12 @@ public function process() {
);

$this->data->counts[ $position ]++;
$this->data->counts['total']++;

if ( 'registered' !== $position ) {
$this->data->counts['total']++;
}

$processed[] = $handle;
}
}

Expand Down
5 changes: 5 additions & 0 deletions data/assets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,9 @@ class QM_Data_Assets extends QM_Data {
* @var string
*/
public $port;

/**
* @var array<int, string>
*/
public $registered;
}
91 changes: 81 additions & 10 deletions output/html/assets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,65 @@ public function output() {
echo '</tfoot>';

$this->after_tabular_output();

$this->before_tabular_output( $this->collector->id() . '-registered', __( 'Registered', 'query-monitor' ) );

/* translators: %s: "styles" or "scripts" */
$caption_format = esc_html__( 'Enqueued %s are not included.', 'query-monitor' );

printf(
'<caption><h2 id="%1$s-caption">%2$s</h2></caption>',
esc_attr( $this->collector->id() . '-registered' ),
esc_html( sprintf( $caption_format, strtolower( $type_label['plural'] ) ) )
);

echo '<thead>';
echo '<tr>';
echo '<th scope="col">' . esc_html__( 'Handle', 'query-monitor' ) . '</th>';
echo '<th scope="col" class="qm-filterable-column">';
$args = array(
'prepend' => array(
'local' => $data->full_host,
),
);
echo $this->build_filter( $type . '-host', $hosts, __( 'Host', 'query-monitor' ), $args ); // WPCS: XSS ok.
echo '</th>';
echo '<th scope="col">' . esc_html__( 'Source', 'query-monitor' ) . '</th>';
echo '<th scope="col" class="qm-filterable-column">';
echo $this->build_filter( $type . '-dependencies', $data->dependencies, __( 'Dependencies', 'query-monitor' ) ); // WPCS: XSS ok.
echo '</th>';
echo '<th scope="col" class="qm-filterable-column">';
echo $this->build_filter( $type . '-dependents', $data->dependents, __( 'Dependents', 'query-monitor' ) ); // WPCS: XSS ok.
echo '</th>';
echo '<th scope="col">' . esc_html__( 'Version', 'query-monitor' ) . '</th>';
echo '</tr>';
echo '</thead>';

echo '<tbody>';

if ( ! empty( $data->assets['registered'] ) ) {
foreach ( $data->assets['registered'] as $handle => $asset ) {
$this->dependency_row( $handle, $asset, '' );
}
}

echo '</tbody>';

echo '<tfoot>';

echo '<tr>';
printf(
'<td colspan="6">%1$s</td>',
sprintf(
esc_html( $type_label['total'] ),
'<span class="qm-items-number">' . esc_html( number_format_i18n( $data->counts['registered'] ) ) . '</span>'
)
);
echo '</tr>';
echo '</tfoot>';

echo '</table>';
echo '</div>';
}

/**
Expand All @@ -131,11 +190,10 @@ protected function dependency_row( $handle, array $asset, $label ) {
$dependents_list = implode( ' ', $asset['dependents'] );

$dependency_output = array();
$warning = QueryMonitor::icon( 'warning' );

foreach ( $asset['dependencies'] as $dep ) {
if ( isset( $data->missing_dependencies[ $dep ] ) ) {
$warning = QueryMonitor::icon( 'warning' );

$dependency_output[] = sprintf(
'<span style="white-space:nowrap">%1$s%2$s</span>',
$warning,
Expand All @@ -161,17 +219,18 @@ protected function dependency_row( $handle, array $asset, $label ) {
$type = $this->collector->get_dependency_type();

echo '<tr data-qm-subject="' . esc_attr( $type . '-' . $handle ) . '" data-qm-' . esc_attr( $type ) . '-host="' . esc_attr( $qm_host ) . '" data-qm-' . esc_attr( $type ) . '-dependents="' . esc_attr( $dependents_list ) . '" data-qm-' . esc_attr( $type ) . '-dependencies="' . esc_attr( $dependencies_list ) . '" class="' . esc_attr( $class ) . '">';
echo '<td class="qm-nowrap">';

$warning = QueryMonitor::icon( 'warning' );
if ( $label !== '' ) {
echo '<td class="qm-nowrap">';

if ( $asset['warning'] ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo $warning;
}
if ( $asset['warning'] ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo $warning;
}

echo esc_html( $label );
echo '</td>';
echo esc_html( $label );
echo '</td>';
}

$host = $asset['host'];
$parts = explode( '.', $host );
Expand Down Expand Up @@ -282,6 +341,18 @@ public function admin_menu( array $menu ) {
$id = $this->collector->id();
$menu[ $id ] = $this->menu( $args );

/* translators: %s: number of registered scripts */
$label_format = _x( 'Registered (%s)', 'Registered scripts', 'query-monitor' );
$label = sprintf( $label_format, number_format_i18n( $data->counts['registered'] ) );

$menu[ $id ]['children'] = array(
array(
'title' => esc_html( $label ),
'id' => esc_attr( "query-monitor-{$this->collector->id}-registered" ),
'href' => esc_attr( '#' . $this->collector->id() . '-registered' ),
),
);

return $menu;

}
Expand Down