@bigbinary/neeto-playwright-commons 1.4.6 → 1.5.0

package/index.d.ts

@@ -1,5 +1,6 @@
 import * as _playwright_test from '@playwright/test';
 import { Page, APIRequestContext, Response, APIResponse, Fixtures, PlaywrightWorkerArgs, PlaywrightWorkerOptions, PlaywrightTestArgs, PlaywrightTestOptions } from '@playwright/test';
+import MailosaurClient from 'mailosaur';
 import { I18nPlaywrightFixture } from 'playwright-i18next-fixture';
 
 interface InterceptMultipleResponsesParams {
@@ -49,9 +50,26 @@ declare class CustomCommands {
     verifyFieldValue: VerifyFieldValue;
 }
 
+interface FetchOtpFromEmailFilterParameters {
+    email: string;
+    subjectSubstring?: string;
+    timeout?: number;
+    receivedAfter?: Date;
+}
+type FetchOtpFromEmail = (props: FetchOtpFromEmailFilterParameters) => Promise<string | undefined>;
+declare class MailosaurUtils {
+    mailosaur: MailosaurClient;
+    serverId: string;
+    constructor(mailosaur: MailosaurClient);
+    fetchOtpFromEmail: FetchOtpFromEmail;
+    generateRandomMailosaurEmail: () => string;
+}
+
 interface CustomFixture {
     neetoPlaywrightUtilities: CustomCommands;
     page: Page;
+    mailosaur: MailosaurClient;
+    mailosaurUtils: MailosaurUtils;
 }
 type Commands = Fixtures<CustomFixture, PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 declare const commands: Commands;
@@ -100,6 +118,7 @@ declare const CREDENTIALS: {
     email: string;
     password: string;
 };
+declare const OTP_EMAIL_PATTERN = "is your login code";
 
 declare const BASE_URL = "/api/v1";
 declare const ROUTES: {
@@ -350,6 +369,11 @@ declare const updateCredentials: UpdateCredentials;
 declare const clearCredentials: ClearCredentials;
 declare const hyphenize: Hyphenize;
 declare const joinHyphenCase: JoinHyphenCase;
+declare const skipTest: {
+    forDevelopmentEnv: () => void;
+    forReviewEnv: () => void;
+    forAllExceptStagingEnv: () => void;
+};
 
 interface LoginProps {
     page: Page;
@@ -373,4 +397,4 @@ interface Overrides {
 }
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
 
-export { BASE_URL, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, IS_STAGING_ENV, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OrganizationPage, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, readFileSyncIfExists, updateCredentials, writeDataToFile };
+export { BASE_URL, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, IS_STAGING_ENV, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, readFileSyncIfExists, skipTest, updateCredentials, writeDataToFile };

package/index.js

@@ -1,6 +1,9 @@
-import { expect, defineConfig, devices } from '@playwright/test';
+import test, { expect, defineConfig, devices } from '@playwright/test';
 import * as require$$0 from 'fs';
 import require$$0__default from 'fs';
+import { faker } from '@faker-js/faker';
+import { isNil, isNotNil, mergeDeepLeft, mergeAll } from 'ramda';
+import MailosaurClient from 'mailosaur';
 import dayjs from 'dayjs';
 import { getI18nInstance, initI18n } from 'playwright-i18next-fixture';
 import require$$2 from 'os';
@@ -8,7 +11,6 @@ import require$$0$1 from 'path';
 import require$$0$2 from 'util';
 import require$$0$3 from 'stream';
 import require$$0$4 from 'events';
-import { mergeDeepLeft, mergeAll } from 'ramda';
 import require$$3 from 'crypto';
 
 const ENVIRONMENT = {
@@ -25,7 +27,9 @@ const CREDENTIALS = {
     email: "oliver@example.com",
     password: "welcome",
 };
+const OTP_EMAIL_PATTERN = "is your login code";
 
+/* eslint-disable playwright/no-skipped-test */
 const joinString = (string1, string2, string3 = "", separator = " ") => {
     if (string3 === "") {
         return string1 + separator + string2;
@@ -75,6 +79,11 @@ const hyphenize = input => {
     return fallbackString;
 };
 const joinHyphenCase = (...args) => args.join(" ").replace(/\s+/g, "-").toLowerCase();
+const skipTest = {
+    forDevelopmentEnv: () => test.skip(process.env.TEST_ENV === ENVIRONMENT.development),
+    forReviewEnv: () => test.skip(process.env.TEST_ENV === ENVIRONMENT.review),
+    forAllExceptStagingEnv: () => test.skip(process.env.TEST_ENV !== ENVIRONMENT.staging),
+};
 
 const COMMON_SELECTORS = {
     spinner: ".neeto-ui-spinner",
@@ -208,16 +217,53 @@ class CustomCommands {
     }
 }
 
+class MailosaurUtils {
+    constructor(mailosaur) {
+        this.fetchOtpFromEmail = async ({ email, subjectSubstring = OTP_EMAIL_PATTERN, timeout = 2 * 60 * 1000, receivedAfter = new Date(), }) => {
+            var _a, _b, _c;
+            const receivedEmail = await this.mailosaur.messages.get(this.serverId, { sentTo: email, subject: subjectSubstring }, { timeout, receivedAfter });
+            const otp = (_c = (_b = (_a = receivedEmail === null || receivedEmail === void 0 ? void 0 : receivedEmail.text) === null || _a === void 0 ? void 0 : _a.codes) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.value;
+            if (isNil(otp)) {
+                throw new Error(`No codes found in the email with subject: ${receivedEmail.subject}. Please re-evaluate the filtering parameters.`);
+            }
+            return otp;
+        };
+        this.generateRandomMailosaurEmail = () => faker.internet.email({ provider: `${this.serverId}.mailosaur.net` });
+        this.mailosaur = mailosaur;
+        if (isNotNil(process.env.MAILOSAUR_SERVER_ID)) {
+            this.serverId = process.env.MAILOSAUR_SERVER_ID;
+        }
+        else {
+            throw new Error("ENV variable MAILOSAUR_SERVER_ID is not defined. Please add the Server ID to use this method. Please visit https://mailosaur.com/app/servers to find the Server ID.");
+        }
+    }
+}
+
 const commands = {
     neetoPlaywrightUtilities: async ({ page, request }, use) => {
         const commands = new CustomCommands(page, request);
         await use(commands);
     },
+    mailosaur: async ({}, use) => {
+        skipTest.forAllExceptStagingEnv();
+        if (isNotNil(process.env.MAILOSAUR_API_KEY)) {
+            const mailosaur = new MailosaurClient(process.env.MAILOSAUR_API_KEY);
+            await use(mailosaur);
+        }
+        else {
+            throw new Error("ENV variable MAILOSAUR_API_KEY is not defined. Please add the API key to use this fixture. Please visit https://mailosaur.com/app/account/keys to find the API key.");
+        }
+    },
     page: async ({ page }, use) => {
         await page.goto("/");
         await page.waitForLoadState();
         await use(page);
     },
+    mailosaurUtils: async ({ mailosaur }, use) => {
+        skipTest.forAllExceptStagingEnv();
+        const mailosaurUtils = new MailosaurUtils(mailosaur);
+        await use(mailosaurUtils);
+    },
 };
 
 const generateStagingData = (product = "invoice") => {
@@ -1427,7 +1473,7 @@ const append = (queue = '', stash = '', enclose = false) => {
   return utils$g.flatten(result);
 };
 
-const expand$1 = (ast, options = {}) => {
+const expand$2 = (ast, options = {}) => {
   let rangeLimit = options.rangeLimit === void 0 ? 1000 : options.rangeLimit;
 
   let walk = (node, parent = {}) => {
@@ -1507,7 +1553,7 @@ const expand$1 = (ast, options = {}) => {
   return utils$g.flatten(walk(ast));
 };
 
-var expand_1 = expand$1;
+var expand_1 = expand$2;
 
 var constants$4 = {
   MAX_LENGTH: 1024 * 64,
@@ -1896,7 +1942,7 @@ var parse_1$1 = parse$4;
 
 const stringify = stringify$4;
 const compile = compile_1;
-const expand = expand_1;
+const expand$1 = expand_1;
 const parse$3 = parse_1$1;
 
 /**
@@ -2016,7 +2062,7 @@ braces$1.expand = (input, options = {}) => {
     input = braces$1.parse(input, options);
   }
 
-  let result = expand(input, options);
+  let result = expand$1(input, options);
 
   // filter out empty strings if specified
   if (options.noempty === true) {
@@ -7407,12 +7453,12 @@ const loginWithoutSSO = async ({ page, neetoPlaywrightUtilities, loginPath = "/"
 const login = async ({ page, neetoPlaywrightUtilities, loginPath, }) => !IS_STAGING_ENV &&
     (await loginWithoutSSO({ page, neetoPlaywrightUtilities, loginPath }));
 
-var main$1 = {exports: {}};
+var main$2 = {exports: {}};
 
 var name = "dotenv";
 var version$1 = "16.3.1";
 var description = "Loads environment variables from .env file";
-var main = "lib/main.js";
+var main$1 = "lib/main.js";
 var types = "lib/main.d.ts";
 var exports = {
 	".": {
@@ -7475,7 +7521,7 @@ var require$$4 = {
 	name: name,
 	version: version$1,
 	description: description,
-	main: main,
+	main: main$1,
 	types: types,
 	exports: exports,
 	scripts: scripts,
@@ -7794,21 +7840,108 @@ const DotenvModule = {
   populate
 };
 
-main$1.exports.configDotenv = DotenvModule.configDotenv;
-main$1.exports._configVault = DotenvModule._configVault;
-main$1.exports._parseVault = DotenvModule._parseVault;
-main$1.exports.config = DotenvModule.config;
-main$1.exports.decrypt = DotenvModule.decrypt;
-main$1.exports.parse = DotenvModule.parse;
-main$1.exports.populate = DotenvModule.populate;
+main$2.exports.configDotenv = DotenvModule.configDotenv;
+main$2.exports._configVault = DotenvModule._configVault;
+main$2.exports._parseVault = DotenvModule._parseVault;
+main$2.exports.config = DotenvModule.config;
+main$2.exports.decrypt = DotenvModule.decrypt;
+main$2.exports.parse = DotenvModule.parse;
+main$2.exports.populate = DotenvModule.populate;
+
+main$2.exports = DotenvModule;
+
+var main = {};
+
+// like String.prototype.search but returns the last index
+function _searchLast (str, rgx) {
+  const matches = Array.from(str.matchAll(rgx));
+  return matches.length > 0 ? matches.slice(-1)[0].index : -1
+}
+
+function _interpolate (envValue, environment, config) {
+  // find the last unescaped dollar sign in the
+  // value so that we can evaluate it
+  const lastUnescapedDollarSignIndex = _searchLast(envValue, /(?!(?<=\\))\$/g);
+
+  // If we couldn't match any unescaped dollar sign
+  // let's return the string as is
+  if (lastUnescapedDollarSignIndex === -1) return envValue
 
-main$1.exports = DotenvModule;
+  // This is the right-most group of variables in the string
+  const rightMostGroup = envValue.slice(lastUnescapedDollarSignIndex);
+
+  /**
+   * This finds the inner most variable/group divided
+   * by variable name and default value (if present)
+   * (
+   *   (?!(?<=\\))\$        // only match dollar signs that are not escaped
+   *   {?                   // optional opening curly brace
+   *     ([\w]+)            // match the variable name
+   *     (?::-([^}\\]*))?   // match an optional default value
+   *   }?                   // optional closing curly brace
+   * )
+   */
+  const matchGroup = /((?!(?<=\\))\${?([\w]+)(?::-([^}\\]*))?}?)/;
+  const match = rightMostGroup.match(matchGroup);
+
+  if (match != null) {
+    const [, group, variableName, defaultValue] = match;
+
+    return _interpolate(
+      envValue.replace(
+        group,
+        environment[variableName] ||
+          defaultValue ||
+          config.parsed[variableName] ||
+          ''
+      ),
+      environment,
+      config
+    )
+  }
+
+  return envValue
+}
+
+function _resolveEscapeSequences (value) {
+  return value.replace(/\\\$/g, '$')
+}
+
+function expand (config) {
+  // if ignoring process.env, use a blank object
+  const environment = config.ignoreProcessEnv ? {} : process.env;
+
+  for (const configKey in config.parsed) {
+    const value = Object.prototype.hasOwnProperty.call(environment, configKey)
+      ? environment[configKey]
+      : config.parsed[configKey];
+
+    config.parsed[configKey] = _resolveEscapeSequences(
+      _interpolate(value, environment, config)
+    );
+  }
+
+  for (const processKey in config.parsed) {
+    environment[processKey] = config.parsed[processKey];
+  }
+
+  return config
+}
+
+main.expand = expand;
 
 // @ts-check
 var _a, _b;
-main$1.exports.config({
+const env = main$2.exports.config({
     path: `./e2e/config/.env.${(_a = process.env.TEST_ENV) !== null && _a !== void 0 ? _a : "development"}`,
 });
+main.expand(env);
+if (require$$0.existsSync("./e2e/config/.env.local")) {
+    const localEnv = main$2.exports.config({
+        path: "./e2e/config/.env.local",
+    });
+    main.expand(localEnv);
+}
 const currentsConfig = {
     ciBuildId: process.env.NEETO_CI_JOB_ID,
     recordKey: "PVHNwxEOySsdAeTc",
@@ -7822,7 +7955,7 @@ const definePlaywrightConfig = (overrides) => {
         fullyParallel: true,
         forbidOnly: isCI,
         retries: isCI ? 1 : 0,
-        timeout: 0,
+        timeout: 5 * 60 * 1000,
         reporter: isCI
             ? [["@currents/playwright", { ...currentsConfig, ...currentsOverrides }]]
             : [["line"]],
@@ -7854,5 +7987,5 @@ const definePlaywrightConfig = (overrides) => {
     });
 };
 
-export { BASE_URL, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, IS_STAGING_ENV, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OrganizationPage, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, readFileSyncIfExists, updateCredentials, writeDataToFile };
+export { BASE_URL, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, IS_STAGING_ENV, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, readFileSyncIfExists, skipTest, updateCredentials, writeDataToFile };
 //# sourceMappingURL=index.js.map