setup-uv/src/setup-uv.ts

import fs from "node:fs";
import * as path from "node:path";
import * as core from "@actions/core";
import * as exec from "@actions/exec";
import { restoreCache } from "./cache/restore-cache";
import {
  downloadVersion,
  resolveVersion,
  tryGetFromToolCache,
} from "./download/download-version";
import { STATE_UV_PATH, STATE_UV_VERSION } from "./utils/constants";
import {
  activateEnvironment as activateEnvironmentInput,
  addProblemMatchers,
  CacheLocalSource,
  cacheLocalPath,
  checkSum,
  enableCache,
  githubToken,
  ignoreEmptyWorkdir,
  manifestFile,
  pythonDir,
  pythonVersion,
  resolutionStrategy,
  toolBinDir,
  toolDir,
  venvPath,
  versionFile as versionFileInput,
  version as versionInput,
  workingDirectory,
} from "./utils/inputs";
import {
  type Architecture,
  getArch,
  getPlatform,
  type Platform,
} from "./utils/platforms";
import { getUvVersionFromFile } from "./version/resolve";

const sourceDir = __dirname;

async function getPythonVersion(): Promise<string> {
  if (pythonVersion !== "") {
    return pythonVersion;
  }

  let output = "";
  const options: exec.ExecOptions = {
    listeners: {
      stdout: (data: Buffer) => {
        output += data.toString();
      },
    },
    silent: !core.isDebug(),
  };

  try {
    const execArgs = ["python", "find", "--directory", workingDirectory];
    await exec.exec("uv", execArgs, options);
    const pythonPath = output.trim();

    output = "";
    await exec.exec(pythonPath, ["--version"], options);
    // output is like "Python 3.8.10"
    return output.split(" ")[1].trim();
  } catch (error) {
    const err = error as Error;
    core.debug(`Failed to get python version from uv. Error: ${err.message}`);
    return "unknown";
  }
}

async function run(): Promise<void> {
  detectEmptyWorkdir();
  const platform = await getPlatform();
  const arch = getArch();

  try {
    if (platform === undefined) {
      throw new Error(`Unsupported platform: ${process.platform}`);
    }
    if (arch === undefined) {
      throw new Error(`Unsupported architecture: ${process.arch}`);
    }
    const setupResult = await setupUv(platform, arch, checkSum, githubToken);

    addToolBinToPath();
    addUvToPathAndOutput(setupResult.uvDir);
    setToolDir();
    addPythonDirToPath();
    setupPython();
    await activateEnvironment();
    addMatchers();
    setCacheDir();

    core.setOutput("uv-version", setupResult.version);
    core.saveState(STATE_UV_VERSION, setupResult.version);
    core.info(`Successfully installed uv version ${setupResult.version}`);

    const pythonVersion = await getPythonVersion();
    core.setOutput("python-version", pythonVersion);

    if (enableCache) {
      await restoreCache(pythonVersion);
    }
    // https://github.com/nodejs/node/issues/56645#issuecomment-3077594952
    await new Promise((resolve) => setTimeout(resolve, 50));
    process.exit(0);
  } catch (err) {
    core.setFailed((err as Error).message);
  }
}

function detectEmptyWorkdir(): void {
  if (fs.readdirSync(workingDirectory).length === 0) {
    if (ignoreEmptyWorkdir) {
      core.info(
        "Empty workdir detected. Ignoring because ignore-empty-workdir is enabled",
      );
    } else {
      core.warning(
        "Empty workdir detected. This may cause unexpected behavior. You can enable ignore-empty-workdir to mute this warning.",
      );
    }
  }
}

async function setupUv(
  platform: Platform,
  arch: Architecture,
  checkSum: string | undefined,
  githubToken: string,
): Promise<{ uvDir: string; version: string }> {
  const resolvedVersion = await determineVersion();
  const toolCacheResult = tryGetFromToolCache(arch, resolvedVersion);
  if (toolCacheResult.installedPath) {
    core.info(`Found uv in tool-cache for ${toolCacheResult.version}`);
    return {
      uvDir: toolCacheResult.installedPath,
      version: toolCacheResult.version,
    };
  }

  const downloadResult = await downloadVersion(
    platform,
    arch,
    resolvedVersion,
    checkSum,
    githubToken,
    manifestFile,
  );

  return {
    uvDir: downloadResult.cachedToolDir,
    version: downloadResult.version,
  };
}

async function determineVersion(): Promise<string> {
  return await resolveVersion(
    getRequestedVersion(),
    manifestFile,
    resolutionStrategy,
  );
}

