@sentry/craft/dist/config.js

Object.defineProperty(exports, "__esModule", { value: true });
exports.getStatusProviderFromConfig = exports.getArtifactProviderFromConfig = exports.getGitTagPrefix = exports.getGlobalGithubConfig = exports.checkMinimalConfigVersion = exports.getConfiguration = exports.validateConfiguration = exports.getProjectConfigSchema = exports.getConfigFileDir = exports.getConfigFilePath = exports.findConfigFile = exports.DEFAULT_RELEASE_BRANCH_NAME = exports.CONFIG_FILE_NAME = void 0;
const fs_1 = require("fs");
const path_1 = require("path");
const Ajv = require("ajv");
const js_yaml_1 = require("js-yaml");
const logger_1 = require("./logger");
const errors_1 = require("./utils/errors");
const version_1 = require("./utils/version");
const github_1 = require("./artifact_providers/github");
const zeus_1 = require("./artifact_providers/zeus");
const none_1 = require("./artifact_providers/none");
const gcs_1 = require("./artifact_providers/gcs");
const zeus_2 = require("./status_providers/zeus");
const github_2 = require("./status_providers/github");
// TODO support multiple configuration files (one per configuration)
exports.CONFIG_FILE_NAME = '.craft.yml';
/**
 * The default prefix for the release branch.
 */
exports.DEFAULT_RELEASE_BRANCH_NAME = 'release';
/**
 * Cached path to the configuration file
 */
let _configPathCache;
/**
 * Cached configuration
 */
let _configCache;
/**
 * Searches the current and parent directories for the configuration file
 *
 * Returns "undefined" if no file was found.
 */
function findConfigFile() {
    if (_configPathCache) {
        return _configPathCache;
    }
    const cwd = process.cwd();
    const MAX_DEPTH = 1024;
    let depth = 0;
    let currentDir = cwd;
    while (depth <= MAX_DEPTH) {
        const probePath = path_1.join(currentDir, exports.CONFIG_FILE_NAME);
        if (fs_1.existsSync(probePath) && fs_1.lstatSync(probePath).isFile()) {
            _configPathCache = probePath;
            return _configPathCache;
        }
        const parentDir = path_1.dirname(currentDir);
        if (currentDir === parentDir) {
            // Reached root directory
            return undefined;
        }
        currentDir = parentDir;
        depth += 1;
    }
    logger_1.logger.warn('findConfigFile: Reached maximum allowed directory depth');
    return undefined;
}
exports.findConfigFile = findConfigFile;
/**
 * Returns project configuration (.craft.yml) file path
 *
 * Throws an error if the file cannot be found.
 */
function getConfigFilePath() {
    const configFilePath = findConfigFile();
    if (!configFilePath) {
        throw new errors_1.ConfigurationError(`Cannot find Craft configuration file. Have you added "${exports.CONFIG_FILE_NAME}" to your project?`);
    }
    return configFilePath;
}
exports.getConfigFilePath = getConfigFilePath;
/**
 * Returns the path to the directory that contains the configuration file
 *
 * Returns "undefined" if no configuration file can be found.
 */
function getConfigFileDir() {
    const configFilePath = findConfigFile();
    if (!configFilePath) {
        return undefined;
    }
    return path_1.dirname(configFilePath);
}
exports.getConfigFileDir = getConfigFileDir;
/**
 * Reads JSON schema for project configuration
 */
function getProjectConfigSchema() {
    return require('./schemas/projectConfig.schema');
}
exports.getProjectConfigSchema = getProjectConfigSchema;
/**
 * Parses and validate passed configuration object
 *
 * Throw an error is the object cannot be properly parsed as configuration.
 *
 * @param rawConfig Raw project configuration object
 */
function validateConfiguration(rawConfig) {
    logger_1.logger.debug('Parsing and validating the configuration file...');
    const schemaName = 'projectConfig';
    const projectConfigSchema = getProjectConfigSchema();
    const ajvValidator = new Ajv().addSchema(projectConfigSchema, schemaName);
    const valid = ajvValidator.validate(schemaName, rawConfig);
    if (valid) {
        return rawConfig;
    }
    else {
        throw new errors_1.ConfigurationError(`Cannot parse configuration file:\n${ajvValidator.errorsText()}`);
    }
}
exports.validateConfiguration = validateConfiguration;
/**
 * Returns the parsed configuration file contents
 */
function getConfiguration() {
    if (_configCache) {
        return _configCache;
    }
    const configPath = getConfigFilePath();
    logger_1.logger.debug('Configuration file found: ', configPath);
    const rawConfig = js_yaml_1.safeLoad(fs_1.readFileSync(configPath, 'utf-8'));
    _configCache = validateConfiguration(rawConfig);
    return _configCache;
}
exports.getConfiguration = getConfiguration;
/**
 * Checks that the current "craft" version is compatible with the configuration
 *
 * "minVersion" configuration parameter specifies the minimal version of "craft"
 * that can work with the given configuration.
 */
