add data-cleanup, exclude-and-sanitize tests

Author: ahuseyn

plugins/wpgraphql-logging/tests/e2e/specs/data-cleanup.spec.js

@@ -0,0 +1,57 @@
+import { expect, test } from "@wordpress/e2e-test-utils-playwright";
+import {
+	configureDataManagement,
+	goToLoggingSettingsPage,
+	resetPluginSettings,
+} from "../utils";
+
+test.describe("Data Management - Configure Automatic Cleanup", () => {
+	test.beforeEach(async ({ admin }) => {
+		await resetPluginSettings(admin);
+	});
+
+	test("should configure data deletion settings and verify they are saved", async ({
+		page,
+		admin,
+	}) => {
+		// Set up logging settings
+		await goToLoggingSettingsPage(admin);
+		await expect(page.locator("h1")).toHaveText("WPGraphQL Logging Settings");
+
+		await configureDataManagement(page, {
+			dataDeletionEnabled: true,
+			dataRetentionDays: "7",
+			dataSanitizationEnabled: false,
+		});
+
+		await expect(page.locator(".notice.notice-success")).toBeVisible();
+
+		// Reload the page to verify settings persisted
+		await page.reload({ waitUntil: "networkidle" });
+
+		await page
+			.locator("#wpbody-content")
+			.getByRole("link", { name: "Data Management" })
+			.click();
+
+		const deletionCheckbox = page.locator(
+			'input[name="wpgraphql_logging_settings[data_management][data_deletion_enabled]"]'
+		);
+		await expect(deletionCheckbox).toBeChecked();
+
+		const retentionInput = page.locator(
+			'input[name="wpgraphql_logging_settings[data_management][data_retention_days]"]'
+		);
+		await expect(retentionInput).toHaveValue("7");
+
+		// Verify cron job is scheduled with wp-crontrol plugin
+		await admin.visitAdminPage("/tools.php?page=wp-crontrol");
+		await expect(page.locator("h1")).toContainText("Cron Events");
+
+		const cleanupHook = page
+			.locator(".crontrol_hook")
+			.filter({ hasText: "wpgraphql_logging_deletion_cleanup" });
+
+		await expect(cleanupHook).toBeVisible();
+	});
+});

plugins/wpgraphql-logging/tests/e2e/specs/exclude-and-sanitize.spec.js

@@ -0,0 +1,79 @@
+import { expect, test } from "@wordpress/e2e-test-utils-playwright";
+import {
+	goToLoggingSettingsPage,
+	goToLogsListPage,
+	configureLogging,
+	executeGraphQLQuery,
+	resetPluginSettings,
+} from "../utils";
+import { GET_POSTS_QUERY } from "../constants";
+
+test.describe("Exclude Sensitive Queries from Logging", () => {
+	test.beforeEach(async ({ admin }) => {
+		await resetPluginSettings(admin);
+	});
+
+	test("should exclude queries from logs when configured", async ({
+		page,
+		admin,
+		request,
+	}) => {
+		// Set up logging with GetPosts excluded
+		await goToLoggingSettingsPage(admin);
+		await expect(page.locator("h1")).toHaveText("WPGraphQL Logging Settings");
+
+		await configureLogging(page, {
+			enabled: true,
+			dataSampling: "100",
+			eventLogSelection: ["graphql_request_results"],
+			excludeQueries: "GetPosts",
+		});
+
+		await expect(page.locator(".notice.notice-success")).toBeVisible();
+
+		// Execute the excluded query
+		const response = await executeGraphQLQuery(request, GET_POSTS_QUERY);
+		expect(response.ok()).toBeTruthy();
+
+		// Verify query is not logged
+		await goToLogsListPage(admin);
+		await expect(page.locator("h1")).toContainText("WPGraphQL Logs");
+
+		await expect(
+			page.locator('td.colspanchange:has-text("No items found.")')
+		).toBeVisible();
+	});
+
+	test("should log queries when not excluded", async ({
+		page,
+		admin,
+		request,
+	}) => {
+		// Set up logging without excluded queries
+		await goToLoggingSettingsPage(admin);
+
+		await configureLogging(page, {
+			enabled: true,
+			dataSampling: "100",
+			eventLogSelection: ["graphql_request_results"],
+			excludeQueries: "",
+		});
+
+		await expect(page.locator(".notice.notice-success")).toBeVisible();
+
+		// Execute query
+		await executeGraphQLQuery(request, GET_POSTS_QUERY);
+
+		// Navigate to logs and verify query is logged
+		await goToLogsListPage(admin);
+		await expect(page.locator("h1")).toContainText("WPGraphQL Logs");
+
+		// Verify GetPosts query is logged
+		const getPostsLog = page
+			.locator("#the-list tr")
+			.filter({ hasText: "GetPosts" });
+		await expect(getPostsLog).toBeVisible({ timeout: 10000 });
+	});
+
+	// TODO add sanitization tests here
+});

plugins/wpgraphql-logging/tests/e2e/utils.js

@@ -129,3 +129,55 @@ export async function getLogDetails(page, logId) {
 
 	return details;
 }
+
+/**
+ * Configure data management settings
+ */
+export async function configureDataManagement(page, settings = {}) {
+	const {
+		dataDeletionEnabled = false,
+		dataRetentionDays = "30",
+		dataSanitizationEnabled = false,
+		dataSanitizationMethod = "recommended",
+	} = settings;
+
+	// Switch to Data Management tab
+	await switchToSettingsTab(page, "Data Management");
+
+	// Enable/disable data deletion
+	const deletionCheckbox = page.locator(
+		'input[name="wpgraphql_logging_settings[data_management][data_deletion_enabled]"]'
+	);
+	if (dataDeletionEnabled) {
+		await deletionCheckbox.check();
+	} else {
+		await deletionCheckbox.uncheck();
+	}
+
+	// Set data retention days
+	await page
+		.locator(
+			'input[name="wpgraphql_logging_settings[data_management][data_retention_days]"]'
+		)
+		.fill(dataRetentionDays);
+
+	// Enable/disable data sanitization
+	const sanitizationCheckbox = page.locator(
+		'input[name="wpgraphql_logging_settings[data_management][data_sanitization_enabled]"]'
+	);
+	if (dataSanitizationEnabled) {
+		await sanitizationCheckbox.check();
+	} else {
+		await sanitizationCheckbox.uncheck();
+	}
+
+	// Set sanitization method
+	await page
+		.locator(
+			'select[name="wpgraphql_logging_settings[data_management][data_sanitization_method]"]'
+		)
+		.selectOption(dataSanitizationMethod);
+
+	await page.getByRole("button", { name: "Save Changes" }).click();
+	await page.waitForSelector(".notice.notice-success");
+}