@testim/testim-cli/commons/featureFlags.js

'use strict';

const { ROLLOUT_KEY, IS_ON_PREM } = require('./config');
const logger = require('./logger').getLogger('FeatureFlagsService');
const Promise = require('bluebird');
const Rox = require('rox-node');

// IS_UNIT_TEST = disable rollout if code run in unit test mode to ignore mocha process stuck on running
const USE_FEATURE_FLAGS = !IS_ON_PREM && !process.env.IS_UNIT_TEST;

const FORCE_FETCH_TIMEOUT_MS = 20000; // rollout sometimes takes up to 15 seconds to load
const SEC_IN_DAY = 60 * 60 * 24;

class FeatureFlagsService {
    constructor() {
        this.flags = {
            useNewWebdriverApi: new Rox.Flag(),
            useNewWSCLI: new Rox.Flag(),
            disableEdgeVisibilityChecks: new Rox.Flag(),
            useSafariWebdriverVisibilityChecks: new Rox.Flag(),
            useClickimVisibilityChecks: new Rox.Flag(),
            useIEWebdriverVisibilityChecks: new Rox.Flag(),
            enableTDKRun: new Rox.Flag(true),
            runGetElementCodeInAut: new Rox.Flag(),
            enableNpmPackageInstallUsingNpmCli: new Rox.Flag(),
            enableFrameSwitchOptimization: new Rox.Flag(),
            maximumJsResultSize: new Rox.Configuration(2000 * 1024),
            skipFileInputClicks: new Rox.Flag(),
            enableMockNetwork: new Rox.Flag(),
            errorMessageOnBadNetwork: new Rox.Flag(true),
            warnOnBadNetwork: new Rox.Flag(false),
        };
        Rox.register('default', this.flags);
    }

    setProjectId(projectId) {
        Rox.setCustomStringProperty('projectId', projectId);
    }

    setCompanyId(companyId) {
        Rox.setCustomStringProperty('companyId', companyId);
    }

    setRunnerMode(mode) {
        Rox.setCustomStringProperty('runnerMode', mode);
    }

    fetch() {
        if (!USE_FEATURE_FLAGS) {
            return Promise.resolve();
        }
        const opts = {
            fetchIntervalInSec: SEC_IN_DAY, // we don't actually want to refresh feature flags in the CLI,
            disableNetworkFetch: false,
        };


        if (global.ProxyAgent) {
            const agent = new global.ProxyAgent(global.proxyUri);
            opts.httpsAgent = agent;
            opts.httpAgent = agent;
        }

        return Promise.resolve(Rox.setup(ROLLOUT_KEY, opts))
            .timeout(FORCE_FETCH_TIMEOUT_MS).catch(err => logger.error('failed to get feature flag status', err));
    }
}

module.exports = new FeatureFlagsService();