@dbx-tools/projen 0.9.19 → 0.9.28

package/tasks/publish-npm.ts

@@ -2,6 +2,7 @@
 /** Idempotent npm archive publication for release recovery. */
 import { createHash } from "node:crypto";
 import {
+  chmodSync,
   lstatSync,
   mkdtempSync,
   readFileSync,
@@ -15,6 +16,7 @@ import { join, relative, resolve } from "node:path";
 import * as exec from "@dbx-tools/core/exec";
 import { log } from "@dbx-tools/shared-core";
 import { Command } from "commander";
+import { runTaskCommand } from "../src/_task-command.ts";
 
 const DEFAULT_REGISTRY = "https://registry.npmjs.org";
 const logger = log.logger("projen:publish-npm");
@@ -29,6 +31,7 @@ export interface NpmReleaseIdentity {
 }
 
 interface NpmArchiveManifest {
+  readonly [key: string]: unknown;
   readonly dependencies?: Readonly<Record<string, string>>;
   readonly optionalDependencies?: Readonly<Record<string, string>>;
   readonly name?: string;
@@ -37,6 +40,19 @@ interface NpmArchiveManifest {
   readonly version?: string;
 }
 
+export type NpmArchiveManifestTransform = (
+  manifest: NpmArchiveManifest,
+) => Readonly<Record<string, unknown>>;
+
+function archiveFileEntries(directory: string, prefix = ""): string[] {
+  return readdirSync(directory, { withFileTypes: true }).flatMap((entry) => {
+    const relativePath = prefix ? `${prefix}/${entry.name}` : entry.name;
+    return entry.isDirectory()
+      ? archiveFileEntries(join(directory, entry.name), relativePath)
+      : [relativePath];
+  });
+}
+
 function normalizedRepository(value: unknown): string | undefined {
   const url =
     typeof value === "string"
@@ -241,25 +257,60 @@ export function packNpmPackage(
   directory: string,
   destination: string,
   path = process.env.PATH ?? "",
+  transformManifest?: NpmArchiveManifestTransform,
 ): string {
   const executable = process.versions.bun ? process.execPath : "bun";
-  exec.spawnSync(
-    executable,
-    ["pm", "pack", "--destination", destination, "--ignore-scripts", "--quiet"],
-    {
-      cwd: directory,
-      env: { ...process.env, PATH: path },
-      stdout: "inherit",
-      stderr: "inherit",
-      stdin: "ignore",
-      check: true,
-    },
-  );
+  const manifest = join(directory, "package.json");
+  const manifestMode = lstatSync(manifest).mode & 0o777;
+  const restoreManifestMode = (manifestMode & 0o200) === 0;
+  if (restoreManifestMode) chmodSync(manifest, manifestMode | 0o200);
+  try {
+    exec.spawnSync(
+      executable,
+      ["pm", "pack", "--destination", destination, "--ignore-scripts", "--quiet"],
+      {
+        cwd: directory,
+        env: { ...process.env, PATH: path },
+        stdout: "inherit",
+        stderr: "inherit",
+        stdin: "ignore",
+        check: true,
+      },
+    );
+  } finally {
+    if (restoreManifestMode) chmodSync(manifest, manifestMode);
+  }
   const archives = readdirSync(destination).filter((file) => file.endsWith(".tgz"));
   if (archives.length !== 1) {
     throw new Error(`Expected one packed npm archive, found ${archives.length}`);
   }
-  return join(destination, archives[0]);
+  const archive = join(destination, archives[0]);
+  if (!transformManifest) return archive;
+
+  const temp = mkdtempSync(join(tmpdir(), "projen-npm-project-"));
+  try {
+    exec.spawnSync("tar", ["-xzf", archive, "-C", temp], {
+      cwd: process.cwd(),
+      stdout: "ignore",
+      stderr: "inherit",
+      stdin: "ignore",
+      check: true,
+    });
+    const manifestPath = join(temp, "package", "package.json");
+    const manifest = JSON.parse(readFileSync(manifestPath, "utf8")) as NpmArchiveManifest;
+    writeFileSync(manifestPath, `${JSON.stringify(transformManifest(manifest), null, 2)}\n`);
+    rmSync(archive, { force: true });
+    exec.spawnSync("tar", ["-czf", archive, "-C", temp, ...archiveFileEntries(temp)], {
+      cwd: process.cwd(),
+      stdout: "ignore",
+      stderr: "inherit",
+      stdin: "ignore",
+      check: true,
+    });
+    return archive;
+  } finally {
+    rmSync(temp, { recursive: true, force: true });
+  }
 }
 
 export async function publishNpmArchives(options: {
@@ -291,23 +342,13 @@ export async function publishNpmArchives(options: {
         continue;
       }
     }
-    exec.spawnSync(
-      "npm",
-      [
-        "publish",
-        archive,
-        ...(local.access ? ["--access", local.access] : []),
-        ...(options.registry ? ["--registry", options.registry] : []),
-        ...(options.dryRun ? ["--dry-run"] : []),
-      ],
-      {
-        cwd: process.cwd(),
-        stdout: "inherit",
-        stderr: "inherit",
-        stdin: "ignore",
-        check: true,
-      },
-    );
+    runTaskCommand(process.cwd(), "npm", [
+      "publish",
+      archive,
+      ...(local.access ? ["--access", local.access] : []),
+      ...(options.registry ? ["--registry", options.registry] : []),
+      ...(options.dryRun ? ["--dry-run"] : []),
+    ]);
   }
 }
 

package/tasks/publish-python.ts

@@ -1,38 +1,29 @@
 #!/usr/bin/env -S bun
 import {
   chmodSync,
+  cpSync,
   existsSync,
   mkdirSync,
   mkdtempSync,
   readFileSync,
   readdirSync,
   rmSync,
-  statSync,
   writeFileSync,
 } from "node:fs";
 import { tmpdir } from "node:os";
-import { basename, join, resolve } from "node:path";
-import * as exec from "@dbx-tools/core/exec";
+import { basename, dirname, join, resolve } from "node:path";
 import { Command } from "commander";
 import { parse, stringify } from "smol-toml";
-import { pythonProjectInfo, stampPythonProject } from "./uniffi-python.js";
-import type { ReleasePlan } from "../src/release-plan.ts";
+import { preparePythonProjectForPublication, pythonProjectInfo } from "./python-release.ts";
+import { runTaskCommand } from "../src/_task-command.ts";
 
 interface PythonProjectFile {
   readonly directory: string;
-  readonly mode: number;
   readonly name: string;
   readonly version: string;
   readonly path: string;
   readonly private: boolean;
   readonly source: string;
-  readonly uniffi: boolean;
-}
-
-export interface StampPythonProjectsOptions {
-  readonly excludeUniFFI?: boolean;
-  readonly rewriteDependencies?: boolean;
-  readonly versions?: ReadonlyMap<string, string>;
 }
 
 /** Python wheel and source archives accepted by Twine and package indexes. */
@@ -43,16 +34,7 @@ export function pythonDistributionPaths(directory: string): string[] {
     .map((file) => join(directory, file));
 }
 
-export interface RestorePythonProjects {
-  (): void;
-  readonly paths: readonly string[];
-}
-
-export function stampPythonProjects(
-  root: string,
-  version: string,
-  options: StampPythonProjectsOptions = {},
-): RestorePythonProjects {
+function pythonProjects(root: string): PythonProjectFile[] {
   const packageFiles = readdirSync(root, { withFileTypes: true })
     .filter((entry) => entry.isDirectory())
     .map((entry) => resolve(root, entry.name, "pyproject.toml"))
@@ -60,59 +42,17 @@ export function stampPythonProjects(
     .sort();
   const allProjects: PythonProjectFile[] = packageFiles.map((path) => {
     const source = readFileSync(path, "utf8");
-    const info = pythonProjectInfo(source, { parse, stringify });
+    const info = pythonProjectInfo(source, { parse });
     return {
       directory: basename(resolve(path, "..")),
-      mode: statSync(path).mode,
       name: info.name,
       version: info.version,
       path,
       private: info.private,
       source,
-      uniffi: info.uniffi,
     };
   });
-  const projects = allProjects.filter(
-    (project) =>
-      !project.private &&
-      (!options.excludeUniFFI || !project.uniffi) &&
-      (!options.versions || options.versions.has(project.directory)),
-  );
-  if (projects.length === 0) throw new Error(`No Python packages found under ${root}`);
-
-  try {
-    for (const project of projects) {
-      const stamped = stampPythonProject(project.source, {
-        packages: allProjects,
-        rewriteDependencies: options.rewriteDependencies,
-        usePackageVersions: options.versions !== undefined,
-        toml: { parse, stringify },
-        version: options.versions?.get(project.directory) ?? version,
-      });
-      chmodSync(project.path, project.mode | 0o200);
-      writeFileSync(project.path, stamped);
-      chmodSync(project.path, project.mode);
-    }
-  } catch (error) {
-    for (const project of projects) {
-      chmodSync(project.path, project.mode | 0o200);
-      writeFileSync(project.path, project.source);
-      chmodSync(project.path, project.mode);
-    }
-    throw error;
-  }
-
-  const restore = () => {
-    for (const project of projects) {
-      chmodSync(project.path, project.mode | 0o200);
-      writeFileSync(project.path, project.source);
-      chmodSync(project.path, project.mode);
-    }
-  };
-  Object.defineProperty(restore, "paths", {
-    value: projects.map((project) => project.path),
-  });
-  return restore as RestorePythonProjects;
+  return allProjects;
 }
 
 export function publishPythonProjects(options: {
@@ -121,12 +61,12 @@ export function publishPythonProjects(options: {
   readonly publishUrl: string;
   readonly root: string;
   readonly version: string;
-  readonly plan?: ReleasePlan;
 }): void {
   const output = mkdtempSync(join(tmpdir(), "projen-python-publish-"));
   try {
     buildPythonProjects({ ...options, output });
-    exec.spawnSync(
+    runTaskCommand(
+      process.cwd(),
       "uvx",
       [
         "--from",
@@ -139,14 +79,7 @@ export function publishPythonProjects(options: {
         ...(options.dryRun ? ["--dry-run"] : []),
         output,
       ],
-      {
-        cwd: process.cwd(),
-        env: { ...process.env, UV_DEFAULT_INDEX: options.indexUrl },
-        stdout: "inherit",
-        stderr: "inherit",
-        stdin: "ignore",
-        check: true,
-      },
+      { env: { ...process.env, UV_DEFAULT_INDEX: options.indexUrl } },
     );
   } finally {
     rmSync(output, { recursive: true, force: true });
@@ -156,117 +89,97 @@ export function publishPythonProjects(options: {
 /** Build the exact Python release distributions without publishing them. */
 export function buildPythonProjects(options: {
   readonly allowEmpty?: boolean;
-  readonly excludeUniFFI?: boolean;
   readonly output: string;
+  readonly packages?: readonly string[];
   readonly root: string;
   readonly version: string;
-  readonly plan?: ReleasePlan;
 }): void {
   const root = resolve(options.root);
   const output = resolve(options.output);
   rmSync(output, { recursive: true, force: true });
-  const standardProjects = options.excludeUniFFI
-    ? readdirSync(root, { withFileTypes: true })
-        .filter((entry) => entry.isDirectory())
-        .map((entry) => resolve(root, entry.name, "pyproject.toml"))
-        .filter(existsSync)
-        .map((path) => pythonProjectInfo(readFileSync(path, "utf8"), { parse, stringify }))
-        .filter((project) => !project.private && !project.uniffi)
-    : undefined;
-  if (standardProjects?.length === 0 && options.allowEmpty) {
+  const allProjects = pythonProjects(root);
+  const requested = new Set(options.packages ?? []);
+  const missing = [...requested].filter(
+    (directory) => !allProjects.some((project) => project.directory === directory),
+  );
+  if (missing.length > 0) throw new Error(`Unknown Python packages: ${missing.join(", ")}`);
+  const projects = allProjects.filter(
+    (project) => !project.private && (requested.size === 0 || requested.has(project.directory)),
+  );
+  if (projects.length === 0 && options.allowEmpty) {
     mkdirSync(output, { recursive: true });
     return;
   }
-  const planned = new Map(
-    options.plan?.pythonPackages.map((pkg) => [pkg.path.replace(/^.*\//, ""), pkg.version]) ?? [],
-  );
-  const stamp = stampPythonProjects(root, options.version, {
-    excludeUniFFI: options.excludeUniFFI,
-    ...(options.plan ? { versions: planned } : {}),
-  });
+  if (projects.length === 0) throw new Error(`No Python packages found under ${root}`);
+
+  const temporaryRoot = mkdtempSync(join(tmpdir(), "projen-python-release-"));
   try {
-    const packages = options.plan?.pythonPackages ?? [];
-    if (packages.length > 0) {
-      for (const pkg of packages) {
-        exec.spawnSync("uv", ["build", "--package", pkg.identity, "--out-dir", output], {
-          cwd: process.cwd(),
-          stdout: "inherit",
-          stderr: "inherit",
-          stdin: "ignore",
-          check: true,
-        });
-      }
-    } else if (options.excludeUniFFI) {
-      for (const project of standardProjects ?? []) {
-        exec.spawnSync("uv", ["build", "--package", project.name, "--out-dir", output], {
-          cwd: process.cwd(),
-          stdout: "inherit",
-          stderr: "inherit",
-          stdin: "ignore",
-          check: true,
-        });
-      }
-    } else {
-      exec.spawnSync("uv", ["build", "--all-packages", "--out-dir", output], {
-        cwd: process.cwd(),
-        stdout: "inherit",
-        stderr: "inherit",
-        stdin: "ignore",
-        check: true,
-      });
+    mkdirSync(output, { recursive: true });
+    for (const project of projects) {
+      const packageRoot = join(temporaryRoot, project.directory);
+      cpSync(dirname(project.path), packageRoot, { recursive: true });
+      const manifestPath = join(packageRoot, "pyproject.toml");
+      chmodSync(manifestPath, 0o644);
+      writeFileSync(
+        manifestPath,
+        preparePythonProjectForPublication(project.source, {
+          packages: allProjects,
+          toml: { parse, stringify },
+          version: options.version,
+        }),
+      );
+      runTaskCommand(root, "uv", ["build", "--out-dir", output, packageRoot]);
     }
     const distributions = pythonDistributionPaths(output);
     if (distributions.length === 0) {
       throw new Error(`No Python distributions found in ${output}`);
     }
-    exec.spawnSync("uvx", ["twine", "check", ...distributions], {
-      cwd: process.cwd(),
-      stdout: "inherit",
-      stderr: "inherit",
-      stdin: "ignore",
-      check: true,
-    });
+    runTaskCommand(process.cwd(), "uvx", ["twine", "check", ...distributions]);
   } finally {
-    stamp();
+    rmSync(temporaryRoot, { recursive: true, force: true });
   }
 }
 
 if (import.meta.main) {
   const program = new Command();
   program
-    .argument("[version]", "Python package version")
-    .requiredOption("--index-url <url>", "devpi Simple API URL")
-    .requiredOption("--publish-url <url>", "devpi writable index URL")
+    .argument("<version>", "Python package version")
+    .option("--index-url <url>", "devpi Simple API URL")
+    .option("--publish-url <url>", "devpi writable index URL")
     .option("--root <path>", "Python workspace package root", "packages/py")
-    .option("--plan <path>", "affected release plan")
+    .option("--package <directory...>", "Build only selected package directories")
     .option("--output <path>", "Build distributions into a directory without publishing")
     .option("--dry-run", "build and inspect distributions without uploading")
     .action(
       (
-        version: string | undefined,
+        version: string,
         options: {
           dryRun?: boolean;
-          indexUrl: string;
-          publishUrl: string;
+          indexUrl?: string;
+          package?: string[];
+          publishUrl?: string;
           root: string;
-          plan?: string;
           output?: string;
         },
       ) => {
-        const plan = options.plan
-          ? (JSON.parse(readFileSync(options.plan, "utf8")) as ReleasePlan)
-          : undefined;
-        const fallbackVersion = version ?? plan?.pythonPackages[0]?.version;
-        if (!fallbackVersion) throw new Error("Python publication requires a version or plan");
         if (options.output) {
           buildPythonProjects({
             output: options.output,
+            packages: options.package,
             root: options.root,
-            version: fallbackVersion,
-            plan,
+            version,
           });
         } else {
-          publishPythonProjects({ ...options, version: fallbackVersion, plan });
+          if (!options.indexUrl || !options.publishUrl) {
+            throw new Error("--index-url and --publish-url are required when publishing");
+          }
+          publishPythonProjects({
+            dryRun: options.dryRun,
+            indexUrl: options.indexUrl,
+            publishUrl: options.publishUrl,
+            root: options.root,
+            version,
+          });
         }
       },
     );