fix: support build targets with different name than its path filename (#82)

* test

* fix: resolve correct binary name by parsing build target spec

* fix: use correct path when looking for build target

* test: fix compile error in fixture and add entry to probes

Author: williamboman

Cargo.toml

@@ -13,5 +13,5 @@ exclude = [
     "test/fixtures/02-with-utility",
     "test/fixtures/03-with-function",
     "test/fixtures/04-with-parameter",
-    "test/fixtures/05-preconfigured-binary"
+    "test/fixtures/05-with-similar-entrypaths"
 ]

package.json

@@ -21,6 +21,7 @@
   },
   "prettier": "@vercel/style-guide/prettier",
   "dependencies": {
+    "@iarna/toml": "^2.2.5",
     "execa": "5",
     "typescript": "^4.9.4"
   },

pnpm-lock.yaml

@@ -12,7 +12,7 @@ import {
 import execa from 'execa';
 import { installRustToolchain } from './lib/rust-toolchain';
 import type { Runtime } from './lib/runtime';
-import { getCargoMetadata } from './lib/cargo';
+import { getCargoMetadata, findBinaryName, findCargoWorkspace } from './lib/cargo';
 
 type RustEnv = Record<'RUSTFLAGS' | 'PATH', string>;
 
@@ -75,12 +75,11 @@ async function buildHandler(options: BuildOptions): Promise<BuildResultV3> {
     RUSTFLAGS: [process.env.RUSTFLAGS].filter(Boolean).join(' '),
   };
 
-  // The binary name is the name of the entrypoint file
-  // We assume each binary is specified correctly with `[[bin]]` in `Cargo.toml`
-  const binaryName = path
-    .basename(entryPath, '.rs')
-    .replace('[', '_')
-    .replace(']', '_');
+  const cargoWorkspace = await findCargoWorkspace({
+    env: rustEnv,
+    cwd: path.dirname(entryPath),
+  });
+  const binaryName = findBinaryName(cargoWorkspace, entryPath);
 
   await runUserScripts(workPath);
 

src/index.ts

@@ -1,3 +1,6 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import toml from '@iarna/toml';
 import execa from 'execa';
 
 export interface CargoMetadataRoot {
@@ -128,3 +131,54 @@ export async function getCargoMetadata(
 
   return JSON.parse(cargoMetaData) as CargoMetadataRoot;
 }
+
+interface CargoConfig {
+  env: Record<string, any>;
+  cwd: string;
+}
+
+interface CargoBuildTarget {
+  name?: string;
+  path?: string;
+}
+
+interface CargoToml {
+  bin?: CargoBuildTarget[];
+}
+
+interface CargoWorkspace {
+  toml: CargoToml;
+  root: string;
+}
+
+export async function findCargoWorkspace(
+  config: CargoConfig,
+): Promise<CargoWorkspace> {
+  const { stdout: projectDescriptionStr } = await execa(
+    'cargo',
+    ['locate-project'],
+    config,
+  );
+  const projectDescription = JSON.parse(projectDescriptionStr) as {
+    root: string;
+  };
+  return {
+    toml: await toml.parse.stream(fs.createReadStream(projectDescription.root)),
+    root: projectDescription.root,
+  };
+}
+
+export function findBinaryName(
+  workspace: CargoWorkspace,
+  entryPath: string,
+): string {
+  const { bin } = workspace.toml;
+  if (bin) {
+    const relativePath = path.relative(path.dirname(workspace.root), entryPath);
+    const entry = bin.find((binEntry) => binEntry.path === relativePath);
+    if (entry?.name) {
+      return entry.name;
+    }
+  }
+  return path.basename(entryPath, '.rs').replace('[', '_').replace(']', '_');
+}

src/lib/cargo.ts

@@ -17,9 +17,9 @@ interface Config {
 }
 
 interface Probe {
-  status: number;
   path: string;
-  mustContain: string;
+  status?: number;
+  mustContain?: string;
 }
 
 interface ProbesConf {
@@ -118,4 +118,7 @@ describe('vercel-rust', () => {
   it('deploy 04-with-parameter', async () => {
     await expect(testFixture('04-with-parameter')).resolves.toBe('ok');
   });
+  it('deploy 05-with-similar-entrypaths', async () => {
+    await expect(testFixture('05-with-similar-entrypaths')).resolves.toBe('ok');
+  });
 });

test/fixtures.test.ts

@@ -0,0 +1 @@
+.vercel

test/fixtures/01-include-files/.gitignore

@@ -0,0 +1 @@
+.vercel

test/fixtures/02-with-utility/.gitignore

@@ -0,0 +1 @@
+.vercel

test/fixtures/03-with-function/.gitignore

@@ -0,0 +1 @@
+.vercel