Merge pull request #6646 from mook-as/e2e/startSlowerDesktop-returns

E2E: utils: fix startSlowerDesktop()

e2e/backend.e2e.spec.ts

@@ -21,10 +21,7 @@ test.describe.serial('KubernetesBackend', () => {
   let page: Page;
 
   test.beforeAll(async() => {
-    const result = await startSlowerDesktop(__filename);
-
-    electronApp = result[0] as ElectronApplication;
-    page = result[1] as Page;
+    [electronApp, page] = await startSlowerDesktop(__filename);
   });
 
   test.afterAll(() => teardown(electronApp, __filename));

e2e/credentials-server.e2e.spec.ts

@@ -225,10 +225,7 @@ describeWithCreds('Credentials server', () => {
 
   test.beforeAll(async() => {
     await tool('rdctl', 'factory-reset', '--verbose');
-    const result = await startSlowerDesktop(__filename, { kubernetes: { enabled: false } });
-
-    electronApp = result[0] as ElectronApplication;
-    page = result[1] as Page;
+    [electronApp, page] = await startSlowerDesktop(__filename, { kubernetes: { enabled: false } });
   });
 
   test.afterAll(async() => {

e2e/extensions.e2e.spec.ts

@@ -61,13 +61,10 @@ test.describe.serial('Extensions', () => {
   }
 
   test.beforeAll(async() => {
-    const result = await startSlowerDesktop(__filename, {
+    [app, page] = await startSlowerDesktop(__filename, {
       containerEngine: { name: ContainerEngine.MOBY },
       kubernetes:      { enabled: false },
     });
-
-    app = result[0] as ElectronApplication;
-    page = result[1] as Page;
   });
 
   test.afterAll(() => teardown(app, __filename));

e2e/rdctl.e2e.spec.ts

@@ -116,10 +116,7 @@ test.describe('Command server', () => {
   test.describe.configure({ mode: 'serial' });
 
   test.beforeAll(async() => {
-    const result = await startSlowerDesktop(__filename, { kubernetes: { enabled: true } });
-
-    electronApp = result[0] as ElectronApplication;
-    page = result[1] as Page;
+    [electronApp, page] = await startSlowerDesktop(__filename, { kubernetes: { enabled: true } });
   });
 
   test.afterAll(() => teardown(electronApp, __filename));

e2e/utils/TestUtils.ts

@@ -354,22 +354,23 @@ export async function retry<T>(proc: () => Promise<T>, options?: { delay?: numbe
 }
 
 export interface startRancherDesktopOptions {
+  /** Whether to use the mock backend; defaults to true. */
   mock?: boolean;
+  /** The environment to use. */
   env?: Record<string, string>;
+  /** Set to false if we want to see the first-run dialog (defaults to true). */
   noModalDialogs?: boolean;
+  /** Maximum time in milliseconds to wait for the app to launch. */
   timeout?: number;
+  /** The name to use for the log; defaults to the test name. */
   logName?: string;
 }
 
 /**
  * Run Rancher Desktop; return promise that resolves to commonly-used
  * playwright objects when it has started.
  * @param testPath The path to the test file.
- * @param options with sub-options:
- *  options.tracing Whether to start tracing (defaults to true).
- *  options.mock Whether to use the mock backend (defaults to true).
- *  options.env The environment to use
- *  options.noModalDialogs Set to false if we want to see the first-run dialog (defaults to true).
+ * @param options Additional options; see type definition for details.
  */
 export async function startRancherDesktop(testPath: string, options?: startRancherDesktopOptions): Promise<ElectronApplication> {
   testInfo = { testPath, startTime: Date.now() };
@@ -380,7 +381,7 @@ export async function startRancherDesktop(testPath: string, options?: startRanch
     // See pkg/rancher-desktop/utils/commandLine.ts before changing the next item as the final option.
     '--disable-dev-shm-usage',
   ];
-  const launchOptions: Record<string, any> = {
+  const launchOptions: Parameters<typeof _electron.launch>[0] = {
     args,
     env: {
       ...process.env,
@@ -390,7 +391,7 @@ export async function startRancherDesktop(testPath: string, options?: startRanch
     },
   };
 
-  if (options?.noModalDialogs ?? false) {
+  if (options?.noModalDialogs ?? true) {
     args.push('--no-modal-dialogs');
   }
   if (options?.timeout) {
@@ -403,7 +404,7 @@ export async function startRancherDesktop(testPath: string, options?: startRanch
   return electronApp;
 }
 
-export async function startSlowerDesktop(filename: string, defaultSettings: RecursivePartial<Settings> = {}): Promise<Array<ElectronApplication | Page>> {
+export async function startSlowerDesktop(filename: string, defaultSettings: RecursivePartial<Settings> = {}): Promise<[ElectronApplication, Page]> {
   const launchOptions: startRancherDesktopOptions = { mock: false };
 
   createDefaultSettings(defaultSettings);