api-cache.test.js

/**
 * API caching functions tests.
 *
 * Site Kit by Google, Copyright 2022 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * WordPress dependencies
 */
import { visitAdminPage } from '@wordpress/e2e-test-utils';

/**
 * Internal dependencies
 */
import {
	resetSiteKit,
	safeLoginUser,
	setupSiteKit,
	useRequestInterception,
} from '../utils';
import { deleteAuthCookie } from '../utils/delete-auth-cookie';

async function goToWordPressDashboard() {
	await visitAdminPage( 'index.php' );
}

async function googleSiteKitAPIGetTime() {
	await page.waitForFunction(
		() =>
			window.googlesitekit !== undefined &&
			window.googlesitekit.api !== undefined
	);

	return await page.evaluate( () => {
		// `useCache` is enabled by default for `get` calls,
		// but we'll be explicit here for the sake of the test.
		return window.googlesitekit.api.get( 'e2e', 'util', 'time', null, {
			useCache: true,
		} );
	} );
}

describe( 'API cache', () => {
	beforeAll( async () => {
		await page.setRequestInterception( true );
		useRequestInterception( ( request ) => {
			const url = request.url();
			if ( url.match( 'search-console/data/searchanalytics' ) ) {
				request.respond( { status: 200, body: '[]' } );
			} else {
				request.continue();
			}
		} );

		await setupSiteKit();
	} );

	afterAll( async () => {
		await resetSiteKit();
	} );

	it( 'isolates client storage between sessions', async () => {
		// Navigate to WP dashboard to use SK APIs
		// while minimizing side-effects from reporting, etc.
		await goToWordPressDashboard();

		const initialTimeData = await googleSiteKitAPIGetTime();
		expect( initialTimeData ).toMatchObject( {
			microtime: expect.any( Number ),
		} );

		// Show that the data is cached when fetching again.
		const timeData = await googleSiteKitAPIGetTime();
		expect( timeData ).toEqual( initialTimeData );

		// Delete auth cookie to sign out the current user.
		// This was needed in the past due to cache clearing
		// that was hooked into the logout action.
		// Deleting cookies makes it more clear that the observed
		// result is due to a new session only. It's also faster.
		await deleteAuthCookie();

		await safeLoginUser( 'admin', 'password' );

		await goToWordPressDashboard();

		// Now that we're in a new session, we expect the API cache to be clear
		// so the request should hit the backend and produce a new (greater) value.
		const newTimeData = await googleSiteKitAPIGetTime();
		expect( newTimeData ).not.toEqual( initialTimeData );
		expect( initialTimeData ).toMatchObject( {
			microtime: expect.any( Number ),
		} );
		expect( newTimeData.microtime ).toBeGreaterThan(
			initialTimeData.microtime
		);
	} );
} );