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

// Shared Friendica Playwright spec state: env vars, login/logout flow
// helpers, and the variant-aware path selectors. `playwright.spec.js`
// wires the lifecycle hook and `require()`s one test module per scenario
const { resolveTimeout } = require("./timeouts");
// so each test stays atomar and individually inspectable.
//
// Variant matrix (see meta/variants.yml):
//   v0  oauth2 + ldap + oidc all enabled — double-login pattern below
//   v1  every dynamic flag disabled      — only guest test runs
//   v2  ldap enabled, oauth2 + oidc off  — direct in-app login (no Keycloak hop)
// All three are selected at runtime by inspecting `SSO_SERVICE_ENABLED`
// and `LDAP_SERVICE_ENABLED` — the spec stays one file across variants.

const { expect } = require("@playwright/test");

const { decodeDotenvQuotedValue, performKeycloakLoginForm, runGuestFlow, gotoOnion } = require("./personas");
const { isServiceEnabled, skipUnlessServiceEnabled } = require("./service-gating");

const friendicaBaseUrl = decodeDotenvQuotedValue(process.env.FRIENDICA_BASE_URL);
const canonicalDomain  = decodeDotenvQuotedValue(process.env.CANONICAL_DOMAIN);
const adminUsername    = decodeDotenvQuotedValue(process.env.ADMIN_USERNAME);
const adminPassword    = decodeDotenvQuotedValue(process.env.ADMIN_PASSWORD);
const biberUsername    = decodeDotenvQuotedValue(process.env.BIBER_USERNAME);
const biberPassword    = decodeDotenvQuotedValue(process.env.BIBER_PASSWORD);

function trimmedBaseUrl() {
  return friendicaBaseUrl.replace(/\/$/, "");
}

async function loginViaFriendicaForm(page, username, password) {
  const passwordField = page.locator("input[name='password']").first();
  await passwordField.waitFor({ state: "visible", timeout: resolveTimeout(30_000) });

  const usernameField = page.locator("input[name='username']").first();
  const loginForm = page.locator("form").filter({ has: passwordField });
  const signInButton = loginForm
    .locator("button[type='submit'], input[type='submit']")
    .or(loginForm.getByRole("button", { name: /sign\s*in|log\s*in|anmelden|connexion|iniciar|entrar/i }))
    .first();

  await usernameField.fill(username);
  await passwordField.fill(password);
  await Promise.all([
    page.waitForLoadState("domcontentloaded"),
    signInButton.click({ timeout: resolveTimeout(30_000) }),
  ]);
}

// v0 path: oauth2-proxy gates the friendica vhost, so /login first redirects
// through Keycloak — the browser-flow path that ENFORCES 2FA when the realm
// has it configured. After the Keycloak round-trip Friendica still renders
// its OWN login form: there is no header-trusted auto-login addon in stock
// Friendica (Owa.php / OAuth.php only read HTTP_AUTHORIZATION for API auth,
// never for the web session). Fill that second form so `ldapauth`'s
// else-branch (User::getAuthenticationInfo + User::getById against the
// pre-created friendica.user row) starts a Friendica session. See TODO.md
// for the SAML migration that would collapse this back into a single hop.
async function loginViaOauth2ProxyAndFriendica(page, username, password) {
  const baseUrl = trimmedBaseUrl();
  await gotoOnion(page, `${baseUrl}/`, { waitUntil: "domcontentloaded" }).catch(() => {});

  // Step 1: oauth2-proxy intercepted the request — page is now on Keycloak.
  await performKeycloakLoginForm(page, username, password);
  // Wait until the browser hostname is the canonical friendica domain. The
  // naive `url().includes(canonicalDomain)` matches Keycloak's auth URL too
  // (the canonical domain appears in the `redirect_uri` query param), which
  // would let Step 2 run against Keycloak's form instead of Friendica's.
  await expect
    .poll(() => {
      try { return new URL(page.url()).hostname; } catch { return ""; }
    }, {
      timeout: resolveTimeout(60_000),
      message: `Expected page hostname to become ${canonicalDomain} after Keycloak login`,
    })
    .toBe(canonicalDomain);

  // Step 2: Friendica's own login form (post-oauth2-proxy).
  await page.waitForLoadState("domcontentloaded", { timeout: resolveTimeout(30_000) }).catch(() => {});
  if (await page.locator("input[name='password']").first().waitFor({ state: "visible", timeout: resolveTimeout(2_000) }).then(() => true).catch(() => false)) {
    await loginViaFriendicaForm(page, username, password);
  }

  // Verify Friendica's authenticated surface is now rendered. Navigate to
  // an authenticated route explicitly so we don't race a same-page re-render
  // after the POST redirect — the frio / vier themes both expose
  // #topbar-first on /network; `a[href*='/logout']` is the cross-theme
  // fallback for less-canonical themes.
  await gotoOnion(page, `${baseUrl}/network`, { waitUntil: "domcontentloaded" }).catch(() => {});
  const profileMenu = page.locator("#topbar-first, #navbar-apps-menu, a[href*='/logout']").first();
  await profileMenu.waitFor({ state: "visible", timeout: resolveTimeout(60_000) });
}

// v2 path: no oauth2-proxy gating, friendica's `/login` is directly reachable.
// `ldapauth`'s bind path authenticates against openldap, the pre-created
// administrator row in friendica.user lets the else-branch return a uid →
// hook sets authenticated=1 → session established.
async function loginViaFriendicaDirect(page, username, password) {
  const baseUrl = trimmedBaseUrl();
  await gotoOnion(page, `${baseUrl}/login`, { waitUntil: "domcontentloaded" });
  await loginViaFriendicaForm(page, username, password);
  await gotoOnion(page, `${baseUrl}/network`, { waitUntil: "domcontentloaded" }).catch(() => {});
  const profileMenu = page.locator("#topbar-first, #navbar-apps-menu, a[href*='/logout']").first();
  await profileMenu.waitFor({ state: "visible", timeout: resolveTimeout(60_000) });
}

function pickLoginPath() {
  return isServiceEnabled("sso") ? loginViaOauth2ProxyAndFriendica : loginViaFriendicaDirect;
}

async function friendicaLogout(page) {
  const baseUrl = trimmedBaseUrl();
  await gotoOnion(page, `${baseUrl}/logout`, { waitUntil: "commit" }).catch(() => {});
}

// Provision biber's friendica.user row by walking the LDAP login path
// once. ldapauth materialises the row on first successful bind; needed
// before any test that asserts on /profile/biber (without this seeding
// the profile would 404). Logs out at the end so the caller starts from
// a clean session.
async function provisionBiberAccount(browser) {
  const login = pickLoginPath();
  const context = await browser.newContext({ ignoreHTTPSErrors: true });
  try {
    const page = await context.newPage();
    await login(page, biberUsername, biberPassword);
    await friendicaLogout(page);
  } finally {
    await context.close().catch(() => {});
  }
}

module.exports = {
  env: {
    friendicaBaseUrl,
    canonicalDomain,
    adminUsername,
    adminPassword,
    biberUsername,
    biberPassword,
  },
  trimmedBaseUrl,
  isServiceEnabled,
  skipUnlessServiceEnabled,
  loginViaFriendicaForm,
  loginViaOauth2ProxyAndFriendica,
  loginViaFriendicaDirect,
  pickLoginPath,
  friendicaLogout,
  provisionBiberAccount,
  runGuestFlow,
};