create-application.ts

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import * as Electron from 'electron';
import { AppConstructorOptions, Application } from 'spectron';
import { retry } from 'tests/common/retry';

import {
    DEFAULT_APP_CONNECT_RETRIES,
    DEFAULT_APP_CONNECT_TIMEOUT_MS,
    DEFAULT_CHROMEDRIVER_START_RETRIES,
    DEFAULT_CHROMEDRIVER_START_TIMEOUT_MS,
} from 'tests/electron/setup/timeouts';
import { AppController } from './view-controllers/app-controller';

export interface AppOptions extends Partial<AppConstructorOptions> {
    suppressFirstTimeDialog: boolean;
}

export async function createApplication(options?: AppOptions): Promise<AppController> {
    const targetApp = `${
        (global as any).rootDir
    }/drop/electron/unified-dev/product/bundle/main.bundle.js`;

    const unifiedOptions = {
        env: {
            ANDROID_HOME: `${(global as any).rootDir}/drop/mock-adb`,
        },
        ...options,
    };
    const appController = await createAppController(targetApp, unifiedOptions);

    if (options?.suppressFirstTimeDialog === true) {
        await appController.setTelemetryState(false);
    }

    return appController;
}

export async function createAppController(
    targetApp: string,
    overrideSpectronOptions?: Partial<AppConstructorOptions>,
): Promise<AppController> {
    const app = await retry(
        async () => {
            const app = new Application({
                path: Electron as any,
                args: [targetApp],
                connectionRetryCount: DEFAULT_APP_CONNECT_RETRIES,
                connectionRetryTimeout: DEFAULT_APP_CONNECT_TIMEOUT_MS,
                startTimeout: DEFAULT_CHROMEDRIVER_START_TIMEOUT_MS,
                ...overrideSpectronOptions,
            });
            await app.start();
            return app;
        },
        {
            operationLabel: 'app.start',
            warnOnRetry: true,
            maxRetries: DEFAULT_CHROMEDRIVER_START_RETRIES,
            retryOnlyIfMatches: err =>
                err?.message?.includes('ChromeDriver did not start within') ||
                err?.message?.includes('Failed to create session.\nread ECONNRESET'),
        },
    );

    return new AppController(app);
}