privacy.sexy/tests/checks/desktop-runtime-errors/check-desktop-runtime-errors/utils/npm.ts

import { join } from 'path';
import { rm, readFile } from 'fs/promises';
import { exists, isDirMissingOrEmpty } from './io';
import { CommandResult, runCommand } from './run-command';
import { LogLevel, die, log } from './log';
import { sleep } from './sleep';
import type { ExecOptions } from 'child_process';

const NPM_INSTALL_MAX_RETRIES = 3;
const NPM_INSTALL_RETRY_DELAY_MS = 5 /* seconds */ * 1000;

export async function ensureNpmProjectDir(projectDir: string): Promise<void> {
  if (!projectDir) { throw new Error('missing project directory'); }
  if (!await exists(join(projectDir, 'package.json'))) {
    die(`\`package.json\` not found in project directory: ${projectDir}`);
  }
}

export async function npmInstall(projectDir: string): Promise<void> {
  if (!projectDir) { throw new Error('missing project directory'); }
  const npmModulesPath = join(projectDir, 'node_modules');
  if (!await isDirMissingOrEmpty(npmModulesPath)) {
    log(`Directory "${npmModulesPath}" exists and has content. Skipping \`npm install\`.`);
    return;
  }
  log('Starting dependency installation...');
  const { error } = await executeWithRetry('npm install --loglevel=error', {
    cwd: projectDir,
  }, NPM_INSTALL_MAX_RETRIES, NPM_INSTALL_RETRY_DELAY_MS);
  if (error) {
    die(error);
  }
  log('Installed dependencies...');
}

export async function npmBuild(
  projectDir: string,
  buildCommand: string,
  distDir: string,
  forceRebuild: boolean,
): Promise<void> {
  if (!projectDir) { throw new Error('missing project directory'); }
  if (!buildCommand) { throw new Error('missing build command'); }
  if (!distDir) { throw new Error('missing distribution directory'); }

  const isMissingBuild = await isDirMissingOrEmpty(distDir);

  if (!isMissingBuild && !forceRebuild) {
    log(`Directory "${distDir}" exists and has content. Skipping build: '${buildCommand}'.`);
    return;
  }

  if (forceRebuild) {
    log(`Removing directory "${distDir}" for a clean build (triggered by \`--build\` flag).`);
    await rm(distDir, { recursive: true, force: true });
  }

  log('Building project...');
  const { error } = await runCommand(buildCommand, {
    cwd: projectDir,
  });
  if (error) {
    log(error, LogLevel.Warn); // Cannot disable Vue CLI errors, stderr contains false-positives.
  }
}

const appNameCache = new Map<string, string>();

export async function getAppName(projectDir: string): Promise<string> {
  if (!projectDir) { throw new Error('missing project directory'); }
  if (appNameCache.has(projectDir)) {
    return appNameCache.get(projectDir);
  }
  const packageData = await readPackageJsonContents(projectDir);
  try {
    const packageJson = JSON.parse(packageData);
    const name = packageJson.name as string;
    if (!name) {
      return die(`The \`package.json\` file doesn't specify a name: ${packageData}`);
    }
    appNameCache.set(projectDir, name);
    return name;
  } catch (error) {
    return die(`Unable to parse \`package.json\`. Error: ${error}\nContent: ${packageData}`);
  }
}

async function readPackageJsonContents(projectDir: string): Promise<string> {
  if (!projectDir) { throw new Error('missing project directory'); }
  const packagePath = join(projectDir, 'package.json');
  if (!await exists(packagePath)) {
    return die(`\`package.json\` file not found at ${packagePath}`);
  }
  try {
    const packageData = await readFile(packagePath, 'utf8');
    return packageData;
  } catch (error) {
    log(`Error reading \`package.json\` from ${packagePath}.`, LogLevel.Error);
    return die(`Error detail: ${error}`);
  }
}

async function executeWithRetry(
  command: string,
  options: ExecOptions,
  maxRetries: number,
  retryDelayInMs: number,
  currentAttempt = 1,
): Promise<CommandResult> {
  const result = await runCommand(command, options);

  if (!result.error || currentAttempt >= maxRetries) {
    return result;
  }

  log(`Attempt ${currentAttempt} failed. Retrying in ${retryDelayInMs / 1000} seconds...`);
  await sleep(retryDelayInMs);

  const retryResult = await executeWithRetry(
    command,
    options,
    maxRetries,
    retryDelayInMs,
    currentAttempt + 1,
  );
  return retryResult;
}