tests/ui-testing/playwright-tests/unflattened.spec.js (3)

9-22: Consider extracting environment variables.

The login function is well-structured and follows the correct flow. However, consider extracting the environment variables into constants at the top of the file for better readability and maintainability.

---

24-50: Consider using a separate configuration file.

The ingestion function is correctly implemented. However, consider moving the configuration variables (e.g., headers, URLs) to a separate configuration file to improve code organization and maintainability.

---

92-132: Consider adding more assertions.

The test case 'stream to toggle store original data toggle and display o2 id' is comprehensive and covers the required user interactions. However, consider adding more assertions to verify the expected behavior and state of the application after each significant interaction.

Configuration used: CodeRabbit UI
Review profile: CHILL

tests/ui-testing/playwright-tests/unflattened.spec.js (7)

1-5: Organize imports and remove unused imports.

• Group imports by type (e.g., external libraries, internal modules) and sort them alphabetically within each group for better readability.
• Remove the unused import log from console.

Apply this diff to organize imports and remove unused imports:

-import { test, expect } from "@playwright/test";
-import logData from "../../ui-testing/cypress/fixtures/log.json";
-import { log } from "console";
-import logsdata from "../../test-data/logs_data.json";
+import { expect, test } from "@playwright/test";
+
+import logData from "../../ui-testing/cypress/fixtures/log.json";
+import logsdata from "../../test-data/logs_data.json";

---

6-6: Consider using more descriptive test configuration.

The test configuration { mode: 'parallel' } is not very descriptive. Consider adding a comment to explain the purpose of this configuration or using a more descriptive configuration object.

// Run tests in parallel mode for faster execution
test.describe.configure({ mode: 'parallel' });

---

9-22: Extract selectors and use more descriptive variable names.

• Extract selectors into constants for better readability and maintainability.
• Use more descriptive variable names for the page object methods (e.g., fillLoginUserId instead of fill).

Apply this diff to extract selectors and use more descriptive variable names:

async function login(page) {
  await page.goto(process.env["ZO_BASE_URL"]);
  //  await page.getByText('Login as internal user').click();
  await page.waitForTimeout(1000);
-  await page
-    .locator('[data-cy="login-user-id"]')
-    .fill(process.env["ZO_ROOT_USER_EMAIL"]);
+  const loginUserIdSelector = '[data-cy="login-user-id"]';
+  await page.locator(loginUserIdSelector).fillLoginUserId(process.env["ZO_ROOT_USER_EMAIL"]);
  //Enter Password
  await page.locator('label').filter({ hasText: 'Password *' }).click();
-  await page
-    .locator('[data-cy="login-password"]')
-    .fill(process.env["ZO_ROOT_USER_PASSWORD"]);
+  const loginPasswordSelector = '[data-cy="login-password"]';
+  await page.locator(loginPasswordSelector).fillLoginPassword(process.env["ZO_ROOT_USER_PASSWORD"]);
-  await page.locator('[data-cy="login-sign-in"]').click();
+  const loginSignInSelector = '[data-cy="login-sign-in"]';
+  await page.locator(loginSignInSelector).clickSignIn();
}

---

24-50: Improve error handling and logging in the ingestion function.

• Add proper error handling using try-catch blocks to catch and log any errors that may occur during the ingestion process.
• Log the response status code and message for better debugging.

Apply this diff to improve error handling and logging:

async function ingestion(page) {
  const orgId = process.env["ORGNAME"];
  const streamName = "e2e_automate";
  const basicAuthCredentials = Buffer.from(
    `${process.env["ZO_ROOT_USER_EMAIL"]}:${process.env["ZO_ROOT_USER_PASSWORD"]}`
  ).toString('base64');

  const headers = {
    "Authorization": `Basic ${basicAuthCredentials}`,
    "Content-Type": "application/json",
  };
-  const response = await page.evaluate(async ({ url, headers, orgId, streamName, logsdata }) => {
-    const fetchResponse = await fetch(`${url}/api/${orgId}/${streamName}/_json`, {
-      method: 'POST',
-      headers: headers,
-      body: JSON.stringify(logsdata)
-    });
-    return await fetchResponse.json();
-  }, {
-    url: process.env.INGESTION_URL,
-    headers: headers,
-    orgId: orgId,
-    streamName: streamName,
-    logsdata: logsdata
-  });
-  console.log(response);
+  try {
+    const response = await page.evaluate(async ({ url, headers, orgId, streamName, logsdata }) => {
+      const fetchResponse = await fetch(`${url}/api/${orgId}/${streamName}/_json`, {
+        method: 'POST',
+        headers: headers,
+        body: JSON.stringify(logsdata)
+      });
+      return await fetchResponse.json();
+    }, {
+      url: process.env.INGESTION_URL,
+      headers: headers,
+      orgId: orgId,
+      streamName: streamName,
+      logsdata: logsdata
+    });
+    console.log(`Ingestion response: ${response.status} - ${response.statusText}`);
+  } catch (error) {
+    console.error(`Ingestion error: ${error.message}`);
+    throw error;
+  }
}

---

52-57: Use more descriptive function and variable names.

• Rename the function to selectStreamAndStreamTypeForLogsSearch to better describe its purpose.
• Rename the stream parameter to streamName for clarity.

Apply this diff to use more descriptive names:

-const selectStreamAndStreamTypeForLogs = async (page, stream) => {
+const selectStreamAndStreamTypeForLogsSearch = async (page, streamName) => {
  await page.waitForTimeout(
    4000); await page.locator(
      '[data-test="log-search-index-list-select-stream"]').click({ force: true }); await page.locator(
-        "div.q-item").getByText(`${stream}`).first().click({ force: true });
+        "div.q-item").getByText(`${streamName}`).first().click({ force: true });
};

---

66-76: Improve error handling and use more descriptive variable names.

• Add proper error handling using try-catch blocks to catch and log any errors that may occur during the query application process.
• Rename the search variable to searchResponse for clarity.

Apply this diff to improve error handling and use more descriptive names:

async function applyQueryButton(page) {
  // click on the run query button
  // Type the value of a variable into an input field
-  const search = page.waitForResponse(logData.applyQuery);
+  const searchResponse = page.waitForResponse(logData.applyQuery);
  await page.waitForTimeout(3000);
-  await page.locator("[data-test='logs-search-bar-refresh-btn']").click({
-    force: true,
-  });
+  try {
+    await page.locator("[data-test='logs-search-bar-refresh-btn']").click({
+      force: true,
+    });
+  } catch (error) {
+    console.error(`Error clicking refresh button: ${error.message}`);
+    throw error;
+  }
  // get the data from the search variable
-  await expect.poll(async () => (await search).status()).toBe(200);
+  await expect.poll(async () => (await searchResponse).status()).toBe(200);
}

---

78-90: Improve test setup and use more descriptive variable names.

• Move the allsearch variable declaration before the selectStreamAndStreamTypeForLogs function call to ensure the response is captured.
• Rename the allsearch variable to allSearchResponse for clarity.

Apply this diff to improve test setup and use more descriptive names:

test.beforeEach(async ({ page }) => {
  await login(page);
  await page.waitForTimeout(1000)
  await ingestion(page);
  await page.waitForTimeout(2000)

  await page.goto(
    `${logData.logsUrl}?org_identifier=${process.env["ORGNAME"]}`
  );
-  const allsearch = page.waitForResponse("**/api/default/_search**");
+  const allSearchResponse = page.waitForResponse("**/api/default/_search**");
  await selectStreamAndStreamTypeForLogs(page, logData.Stream);
  await applyQueryButton(page);
+  await allSearchResponse;
});

Configuration used: CodeRabbit UI
Review profile: CHILL