function getRequestedVersion(): string {
  if (versionInput !== "") {
    return versionInput;
  }

  if (versionFileInput !== "") {
    const versionFromFile = getUvVersionFromFile(versionFileInput);
    if (versionFromFile === undefined) {
      throw new Error(
        `Could not determine uv version from file: ${versionFileInput}`,
      );
    }
    return versionFromFile;
  }

  const versionFromUvToml = getUvVersionFromFile(
    `${workingDirectory}${path.sep}uv.toml`,
  );
  const versionFromPyproject = getUvVersionFromFile(
    `${workingDirectory}${path.sep}pyproject.toml`,
  );

  if (versionFromUvToml === undefined && versionFromPyproject === undefined) {
    core.info(
      "Could not determine uv version from uv.toml or pyproject.toml. Falling back to latest.",
    );
  }

  return versionFromUvToml || versionFromPyproject || "latest";
}

function addUvToPathAndOutput(cachedPath: string): void {
  core.setOutput("uv-path", `${cachedPath}${path.sep}uv`);
  core.saveState(STATE_UV_PATH, `${cachedPath}${path.sep}uv`);
  core.setOutput("uvx-path", `${cachedPath}${path.sep}uvx`);
  if (process.env.UV_NO_MODIFY_PATH !== undefined) {
    core.info("UV_NO_MODIFY_PATH is set, not modifying PATH");
  } else {
    core.addPath(cachedPath);
    core.info(`Added ${cachedPath} to the path`);
  }
}

function addToolBinToPath(): void {
  if (toolBinDir !== undefined) {
    core.exportVariable("UV_TOOL_BIN_DIR", toolBinDir);
    core.info(`Set UV_TOOL_BIN_DIR to ${toolBinDir}`);
    if (process.env.UV_NO_MODIFY_PATH !== undefined) {
      core.info(`UV_NO_MODIFY_PATH is set, not adding ${toolBinDir} to path`);
    } else {
      core.addPath(toolBinDir);
      core.info(`Added ${toolBinDir} to the path`);
    }
  } else {
    if (process.env.UV_NO_MODIFY_PATH !== undefined) {
      core.info("UV_NO_MODIFY_PATH is set, not adding user local bin to path");
      return;
    }
    if (process.env.XDG_BIN_HOME !== undefined) {
      core.addPath(process.env.XDG_BIN_HOME);
      core.info(`Added ${process.env.XDG_BIN_HOME} to the path`);
    } else if (process.env.XDG_DATA_HOME !== undefined) {
      core.addPath(`${process.env.XDG_DATA_HOME}/../bin`);
      core.info(`Added ${process.env.XDG_DATA_HOME}/../bin to the path`);
    } else {
      core.addPath(`${process.env.HOME}/.local/bin`);
      core.info(`Added ${process.env.HOME}/.local/bin to the path`);
    }
  }
}

function setToolDir(): void {
  if (toolDir !== undefined) {
    core.exportVariable("UV_TOOL_DIR", toolDir);
    core.info(`Set UV_TOOL_DIR to ${toolDir}`);
  }
}

function addPythonDirToPath(): void {
  core.exportVariable("UV_PYTHON_INSTALL_DIR", pythonDir);
  core.info(`Set UV_PYTHON_INSTALL_DIR to ${pythonDir}`);
  if (process.env.UV_NO_MODIFY_PATH !== undefined) {
    core.info("UV_NO_MODIFY_PATH is set, not adding python dir to path");
  } else {
    core.addPath(pythonDir);
    core.info(`Added ${pythonDir} to the path`);
  }
}

function setupPython(): void {
  if (pythonVersion !== "") {
    core.exportVariable("UV_PYTHON", pythonVersion);
    core.info(`Set UV_PYTHON to ${pythonVersion}`);
  }
}

async function activateEnvironment(): Promise<void> {
  if (activateEnvironmentInput) {
    if (process.env.UV_NO_MODIFY_PATH !== undefined) {
      throw new Error(
        "UV_NO_MODIFY_PATH and activate-environment cannot be used together.",
      );
    }

    core.info(`Creating and activating python venv at ${venvPath}...`);
    await exec.exec("uv", [
      "venv",
      venvPath,
      "--directory",
      workingDirectory,
      "--clear",
    ]);

    let venvBinPath = `${venvPath}${path.sep}bin`;
    if (process.platform === "win32") {
      venvBinPath = `${venvPath}${path.sep}Scripts`;
    }
    core.addPath(path.resolve(venvBinPath));
    core.exportVariable("VIRTUAL_ENV", venvPath);
    core.setOutput("venv", venvPath);
  }
}

function setCacheDir(): void {
  if (cacheLocalPath !== undefined) {
    if (cacheLocalPath.source === CacheLocalSource.Config) {
      core.info(
        "Using cache-dir from uv config file, not modifying UV_CACHE_DIR",
      );
      return;
    }
    core.exportVariable("UV_CACHE_DIR", cacheLocalPath.path);
    core.info(`Set UV_CACHE_DIR to ${cacheLocalPath.path}`);
  }
}

function addMatchers(): void {
  if (addProblemMatchers) {
    const matchersPath = path.join(sourceDir, "..", "..", ".github");
    core.info(`##[add-matcher]${path.join(matchersPath, "python.json")}`);
  }
}

run();