Refactored WP_Debug_Data::debug_data() Part 1 #7065

apermo · 2024-07-20T11:48:53Z

Changed: Moving $info['wp-filesystem'] to own function

Follow up to #7027 as discussed with @dmsnell and @costdev

To keep the structure intact over all PRs, we will start moving content from the $info array into own function from the bottom up, this way the result will always be identical and combarable.

Summary of the coming steps:

wp-filesystem (we are here)
wp-constants
wp-database
wp-server
wp-media
wp-plugins-active & wp-plugins-inactive
wp-mu-plugins
wp-themes-inactive
wp-parent-theme
wp-active-theme
wp-dropins
wp-paths-sizes
wp-core

Refactoring WP_Debug_Data::debug_data(); into smaller functions for

better maintainability
reduced complexity
preparation for future unit tests
improved extensibility (see trac for details)
added php7.2 style type hints
fixed an error with $parent_theme_auto_update_string showing the value from $auto_updates_string (This will be handled only in Step 9)

Trac ticket: https://core.trac.wordpress.org/ticket/61648#ticket

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Changed: Moving $info['wp-filesystem'] to own function

github-actions · 2024-07-20T11:49:12Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props apermo, dmsnell, costdev, afragen.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

github-actions · 2024-07-20T12:00:27Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

apermo · 2024-07-21T10:58:36Z

I decided to move the add_filter() calls from WP_Debug_Data::debug_data() to a new function WP_Debug_Data::init_filters() which is called on admin_init this way the filters be altered in a non hacky way by plugin authors easily.

apermo · 2024-07-21T11:26:37Z

Update: I had to move that around a bit, in order to minimize dependencies. To allow plugin authors a convenient way to rearrange debug information, I introduced a new action pre_debug_information that will be fired directly before the filter debug_information, I decided to do this, instead of relying on plugin authors to use the filter to achieve the same, since I understand that it is a kind of hacky approach to use a filter to do an actions job.

Changed: Moving add_filter calls a distinct function. Added: 'pre_debug_information' to allow plugin_authors to alter, add, or remove the core debug information callbacks.

Removed: Outdated information from phpDoc

apermo · 2024-07-21T15:15:34Z

In branch refactor-wp-debug-data-old is the original PR, with a minor update, to integrate changed approaches and more phpDoc from the new refactoring.

In refactor-wp-debug-data/all-parts there is already one commit for each refactored function prepared as stated above.

src/wp-admin/includes/class-wp-debug-data.php

@costdev

Applied code review from @costdev

Removed: ::init_filters() Changed: From apply_filters approach to return array approach.

dmsnell

I'll let some other folks review this if they want, but the code as proposed seems clear enough to me.

costdev

Thanks for the updates @apermo!

I've left one small change to meet Docblock language standards.

src/wp-admin/includes/class-wp-debug-data.php

Co-authored-by: Colin Stewart <79332690+costdev@users.noreply.github.com>

costdev · 2024-07-24T20:56:31Z

Thanks @apermo! I think this looks like a good approach for making things more maintainable.

Hopefully @afragen and @Clorith have some time to take a look at this and review as Site Health component maintainers.

costdev

Approving from my perspective, pending reviews from one or more component maintainers.

src/wp-admin/includes/class-wp-debug-data.php

afragen · 2024-07-28T18:24:21Z

LGTM 👍

dmsnell · 2024-07-29T18:02:50Z

Prepping to merge.

This is the first part in a larger modularization of the data in `WP_Debug_Data`. Previously this was a single massive method drawing in debug data from various groups of related data, where the groups were independent from each other. This patch separates the first of twelve groups, the `wp-filesystem` info, into a separate method focused on that data. This work precedes changes to make the `WP_Debug_Data` class more extensible for better use by plugin and theme code. Developed in #7065 Discussed in https://core.trac.wordpress.org/ticket/61648 Props: afragen, apermo, costdev, dmsnell. See #61648. git-svn-id: https://develop.svn.wordpress.org/trunk@58830 602fd350-edb4-49c9-b593-d223f7449a82

dmsnell · 2024-07-29T18:21:38Z

Merged in [58830]
345699c

This is the first part in a larger modularization of the data in `WP_Debug_Data`. Previously this was a single massive method drawing in debug data from various groups of related data, where the groups were independent from each other. This patch separates the first of twelve groups, the `wp-filesystem` info, into a separate method focused on that data. This work precedes changes to make the `WP_Debug_Data` class more extensible for better use by plugin and theme code. Developed in WordPress/wordpress-develop#7065 Discussed in https://core.trac.wordpress.org/ticket/61648 Props: afragen, apermo, costdev, dmsnell. See #61648. Built from https://develop.svn.wordpress.org/trunk@58830 git-svn-id: http://core.svn.wordpress.org/trunk@58226 1a063a9b-81f0-0310-95a4-ce76da25c4cd

This is the first part in a larger modularization of the data in `WP_Debug_Data`. Previously this was a single massive method drawing in debug data from various groups of related data, where the groups were independent from each other. This patch separates the first of twelve groups, the `wp-filesystem` info, into a separate method focused on that data. This work precedes changes to make the `WP_Debug_Data` class more extensible for better use by plugin and theme code. Developed in WordPress/wordpress-develop#7065 Discussed in https://core.trac.wordpress.org/ticket/61648 Props: afragen, apermo, costdev, dmsnell. See #61648. Built from https://develop.svn.wordpress.org/trunk@58830 git-svn-id: https://core.svn.wordpress.org/trunk@58226 1a063a9b-81f0-0310-95a4-ce76da25c4cd

Refactored WP_Debug_Data::debug_data() Part 1

b3fff8f

Changed: Moving $info['wp-filesystem'] to own function

apermo force-pushed the refactor-wp-debug-data/part1 branch from 7376882 to 0ea0e0e Compare July 21, 2024 10:56

apermo force-pushed the refactor-wp-debug-data/part1 branch from 0ea0e0e to 9e1b504 Compare July 21, 2024 11:22

apermo force-pushed the refactor-wp-debug-data/part1 branch from 9e1b504 to f1b1ff4 Compare July 21, 2024 11:55

Refactored WP_Debug_Data::debug_data() Part 1

604c49f

Changed: Moving add_filter calls a distinct function. Added: 'pre_debug_information' to allow plugin_authors to alter, add, or remove the core debug information callbacks.

apermo force-pushed the refactor-wp-debug-data/part1 branch from f1b1ff4 to 604c49f Compare July 21, 2024 11:56

Refactored WP_Debug_Data::debug_data() Part 1

438161c

Removed: Outdated information from phpDoc

costdev reviewed Jul 23, 2024

View reviewed changes