feat: add hidden browser window for execution [INS-3378]

packages/insomnia-smoke-test/playwright/test.ts

@@ -2,6 +2,7 @@
 import { ElectronApplication, test as baseTest, TraceMode } from '@playwright/test';
 import path from 'path';
 
+import { getLoadedPage } from '../playwright/utils';
 import {
   bundleType,
   cwd,
@@ -96,18 +97,18 @@ export const test = baseTest.extend<{
 
     await electronApp.close();
   },
-  page: async ({ app }, use) => {
-    const page = await app.firstWindow();
-
-    await page.waitForLoadState();
 
+  page: async ({ app }, use) => {
+    const page = await getLoadedPage(app, 'Insomnia');
     await use(page);
   },
+
   dataPath: async ({ }, use) => {
     const insomniaDataPath = randomDataPath();
 
     await use(insomniaDataPath);
   },
+
   userConfig: async ({ }, use) => {
     await use({
       skipOnboarding: true,

packages/insomnia-smoke-test/playwright/utils.ts

@@ -0,0 +1,36 @@
+import { ElectronApplication } from '@playwright/test';
+
+import config from '../playwright.config';
+
+export async function getLoadedPage(app: ElectronApplication, pageHTMLTitle: string) {
+    const pollingInterval = 500;
+    const timeoutMs = config.timeout;
+
+    if (!timeoutMs) {
+        throw Error('timeout is undefined in playwright.config.ts, probably the config is modifed.');
+    }
+
+    const targetPage = await (async () => {
+        for (let i = 0; i < timeoutMs / pollingInterval; i++) {
+            const pages = app.windows();
+
+            for (const page of pages) {
+                const pageTitle = await page.title();
+                if (pageTitle === pageHTMLTitle) {
+                    return page;
+                }
+            }
+
+            await new Promise(resolve => setTimeout(resolve, pollingInterval));
+        }
+
+        return undefined;
+    })();
+
+    if (!targetPage) {
+        throw Error(`page (${pageHTMLTitle}) is not loaded until ${timeoutMs}ms, please manually launch app and check why`);
+    }
+
+    await targetPage.waitForLoadState();
+    return targetPage;
+};

packages/insomnia-smoke-test/tests/smoke/git-sync.test.ts

@@ -1,4 +1,5 @@
 import { test } from '../../playwright/test';
+
 test('Clone from github', async ({ page }) => {
   await page.getByLabel('Clone git repository').click();
   await page.getByRole('tab', { name: ' Git' }).click();
@@ -8,8 +9,10 @@ test('Clone from github', async ({ page }) => {
   await page.getByPlaceholder('MyUser').fill('J');
   await page.getByPlaceholder('88e7ee63b254e4b0bf047559eafe86ba9dd49507').fill('J');
   await page.getByTestId('git-repository-settings-modal__sync-btn').click();
+
   await page.getByLabel('Toggle preview').click();
 });
+
 test('Sign in with GitHub', async ({ app, page }) => {
   await page.getByRole('button', { name: 'New Document' }).click();
   await page.getByRole('dialog').getByRole('button', { name: 'Create' }).click();
@@ -22,11 +25,22 @@ test('Sign in with GitHub', async ({ app, page }) => {
   // and return the url that would be created by following the GitHub OAuth flow.
   // https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps#web-application-flow
   const fakeGitHubOAuthWebFlow = app.evaluate(electron => {
-    return new Promise<{ redirectUrl: string }>(resolve => {
-      const webContents = electron.BrowserWindow.getAllWindows()[0].webContents;
+    return new Promise<{ redirectUrl: string }>((resolve, reject) => {
+
+      const wins = electron.BrowserWindow.getAllWindows();
+      let mainWin = undefined;
+      for (let i = 0; i < wins.length; i++) {
+        mainWin = wins[i].title === 'Insomnia' ? wins[i] : undefined;
+      }
+      if (!mainWin) {
+        reject('main window is not found, probably the title of the mainWindow is modified or it is not started');
+      }
+
+      const webContents = mainWin?.webContents;
+
       // Remove all navigation listeners so that only the one we inject will run
-      webContents.removeAllListeners('will-navigate');
-      webContents.on('will-navigate', (event: Event, url: string) => {
+      webContents?.removeAllListeners('will-navigate');
+      webContents?.on('will-navigate', (event: Event, url: string) => {
         event.preventDefault();
         const parsedUrl = new URL(url);
         // We use the same state parameter that the app created to assert that we prevent CSRF

packages/insomnia-smoke-test/tests/smoke/oauth-gitlab.test.ts

@@ -1,3 +1,5 @@
+import { expect } from '@playwright/test';
+
 import { test } from '../../playwright/test';
 
 test('Sign in with Gitlab', async ({ app, page }) => {
@@ -8,11 +10,21 @@ test('Sign in with Gitlab', async ({ app, page }) => {
   await page.getByRole('tab', { name: 'GitLab' }).click();
 
   const fakeGitLabOAuthWebFlow = app.evaluate(electron => {
-    return new Promise<{ redirectUrl: string }>(resolve => {
-      const webContents = electron.BrowserWindow.getAllWindows()[0].webContents;
+    return new Promise<{ redirectUrl: string }>((resolve, reject) => {
+      const wins = electron.BrowserWindow.getAllWindows();
+      let mainWin = undefined;
+      for (let i = 0; i < wins.length; i++) {
+        mainWin = wins[i].title === 'Insomnia' ? wins[i] : undefined;
+      }
+
+      if (!mainWin) {
+        reject('main window is not found, probably the title of the mainWindow is modified or it is not started');
+      }
+
+      const webContents = mainWin?.webContents;
       // Remove all navigation listeners so that only the one we inject will run
-      webContents.removeAllListeners('will-navigate');
-      webContents.on('will-navigate', (event: Event, url: string) => {
+      webContents?.removeAllListeners('will-navigate');
+      webContents?.on('will-navigate', (event: Event, url: string) => {
         event.preventDefault();
         const parsedUrl = new URL(url);
         // We use the same state parameter that the app created to assert that we prevent CSRF