Files
wp-graphql-woocommerce/tests/functional/DownloadableItemAuthCest.php
Geoff TaylorandGitHub 460b101b47 fix: HPOS order mutation data loss, COT cursor pagination, email tests, checkout auth (#1003)
* devops: WC email template tests, COT cursor HPOS fix, checkout account auth

WC Email Template Tests:
- Add WooCommerceEmailTemplatesTest verifying WC email templates are used
  for registerCustomer, checkout with account creation, and password reset
- Use MockPHPMailer to capture emails and verify HTML content type
- Disable deferred transactional emails during tests via GRAPHQL_TESTING flag

COT Cursor HPOS Fix:
- Fix COT_Cursor::compare_with to resolve orderby aliases and legacy meta
  keys (_order_total, _date_completed, etc.) to COT column names
- Add resolve_orderby_alias() mapping short aliases and meta keys to columns
- Add DB_Hooks::clean_query_vars to translate post_* and meta_key orderby
  to COT-compatible equivalents via woocommerce_order_query_args filter

Checkout Account Authentication:
- Add authenticate field to CreateAccountInput type
- Gate wc_set_customer_auth_cookie() behind authenticate flag in checkout
  mutation so account creation doesn't auto-authenticate by default

Closes #882

* devops: codeception.dist.yml updated

* fix: Functional test cleanup and CI coverage condition

Test fixes:
- Enable authorizing URL fields in ProtectedRouterCest and
  DownloadableItemAuthCest via setWooGraphQLSetting
- Add stale data cleanup (sessions, users, products, orders) to
  GraphQLE2E _setupStore/getCatalog/setupStoreAndUsers
- Fix CartTransactionQueueCest and CartQueriesTest for test isolation

CI:
- Only run coverage job when at least one upstream job succeeds

* chore: Linter compliances met

* fix: HPOS order mutation data loss and CI coverage condition

Refactor order create/update mutations to set all props on a single
WC_Order instance before saving, mirroring the WC REST API pattern.
Previously, separate add_order_meta() and add_items() calls each loaded
their own order instance and saved independently, causing HPOS data loss
for payment method, addresses, and other fields.

Also fix CI coverage job to only run when all upstream jobs succeed,
and correct test assertions for RAW format line item totals.

Closes #591

* chore: Linter compliances met

* chore: Remove dead code from Order_Mutation after prepare_order refactor

Removes add_items() and update_address() which are no longer called
after the prepare_order() consolidation.

* chore: Remove dead code add_order_meta and update_item_meta_data
2026-03-30 21:42:00 -04:00

318 lines
9.1 KiB
PHP

<?php
use WPGraphQL\WooCommerce\Vendor\Firebase\JWT\JWT;
use WPGraphQL\WooCommerce\Vendor\Firebase\JWT\Key;
use Tests\WPGraphQL\Logger\CodeceptLogger as Signal;
/**
* Tests downloadable item authentication for headless frontends.
*
* @see https://github.com/wp-graphql/wp-graphql-woocommerce/issues/266
*/
class DownloadableItemAuthCest {
public function _before( FunctionalTester $I ) {
if ( ! defined( 'GRAPHQL_WOOCOMMERCE_SECRET_KEY' ) ) {
define( 'GRAPHQL_WOOCOMMERCE_SECRET_KEY', 'testestestestestestestestestest!!' );
}
// Enable authorizing URL fields for download URL nonce handling.
$I->setWooGraphQLSetting(
'enable_authorizing_url_fields',
[
'cart_url' => 'cart_url',
'checkout_url' => 'checkout_url',
'account_url' => 'account_url',
'add_payment_method_url' => 'add_payment_method_url',
]
);
// Disable approved download directories check for tests.
update_option( 'wc_downloads_approved_directories_mode', 'disabled' );
wp_cache_flush();
}
/**
* Helper: Creates a downloadable product, order, and grants download permissions.
* Returns the auth_token, session_token, and session_id for the logged-in customer.
*/
private function setupDownloadableOrder( FunctionalTester $I ): array {
$I->setupStoreAndUsers();
// Enable download access after payment.
$I->haveOptionInDatabase( 'woocommerce_downloads_grant_access_after_payment', 'yes' );
// Create a downloadable product via WPDb.
$download_id = wp_generate_uuid4();
$product_id = $I->havePostInDatabase(
[
'post_type' => 'product',
'post_title' => 'Test eBook',
'post_status' => 'publish',
'meta_input' => [
'_price' => '10',
'_regular_price' => '10',
'_virtual' => 'yes',
'_downloadable' => 'yes',
'_downloadable_files' => serialize(
[
$download_id => [
'id' => $download_id,
'name' => 'Test eBook PDF',
'file' => 'http://example.com/test-ebook.pdf',
],
]
),
],
]
);
$term_taxonomy_id = $I->grabTermTaxonomyIdFromDatabase(
[ 'taxonomy' => 'product_type', 'term_id' => $I->grabTermIdFromDatabase( [ 'slug' => 'simple' ] ) ]
);
$I->haveTermRelationshipInDatabase( $product_id, $term_taxonomy_id );
// Log in to get user ID.
$login = $I->login(
[
'clientMutationId' => 'login',
'username' => 'jimbo1234@example.com',
'password' => 'password',
]
);
$auth_token = $I->lodashGet( $login, 'data.login.authToken' );
$customer_id = $I->lodashGet( $login, 'data.login.customer.databaseId' );
$session_token = $I->grabHttpHeader( 'woocommerce-session' );
// Decode session_id from token.
JWT::$leeway = 60;
$token_data = JWT::decode( $session_token, new Key( GRAPHQL_WOOCOMMERCE_SECRET_KEY, 'HS256' ) );
$session_id = $token_data->data->customer_id;
// Create a completed order via GraphQL and grant download permissions.
// Add product to cart and checkout to create order.
$headers = [
'Authorization' => "Bearer {$auth_token}",
'woocommerce-session' => "Session {$session_token}",
];
$add_result = $I->addToCart(
[
'clientMutationId' => 'addEbook',
'productId' => $product_id,
'quantity' => 1,
],
$headers
);
$session_token = $I->grabHttpHeader( 'woocommerce-session' );
$headers['woocommerce-session'] = "Session {$session_token}";
$checkout_result = $I->checkout(
[
'clientMutationId' => 'checkout',
'paymentMethod' => 'bacs',
'isPaid' => true,
'billing' => [
'firstName' => 'Jim',
'lastName' => 'Bo',
'email' => 'jimbo1234@example.com',
'address1' => '123 Main St',
'city' => 'London',
'postcode' => 'CB23 1AB',
'country' => 'GB',
],
],
$headers
);
$order_id = $I->lodashGet( $checkout_result, 'data.checkout.order.databaseId' );
wc_downloadable_product_permissions( $order_id, true );
return compact( 'auth_token', 'session_token', 'session_id', 'customer_id', 'product_id' );
}
/**
* Test that the downloadNonce field returns a valid nonce for the download URL.
*/
public function testDownloadNonceFieldIsReturned( FunctionalTester $I ) {
$data = $this->setupDownloadableOrder( $I );
$query = '
query {
customer {
downloadableItems {
nodes {
downloadId
url
downloadNonce
downloadUrl
}
}
}
}
';
$response = $I->sendGraphQLRequest(
$query,
null,
[
'Authorization' => "Bearer {$data['auth_token']}",
'woocommerce-session' => "Session {$data['session_token']}",
]
);
$download_nonce = $I->lodashGet( $response, 'data.customer.downloadableItems.nodes.0.downloadNonce' );
$I->assertNotEmpty( $download_nonce, 'downloadNonce should be returned for downloadable items.' );
$I->assertIsString( $download_nonce );
$download_url = $I->lodashGet( $response, 'data.customer.downloadableItems.nodes.0.downloadUrl' );
$I->assertNotEmpty( $download_url, 'downloadUrl should be returned for downloadable items.' );
// The downloadUrl should contain the nonce value.
$I->assertStringContainsString( $download_nonce, $download_url );
}
/**
* Test that the downloadUrl field returns a nonced Protected Router URL
* that redirects to the WooCommerce download endpoint.
*/
public function testDownloadUrlRedirectsToWooCommerceDownload( FunctionalTester $I ) {
$data = $this->setupDownloadableOrder( $I );
$query = '
query {
customer {
downloadableItems {
nodes {
downloadId
url
downloadUrl
}
}
}
}
';
$response = $I->sendGraphQLRequest(
$query,
null,
[
'Authorization' => "Bearer {$data['auth_token']}",
'woocommerce-session' => "Session {$data['session_token']}",
]
);
$download_url = $I->lodashGet( $response, 'data.customer.downloadableItems.nodes.0.downloadUrl' );
$I->assertNotEmpty( $download_url, 'downloadUrl should be returned for downloadable items.' );
// The downloadUrl should point to the transfer-session endpoint.
$I->assertStringContainsString( 'transfer-session', $download_url );
$I->assertStringContainsString( 'session_id=', $download_url );
// Following the URL should redirect to the WooCommerce download endpoint.
$I->stopFollowingRedirects();
$I->amOnUrl( $download_url );
$I->seeResponseCodeIs( 302 );
$I->startFollowingRedirects();
}
/**
* Test that the downloadUrl with an invalid nonce does NOT redirect to the download.
*/
public function testDownloadUrlWithInvalidNonceRedirectsToHome( FunctionalTester $I ) {
$data = $this->setupDownloadableOrder( $I );
$wp_url = getenv( 'WORDPRESS_URL' );
$I->stopFollowingRedirects();
$I->amOnUrl( "{$wp_url}/transfer-session?session_id={$data['session_id']}&_wc_download=invalid_nonce" );
$I->seeResponseCodeIs( 302 );
$I->followRedirect();
$I->dontSeeInCurrentUrl( 'download_file' );
$I->startFollowingRedirects();
}
/**
* Test that preAuthDownloadUrl is only available when the setting is enabled.
*/
public function testPreAuthDownloadUrlOnlyAvailableWhenEnabled( FunctionalTester $I ) {
$data = $this->setupDownloadableOrder( $I );
// Ensure the setting is disabled.
$I->setWooGraphQLSetting( 'enable_pre_auth_download_urls', 'off' );
$query = '
query {
customer {
downloadableItems {
nodes {
downloadId
url
}
}
}
}
';
$response = $I->sendGraphQLRequest(
$query,
null,
[
'Authorization' => "Bearer {$data['auth_token']}",
'woocommerce-session' => "Session {$data['session_token']}",
]
);
// Should succeed — url is always available.
$url = $I->lodashGet( $response, 'data.customer.downloadableItems.nodes.0.url' );
$I->assertNotEmpty( $url );
}
/**
* Test that preAuthDownloadUrl generates a working download link when enabled.
*/
public function testPreAuthDownloadUrlWorksWhenEnabled( FunctionalTester $I ) {
$data = $this->setupDownloadableOrder( $I );
// Enable the setting.
$I->setWooGraphQLSetting( 'enable_pre_auth_download_urls', 'on' );
$query = '
query {
customer {
downloadableItems {
nodes {
downloadId
url
preAuthDownloadUrl
}
}
}
}
';
$response = $I->sendGraphQLRequest(
$query,
null,
[
'Authorization' => "Bearer {$data['auth_token']}",
'woocommerce-session' => "Session {$data['session_token']}",
]
);
$pre_auth_url = $I->lodashGet( $response, 'data.customer.downloadableItems.nodes.0.preAuthDownloadUrl' );
$I->assertNotEmpty( $pre_auth_url, 'preAuthDownloadUrl should be returned when setting is enabled.' );
// The URL should contain a token parameter.
$I->assertStringContainsString( 'token=', $pre_auth_url );
// Following the URL should not return a "must be logged in" error.
// WooCommerce will try to serve the file — it may fail because the file
// doesn't exist in the test environment, but it should NOT return a login error.
$I->amOnUrl( $pre_auth_url );
$I->dontSee( 'You must be logged in' );
}
}