-
Notifications
You must be signed in to change notification settings - Fork 0
Testing Instructions for Critical Flow
Verify that the Reddit for WooCommerce plugin cannot be activated if WooCommerce is not installed/active, and can be activated successfully when WooCommerce is active.
Steps to Test:
Scenario 1 – WooCommerce Not Installed/Active
- Navigate to Plugins → Add New in WordPress admin.
- Install the Reddit for WooCommerce plugin from the WordPress.org repository or plugin zip file(but do not install WooCommerce).
- Attempt to Activate the Reddit for WooCommerce plugin.
Scenario 2 – WooCommerce Installed and Active
- Install and activate the WooCommerce plugin.
- Install the Reddit for WooCommerce plugin (if not already installed).
- Activate the Reddit for WooCommerce plugin.
Expected Result:
-
Scenario 1:
- Activation should be blocked.
- An admin notice/message should appear indicating that WooCommerce is required for Reddit for WooCommerce to function.
-
Scenario 2:
- Plugin should activate successfully without any errors.
- Reddit settings/options should appear under Marketing.
Steps to Test:
- Activate the Reddit for WooCommerce plugin.
- Navigate to WooCommerce > Marketing in the left admin menu.
Expected Result: A new menu item labelled “Reddit” appears under WooCommerce > Marketing.
Steps to Test:
- Go to Dashboard > Marketing in the WordPress admin dashboard.
- Click on the “Reddit” card under the Channels section, or click the Reddit menu item under Marketing.
Expected Result:
- The user is redirected to the “Set up your accounts” screen.
- This screen provides step-by-step guidance for the merchant to complete the initial configuration, such as connecting a WordPress.com account and a Reddit account.
WordPress.com connection in “Set up your accounts” screen should display a connected status with email after successful connection
Preconditions:
- WooCommerce and Reddit for WooCommerce plugins are installed and activated.
- Reddit for WooCommerce plugin is not yet fully configured.
Steps to Test:
- Navigate to Marketing in the WordPress admin dashboard.
- Click on the Reddit tab Marketing.
- On the “Set up your accounts” screen, locate the WordPress.com card.
- Click the Connect button on the WordPress.com card.
- Follow the authentication and authorization process to connect a WordPress.com account.
Expected Result:
-
After successful connection, the WordPress.com card updates to show:
- A green checkmark indicating the connection status.
- The connected WordPress.com account’s email address displayed within the card.
Reddit account connection card in the “Set up your accounts” screen should display account details after successful connection
Preconditions:
- Reddit for WooCommerce plugin is not yet fully configured.
- WordPress.com account is already connected.
Steps to Test:
- Navigate to Marketing > Reddit in the WordPress admin dashboard.
- Click on the Reddit tab.
- On the “Set up your accounts” screen, locate the Reddit card.
- Click the Connect button on the Reddit card.
- Follow the authentication and authorization process to connect your Reddit Business account.
Expected Result:
-
After successful connection, the Reddit Business card updates to show:
- Emails ID linked to the connected Reddit email ID.
- Business Name Reddit Business account details.
- Ads Account ID/name associated with the connected organization.
- Pixel ID linked to the connected Reddit Ads account.
- A green checkmark indicating the connection status.
Option “Or, connect to a different Reddit account” should disconnect the current account and allow connecting a new one.
Preconditions:
- WordPress.com account is connected.
- Reddit Business account is already connected and displaying Organisation Name, Ads Account, and Pixel ID.
Steps to Test:
- On the “Set up your accounts” screen, locate the Reddit Business card showing the connected account details.
- Click on 'Edit'.
- Click the “Or, connect to a different Reddit account” option.
- Follow the process to create a new Business account.
Expected Result:
- The existing Reddit Business account connection is successfully disconnected.
- The setup flow prompts the merchant to create a new Reddit Business account.
- Once the new connection is complete, the Email Id, Business Name, Ads Account, and Pixel ID update to reflect the newly connected account.
Verify functionality for creating a new Business account via “Or, create a new Business account” option
Preconditions:
- WooCommerce and Reddit for WooCommerce plugins are installed and activated.
- WordPress.com account is connected.
- A Reddit Business account is already connected and displayed in the Reddit Business card.
Steps to Test:
-
On the “Set up your accounts” screen, locate the **Reddit ** card showing the connected account details.
-
Click on Edit.
-
Select “Or, create a new Business account” option.
-
A modal popup should appear with the following confirmation message:
Create Business Account Are you sure you want to create a new Business account? You already have another Business account associated with this Reddit account. [Yes, I want a new account] [Cancel] -
Click on “Yes, I want a new account.”
Expected Result:
- The modal should close, and a new browser tab opens.
- The new tab should display the Reddit interface to create a new Business account.
- User can proceed with the setup and link this new account to plugin.
Continue button should activate after connecting WordPress.com and Reddit accounts, leading to success modal
Steps to Test:
-
On the Set up your accounts screen:
- Connect the WordPress.com account and confirm the green checkmark appears with connected email.
- Connect the Reddit account and confirm the green checkmark appears with details like, Ads Account, and Pixel ID, etc.
-
Verify that the Continue button is now active.
-
Click the Continue button.
Expected Result:
- The Continue button is enabled only after both accounts (WordPress.com and Reddit) show a connected status with green checkmarks.
- Clicking Continue navigates to the next screen.
- A modal appears stating “You’ve successfully set up Reddit for WooCommerce! 🎉” confirming completion of the setup.
Steps to Test:
-
When the success modal appears, click the 'X' icon in the top corner of the modal.
- Verify the modal closes.
-
Or click the 'Close' button within the modal.
- Verify the modal closes.
-
Or press the Escape key on the keyboard.
- Verify the modal closes.
Expected Result:
- In all three cases ('X' icon, 'Close' button, Escape key), the success modal closes and the user is returned to the main screen without breaking layout or losing expected state.
Steps to Test:
- Go to WordPress Admin → Products → Add New.
- Scroll to the Product data > Reddit section.
- Observe the default state of the checkbox.
Expected Result:
- The Reddit Catalog Item checkbox is visible.
- The checkbox is checked by default.
Steps to Test:
- Go to Plugins in WordPress Admin.
- Deactivate the Reddit for WooCommerce plugin.
- Go to Products → Add New.
- Also check Products → Edit for any existing product.
Expected Result:
- The Reddit Catalog Item checkbox is not visible on both the Add New Product and Edit Product screens.
Steps to Test:
- With Reddit plugin active, create a new product (checkbox should be checked by default).
- Save the product.
- Go to Products → Edit for the same product.
- Uncheck the Reddit Catalog Item checkbox.
- Save/Update the product.
Expected Result:
- The Reddit Catalog Item checkbox remains unchecked after saving.
- No automatic re-check happens unless manually enabled again.
Precondition: User account is connected but does not have the Catalog Manager role assigned.
Test Steps:
- Log in to the WordPress Admin Dashboard.
- Navigate to **Marketing › Reddit › Complete the onboarding flow.
- Attempt to create a catalog without having the Catalog Manager role assigned.
- Observe the interface for a notice displayed.
Expected Result:
-
A notice should appear with the following message:
“Your account doesn't have the Catalog Manager role, which is required for catalog creation. Please assign it by going to Your Account › Edit › Member Details & Business Role › Advanced Role here. Once the role is assigned, please click Create Catalog.”
-
The message should be clearly visible and accessible.
-
The user should not be able to proceed with catalog creation until the Catalog Manager role is assigned.
-
The message should include a clear path or guidance to assign the role.
Test Steps:
- Log in to the WordPress Admin Dashboard.
- Navigate to Marketing › Reddit › Setting Screen .
- Attempt to create a catalog, to simulate or trigger an error (change store currency to any non-supported currency, e.g. INR).
- Observe the interface for any notice or warning displayed.
Expected Result:
-
A notice should appear with the following message:
“There was some error creating the Catalog. Please check the logs for more details.”
-
The message should be clearly visible and accessible.
-
The message should guide the user to check logs for details on the issue.
Test Steps:
- Start the Reddit for WooCommerce onboarding process.
- Complete all onboarding steps until redirected to the
settingspage. - Check if the Catalog CSV export job is running.
Expected Result:
- On reaching the
settingspage, the Catalog CSV export job should start immediately.
Test Steps:
- Complete onboarding as in Case-1.
- Go to WooCommerce → Status → Scheduled Actions
- Search for the Catalog CSV
reddit_for_woocommerce_recurring_catalog_exportrecurring job.
Expected Result:
- A recurring job for Catalog CSV export should be scheduled with frequency Every 1 day.
Test Steps:
- Ensure onboarding is complete and the recurring job is visible in Action Scheduler.
- Deactivate the Reddit for WooCommerce plugin from Plugins page.
- Check WooCommerce → Status → Scheduled Actions again.
Expected Result:
- The recurring Catalog CSV job
Reddit_for_woocommerce_recurring_catalog_exportshould be removed from the schedule.
Test Steps:
- Complete onboarding and ensure the recurring job is present.
- Deactivate and then reactivate the Reddit for WooCommerce plugin.
- Check WooCommerce → Status → Scheduled Actions.
Expected Result:
- The recurring Catalog CSV job should be re-added with once daily frequency after activation, only if onboarding has already been completed.
Test Steps:
- Ensure there are no published products on the WooCommerce site.
- Go to the Reddit for WooCommerce settings page.
- Locate and click the Generate CSV button.
Expected Result:
- A Snackbar notice should appear at the bottom of the screen (as shown in the reference image).
- The notice should clearly inform the user that there are no products available for CSV generation.
- No CSV generation process should start.
Test Steps:
-
Ensure there is at least one published product in the WooCommerce store.
-
Go to the Reddit for WooCommerce settings page.
-
Click the Generate CSV button.
Expected Result:
-
A message appears: "We’re generating your CSV file… This may take a few seconds."
-
The CSV generation process should start immediately.
-
No error or warning messages should be displayed.
-
Once completed, it should show a message like "Last exported on Date & Time."
Steps to Test:
- Log in to the Reddit Ads Dashboard with the connected Reddit Business account.
- Navigate to the Catalogs section.
- Locate the synced catalog associated with the WooCommerce store.
- Verify that the Catalog name matches the WooCommerce store name.
Expected Result:
-
The product catalog should appear in the Product Catalogs section.
-
The catalog should display the following details correctly:
- Name – Matches the WooCommerce store name.
- Catalog Health – Shows sync/health status.
- Products – Total number of synced products.
- Rejected Products – Count of products rejected by Reddit.
- Approved Products – Count of successfully approved products.
- Last Updated – Shows the most recent sync date/time.
| Step No. | Test Steps | Expected Result |
|---|---|---|
| 1 | Open the store homepage. | Reddit Pixel Helper should show PageVisit event fired. |
| 2 | Navigate to any Single Product Page. | Reddit Pixel Helper should show ViewContent event fired with parameters:• id (Product id)• name (product name) |
| 3 | Click Add to Cart for the product. | Reddit Pixel Helper should show AddToCart event fired with parameters:• itemCount, value, currency, products id, product name |
| 4 | Proceed to checkout and place an order successfully. | Reddit Pixel Helper should show Purchase event fired with parameters:• price (Total order value)• currency• conversionId• product's id and name, itemCount |
Recording.1439.mp4
Steps:
- Conversion tracking is enabled in Reddit > Settings > Track Conversions.
- Test customer account is available for placing an order.
- Add the following line in
wp-config.phpto log API responses locally:
define( 'REDDIT_FOR_WOOCOMMERCE_DEBUG', true );- Check log under WooCommerce > Status > Logs > plugin-reddit-for-woocommerce.
Steps to Test & Expected Results
| Step No. | Test Steps | Expected Result (Event Payload Example) |
|---|---|---|
| 1 | Open the store Homepage. |
PageVisit event is logged with metadata. Example: json { "event_at": "2025-09-02T12:29:45+00:00", "event_type": { "tracking_type": "PageVisit" }, "event_metadata": { "conversion_id": "473b283a-b4ee-4de6-88f8-6bc6b5b9439b" }, "user": { "ip_address": "xxx", "user_agent": "xxx", "uuid": "from _rdt_uuid cookie" } }
|
| 2 | Navigate to a Single Product Page. |
ViewContent event is logged with product details. Example. json { "event_type": { "tracking_type": "ViewContent" }, "event_metadata": { "conversion_id": "83fc5f55-7379-4fb8-830c-f4c9c39d0872", "products": [ { "id": "60", "name": "Simple Product" } ] }, "user": { "uuid": "from _rdt_uuid cookie" } }
|
| 3 | Click Add to Cart. |
AddToCart event is logged with cart data. Example json { "event_type": { "tracking_type": "AddToCart" }, "event_metadata": { "conversion_id": "83fc5f55-7379-4fb8-830c-f4c9c39d0872", "item_count": 1, "value_decimal": 14, "currency": "USD", "products": [ { "id": "60", "name": "Simple Product" } ] }, "user": { "uuid": "from _rdt_uuid cookie" } }
|
| 4 | Complete Checkout and place an order. |
Purchase event is logged with order details. Example json { "event_type": { "tracking_type": "Purchase" }, "event_metadata": { "conversion_id": "wc_order_fNJwU8EPw9J3S", "item_count": 3, "value_decimal": 314, "currency": "USD", "products": [ { "id": "60", "name": "Simple Product" }, { "id": "62", "name": "Variation Product - Red" } ] }, "user": { "uuid": "from _rdt_uuid cookie" } }
|