Skip to content

Trigger feed uploads on onboarding completion #2995

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

Closed
nrostrow-meta wants to merge 6 commits into from
Closed

Trigger feed uploads on onboarding completion #2995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7c64d59
Add function to FeedManager to trigger all feed uploads
nrostrow-meta Mar 29, 2025
ea5fe32
Merge branch 'main' into trigger_feed_uploads_on_onboarding_completion
nrostrow-meta Mar 31, 2025
12b52d4
Triggering metadata feed uploads on CPI ID change.
nrostrow-meta Mar 31, 2025
fe74a5e
Triggering uploads after options have been changed.
nrostrow-meta Mar 31, 2025
2bab1d4
params -> request_data
nrostrow-meta Mar 31, 2025
ef59fe7
Merge branch 'main' into trigger_feed_uploads_on_onboarding_completion
nrostrow-meta Mar 31, 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
14 changes: 7 additions & 7 deletions facebook-commerce.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ class WC_Facebookcommerce_Integration extends WC_Integration {
const OPTION_HAS_AUTHORIZED_PAGES_READ_ENGAGEMENT = 'wc_facebook_has_authorized_pages_read_engagement';

/** @var string the WordPress option name where the messenger chat status is stored */
const OPTION_ENABLE_MESSENGER = 'wc_facebook_enable_messenger';
const OPTION_ENABLE_MESSENGER = 'wc_facebook_enable_messenger';

/** @var string|null the configured product catalog ID */
public $product_catalog_id;
Expand Down Expand Up @@ -900,27 +900,27 @@ private function save_facebook_product_attributes( $woo_product ) {
if ( isset( $_POST[ WC_Facebook_Product::FB_SIZE ] ) ) {
$woo_product->set_fb_size( sanitize_text_field( wp_unslash( $_POST[ WC_Facebook_Product::FB_SIZE ] ) ) );
}

if ( isset( $_POST[ WC_Facebook_Product::FB_COLOR ] ) ) {
$woo_product->set_fb_color( sanitize_text_field( wp_unslash( $_POST[ WC_Facebook_Product::FB_COLOR ] ) ) );
}

if ( isset( $_POST[ WC_Facebook_Product::FB_MATERIAL ] ) ) {
$woo_product->set_fb_material( sanitize_text_field( wp_unslash( $_POST[ WC_Facebook_Product::FB_MATERIAL ] ) ) );
}

if ( isset( $_POST[ WC_Facebook_Product::FB_PATTERN ] ) ) {
$woo_product->set_fb_pattern( sanitize_text_field( wp_unslash( $_POST[ WC_Facebook_Product::FB_PATTERN ] ) ) );
}

if ( isset( $_POST[ WC_Facebook_Product::FB_AGE_GROUP ] ) ) {
$woo_product->set_fb_age_group( sanitize_text_field( wp_unslash( $_POST[ WC_Facebook_Product::FB_AGE_GROUP ] ) ) );
}

if ( isset( $_POST[ WC_Facebook_Product::FB_GENDER ] ) ) {
$woo_product->set_fb_gender( sanitize_text_field( wp_unslash( $_POST[ WC_Facebook_Product::FB_GENDER ] ) ) );
}

if ( isset( $_POST[ WC_Facebook_Product::FB_PRODUCT_CONDITION ] ) ) {
$woo_product->set_fb_condition( sanitize_text_field( wp_unslash( $_POST[ WC_Facebook_Product::FB_PRODUCT_CONDITION ] ) ) );
}
Expand Down
48 changes: 36 additions & 12 deletions includes/API/Plugin/Settings/Handler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public function register_routes() {
* @param \WP_REST_Request $wp_request The WordPress request object.
* @return \WP_REST_Response
*/
public function handle_update( \WP_REST_Request $wp_request ) {
public function handle_update( \WP_REST_Request $wp_request ): \WP_REST_Response {
try {
$request = new UpdateRequest( $wp_request );
$request_data = $request->get_data();
Expand All @@ -75,8 +75,11 @@ public function handle_update( \WP_REST_Request $wp_request ) {
);
}

// Maybe trigger products sync and/or metadata feed uploads
$this->maybe_trigger_feed_uploads( $request_data );
// Check if we should trigger product sync and/or metadata feed uploads for this update
// Only trigger product sync if catalog id is being updated
$should_trigger_product_sync = ! empty( $request_data['product_catalog_id'] ) && facebook_for_woocommerce()->get_integration()->get_product_catalog_id() !== $request_data['product_catalog_id'];
// Only trigger metadata feed uploads if CPI id is being updated
$should_trigger_metadata_feed_uploads = ! empty( $request_data['commerce_partner_integration_id'] ) && facebook_for_woocommerce()->get_connection_handler()->get_commerce_partner_integration_id() !== $request_data['commerce_partner_integration_id'];

// Map parameters to options and update settings
$options = $this->map_params_to_options( $request_data );
Expand All @@ -85,6 +88,9 @@ public function handle_update( \WP_REST_Request $wp_request ) {
// Update connection status flags
$this->update_connection_status( $request_data );

// Maybe trigger products sync and/or metadata feed uploads
$this->maybe_trigger_feed_uploads( $should_trigger_product_sync, $should_trigger_metadata_feed_uploads, $request_data );

return $this->success_response(
[
'message' => __( 'Facebook settings updated successfully', 'facebook-for-woocommerce' ),
Expand All @@ -108,7 +114,7 @@ public function handle_update( \WP_REST_Request $wp_request ) {
* @param \WP_REST_Request $wp_request The WordPress request object.
* @return \WP_REST_Response
*/
public function handle_uninstall( \WP_REST_Request $wp_request ) {
public function handle_uninstall( \WP_REST_Request $wp_request ): \WP_REST_Response {
try {
$request = new UninstallRequest( $wp_request );
$validation_result = $request->validate();
Expand Down Expand Up @@ -144,7 +150,7 @@ public function handle_uninstall( \WP_REST_Request $wp_request ) {
* @param array $params Request parameters.
* @return array Mapped options.
*/
private function map_params_to_options( $params ) {
private function map_params_to_options( array $params ): array {
$options = [];

// Map access tokens
Expand Down Expand Up @@ -196,7 +202,7 @@ private function map_params_to_options( $params ) {
* @param array $settings Array of settings to update.
* @return void
*/
private function update_settings( $settings ) {
private function update_settings( array $settings ) {
foreach ( $settings as $key => $value ) {
if ( ! empty( $key ) ) {
update_option( $key, $value );
Expand All @@ -212,7 +218,7 @@ private function update_settings( $settings ) {
* @param array $params Request parameters.
* @return void
*/
private function update_connection_status( $params ) {
private function update_connection_status( array $params ) {
// Set the connection is complete
update_option( 'wc_facebook_has_connected_fbe_2', 'yes' );
update_option( 'wc_facebook_has_authorized_pages_read_engagement', 'yes' );
Expand Down Expand Up @@ -253,16 +259,18 @@ private function clear_integration_options() {

/**
* Triggers products sync if catalog id is being set to a different value.
* Triggers metadata feed uploads if CPI id is being set to a different value.
*
* @since 3.5.0
*
* @param array $params Request parameters.
* @param bool $should_trigger_product_sync
* @param bool $should_trigger_metadata_feed_uploads
* @param array $params
* @return void
*/
private function maybe_trigger_feed_uploads( $params ) {
// Only sync products if catalog id has been updated.
private function maybe_trigger_feed_uploads( bool $should_trigger_product_sync, bool $should_trigger_metadata_feed_uploads, array $params ) {
try {
if ( ! empty( $params['product_catalog_id'] ) && facebook_for_woocommerce()->get_integration()->get_product_catalog_id() !== $params['product_catalog_id'] ) {
if ( $should_trigger_product_sync ) {
// Allow opt-out of full batch-API sync, for example if store has a large number of products.
if ( facebook_for_woocommerce()->get_integration()->allow_full_batch_api_sync() ) {
facebook_for_woocommerce()->get_products_sync_handler()->create_or_update_all_products();
Expand All @@ -277,7 +285,23 @@ private function maybe_trigger_feed_uploads( $params ) {
'event' => 'product_sync',
'event_type' => 'sync_products_after_settings_update',
'extra_data' => [
'message' => 'failed sync products during the update settings request.',
'params' => wp_json_encode( $params ),
],
]
);
}
try {
if ( $should_trigger_metadata_feed_uploads ) {
facebook_for_woocommerce()->feed_manager->run_all_feed_uploads();
}
} catch ( \Exception $exception ) {
\WC_Facebookcommerce_Utils::logExceptionImmediatelyToMeta(
$exception,
[
'event' => 'feed_upload',
'event_type' => 'trigger_feed_uploads_after_settings_update',
'extra_data' => [
'params' => wp_json_encode( $params ),
],
]
);
Expand Down
12 changes: 12 additions & 0 deletions includes/Feed/FeedManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,18 @@ public function get_feed_instance( string $feed_type ): AbstractFeed {
return $this->feed_instances[ $feed_type ];
}

/**
* Run all feed uploads.
*
* @return void
* @since 3.5.0
*/
public function run_all_feed_uploads(): void {
foreach ( $this->feed_instances as $feed_type ) {
$feed_type->regenerate_feed();
}
}

/**
* Get the feed instance for the given feed type.
*
Expand Down