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 'Debug' option for API requests in Apple News to output debugging info #1111

Merged
merged 11 commits into from
May 2, 2024
Merged

Add 'Debug' option for API requests in Apple News to output debugging info #1111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
07f6355
Add 'Debug' link to API request in Apple News plugin
attackant Apr 29, 2024
55ecbfa
Update debug URL in Apple News plugin
attackant Apr 29, 2024
e965660
Add debug action to Apple News plugin admin
attackant Apr 29, 2024
e16625c
Refactor push action and add debugging to Apple News plugin
attackant Apr 29, 2024
23042bd
Update Apple News plugin to version 2.4.9
attackant Apr 30, 2024
c0c0979
Updated version and dependencies of 'publish-to-apple-news' plugin
attackant Apr 30, 2024
4ff3151
Fix version number for new base branch Apple News plugin version to 2…
attackant Apr 30, 2024
40b1141
Merge branch 'release/v2.5.0' into issue-1110
attackant May 2, 2024
be062c1
add screenshots
attackant May 2, 2024
f0b316c
rm images we dont need here
attackant May 2, 2024
53714e9
Refactor post metadata retrieval in Apple News plugin for 2.5.0
attackant May 2, 2024
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
209 changes: 153 additions & 56 deletions admin/apple-actions/index/class-push.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@
require_once plugin_dir_path( __FILE__ ) . '../class-api-action.php';
require_once plugin_dir_path( __FILE__ ) . 'class-export.php';

use Admin_Apple_Async;
use Admin_Apple_Notice;
use Admin_Apple_Sections;
use Apple_Actions\Action_Exception;
use Apple_Actions\API_Action;
use Apple_Exporter\Exporter;
use Apple_Exporter\Settings;
use Apple_Push_API\Request\Request_Exception;

