@aztec/builder 0.46.5 → 0.46.6

package/src/cli/update/noir.ts

@@ -1,57 +0,0 @@
-import { type LogFn } from '@aztec/foundation/log';
-import { parseNoirPackageConfig } from '@aztec/foundation/noir';
-
-import TOML from '@iarna/toml';
-import { readFile } from 'fs/promises';
-import { join, relative, resolve } from 'path';
-
-import { type DependencyChanges } from './common.js';
-import { atomicUpdateFile, prettyPrintNargoToml } from './utils.js';
-
-/**
- * Updates Aztec.nr dependencies
- * @param contractPath - Path to the contract to be updated
- * @param tag - The tag to update to
- * @param log - Logging function
- */
-export async function updateAztecNr(contractPath: string, tag: string, log: LogFn): Promise<DependencyChanges> {
-  const configFilepath = resolve(join(contractPath, 'Nargo.toml'));
-  const packageConfig = parseNoirPackageConfig(TOML.parse(await readFile(configFilepath, 'utf-8')));
-  const changes: DependencyChanges = {
-    dependencies: [],
-    file: configFilepath,
-  };
-
-  log(`Updating Aztec.nr libraries to ${tag} in ${relative(process.cwd(), changes.file)}`);
-  for (const dep of Object.values(packageConfig.dependencies)) {
-    if (!('git' in dep)) {
-      continue;
-    }
-
-    // remove trailing slash
-    const gitUrl = dep.git.toLowerCase().replace(/\/$/, '');
-    if (gitUrl !== 'https://github.com/aztecprotocol/aztec-packages') {
-      continue;
-    }
-
-    if (dep.tag !== tag) {
-      // show the Aztec.nr package name rather than the lib name
-      const dirParts = dep.directory?.split('/') ?? [];
-      changes.dependencies.push({
-        name: dirParts.slice(-2).join('/'),
-        from: dep.tag,
-        to: tag,
-      });
-
-      dep.tag = tag;
-      dep.directory = dep.directory?.replace('yarn-project/', 'noir-projects/');
-    }
-  }
-
-  if (changes.dependencies.length > 0) {
-    const contents = prettyPrintNargoToml(packageConfig);
-    await atomicUpdateFile(configFilepath, contents);
-  }
-
-  return changes;
-}

package/src/cli/update/npm.ts

