Add 'Debug' option for API requests in Apple News to output debugging info #1111
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A 'Debug' link has been added to the API request in the admin section of the Apple News plugin. This link, which opens in a new tab, can be used for debugging purposes. It is particularly useful for showing the API request.
The code changes modify the debug URL generation in the Apple News plugin. Instead of directly using the 'get_permalink' method, it now calls the 'action_query_params' method from the Admin_Apple_Index_Page class. This change enhances the URL generation by organizing the query parameters for the debug action.
A 'debug' case has been added to the action mapping in the Apple News admin. This action corresponds to a new 'debug_action' function, which initiates a debug process for a post identified by a given ID. This function will help to facilitate issue identification and resolution.
The `push` action code in the Apple News plugin has been significantly refactored adding a debugging method which shows the data that will be sent to the API. The action of getting custom post metadata has been moved into a separate private method, `get_meta`, to keep the class DRY.
This commit updates the version of the Publish to Apple News plugin from 2.4.8 to 2.4.9. The new version includes debugging for Apple News API requests, as indicated by the change in the readme file. The version number has been updated in all relevant files.
The 'publish-to-apple-news' plugin version has been upgraded from 2.4.8 to 2.4.9. Key dependencies including '@wordpress/*' packages and '@babel/*' packages have also been updated to newer versions, enhancing compatibility with WP 6.5 and resolving potential issues. 'package-lock.json' has been revised to reflect these modifications.
….5.0 The version of the "Publish to Apple News" WordPress plugin has been updated from 2.4.9 to 2.5.0. This is reflected in all files where the version number is declared. This versioning update indicates the inclusion of new enhancements or bug fixes.
mogmarsh
reviewed
May 2, 2024
Comment on lines
558
to
561
| $is_paid = (bool) get_post_meta( $post_id, 'apple_news_is_paid', true ); | ||
| $is_preview = (bool) get_post_meta( $post_id, 'apple_news_is_preview', true ); | ||
| $is_hidden = (bool) get_post_meta( $post_id, 'apple_news_is_hidden', true ); | ||
| $is_sponsored = (bool) get_post_meta( $post_id, 'apple_news_is_sponsored', true ); |
There was a problem hiding this comment.
in 2.5.0, these actually can be set by the meta or inherit the channel default, so they won't always be bool any more. See https://github.com/alleyinteractive/apple-news/pull/1090/files
There was a problem hiding this comment.
Give this a look, thanks Greg.
mogmarsh
reviewed
May 2, 2024
| return; | ||
| } | ||
|
|
||
| $action = new Apple_Actions\Index\Push( $this->settings, $id ); |
There was a problem hiding this comment.
does this actually push it? Is that what we want to happen?
There was a problem hiding this comment.
No, just calls the constructor and sends in the settings, we only call the debug method, not the push method, then debug info is printed to the screen and then exits. I'll add a bit of documentation to the README.
There was a problem hiding this comment.
Added some docs here: https://github.com/alleyinteractive/apple-news/wiki/Usage#debug-api-requests
mogmarsh
requested changes
May 2, 2024
The method of retrieving post metadata in the Apple News plugin has been changed to match other commits in this version.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A 'Debug' link has been added to the API request in the admin section of the Apple News plugin. This link, which opens in a new tab, can be used for debugging purposes. It is particularly useful for showing the API request.
Also syncs WP scripts node dependencies with WordPress 6.5
Addresses #1110