nx/dist/src/utils/workspace-id.js

The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.generateWorkspaceId = generateWorkspaceId;
exports.deriveRepoKey = deriveRepoKey;
exports.computeRepoKey = computeRepoKey;
const crypto_1 = require("crypto");
const git_utils_1 = require("./git-utils");
/**
 * The workspace's analytics identity: the Nx Cloud id when the workspace has
 * one (most stable — it survives repo moves and renames), else the repo key.
 * Null when neither is available, in which case nothing is reported.
 */
function generateWorkspaceId(root, nxJson) {
    const nxCloudId = nxJson?.nxCloudId ?? nxJson?.nxCloudAccessToken;
    if (nxCloudId) {
        return nxCloudId;
    }
    return deriveRepoKey(root);
}
/**
 * Derive the stable, unsalted key identifying this workspace in the
 * repoTelemetry registry: `sha256(<repo identity> + '#' + <workspace path
 * relative to the git root>)`.
 *
 * The repo identity is the normalized `domain/slug` from the git remote
 * (protocol-independent: ssh, https, and token-authenticated URLs of the
 * same repo produce the same key), falling back to the first-commit SHA
 * when no remote exists. Returns null when no identity is derivable — not
 * a git repository, or a shallow clone without a remote.
 */
function deriveRepoKey(directory) {
    const identity = getRepoIdentity(directory);
    if (!identity) {
        return null;
    }
    return computeRepoKey(identity, (0, git_utils_1.getGitRootRelativePath)(directory) ?? '');
}
function computeRepoKey(identity, relativePath) {
    return (0, crypto_1.createHash)('sha256')
        .update(`${identity}#${relativePath}`)
        .digest('hex');
}
function getRepoIdentity(directory) {
    const remote = (0, git_utils_1.getVcsRemoteInfo)(directory);
    if (remote) {
        // Hosts route case-insensitively and hold one canonical casing, so a
        // hand-typed remote must key the same as the canonical one the claim
        // flow derives from the host's API.
        return `${remote.domain}/${remote.slug}`.toLowerCase().replace(/\/+$/, '');
    }
    // Without a remote the first commit is the only stable identity, and a
    // shallow clone doesn't have a real one.
    return (0, git_utils_1.isShallowRepository)(directory) ? null : (0, git_utils_1.getFirstCommitSha)(directory);
}