fix tests, add new basic-usage test

Author: ahuseyn

.gitignore

@@ -16,7 +16,6 @@ test-results/
 # WordPress
 .wp-env
 .wp-env.override.json
-wp-env/
 uploads/
 debug.log
 __MACOSX

plugins/wpgraphql-logging/.wp-env.json

@@ -7,6 +7,7 @@
 		"tests": {
 			"plugins": [
 				"https://github.com/wp-graphql/wp-graphql/releases/latest/download/wp-graphql.zip",
+				"https://github.com/johnbillion/wp-crontrol/archive/refs/tags/1.19.3.zip",
 				".",
 				"./tests/e2e/plugins/reset-wpgraphql-logging-settings/"
 			]

plugins/wpgraphql-logging/tests/e2e/config/global-setup.js

@@ -17,11 +17,7 @@ async function globalSetup(config) {
 	// Authenticate and save the storageState to disk.
 	await requestUtils.setupRest();
 
-	await Promise.all([
-		requestUtils.deleteAllPosts(),
-		requestUtils.deleteAllPages(),
-		requestUtils.resetPreferences(),
-	]);
+	await Promise.all([requestUtils.resetPreferences()]);
 
 	await requestContext.dispose();
 }

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

@@ -1,5 +1,6 @@
 export const PLUGIN_SLUG = "wpgraphql-logging";
 export const RESET_HELPER_PLUGIN_SLUG = "reset-wpgraphql-logging-settings";
+
 export const GET_POSTS_QUERY = `
 	query GetPosts {
 		posts(first: 5) {

plugins/wpgraphql-logging/tests/e2e/specs/basic-usage.spec.js

@@ -97,4 +97,100 @@ test.describe("Configure WPGraphQL Logging Plugin and Verify Logging Works", ()
 			page.locator('td.colspanchange:has-text("No items found.")')
 		).toBeVisible();
 	});
+
+	test("should download the log as CSV and verify the content", async ({
+		page,
+		admin,
+		request,
+	}) => {
+		// Set up logging settings
+		await goToLoggingSettingsPage(admin);
+		await expect(page.locator("h1")).toHaveText("WPGraphQL Logging Settings");
+
+		await configureLogging(page, {
+			enabled: true,
+			dataSampling: "100",
+			eventLogSelection: ["graphql_request_results"],
+		});
+
+		await expect(page.locator(".notice.notice-success")).toBeVisible();
+
+		// Execute a GraphQL query
+		const response = await executeGraphQLQuery(request, GET_POSTS_QUERY);
+		expect(response.ok()).toBeTruthy();
+
+		// Check that the log appears in the logs list
+		await goToLogsListPage(admin);
+		await expect(page.locator("h1")).toContainText("WPGraphQL Logs");
+
+		const logRow = page
+			.locator("#the-list tr")
+			.filter({ hasText: "GetPosts" })
+			.first();
+		await expect(logRow).toBeVisible({ timeout: 10000 });
+
+		// View log details
+		const downloadButton = logRow.locator(".row-actions .download a");
+		await expect(downloadButton).toBeVisible();
+
+		const downloadPromise = page.waitForEvent("download");
+		await downloadButton.focus();
+		await downloadButton.click();
+		const download = await downloadPromise;
+
+		// Verify download properties
+		expect(download.suggestedFilename()).toMatch(/graphql_log_\d+\.csv/);
+		expect(download.suggestedFilename()).toContain(".csv");
+
+		// Optionally save and verify the content
+		const path = await download.path();
+		const fs = require("fs");
+		const content = fs.readFileSync(path, "utf8");
+
+		// Verify CSV contains expected data
+		expect(content).toContain("ID");
+		expect(content).toContain("Date");
+		expect(content).toContain("Level");
+		expect(content).toContain("Message");
+		expect(content).toContain("GetPosts");
+	});
+
+	// test("should set data sampling to 10% and verify only 1 log is created", async ({
+	// 	page,
+	// 	admin,
+	// 	request,
+	// }) => {
+	// 	// Set up logging settings
+	// 	await goToLoggingSettingsPage(admin);
+	// 	await expect(page.locator("h1")).toHaveText("WPGraphQL Logging Settings");
+
+	// 	await configureLogging(page, {
+	// 		enabled: true,
+	// 		dataSampling: "50",
+	// 		eventLogSelection: ["graphql_request_results"],
+	// 	});
+
+	// 	await expect(page.locator(".notice.notice-success")).toBeVisible();
+
+	// 	// Execute a GraphQL queries
+	// 	const responses = await Promise.all(
+	// 		Array.from({ length: 10 }, async () =>
+	// 			executeGraphQLQuery(request, GET_POSTS_QUERY)
+	// 		)
+	// 	);
+	// 	await Promise.all(
+	// 		responses.map(async (response) => {
+	// 			return expect(response.ok()).toBeTruthy();
+	// 		})
+	// 	);
+
+	// 	// Navigate to logs and verify no new logs were created
+	// 	await goToLogsListPage(admin);
+	// 	await expect(page.locator("h1")).toContainText("WPGraphQL Logs");
+
+	// 	const logRow = page.locator("#the-list tr").filter({ hasText: "GetPosts" });
+
+	// 	const logCount = await logRow.count();
+	// 	expect(logCount).toBeLessThanOrEqual(5);
+	// });
 });

plugins/wpgraphql-logging/wp-env/setup/.htaccess

@@ -0,0 +1,21 @@
+<IfModule mod_headers.c>
+    Header set Access-Control-Allow-Origin "*"
+    Header set Access-Control-Allow-Methods "GET, POST, OPTIONS"
+    Header set Access-Control-Allow-Headers "Authorization, Content-Type"
+</IfModule>
+
+# BEGIN WordPress
+# The directives (lines) between "BEGIN WordPress" and "END WordPress" are
+# dynamically generated, and should only be modified via WordPress filters.
+# Any changes to the directives between these markers will be overwritten.
+<IfModule mod_rewrite.c>
+RewriteEngine On
+RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
+RewriteBase /
+RewriteRule ^index\.php$ - [L]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule . /index.php [L]
+</IfModule>
+
+# END WordPress