@bigbinary/neeto-playwright-commons 1.12.10 → 1.13.0

package/index.d.ts

@@ -85,9 +85,10 @@ declare class CustomCommands {
   responses: string[];
   request: APIRequestContext;
   baseURL: string | undefined;
-  csrfToken: string | null;
+  csrfToken: string | null | undefined;
   constructor(page: Page, request: APIRequestContext, baseURL?: string | undefined);
   private waitUntilTimeout;
+  private initializeCsrfToken;
   /**
    *
    * Command to wait until a response with URL responseUrl is found. Optionally,
@@ -719,7 +720,7 @@ declare const generateStagingData: (product?: string) => {
   email: string;
 };
 declare const _default: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & Browser, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions>;
-declare const i18nFixture: Fixtures<I18nPlaywrightFixture, PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+declare const i18nFixture: Fixtures<PlaywrightTestArgs & PlaywrightTestOptions, I18nPlaywrightFixture, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 declare class ThankYouPage {
   page: Page;
   neetoPlaywrightUtilities: CustomCommands;
@@ -1683,19 +1684,22 @@ declare class WebhooksPage {
     ...fieldsToBeVerified
   }: VerifyWebhookDeliveryByEventParams) => Promise<void>;
 }
+interface ZapierPageInitializer {
+  page: Page;
+  neetoPlaywrightUtilities: CustomCommands;
+  integrationRouteIndex?: string;
+  mailerUtils: MailerUtils;
+}
 declare class ZapierPage extends IntegrationBase {
   zapierWebPage: Page;
-  mailosaur: MailosaurClient;
   continueButton: Locator;
+  mailerUtils: MailerUtils;
   constructor({
     page,
     neetoPlaywrightUtilities,
-    integrationRouteIndex
-  }: {
-    page: Page;
-    neetoPlaywrightUtilities: CustomCommands;
-    integrationRouteIndex?: string;
-  });
+    integrationRouteIndex,
+    mailerUtils
+  }: ZapierPageInitializer);
   /**
    *
    * Logs into zapier web app. It takes the following parameters:
@@ -1771,7 +1775,7 @@ declare class ZapierPage extends IntegrationBase {
     submittedEmail: string;
     zapTriggeredAfter: Date;
     productName: string;
-  }) => Promise<mailosaur_lib_models.Message>;
+  }) => Promise<FormattedList | Record<string, never>>;
   /**
    *
    * Skips test if Zapier task limit is exhausted.

package/index.js

@@ -3,7 +3,7 @@ import fs__default, { readFileSync, writeFileSync as writeFileSync$1, unlinkSync
 import * as Path from 'path';
 import Path__default from 'path';
 import { execSync } from 'child_process';
-import test$1, { expect, test as test$2, defineConfig, devices } from '@playwright/test';
+import test$1, { expect, test as test$2, chromium as chromium$1, defineConfig, devices } from '@playwright/test';
 import { curry, not, isEmpty as isEmpty$1, pluck, isNil, isNotNil, mergeDeepLeft, mergeAll } from 'ramda';
 import require$$0$1 from 'util';
 import { faker } from '@faker-js/faker';
@@ -111,7 +111,7 @@ const CREDENTIALS = {
 };
 const OTP_EMAIL_PATTERN = "is your login code";
 const SLACK_DEFAULT_CHANNEL = "general";
-const ZAPIER_TEST_EMAIL = (product) => `neeto-${product}-zapier-test@${process.env.INTEGRATION_MAILOSAUR_SERVER_ID}.mailosaur.net`;
+const ZAPIER_TEST_EMAIL = (product) => `neeto-${product}-zapier-test@${process.env.FASTMAIL_DOMAIN_NAME}`;
 // constants for translation
 const SINGULAR = { count: 1 };
 const PLURAL = { count: 2 };
@@ -3451,6 +3451,12 @@ const getImagePathAndName = (localImagePath) => {
 class CustomCommands {
     constructor(page, request, baseURL = process.env.BASE_URL) {
         this.waitUntilTimeout = (timeout) => new Promise(resolve => setTimeout(resolve, timeout));
+        this.initializeCsrfToken = async () => {
+            this.csrfToken = await this.page
+                .locator("[name='csrf-token']")
+                .getAttribute("content");
+            return this.csrfToken;
+        };
         this.interceptMultipleResponses = ({ responseUrl = "", responseStatus = 200, times = 1, baseUrl, customPageContext, timeout = 35000, } = {}) => {
             const pageContext = customPageContext !== null && customPageContext !== void 0 ? customPageContext : this.page;
             return Promise.all([...new Array(times)].map(() => pageContext.waitForResponse((response) => {
@@ -3533,12 +3539,13 @@ class CustomCommands {
         };
         this.apiRequest = async ({ url, failOnStatusCode = true, headers: additionalHeaders, body: data, method = "get", params = {}, ...otherOptions }) => {
             var _a;
+            const csrfToken = (_a = this.csrfToken) !== null && _a !== void 0 ? _a : (await this.initializeCsrfToken());
             const requestOptions = {
                 failOnStatusCode,
                 headers: {
                     ...additionalHeaders,
                     "accept-encoding": "gzip",
-                    "x-csrf-token": (_a = this.csrfToken) !== null && _a !== void 0 ? _a : "",
+                    "x-csrf-token": csrfToken !== null && csrfToken !== void 0 ? csrfToken : "",
                 },
                 data,
                 ...otherOptions,
@@ -3628,13 +3635,6 @@ class CustomCommands {
         this.responses = [];
         this.request = request;
         this.baseURL = baseURL;
-        this.page
-            .locator("[name='csrf-token']")
-            .getAttribute("content")
-            .then(csrfToken => {
-            this.csrfToken = csrfToken;
-        }, reason => console.error(reason) // eslint-disable-line
-        );
     }
 }
 
@@ -11621,6 +11621,32 @@ class FastmailApi {
     }
 }
 
+const basicHTMLContent = (content) => `
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width" />
+  </head>
+  <body>
+    ${content}
+  </body>
+</html>`;
+const hexToRGB = (hex) => {
+    let r = "", g = "", b = "";
+    if (hex.length === 4) {
+        r = `0x${hex[1]}${hex[1]}`;
+        g = `0x${hex[2]}${hex[2]}`;
+        b = `0x${hex[3]}${hex[3]}`;
+    }
+    else if (hex.length === 7) {
+        r = `0x${hex[1]}${hex[2]}`;
+        g = `0x${hex[3]}${hex[4]}`;
+        b = `0x${hex[5]}${hex[6]}`;
+    }
+    return `rgb(${Number(r)}, ${Number(g)}, ${Number(b)})`;
+};
+
 const dateTimeOneHourAgo = () => new Date(new Date().valueOf() - 60 * 60 * 1000);
 class MailerUtils {
     constructor(neetoPlaywrightUtilities) {
@@ -11661,7 +11687,10 @@ class MailerUtils {
                     body: emailBody,
                     ...contentRecognitions,
                 };
-                const document = new DOMParser().parseFromString(emailBody, "text/html").documentElement;
+                const wrappedHtml = /<html[\s>]/i.test(emailBody)
+                    ? emailBody
+                    : basicHTMLContent(emailBody);
+                const document = new DOMParser().parseFromString(wrappedHtml, "text/html").documentElement;
                 const text = {
                     body: ((_a = document === null || document === void 0 ? void 0 : document.getElementsByTagName("body")[0].textContent) === null || _a === void 0 ? void 0 : _a.trim()) || "",
                     ...contentRecognitions,
@@ -20689,8 +20718,9 @@ const mergeTaxonomies = async (translations, page) => {
 
 const i18nFixture = {
     i18n: [
-        async ({ page }, use) => {
+        async ({}, use) => {
             const translation = readTranslations();
+            const page = await (await chromium$1.launch()).newPage();
             const taxonomies = await mergeTaxonomies(translation, page);
             const options = {
                 debug: false,
@@ -20720,17 +20750,19 @@ const i18nFixture = {
             const i18nInitialized = await initI18n({
                 plugins: [removeTagsProcessor, sentenceCaseProcessor],
                 options,
-                // Fetch translations in every test or fetch once
                 cache: true,
             });
+            await page.close();
             await use(i18nInitialized);
         },
-        // Run as auto fixture to be available through all tests by getI18nInstance()
-        { auto: true },
+        { auto: true, scope: "worker" },
+    ],
+    t: [
+        async ({ i18n }, use) => {
+            await use(i18n.t);
+        },
+        { scope: "worker" },
     ],
-    t: async ({ i18n }, use) => {
-        await use(i18n.t);
-    },
 };
 
 const THANK_YOU_SELECTORS = {
@@ -20923,32 +20955,6 @@ const EMBED_SELECTORS = {
     previewElementPopupButton: "preview-element-popup-button",
 };
 
-const basicHTMLContent = (content) => `
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width" />
-  </head>
-  <body>
-    ${content}
-  </body>
-</html>`;
-const hexToRGB = (hex) => {
-    let r = "", g = "", b = "";
-    if (hex.length === 4) {
-        r = `0x${hex[1]}${hex[1]}`;
-        g = `0x${hex[2]}${hex[2]}`;
-        b = `0x${hex[3]}${hex[3]}`;
-    }
-    else if (hex.length === 7) {
-        r = `0x${hex[1]}${hex[2]}`;
-        g = `0x${hex[3]}${hex[4]}`;
-        b = `0x${hex[5]}${hex[6]}`;
-    }
-    return `rgb(${Number(r)}, ${Number(g)}, ${Number(b)})`;
-};
-
 class EmbedBase {
     constructor({ context, page, neetoPlaywrightUtilities, appName, }) {
         this.initializeEmbedPage = async ({ embedType, embedCode, customElementText = "Click here", }) => {
@@ -23769,7 +23775,7 @@ const ZAPIER_SELECTORS = {
 };
 
 class ZapierPage extends IntegrationBase {
-    constructor({ page, neetoPlaywrightUtilities, integrationRouteIndex, }) {
+    constructor({ page, neetoPlaywrightUtilities, integrationRouteIndex, mailerUtils, }) {
         super({
             page,
             integration: "zapier",
@@ -23910,7 +23916,7 @@ class ZapierPage extends IntegrationBase {
                 timeout: 10000,
             });
         };
-        this.verifyZapIsTriggered = ({ productName, submittedEmail, zapTriggeredAfter, }) => this.mailosaur.messages.get(process.env.INTEGRATION_MAILOSAUR_SERVER_ID, { sentTo: ZAPIER_TEST_EMAIL(productName), body: submittedEmail }, { timeout: 5 * 60000, receivedAfter: zapTriggeredAfter });
+        this.verifyZapIsTriggered = ({ productName, submittedEmail, zapTriggeredAfter, }) => this.mailerUtils.findMessage({ to: ZAPIER_TEST_EMAIL(productName), body: submittedEmail }, { timeout: 2 * 60000, receivedAfter: zapTriggeredAfter });
         this.skipIfTaskLimitIsExhausted = async () => {
             var _a;
             // Zapier provides 100 free task limit for free account; skip test if it's exhausted
@@ -23962,16 +23968,12 @@ class ZapierPage extends IntegrationBase {
             });
             await this.verifyIntegrationStatus("disconnected");
         };
-        if (isNil(process.env.INTEGRATION_MAILOSAUR_API_KEY) ||
-            isNil(process.env.INTEGRATION_MAILOSAUR_SERVER_ID)) {
-            throw new Error("ENV variable INTEGRATION_MAILOSAUR_API_KEY or INTEGRATION_MAILOSAUR_SERVER_ID is not properly configured");
-        }
         if (isNil(process.env.ZAPIER_LOGIN_PASSWORD) ||
             isNil(process.env.ZAPIER_LOGIN_EMAIL) ||
             isNil(process.env.ZAP_ID)) {
             throw new Error("ENV variable ZAPIER_LOGIN_PASSWORD or ZAPIER_LOGIN_EMAIL or ZAP_ID is not properly configured");
         }
-        this.mailosaur = new MailosaurClient(process.env.INTEGRATION_MAILOSAUR_API_KEY);
+        this.mailerUtils = mailerUtils;
     }
 }