@@ -1,154 +0,0 @@
-import { type LogFn } from '@aztec/foundation/log';
-
-import { spawnSync } from 'child_process';
-import { existsSync } from 'fs';
-import { readFile } from 'fs/promises';
-import { join, relative, resolve } from 'path';
-import { type SemVer, parse } from 'semver';
-
-import { type DependencyChanges } from './common.js';
-import { atomicUpdateFile } from './utils.js';
-
-const deprecatedNpmPackages = new Set<string>(['@aztec/cli', '@aztec/aztec-sandbox']);
-const npmDeprecationMessage = `
-The following packages have been deprecated and will no longer be updated on the npm registry:
-${Array.from(deprecatedNpmPackages)
-  .map(pkg => `  - ${pkg}`)
-  .join('\n')}
-Remove them from package.json
-`;
-
-/**
- * Looks up a package.json file and returns its contents
- * @param projectPath - Path to Nodejs project
- * @returns The parsed package.json
- */
-export async function readPackageJson(projectPath: string): Promise<{
-  /** dependencies */
-  dependencies?: Record<string, string>;
-  /** devDependencies */
-  devDependencies?: Record<string, string>;
-}> {
-  const configFilepath = resolve(join(projectPath, 'package.json'));
-  const pkg = JSON.parse(await readFile(configFilepath, 'utf-8'));
-
-  return pkg;
-}
-
-/**
- * Queries the npm registry for the latest version of a package
- * @param packageName - The package to query
- * @param distTag - The distribution tag
- * @returns The latest version of the package on that distribution tag
- */
-export async function getNewestVersion(packageName: string, distTag = 'latest'): Promise<SemVer> {
-  const url = new URL(packageName, 'https://registry.npmjs.org/');
-  const response = await fetch(url);
-  if (!response.ok) {
-    throw new Error(`Failed to fetch ${url}`);
-  }
-
-  const body = await response.json();
-  const latestVersion = parse(body['dist-tags'][distTag]);
-  if (!latestVersion) {
-    throw new Error(`Failed to get latest version from registry`);
-  }
-
-  return latestVersion;
-}
-
-/**
- * Updates a project's \@aztec/* dependencies to the specific version
- * @param projectPath - Path to Nodejs project
- * @param aztecVersion - The version to update to
- * @returns True if the project was updated
- */
-export async function updateAztecDeps(
-  projectPath: string,
-  aztecVersion: SemVer,
-  log: LogFn,
-): Promise<DependencyChanges> {
-  const pkg = await readPackageJson(projectPath);
-  const changes: DependencyChanges = {
-    file: resolve(join(projectPath, 'package.json')),
-    dependencies: [],
-  };
-
-  log(`Updating @aztec packages to ${aztecVersion} in ${relative(process.cwd(), changes.file)}`);
-  const version = aztecVersion.version;
-
-  let detectedDeprecatedPackages = false;
-
-  for (const depType of ['dependencies', 'devDependencies'] as const) {
-    const dependencies = pkg[depType];
-    if (!dependencies) {
-      continue;
-    }
-
-    for (const name of Object.keys(dependencies)) {
-      if (!name.startsWith('@aztec/')) {
-        continue;
-      }
-
-      // different release schedule
-      if (name === '@aztec/aztec-ui') {
-        continue;
-      }
-
-      if (deprecatedNpmPackages.has(name)) {
-        detectedDeprecatedPackages = true;
-        continue;
-      }
-
-      if (dependencies[name] !== version) {
-        changes.dependencies.push({
-          name,
-          from: dependencies[name],
-          to: version,
-        });
-
-        dependencies[name] = version;
-      }
-    }
-  }
-
-  if (detectedDeprecatedPackages) {
-    log(npmDeprecationMessage);
-  }
-
-  if (changes.dependencies.length > 0) {
-    const contents = JSON.stringify(pkg, null, 2) + '\n';
-    await atomicUpdateFile(resolve(join(projectPath, 'package.json')), contents);
-  }
-
-  return changes;
-}
-
-/**
- * Updates a project's yarn.lock or package-lock.json
- * @param projectPath - Path to Nodejs project
- */
-export function updateLockfile(projectPath: string, log: LogFn): void {
-  const isNpm = existsSync(resolve(join(projectPath, 'package-lock.json')));
-  const isYarn = existsSync(resolve(join(projectPath, 'yarn.lock')));
-  const isPnpm = existsSync(resolve(join(projectPath, 'pnpm-lock.yaml')));
-
-  if (isPnpm) {
-    spawnSync('pnpm', ['install'], {
-      cwd: projectPath,
-      stdio: 'inherit',
-    });
-  } else if (isYarn) {
-    spawnSync('yarn', ['install'], {
-      cwd: projectPath,
-      stdio: 'inherit',
-    });
-  } else if (isNpm) {
-    spawnSync('npm', ['install'], {
-      cwd: projectPath,
-      stdio: 'inherit',
-    });
-  } else {
-    log(`No lockfile found in ${projectPath}. Skipping lockfile update...`);
-  }
-}

package/src/cli/update/update.ts

