@bigbinary/neeto-playwright-commons 2.2.0 → 2.2.2

package/index.cjs.js

@@ -1,6 +1,5 @@
 'use strict';
 
-var child_process = require('child_process');
 var neetoCist = require('@bigbinary/neeto-cist');
 var faker = require('@faker-js/faker');
 var fs$4 = require('fs');
@@ -10,6 +9,7 @@ var test = require('@playwright/test');
 var playwrightI18nextFixture = require('playwright-i18next-fixture');
 var require$$0$3 = require('util');
 var ramda = require('ramda');
+var child_process = require('child_process');
 var dayjs = require('dayjs');
 var require$$0$7 = require('stream');
 var require$$0$6 = require('node:buffer');
@@ -247,86 +247,63 @@ class MemberApis {
     });
 }
 
-class RailsEmailRakeClient {
-    workingDirectory;
-    constructor() {
-        this.workingDirectory = process.env.RAILS_ROOT || "..";
-    }
-    convertRawEmail = (rawEmail) => ({
-        from: rawEmail.from,
-        to: rawEmail.to,
-        cc: rawEmail.cc,
-        bcc: rawEmail.bcc,
-        replyTo: rawEmail.reply_to,
-        subject: rawEmail.subject,
-        htmlBody: rawEmail.html_body,
-        textBody: rawEmail.text_body,
-        receivedAt: rawEmail.received_at,
-        attachments: rawEmail.attachments?.map(att => ({
-            name: att.filename,
-            type: att.mime_type,
-            content: att.data,
+class RailsEmailApiClient {
+    port = process.env.RAILS_SERVER_PORT;
+    subdomain = process.env.SUBDOMAIN ?? "spinkart";
+    baseUrl = `http://${this.subdomain}.lvh.me:${this.port}`;
+    emailsEndpoint = `${this.baseUrl}/api/v1/testing/emails`;
+    constructor() { }
+    convertRawEmail = (raw) => ({
+        from: raw.from,
+        to: raw.to,
+        cc: raw.cc,
+        bcc: raw.bcc,
+        replyTo: raw.reply_to,
+        subject: raw.subject,
+        htmlBody: raw.html_body,
+        textBody: raw.text_body,
+        receivedAt: raw.received_at,
+        attachments: raw.attachments?.map(({ filename, mime_type, data }) => ({
+            name: filename,
+            type: mime_type,
+            content: data,
         })),
     });
-    executeRakeTask = async (taskName, args = []) => {
-        const childProcess = child_process.spawn("bundle", ["exec", "rake", taskName, "--", ...args], {
-            cwd: this.workingDirectory,
-            stdio: ["ignore", "pipe", "pipe"],
-        });
-        let stdout = "";
-        let stderr = "";
-        childProcess.stdout?.on("data", data => {
-            stdout += data.toString();
-        });
-        childProcess.stderr?.on("data", data => {
-            stderr += data.toString();
-        });
-        const exitCode = await new Promise((resolve, reject) => {
-            childProcess.on("error", reject);
-            childProcess.on("close", resolve);
-        });
-        if (exitCode !== 0) {
-            throw new Error(`Rake task ${taskName} failed: ${stderr || stdout || `Exit code ${exitCode}`}`);
-        }
-        return this.extractJsonFromOutput(stdout);
-    };
-    extractJsonFromOutput = (output) => {
-        const delimiterMatch = output.match(/<-- Captured Emails Start-->([\s\S]*?)<-- Captured Emails End-->/);
-        return delimiterMatch ? delimiterMatch[1].trim() : output.trim();
+    buildQueryString = (params) => {
+        if (!params)
+            return "";
+        const filtered = Object.fromEntries(Object.entries(neetoCist.keysToSnakeCase(params))
+            .filter(([, v]) => v != null && v !== "")
+            .map(([k, v]) => [k, String(v)]));
+        const query = new URLSearchParams(filtered).toString();
+        return query ? `?${query}` : "";
     };
-    listEmails = async (searchParams) => {
+    fetchJson = async (url, options) => {
         try {
-            const args = this.buildSearchArgs(searchParams);
-            const output = await this.executeRakeTask("playwright:fetch_captured_emails", args);
-            if (!output)
-                return [];
-            const rawEmails = JSON.parse(output);
-            return rawEmails.map(this.convertRawEmail);
+            const res = await fetch(url, options);
+            if (!res.ok)
+                return null;
+            return (await res.json());
         }
-        catch (error) {
-            console.error("Failed to fetch emails:", error);
-            return [];
+        catch (err) {
+            console.error("API error:", err);
+            return null;
         }
     };
-    buildSearchArgs = (searchParams) => Object.entries(neetoCist.keysToSnakeCase(searchParams ?? {}))
-        .filter(([, value]) => value != null && value !== "")
-        .map(([key, value]) => `--${key}=${value}`);
+    listEmails = async (searchParams) => {
+        const query = this.buildQueryString(searchParams);
+        const data = await this.fetchJson(`${this.emailsEndpoint}${query}`);
+        return data?.map(this.convertRawEmail) ?? [];
+    };
     getLatestEmail = async (searchParams) => {
         const emails = await this.listEmails(searchParams);
-        if (emails.length === 0)
-            return null;
-        return emails.reduce((latest, current) => new Date(current.receivedAt) > new Date(latest.receivedAt)
-            ? current
-            : latest);
-    };
-    clearEmails = async () => {
-        try {
-            await this.executeRakeTask("playwright:clear_captured_emails");
-        }
-        catch (error) {
-            console.error("Failed to clear emails:", error);
-        }
+        return emails.reduce((latest, curr) => !latest || new Date(curr.receivedAt) > new Date(latest.receivedAt)
+            ? curr
+            : latest, null);
     };
+    clearEmails = () => this.fetchJson(this.emailsEndpoint, {
+        method: "DELETE",
+    });
 }
 
 class RoleApis {
@@ -5456,6 +5433,7 @@ const LOGIN_SELECTORS = {
     twitterAuthenticationButton: "twitter-authentication-button",
     authenticatorAppOtpInput: "authenticator-app-otp-login-code-input",
     enterOtpInputError: "enter-otp-input-error",
+    authenticatorAppLaterButton: "authenticator-app-promo-later-button",
 };
 
 const MEMBER_SELECTORS = {
@@ -8584,6 +8562,10 @@ class OrganizationPage {
         await submitButton.click();
         await test.expect(submitButton).toBeHidden({ timeout: 35_000 });
     };
+    dismissAuthenticatorSetupPromptIfPresent = async () => {
+        const maybeLaterButton = this.page.getByTestId(LOGIN_SELECTORS.authenticatorAppLaterButton);
+        (await maybeLaterButton.isVisible()) && (await maybeLaterButton.click());
+    };
     createOrganization = async ({ email, businessName, subdomainName, firstName, lastName, appName, }) => {
         if (shouldSkipSetupAndTeardown())
             return;
@@ -8727,11 +8709,13 @@ class OrganizationPage {
         }
         await this.fillEmailAndSubmit(email, loginTimeout);
         await this.fillOTP();
+        await this.dismissAuthenticatorSetupPromptIfPresent();
     };
     loginWithFastmailEmail = async ({ email, loginTimeout = 2 * 60 * 1000, fetchOtpFromEmail, }) => {
         await this.fillEmailAndSubmit(email, loginTimeout);
         const otp = await fetchOtpFromEmail({ email, timeout: 4 * 60 * 1000 });
         await this.fillOTP(otp);
+        await this.dismissAuthenticatorSetupPromptIfPresent();
     };
     setupProfile = async ({ firstName = faker.faker.person.firstName(), lastName = faker.faker.person.lastName(), country, } = {}) => {
         if (IS_DEV_ENV)
@@ -60309,10 +60293,10 @@ const hexToRGB = (hex) => {
 
 class RailsEmailUtils {
     neetoPlaywrightUtilities;
-    railsEmailRakeClient;
+    railsEmailClient;
     constructor(neetoPlaywrightUtilities) {
         this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
-        this.railsEmailRakeClient = new RailsEmailRakeClient();
+        this.railsEmailClient = new RailsEmailApiClient();
     }
     convertRailsEmailToFormattedList = (railsEmail) => {
         if (!railsEmail)
@@ -60363,11 +60347,11 @@ class RailsEmailUtils {
             blobId: "",
         };
     };
-    clearEmails = () => this.railsEmailRakeClient.clearEmails();
-    getLatestEmail = (searchParams) => this.railsEmailRakeClient.getLatestEmail(searchParams);
-    listEmails = (searchParams) => this.railsEmailRakeClient.listEmails(searchParams);
+    clearEmails = () => this.railsEmailClient.clearEmails();
+    getLatestEmail = (searchParams) => this.railsEmailClient.getLatestEmail(searchParams);
+    listEmails = (searchParams) => this.railsEmailClient.listEmails(searchParams);
     listMessages = async (messageSearchCriteria = {}, { receivedAfter = new Date(new Date().valueOf() - 60 * 60 * 1000), } = {}) => {
-        const emails = await this.railsEmailRakeClient.listEmails({
+        const emails = await this.railsEmailClient.listEmails({
             ...messageSearchCriteria,
             receivedAfter: receivedAfter.toISOString(),
         });
@@ -60378,7 +60362,7 @@ class RailsEmailUtils {
     findMessage = async (messageSearchCriteria = {}, { timeout = 10_000, receivedAfter = new Date(new Date().valueOf() - 60 * 60 * 1000), expectedEmailCount = 1, } = {}, shouldThrowErrorOnTimeout = true) => {
         const email = (await this.neetoPlaywrightUtilities.executeRecursively({
             callback: async () => {
-                const railsEmail = await this.railsEmailRakeClient.getLatestEmail({
+                const railsEmail = await this.railsEmailClient.getLatestEmail({
                     ...messageSearchCriteria,
                     receivedAfter: receivedAfter.toISOString(),
                 });
@@ -60387,7 +60371,7 @@ class RailsEmailUtils {
                 return this.convertRailsEmailToFormattedList(railsEmail);
             },
             condition: async () => {
-                const emails = await this.railsEmailRakeClient.listEmails({
+                const emails = await this.railsEmailClient.listEmails({
                     ...messageSearchCriteria,
                     receivedAfter: receivedAfter.toISOString(),
                 });
@@ -60406,7 +60390,7 @@ class RailsEmailUtils {
     findOtpFromEmail = async ({ email, subjectSubstring = OTP_EMAIL_PATTERN, timeout = 10_000, receivedAfter = new Date(), expectedEmailCount = 1, }) => {
         const otp = await this.neetoPlaywrightUtilities.executeRecursively({
             callback: async () => {
-                const railsEmail = await this.railsEmailRakeClient.getLatestEmail({
+                const railsEmail = await this.railsEmailClient.getLatestEmail({
                     to: email,
                     subject: subjectSubstring,
                     receivedAfter: receivedAfter.toISOString(),
@@ -60419,7 +60403,7 @@ class RailsEmailUtils {
                 return formattedEmail.html.codes?.[0] || formattedEmail.text.codes?.[0];
             },
             condition: async () => {
-                const emails = await this.railsEmailRakeClient.listEmails({
+                const emails = await this.railsEmailClient.listEmails({
                     to: email,
                     subject: subjectSubstring,
                     receivedAfter: receivedAfter.toISOString(),
@@ -60433,7 +60417,7 @@ class RailsEmailUtils {
     getEmailAttachment = async (attachmentName, messageSearchCriteria = {}, { receivedAfter = new Date(new Date().valueOf() - 60 * 60 * 1000), expectedEmailCount = 1, timeout = 10_000, } = {}, shouldThrowErrorOnTimeout = true) => {
         const attachmentDetails = (await this.neetoPlaywrightUtilities.executeRecursively({
             callback: async () => {
-                const railsEmail = await this.railsEmailRakeClient.getLatestEmail({
+                const railsEmail = await this.railsEmailClient.getLatestEmail({
                     ...messageSearchCriteria,
                     receivedAfter: receivedAfter.toISOString(),
                 });
@@ -60450,7 +60434,7 @@ class RailsEmailUtils {
                 };
             },
             condition: async () => {
-                const emails = await this.railsEmailRakeClient.listEmails({
+                const emails = await this.railsEmailClient.listEmails({
                     ...messageSearchCriteria,
                     receivedAfter: receivedAfter.toISOString(),
                 });
@@ -107252,7 +107236,35 @@ class ColorPickerUtils {
     };
 }
 
+const STATIC_ASSET_PATTERN = /\.(js|css|woff2?|ttf|eot|png|svg|ico|gif|webp)(\?.*)?$/;
+const assetCache = new Map();
 const commands = {
+    context: async ({ context }, use) => {
+        if (IS_DEV_ENV) {
+            await context.route(STATIC_ASSET_PATTERN, async (route) => {
+                const url = route.request().url();
+                const hit = assetCache.get(url);
+                if (hit)
+                    return route.fulfill(hit);
+                try {
+                    const response = await route.fetch();
+                    const body = await response.body();
+                    const entry = {
+                        body,
+                        status: response.status(),
+                        headers: response.headers(),
+                    };
+                    if (response.ok())
+                        assetCache.set(url, entry);
+                    return route.fulfill(entry);
+                }
+                catch {
+                    return route.continue();
+                }
+            });
+        }
+        await use(context);
+    },
     neetoPlaywrightUtilities: async ({ page, request, baseURL }, use) => {
         const commands = new CustomCommands(page, request, baseURL);
         await use(commands);
@@ -124970,6 +124982,31 @@ const generatePhoneNumberDetails = () => {
     return { flag: country.flag, name: country.name, code: country.code, number };
 };
 
+const DEFAULT_WARMUP_URLS = ["/login"];
+async function warmup({ urls = DEFAULT_WARMUP_URLS, timeout = 60_000, } = {}) {
+    if (!IS_DEV_ENV)
+        return;
+    const { RAILS_SERVER_PORT, SUBDOMAIN = "spinkart" } = process.env;
+    if (!RAILS_SERVER_PORT) {
+        throw new Error("RAILS_SERVER_PORT is not defined in environment variables.");
+    }
+    const baseURL = `http://${SUBDOMAIN}.lvh.me:${RAILS_SERVER_PORT}`;
+    const browser = await test.chromium.launch();
+    const page = await browser.newPage();
+    try {
+        for (const url of urls) {
+            const fullUrl = url.startsWith("http") ? url : `${baseURL}${url}`;
+            await page.goto(fullUrl, {
+                waitUntil: "networkidle", // eslint-disable-line playwright/no-networkidle
+                timeout,
+            });
+        }
+    }
+    finally {
+        await browser.close();
+    }
+}
+
 const CONFIG = {
     DIR: "/tmp/neeto-auth-web",
     LOG: "/tmp/neeto-auth-server.log",
@@ -125985,7 +126022,7 @@ exports.PROJECT_NAMES = PROJECT_NAMES;
 exports.PROJECT_TRANSLATIONS_PATH = PROJECT_TRANSLATIONS_PATH;
 exports.ROLES_SELECTORS = ROLES_SELECTORS;
 exports.ROUTES = ROUTES;
-exports.RailsEmailRakeClient = RailsEmailRakeClient;
+exports.RailsEmailApiClient = RailsEmailApiClient;
 exports.RailsEmailUtils = RailsEmailUtils;
 exports.RoleApis = RoleApis;
 exports.RolesPage = RolesPage;
@@ -126087,5 +126124,6 @@ exports.stealthTest = stealth;
 exports.tableUtils = tableUtils;
 exports.toCamelCase = toCamelCase;
 exports.updateCredentials = updateCredentials;
+exports.warmup = warmup;
 exports.writeDataToFile = writeDataToFile;
 //# sourceMappingURL=index.cjs.js.map