computer-playbook/roles/web-app-odoo/files/playwright/_shared.js

const { expect } = require("@playwright/test");
const { resolveTimeout } = require("./timeouts");
const { decodeDotenvQuotedValue, performKeycloakLoginForm, gotoOnion } = require("./personas");
const { isServiceEnabled } = require("./service-gating");

const env = {
  odooBaseUrl: decodeDotenvQuotedValue(process.env.ODOO_BASE_URL || ""),
  oidcIssuerUrl: decodeDotenvQuotedValue(process.env.OIDC_ISSUER_URL || ""),
  adminUsername: decodeDotenvQuotedValue(process.env.ADMIN_USERNAME || ""),
  adminPassword: decodeDotenvQuotedValue(process.env.ADMIN_PASSWORD || ""),
};

const onionOptions = /\bhttps?:\/\/[^/,\s"']+\.onion\b/i.test(env.odooBaseUrl)
  ? { channel: "chromium", serviceWorkers: "block" }
  : {};

function baseUrl() {
  return env.odooBaseUrl.replace(/\/$/, "");
}

async function clickOdooSsoButton(locator) {
  const providerList = locator.locator(".o_login_auth, .o_auth_oauth_providers");
  const ssoButton = locator
    .locator('a[href*="/auth_oauth/signin"], a[href*="auth_oauth/signin"]')
    .filter({ hasText: /login with sso|sign in with|continue with/i })
    .first();
  const ssoButtonByText = locator.getByRole("link", { name: /login with sso/i }).first();

  await Promise.any([
    providerList.first().waitFor({ state: "visible", timeout: resolveTimeout(60_000) }),
    ssoButton.waitFor({ state: "visible", timeout: resolveTimeout(60_000) }),
    ssoButtonByText.waitFor({ state: "visible", timeout: resolveTimeout(60_000) }),
  ]);

  if (await ssoButtonByText.isVisible().catch(() => false)) {
    await ssoButtonByText.click({ timeout: resolveTimeout(30_000) });
  } else {
    await ssoButton.click({ timeout: resolveTimeout(30_000) });
  }
}

async function nativeLoginToOdoo(page, expectedBaseUrl, webClient) {
  await gotoOnion(page, `${expectedBaseUrl}/web/login`, { waitUntil: "domcontentloaded", timeout: resolveTimeout(60_000) });
  await page.locator('input[name="login"]').fill(env.adminUsername);
  await page.locator('input[name="password"]').fill(env.adminPassword);
  await page
    .locator('form:has(input[name="login"])')
    .getByRole("button", { name: /log\s*in/i })
    .first()
    .click({ timeout: resolveTimeout(30_000) });
  await gotoOnion(page, `${expectedBaseUrl}/odoo`, { waitUntil: "domcontentloaded", timeout: resolveTimeout(60_000) });
  await expect(
    webClient,
    "native (non-SSO) administrator login must land on the authenticated Odoo web client"
  ).toBeVisible({ timeout: resolveTimeout(60_000) });
}

async function loginToOdoo(page) {
  const expectedBaseUrl = baseUrl();
  const webClient = page.locator(".o_web_client, .o_main_navbar, .o_action_manager").first();

  if (!isServiceEnabled("sso")) {
    await nativeLoginToOdoo(page, expectedBaseUrl, webClient);
    return;
  }

  const notLoginUrl = new RegExp(
    `^${expectedBaseUrl.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}(?!/web/login)`
  );
  const issuer = env.oidcIssuerUrl.replace(/\/$/, "");
  for (let attempt = 1; attempt <= 2; attempt += 1) {
    await gotoOnion(page, `${expectedBaseUrl}/web/login`, { waitUntil: "domcontentloaded", timeout: resolveTimeout(60_000) });
    await clickOdooSsoButton(page);

    await Promise.race([
      page.waitForURL((u) => u.toString().startsWith(issuer), { timeout: resolveTimeout(60_000) }).catch(() => {}),
      webClient.waitFor({ state: "visible", timeout: resolveTimeout(120_000) }).catch(() => {}),
    ]);
    if (page.url().startsWith(issuer)) {
      await performKeycloakLoginForm(page, env.adminUsername, env.adminPassword);
      await expect
        .poll(() => page.url(), { timeout: resolveTimeout(60_000), message: "Expected page to navigate back from Keycloak to Odoo" })
        .toMatch(notLoginUrl);
    }

    await gotoOnion(page, `${expectedBaseUrl}/odoo`, { waitUntil: "domcontentloaded", timeout: resolveTimeout(60_000) });
    const rendered = await webClient
      .waitFor({ state: "visible", timeout: resolveTimeout(120_000) })
      .then(() => true)
      .catch(() => false);
    if (rendered) {
      return;
    }
  }
  throw new Error(
    "Odoo SSO login did not establish an authenticated session: the web client did not render after the Keycloak OAuth round-trip"
  );
}

let cachedStorageState = null;

/**
 * Open a context that is already signed in to Odoo.
 *
 * The first caller performs the full SSO round-trip and caches the storage
 * state; later callers restore it. A restored state that no longer renders the
 * web client is discarded and the full login runs instead.
 *
 * @param {import('@playwright/test').Browser} browser
 * @returns {Promise<{context: import('@playwright/test').BrowserContext, page: import('@playwright/test').Page}>}
 */
async function authenticatedContext(browser) {
  const webClient = ".o_web_client, .o_main_navbar, .o_action_manager";
  if (cachedStorageState) {
    const context = await browser.newContext({
      ignoreHTTPSErrors: true,
      storageState: cachedStorageState,
    });
    const page = await context.newPage();
    const restored = await gotoOnion(page, `${baseUrl()}/odoo`, {
      waitUntil: "domcontentloaded",
      timeout: resolveTimeout(60_000),
    })
      .then(() =>
        page
          .locator(webClient)
          .first()
          .waitFor({ state: "visible", timeout: resolveTimeout(60_000) })
      )
      .then(() => true)
      .catch(() => false);
    if (restored) {
      return { context, page };
    }
    cachedStorageState = null;
    await context.close();
  }

  const context = await browser.newContext({ ignoreHTTPSErrors: true });
  const page = await context.newPage();
  await loginToOdoo(page);
  cachedStorageState = await context.storageState();
  return { context, page };
}

async function openModule(page, modulePath) {
  const url = `${baseUrl()}/${String(modulePath).replace(/^\//, "")}`;
  await gotoOnion(page, url, { waitUntil: "domcontentloaded", timeout: resolveTimeout(90_000) });
  const appShell = page.locator(
    ".o_web_client, .o_action_manager, .o_main_navbar, .o_content, .o_list_view, .o_kanban_view"
  );
  // Odoo bootstraps a heavy web-client asset bundle per module; under serial test
  // load the first render can take well over a minute, so allow generous time.
  await expect(appShell.first()).toBeVisible({ timeout: resolveTimeout(120_000) });
}

module.exports = {
  env,
  onionOptions,
  baseUrl,
  clickOdooSsoButton,
  loginToOdoo,
  authenticatedContext,
  openModule,
};