function checkMinimalConfigVersion() {
    const config = getConfiguration();
    const minVersionRaw = config.minVersion;
    if (!minVersionRaw) {
        logger_1.logger.debug('No minimal version specified in the configuration, skpipping the check');
        return;
    }
    const currentVersionRaw = version_1.getPackageVersion();
    if (!currentVersionRaw) {
        throw new Error('Cannot get the current craft version');
    }
    const minVersion = version_1.parseVersion(minVersionRaw);
    if (!minVersion) {
        throw new Error(`Cannot parse the minimal version: "${minVersionRaw}"`);
    }
    const currentVersion = version_1.parseVersion(currentVersionRaw);
    if (!currentVersion) {
        throw new Error(`Cannot parse the current version: "${currentVersionRaw}"`);
    }
    if (version_1.versionGreaterOrEqualThan(currentVersion, minVersion)) {
        logger_1.logger.info(`"craft" version is compatible with the minimal version from the configuration file.`);
    }
    else {
        throw new errors_1.ConfigurationError(`Incompatible "craft" versions. Current version: ${currentVersionRaw},  minimal version: ${minVersionRaw} (taken from .craft.yml).`);
    }
}
exports.checkMinimalConfigVersion = checkMinimalConfigVersion;
/**
 * Return the parsed global Github configuration
 */
function getGlobalGithubConfig() {
    // We extract global Github configuration (owner/repo) from top-level
    // configuration
    const repoGithubConfig = getConfiguration().github || {};
    if (!repoGithubConfig) {
        throw new errors_1.ConfigurationError('GitHub configuration not found in the config file');
    }
    if (!repoGithubConfig.owner) {
        throw new errors_1.ConfigurationError('GitHub target: owner not found');
    }
    if (!repoGithubConfig.repo) {
        throw new errors_1.ConfigurationError('GitHub target: repo not found');
    }
    return repoGithubConfig;
}
exports.getGlobalGithubConfig = getGlobalGithubConfig;
/**
 * Gets git tag prefix from configuration
 */
function getGitTagPrefix() {
    const targets = getConfiguration().targets || [];
    const githubTarget = targets.find(target => target.name === 'github') || {};
    return githubTarget.tagPrefix || '';
}
exports.getGitTagPrefix = getGitTagPrefix;
/**
 * Create an artifact provider instance from the spec in the configuration file
 *
 * @returns An instance of artifact provider (which may be the dummy
 * NoneArtifactProvider if artifact storage is disabled).
 */
function getArtifactProviderFromConfig() {
    var _a, _b;
    const projectConfig = getConfiguration();
    const artifactProviderName = (_a = projectConfig.artifactProvider) === null || _a === void 0 ? void 0 : _a.name;
    const artifactProviderConfig = Object.assign(Object.assign({}, (_b = projectConfig.artifactProvider) === null || _b === void 0 ? void 0 : _b.config), { repoName: projectConfig.github.repo, repoOwner: projectConfig.github.owner });
    switch (artifactProviderName) {
        case undefined: // Zeus is the default at the moment
        case "zeus" /* Zeus */:
            return new zeus_1.ZeusArtifactProvider(artifactProviderConfig);
        case "none" /* None */:
            return new none_1.NoneArtifactProvider();
        case "gcs" /* GCS */:
            return new gcs_1.GCSArtifactProvider(artifactProviderConfig);
        case "github" /* Github */:
            return new github_1.GithubArtifactProvider(artifactProviderConfig);
        default: {
            throw new errors_1.ConfigurationError('Invalid artifact provider');
        }
    }
}
exports.getArtifactProviderFromConfig = getArtifactProviderFromConfig;
/**
 * Create a status provider instance from the spec in the configuration file
 *
 * @returns An instance of status provider
 */
function getStatusProviderFromConfig() {
    const config = getConfiguration() || {};
    const githubConfig = config.github;
    const rawStatusProvider = config.statusProvider || {
        config: undefined,
        name: undefined,
    };
    const { config: statusProviderConfig, name: statusProviderName, } = rawStatusProvider;
    switch (statusProviderName) {
        case undefined:
        case "zeus" /* Zeus */:
            return new zeus_2.ZeusStatusProvider(githubConfig.owner, githubConfig.repo, statusProviderConfig);
        case "github" /* Github */:
            return new github_2.GithubStatusProvider(githubConfig.owner, githubConfig.repo, statusProviderConfig);
        default: {
            throw new errors_1.ConfigurationError('Invalid status provider');
        }
    }
}
exports.getStatusProviderFromConfig = getStatusProviderFromConfig;
//# sourceMappingURL=config.js.map