@@ -1,78 +0,0 @@
-/* eslint-disable jsdoc/require-jsdoc */
-import { type LogFn } from '@aztec/foundation/log';
-
-import { relative, resolve } from 'path';
-import { parse } from 'semver';
-
-import { type DependencyChanges } from './common.js';
-import { GITHUB_TAG_PREFIX } from './github.js';
-import { updateAztecNr } from './noir.js';
-import { getNewestVersion, updateAztecDeps, updateLockfile } from './npm.js';
-
-const AZTECJS_PACKAGE = '@aztec/aztec.js';
-const UPDATE_DOCS_URL = 'https://docs.aztec.network/developers/updating';
-
-export async function update(
-  projectPath: string,
-  contracts: string[],
-  aztecVersion: string,
-  log: LogFn,
-): Promise<void> {
-  const targetAztecVersion =
-    aztecVersion === 'latest' ? await getNewestVersion(AZTECJS_PACKAGE, 'latest') : parse(aztecVersion);
-
-  if (!targetAztecVersion) {
-    throw new Error(`Invalid aztec version ${aztecVersion}`);
-  }
-
-  const projectDependencyChanges: DependencyChanges[] = [];
-  try {
-    const npmChanges = await updateAztecDeps(resolve(process.cwd(), projectPath), targetAztecVersion, log);
-    if (npmChanges.dependencies.length > 0) {
-      updateLockfile(projectPath, log);
-    }
-
-    projectDependencyChanges.push(npmChanges);
-  } catch (err) {
-    if (err instanceof Error && 'code' in err && err.code === 'ENOENT') {
-      log(`No package.json found in ${projectPath}. Skipping npm update...`);
-    } else {
-      throw err;
-    }
-  }
-
-  for (const contract of contracts) {
-    try {
-      projectDependencyChanges.push(
-        await updateAztecNr(
-          resolve(process.cwd(), projectPath, contract),
-          `${GITHUB_TAG_PREFIX}-v${targetAztecVersion.version}`,
-          log,
-        ),
-      );
-    } catch (err) {
-      if (err instanceof Error && 'code' in err && err.code === 'ENOENT') {
-        log(`No Nargo.toml found in ${relative(process.cwd(), contract)}. Skipping...`);
-      } else {
-        throw err;
-      }
-    }
-  }
-
-  log(`To update Docker containers follow instructions at ${UPDATE_DOCS_URL}`);
-
-  projectDependencyChanges.forEach(changes => {
-    printChanges(changes, log);
-  });
-}
-
-function printChanges(changes: DependencyChanges, log: LogFn): void {
-  log(`\nIn ${relative(process.cwd(), changes.file)}:`);
-  if (changes.dependencies.length === 0) {
-    log('  No changes');
-  } else {
-    changes.dependencies.forEach(({ name, from, to }) => {
-      log(`  Updated ${name} from ${from} to ${to}`);
-    });
-  }
-}

package/src/cli/update/utils.ts

@@ -1,50 +0,0 @@
-import { type NoirPackageConfig } from '@aztec/foundation/noir';
-
-import TOML from '@iarna/toml';
-import { CommanderError } from 'commander';
-import { rename, writeFile } from 'fs/promises';
-
-/**
- * Updates a file in place atomically.
- * @param filePath - Path to file
- * @param contents - New contents to write
- */
-export async function atomicUpdateFile(filePath: string, contents: string) {
-  const tmpFilepath = filePath + '.tmp';
-  try {
-    await writeFile(tmpFilepath, contents, {
-      // let's crash if the tmp file already exists
-      flag: 'wx',
-    });
-    await rename(tmpFilepath, filePath);
-  } catch (e) {
-    if (e instanceof Error && 'code' in e && e.code === 'EEXIST') {
-      const commanderError = new CommanderError(
-        1,
-        e.code,
-        `Temporary file already exists: ${tmpFilepath}. Delete this file and try again.`,
-      );
-      commanderError.nestedError = e.message;
-      throw commanderError;
-    } else {
-      throw e;
-    }
-  }
-}
-
-/**
- * Pretty prints Nargo.toml contents to a string
- * @param config - Nargo.toml contents
- * @returns The Nargo.toml contents as a string
- */
-export function prettyPrintNargoToml(config: NoirPackageConfig): string {
-  const withoutDependencies = Object.fromEntries(Object.entries(config).filter(([key]) => key !== 'dependencies'));
-
-  const partialToml = TOML.stringify(withoutDependencies);
-  const dependenciesToml = Object.entries(config.dependencies).map(([name, dep]) => {
-    const depToml = TOML.stringify.value(dep);
-    return `${name} = ${depToml}`;
-  });
-
-  return partialToml + '\n[dependencies]\n' + dependenciesToml.join('\n') + '\n';
-}