/**
* A class to handle a push request from the admin.
Expand Down Expand Up @@ -61,7 +64,7 @@ class Push extends API_Action {
* Constructor.
*
* @param Settings $settings A settings object containing settings at load time.
* @param int $id The ID for the content object to be pushed.
* @param int $id The ID for the content object to be pushed.
*/
public function __construct( $settings, $id ) {
parent::__construct( $settings );
Expand All @@ -73,13 +76,14 @@ public function __construct( $settings, $id ) {
* Perform the push action.
*
* @param boolean $doing_async Optional. Whether the action is being performed asynchronously.
* @param int $user_id Optional. The ID of the user performing the action. Defaults to the current user ID.
* @param int $user_id Optional. The ID of the user performing the action. Defaults to the current user ID.
*
* @access public
* @return boolean
* @throws Action_Exception If the push fails.
*/
public function perform( $doing_async = false, $user_id = null ) {
if ( 'yes' === $this->settings->get( 'api_async' ) && false === $doing_async ) {
if ( 'yes' === $this->settings->__get( 'api_async' ) && false === $doing_async ) {
// Do not proceed if this is already pending publish.
$pending = get_post_meta( $this->id, 'apple_news_api_pending', true );
if ( ! empty( $pending ) ) {
Expand All @@ -89,7 +93,7 @@ public function perform( $doing_async = false, $user_id = null ) {
// Track this publish event as pending with the timestamp it was sent.
update_post_meta( $this->id, 'apple_news_api_pending', time() );

wp_schedule_single_event( time(), \Admin_Apple_Async::ASYNC_PUSH_HOOK, [ $this->id, get_current_user_id() ] );
wp_schedule_single_event( time(), Admin_Apple_Async::ASYNC_PUSH_HOOK, [ $this->id, get_current_user_id() ] );
} else {
return $this->push( $user_id );
}
Expand All @@ -98,10 +102,10 @@ public function perform( $doing_async = false, $user_id = null ) {
/**
* Generate a checksum against the article JSON with certain fields ignored.
*
* @param string $json The JSON to turn into a checksum.
* @param array $meta Optional. Metadata for the article. Defaults to empty array.
* @param string $json The JSON to turn into a checksum.
* @param array $meta Optional. Metadata for the article. Defaults to empty array.
* @param array $bundles Optional. Any bundles that will be sent with the article. Defaults to empty array.
* @param bool $force Optional. Allows bypass of local cache for checksum.
* @param bool $force Optional. Allows bypass of local cache for checksum.
*
* @return string The checksum for the JSON.
*/
Expand Down Expand Up @@ -137,9 +141,11 @@ private function generate_checksum( $json, $meta = [], $bundles = [], $force = f
* Check if the post is in sync before updating in Apple News.
*
* @access private
* @param string $json The JSON for this article to check if it is in sync.
* @param array $meta Optional. Metadata for the article. Defaults to empty array.
*
* @param string $json The JSON for this article to check if it is in sync.
* @param array $meta Optional. Metadata for the article. Defaults to empty array.
* @param array $bundles Optional. Any bundles that will be sent with the article. Defaults to empty array.
*
* @return boolean
* @throws Action_Exception If the post could not be found.
*/
Expand Down Expand Up @@ -167,13 +173,13 @@ private function is_post_in_sync( $json, $meta = [], $bundles = [] ) {
* logic, you can do that by modifying `$in_sync`. The most common use case
* is to not update posts based on custom criteria.
*
* @since 2.0.2 Added the $post_id, $json, $meta, and $bundles parameters.
* @param bool $in_sync Whether the current post is in sync or not.
* @param int $post_id The ID of the post being checked.
* @param string $json The JSON for the current article.
* @param array $meta Metadata for the current article.
* @param array $bundles Any bundles that will be sent with the current article.
*
* @param bool $in_sync Whether the current post is in sync or not.
* @param int $post_id The ID of the post being checked.
* @param string $json The JSON for the current article.
* @param array $meta Metadata for the current article.
* @param array $bundles Any bundles that will be sent with the current article.
* @since 2.0.2 Added the $post_id, $json, $meta, and $bundles parameters.
*/
return apply_filters( 'apple_news_is_post_in_sync', $in_sync, $this->id, $json, $meta, $bundles );
}
Expand All @@ -185,7 +191,7 @@ private function is_post_in_sync( $json, $meta = [], $bundles = [] ) {
* @access private
* @throws Action_Exception If there was an error getting the article from the API.
*/
private function get() {
private function get(): void {
// Ensure we have a valid ID.
$apple_id = get_post_meta( $this->id, 'apple_news_api_id', true );
if ( empty( $apple_id ) ) {
Expand All @@ -206,10 +212,11 @@ private function get() {
* Push the post using the API data.
*
* @param int $user_id Optional. The ID of the user performing the push. Defaults to current user.
*
* @access private
* @throws Action_Exception If unable to push.
*/
private function push( $user_id = null ) {
private function push( $user_id = null ): void {
if ( ! $this->is_api_configuration_valid() ) {
throw new Action_Exception( esc_html__( 'Your Apple News API settings seem to be empty. Please fill in the API key, API secret and API channel fields in the plugin configuration page.', 'apple-news' ) );
}
Expand All @@ -222,8 +229,8 @@ private function push( $user_id = null ) {
* category or tag. By default this is always `false` as all posts are
* published once they reach this step.
*
* @param bool $skip Whether the post should be skipped. Defaults to `false`.
* @param int $post_id The ID of the post.
* @param bool $skip Whether the post should be skipped. Defaults to `false`.
* @param int $post_id The ID of the post.
*/
if ( apply_filters( 'apple_news_skip_push', false, $this->id ) ) {
throw new Action_Exception(
Expand Down Expand Up @@ -254,10 +261,10 @@ private function push( $user_id = null ) {
* for the plugin, but the list can be modified for individual posts via
* this filter.
*
* @since 2.3.0
*
* @param int[] $term_ids The list of term IDs that should trigger a skipped push. Defaults to the term IDs set in plugin options.
* @param int $post_id The ID of the post being exported.
* @param int $post_id The ID of the post being exported.
*
* @since 2.3.0
*/
$skip_term_ids = apply_filters( 'apple_news_skip_push_term_ids', $skip_term_ids, $this->id );

Expand Down Expand Up @@ -357,36 +364,15 @@ private function push( $user_id = null ) {

// Add custom metadata fields.
$custom_meta = get_post_meta( $this->id, 'apple_news_metadata', true );
if ( ! empty( $custom_meta ) && is_array( $custom_meta ) ) {
foreach ( $custom_meta as $metadata ) {
// Ensure required fields are set.
if ( empty( $metadata['key'] ) || empty( $metadata['type'] ) || ! isset( $metadata['value'] ) ) {
continue;
}

// If the value is an array, we have to decode it from JSON.
$value = $metadata['value'];
if ( 'array' === $metadata['type'] ) {
$value = json_decode( $metadata['value'] );

// If the user entered a bad value for the array, bail out without adding it.
if ( empty( $value ) || ! is_array( $value ) ) {
continue;
}
}

// Add the custom metadata field to the article metadata.
$meta['data'][ $metadata['key'] ] = $value;
}
}
$meta = $this->get_meta( $custom_meta, $meta );

/**
* Allow article metadata to be filtered.
*
* @since 2.4.0
*
* @param array $metadata The article metadata to be filtered.
* @param int $post_id The ID of the post being pushed to Apple News.
* @param int $post_id The ID of the post being pushed to Apple News.
*
* @since 2.4.0
*/
$meta['data'] = apply_filters( 'apple_news_article_metadata', $meta['data'], $this->id );

Expand Down Expand Up @@ -438,11 +424,11 @@ private function push( $user_id = null ) {
/**
* Actions to be taken after an article was pushed to Apple News.
*
* @param int $post_id The ID of the post.
* @param object $result The JSON returned by the Apple News API.
* @param int $post_id The ID of the post.
* @param object $result The JSON returned by the Apple News API.
*/
do_action( 'apple_news_after_push', $this->id, $result );
} catch ( \Apple_Push_API\Request\Request_Exception $e ) {
} catch ( Request_Exception $e ) {

// Remove the pending designation if it exists.
delete_post_meta( $this->id, 'apple_news_api_pending' );
Expand Down Expand Up @@ -488,10 +474,11 @@ private function push( $user_id = null ) {
* Processes errors, halts publishing if needed.
*
* @param array $errors Array of errors to be processed.
*
* @access private
* @throws Action_Exception If set to fail on component errors.
*/
private function process_errors( $errors ) {
private function process_errors( $errors ): void {
// Get the current alert settings.
$component_alerts = $this->get_setting( 'component_alerts' );

Expand All @@ -503,7 +490,7 @@ private function process_errors( $errors ) {

// Build the component alert error message, if required.
if ( ! empty( $errors[0]['component_errors'] ) ) {
// Build an list of the components that caused errors.
// Build a list of the components that caused errors.
$component_names = implode( ', ', $errors[0]['component_errors'] );

if ( 'warn' === $component_alerts ) {
Expand Down Expand Up @@ -540,16 +527,89 @@ private function process_errors( $errors ) {
// Throw an exception.
throw new Action_Exception( esc_html( $alert_message ) );
} elseif ( 'warn' === $component_alerts && ! empty( $errors[0]['component_errors'] ) ) {
\Admin_Apple_Notice::error( $alert_message, $user_id );
Admin_Apple_Notice::error( $alert_message, $user_id );
}
}

/**
* Allows debugging of API requests by dumping the data
* that will be sent to the API.
*/
public function debug(): void {
$post_id = $this->id;
$post = get_post( $post_id );
if ( ! $post ) {
return;
}

$this->sections = Admin_Apple_Sections::get_sections_for_post( $post_id );
[ $json, $bundles, $errors ] = $this->generate_article();

// Retrieve the metadata using the same method as in the push() function.
$meta = [ 'data' => [] ];

// Set sections.
if ( ! empty( $this->sections ) ) {
sort( $this->sections );
$meta['data']['links'] = [ 'sections' => $this->sections ];
}

// Get the various settings.
$metadata_keys = [
'isHidden' => 'apple_news_is_hidden',
'isPaid' => 'apple_news_is_paid',
'isPreview' => 'apple_news_is_preview',
'isSponsored' => 'apple_news_is_sponsored',
];
foreach ( $metadata_keys as $metadata_property => $meta_key ) {
$meta_value = get_post_meta( $post_id, $meta_key, true );
if ( 'true' === $meta_value || '1' === $meta_value ) {
$meta['data'][ $metadata_property ] = true;
} elseif ( 'false' === $meta_value || '0' === $meta_value ) {
$meta['data'][ $metadata_property ] = false;
}
}

$maturity_rating = get_post_meta( $post_id, 'apple_news_maturity_rating', true );
if ( ! empty( $maturity_rating ) ) {
$meta['data']['maturityRating'] = $maturity_rating;
}

// Add custom metadata fields.
$custom_meta = get_post_meta( $post_id, 'apple_news_metadata', true );
$meta = $this->get_meta( $custom_meta, $meta );
$meta['data'] = apply_filters( 'apple_news_article_metadata', $meta['data'], $post_id );

header( 'Content-Type: text/html' );

echo '<h1>Apple News API Push</h1><pre style="font-size: 0.9em; background: #f9f9f9; padding: 10px; border: 1px solid #ccc; max-width: 90%; overflow: scroll; white-space: pre-wrap;">';
echo 'Post ID: ' . esc_html( $post_id ) . "\n";

echo '<hr>Article:<br>';
$formatted_json = json_decode( $json );
echo wp_json_encode( $formatted_json, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES );
echo "\n";

echo '<hr>Bundles:<br>';
echo wp_json_encode( $bundles, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES );
echo "\n";

echo '<hr>Meta:<br>';
echo wp_json_encode( $meta, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES );
echo "\n";

echo '</pre>';

// Clean the workspace after the debug.
$this->clean_workspace();
}

/**
* Clean up the workspace.
*
* @access private
*/
private function clean_workspace() {
private function clean_workspace(): void {
if ( is_null( $this->exporter ) ) {
return;
}
Expand Down Expand Up @@ -578,12 +638,12 @@ private function generate_article() {
/**
* Sanitize the JSON output based on whether HTML or markdown is used.
*
* @since 1.2.7
*
* @param string $json The JSON to be sanitized.
*
* @access private
* @return string
* @throws Action_Exception If the JSON is invalid.
* @since 1.2.7
*/
private function sanitize_json( $json ) {
/**
Expand All @@ -597,4 +657,41 @@ private function sanitize_json( $json ) {
return wp_json_encode( $decoded );
}
}

/**
* Get the custom post meta data and add it to the article metadata array.
*
* @access private
*
* @param mixed $custom_meta The custom meta data.
* @param array $meta The article metadata.
*
* @return array The updated article metadata.
*/
private function get_meta( mixed $custom_meta, array $meta ): array {
if ( ! empty( $custom_meta ) && is_array( $custom_meta ) ) {
foreach ( $custom_meta as $metadata ) {
// Ensure required fields are set.
if ( empty( $metadata['key'] ) || empty( $metadata['type'] ) || ! isset( $metadata['value'] ) ) {
continue;
}

// If the value is an array, we have to decode it from JSON.
$value = $metadata['value'];
if ( 'array' === $metadata['type'] ) {
$value = json_decode( $metadata['value'] );

// If the user entered a bad value for the array, bail out without adding it.
if ( empty( $value ) || ! is_array( $value ) ) {
continue;
}
}

// Add the custom metadata field to the article metadata.
$meta['data'][ $metadata['key'] ] = $value;
}
}

return $meta;
}
}
Loading