create-nx-workspace/src/utils/nx/ab-testing.js

Smart Repos · Fast Builds

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.messages = exports.PromptMessages = exports.NxCloudChoices = void 0;
exports.recordStat = recordStat;
const node_child_process_1 = require("node:child_process");
const is_ci_1 = require("../ci/is-ci");
const package_manager_1 = require("../package-manager");
exports.NxCloudChoices = [
    'github',
    'gitlab',
    'azure',
    'bitbucket-pipelines',
    'circleci',
    'skip',
    'yes', // Deprecated but still handled
];
const messageOptions = {
    /**
     * These messages are for setting up CI as part of create-nx-workspace and nx init
     */
    setupCI: [
        {
            code: 'which-ci-provider',
            message: `Which CI provider would you like to use?`,
            initial: 0,
            choices: [
                { value: 'github', name: 'GitHub Actions' },
                { value: 'gitlab', name: 'Gitlab' },
                { value: 'azure', name: 'Azure DevOps' },
                { value: 'bitbucket-pipelines', name: 'BitBucket Pipelines' },
                { value: 'circleci', name: 'Circle CI' },
                { value: 'skip', name: '\nDo it later' },
            ],
            footer: '\nSelf-healing CI, remote caching, and task distribution are provided by Nx Cloud: https://nx.dev/nx-cloud',
            fallback: { value: 'skip', key: 'setupNxCloud' },
        },
    ],
    /**
     * These messages are a fallback for setting up CI as well as when migrating major versions
     */
    setupNxCloud: [
        {
            code: 'enable-caching2',
            message: `Would you like remote caching to make your build faster?`,
            initial: 0,
            choices: [
                { value: 'yes', name: 'Yes' },
                {
                    value: 'skip',
                    name: 'No - I would not like remote caching',
                },
            ],
            footer: '\nRead more about remote caching at https://nx.dev/ci/features/remote-cache',
            hint: `\n(can be disabled any time)`,
            fallback: undefined,
        },
    ],
};
class PromptMessages {
    constructor() {
        this.selectedMessages = {};
    }
    getPrompt(key) {
        if (this.selectedMessages[key] === undefined) {
            if (process.env.NX_GENERATE_DOCS_PROCESS === 'true') {
                this.selectedMessages[key] = 0;
            }
            else {
                this.selectedMessages[key] = Math.floor(Math.random() * messageOptions[key].length);
            }
        }
        return messageOptions[key][this.selectedMessages[key]];
    }
    codeOfSelectedPromptMessage(key) {
        const selected = this.selectedMessages[key];
        if (selected === undefined) {
            return '';
        }
        else {
            return messageOptions[key][selected].code;
        }
    }
}
exports.PromptMessages = PromptMessages;
exports.messages = new PromptMessages();
/**
 * We are incrementing a counter to track how often create-nx-workspace is used in CI
 * vs dev environments. No personal information is collected.
 */
async function recordStat(opts) {
    try {
        if (!shouldRecordStats()) {
            return;
        }
        const axios = require('axios');
        await (axios['default'] ?? axios)
            .create({
            baseURL: 'https://cloud.nx.app',
            timeout: 400,
        })
            .post('/nx-cloud/stats', {
            command: opts.command,
            isCI: (0, is_ci_1.isCI)(),
            useCloud: opts.useCloud,
            meta: opts.meta.filter((v) => !!v).join(','),
        });
    }
    catch (e) {
        if (process.env.NX_VERBOSE_LOGGING === 'true') {
            console.error(e);
        }
    }
}
function shouldRecordStats() {
    const pmc = (0, package_manager_1.getPackageManagerCommand)();
    if (!pmc.getRegistryUrl) {
        // Fallback on true as Package management doesn't support reading config for registry.
        // currently Bun doesn't support fetching config settings https://github.com/oven-sh/bun/issues/7140
        return true;
    }
    try {
        const stdout = (0, node_child_process_1.execSync)(pmc.getRegistryUrl, {
            encoding: 'utf-8',
            windowsHide: false,
        });
        const url = new URL(stdout.trim());
        // don't record stats when testing locally
        return url.hostname !== 'localhost';
    }
    catch {
        // fallback to true if we can't detect the registry
        return true;
    }
}