Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

fix(eve): declare generated service output directory (#3398)

OwenKephartf21e63f60152
diff --git a/.changeset/fair-services-build.md b/.changeset/fair-services-build.md
new file mode 100644
index 000000000..689956a23
--- /dev/null
+++ b/.changeset/fair-services-build.md
@@ -0,0 +1,5 @@
+---
+"eve": patch
+---
+
+Declare `.vercel/output` for generated eve services so Vercel consumes the Build Output API directory that their build commands produce instead of looking for the framework preset's `.output` default.
diff --git a/.changeset/fresh-vercels-sleep.md b/.changeset/fresh-vercels-sleep.md
new file mode 100644
index 000000000..e8ff87aa3
--- /dev/null
+++ b/.changeset/fresh-vercels-sleep.md
@@ -0,0 +1,5 @@
+---
+"eve": patch
+---
+
+Make `withEve` discover a containing workspace when Vercel evaluates `vercel.ts` from its temporary `.vercel` directory.
diff --git a/docs/guides/deployment/vercel.mdx b/docs/guides/deployment/vercel.mdx
index 6396f2be0..c13aeb48e 100644
--- a/docs/guides/deployment/vercel.mdx
+++ b/docs/guides/deployment/vercel.mdx
@@ -118,7 +118,7 @@ export default await withEve({
});
```
-A Vercel project can use only one configuration source, so remove `vercel.json` when adopting `vercel.ts`. Keep `eve` in the root package dependencies so Vercel can import `eve/vercel` while evaluating the configuration. Pass `{ root: "/absolute/workspace/path" }` as the second argument only when `vercel.ts` is evaluated from somewhere other than the workspace root.
+A Vercel project can use only one configuration source, so remove `vercel.json` when adopting `vercel.ts`. Keep `eve` in the root package dependencies so Vercel can import `eve/vercel` while evaluating the configuration. `withEve` discovers the workspace containing its evaluation directory, including Vercel's temporary `.vercel` configuration directory. Pass `{ root: "/absolute/workspace/path" }` as the second argument only when you need to select a specific workspace root.
An authored eve service routed at `/eve/v1` already uses the protocol path; callbacks remain at `/eve/v1/callback/*`. A named mount such as `/support` adds that mount before the protocol path, giving `/support/eve/v1/callback/*`.
diff --git a/packages/eve/src/internal/vercel/build-agent-workspace.integration.test.ts b/packages/eve/src/internal/vercel/build-agent-workspace.integration.test.ts
index 5b5a1d71c..46f2e0581 100644
--- a/packages/eve/src/internal/vercel/build-agent-workspace.integration.test.ts
+++ b/packages/eve/src/internal/vercel/build-agent-workspace.integration.test.ts
@@ -93,6 +93,7 @@ describe("buildAgentWorkspace", () => {
buildCommand:
"cd '../../../agents/support' && export EVE_INTERNAL_BUILD_OUTPUT_DIRECTORY='../../.eve/vercel-services/eve-support/.vercel/output' && export EVE_INTERNAL_HOST_BUILD_OUTPUT_DIRECTORY='../../.vercel/output' && export EVE_PUBLIC_ROUTE_PREFIX='/support' && export EVE_INTERNAL_AGENT_WORKSPACE_MEMBER=1 && node 'node_modules/eve/bin/eve.js' build",
framework: "eve",
+ outputDirectory: ".vercel/output",
root: ".eve/vercel-services/eve-support",
routePrefix: "/support",
routes: [
diff --git a/packages/eve/src/internal/vercel/eve-service-contribution.ts b/packages/eve/src/internal/vercel/eve-service-contribution.ts
index eb51feea7..b577a14af 100644
--- a/packages/eve/src/internal/vercel/eve-service-contribution.ts
+++ b/packages/eve/src/internal/vercel/eve-service-contribution.ts
@@ -155,6 +155,7 @@ export function compileEveVercelService(input: {
service: {
buildCommand: build.buildCommand,
framework: "eve",
+ outputDirectory: ".vercel/output",
root: build.root,
routes: [
...(homeRoute === undefined ? [] : [homeRoute]),
diff --git a/packages/eve/src/internal/vercel/vercel-services-config.test.ts b/packages/eve/src/internal/vercel/vercel-services-config.test.ts
index 94bc0160f..ce88b5950 100644
--- a/packages/eve/src/internal/vercel/vercel-services-config.test.ts
+++ b/packages/eve/src/internal/vercel/vercel-services-config.test.ts
@@ -32,6 +32,7 @@ describe("parseVercelServicesConfig", () => {
[{ services: [{}] }, /must have a non-empty name/],
[{ services: { eve: { framework: 42 } } }, /framework must be a string/],
[{ services: { eve: { mount: false } } }, /mount must be a string or JSON object/],
+ [{ services: { eve: { outputDirectory: 42 } } }, /outputDirectory must be a string/],
[{ services: { eve: { routes: {} } } }, /routes must be an array/],
[{ routes: {} }, /routes must be an array/],
[{ routes: [{ destination: 42 }] }, /destination must be a string or JSON object/],
diff --git a/packages/eve/src/internal/vercel/vercel-services-config.ts b/packages/eve/src/internal/vercel/vercel-services-config.ts
index dd0951171..4b9ca4684 100644
--- a/packages/eve/src/internal/vercel/vercel-services-config.ts
+++ b/packages/eve/src/internal/vercel/vercel-services-config.ts
@@ -32,6 +32,7 @@ export interface VercelServiceConfig {
readonly entrypoint?: string;
readonly framework?: string;
readonly mount?: string | VercelServiceMount;
+ readonly outputDirectory?: string;
readonly routes?: readonly VercelRouteConfig[];
readonly routePrefix?: string;
readonly root?: string;
@@ -41,6 +42,7 @@ export interface VercelServiceConfig {
export interface GeneratedVercelServiceConfig extends VercelServiceConfig {
readonly buildCommand: string;
readonly framework: "eve";
+ readonly outputDirectory: ".vercel/output";
readonly root: string;
readonly routes: readonly VercelRouteConfig[];
}
@@ -135,6 +137,7 @@ function parseServiceConfig(value: JsonValue, path: string): VercelServiceConfig
entrypoint: optionalString(service.entrypoint, `${path}.entrypoint`),
framework: optionalString(service.framework, `${path}.framework`),
mount: parseMount(service.mount, `${path}.mount`),
+ outputDirectory: optionalString(service.outputDirectory, `${path}.outputDirectory`),
routes: parseArray(service.routes, `${path}.routes`, parseRoute),
routePrefix: optionalString(service.routePrefix, `${path}.routePrefix`),
root: optionalString(service.root, `${path}.root`),
diff --git a/packages/eve/src/public/next/index.integration.test.ts b/packages/eve/src/public/next/index.integration.test.ts
index 50e2461d5..dfd6aeec2 100644
--- a/packages/eve/src/public/next/index.integration.test.ts
+++ b/packages/eve/src/public/next/index.integration.test.ts
@@ -85,6 +85,7 @@ describe("withEve Vercel config", () => {
buildCommand:
"cd '../../..' && export EVE_INTERNAL_BUILD_OUTPUT_DIRECTORY='.eve/vercel-services/eve/.vercel/output' && export EVE_INTERNAL_HOST_BUILD_OUTPUT_DIRECTORY='.vercel/output' && node 'node_modules/eve/bin/eve.js' build",
framework: "eve",
+ outputDirectory: ".vercel/output",
routes: [
{
src: "^/eve/v1/(.*)$",
@@ -159,6 +160,7 @@ describe("withEve Vercel config", () => {
buildCommand:
"cd '../../..' && export EVE_INTERNAL_BUILD_OUTPUT_DIRECTORY='.eve/vercel-services/eve/.vercel/output' && export EVE_INTERNAL_HOST_BUILD_OUTPUT_DIRECTORY='../../.vercel/output' && node 'node_modules/eve/bin/eve.js' build",
framework: "eve",
+ outputDirectory: ".vercel/output",
routes: [
{
src: "^/eve/v1/(.*)$",
@@ -414,6 +416,7 @@ describe("withEve Vercel config", () => {
buildCommand:
"cd '../../../agents/billing' && export EVE_INTERNAL_BUILD_OUTPUT_DIRECTORY='../../.eve/vercel-services/eve-billing/.vercel/output' && export EVE_INTERNAL_HOST_BUILD_OUTPUT_DIRECTORY='../../.vercel/output' && export EVE_PUBLIC_ROUTE_PREFIX='/eve/agents/billing' && pnpm build:billing-agent",
framework: "eve",
+ outputDirectory: ".vercel/output",
routes: [
{
src: "^/eve/agents/billing/eve/v1/(.*)$",
@@ -433,6 +436,7 @@ describe("withEve Vercel config", () => {
buildCommand:
"cd '../../../agents/support' && export EVE_INTERNAL_BUILD_OUTPUT_DIRECTORY='../../.eve/vercel-services/eve-support/.vercel/output' && export EVE_INTERNAL_HOST_BUILD_OUTPUT_DIRECTORY='../../.vercel/output' && export EVE_PUBLIC_ROUTE_PREFIX='/eve/agents/support' && node 'node_modules/eve/bin/eve.js' build",
framework: "eve",
+ outputDirectory: ".vercel/output",
routes: [
{
src: "^/eve/agents/support/eve/v1/(.*)$",
@@ -532,6 +536,7 @@ describe("withEve Vercel config", () => {
buildCommand:
"cd '../../../agents/billing' && export EVE_INTERNAL_BUILD_OUTPUT_DIRECTORY='../../.eve/vercel-services/eve-billing/.vercel/output' && export EVE_INTERNAL_HOST_BUILD_OUTPUT_DIRECTORY='../../.vercel/output' && export EVE_PUBLIC_ROUTE_PREFIX='/eve/agents/billing' && node 'node_modules/eve/bin/eve.js' build",
framework: "eve",
+ outputDirectory: ".vercel/output",
routes: [
{
src: "^/eve/agents/billing/eve/v1/(.*)$",
diff --git a/packages/eve/src/public/vercel/index.integration.test.ts b/packages/eve/src/public/vercel/index.integration.test.ts
index 52ce4fe1d..f86dc4e79 100644
--- a/packages/eve/src/public/vercel/index.integration.test.ts
+++ b/packages/eve/src/public/vercel/index.integration.test.ts
@@ -58,6 +58,7 @@ describe("withEve", () => {
buildCommand:
"cd '../../../agents/support' && export EVE_INTERNAL_BUILD_OUTPUT_DIRECTORY='../../.eve/vercel-services/eve-support/.vercel/output' && export EVE_INTERNAL_HOST_BUILD_OUTPUT_DIRECTORY='../../.vercel/output' && export EVE_PUBLIC_ROUTE_PREFIX='/support' && export EVE_INTERNAL_AGENT_WORKSPACE_MEMBER=1 && node 'node_modules/eve/bin/eve.js' build",
framework: "eve",
+ outputDirectory: ".vercel/output",
root: ".eve/vercel-services/eve-support",
routes: [
{
@@ -75,6 +76,20 @@ describe("withEve", () => {
).resolves.toBeUndefined();
});
+ it("discovers the workspace when Vercel evaluates config from .vercel", async () => {
+ const root = await createWorkspace();
+ const configDirectory = join(root, ".vercel");
+ await mkdir(configDirectory);
+ const originalCwd = process.cwd();
+ process.chdir(configDirectory);
+ try {
+ const config = await withEve({});
+ expect(config.services["eve-support"]).toBeDefined();
+ } finally {
+ process.chdir(originalCwd);
+ }
+ });
+
it("does not modify the root Build Output", async () => {
const root = await createWorkspace();
const marker = join(root, ".vercel", "output", "services", "web", "config.json");
diff --git a/packages/eve/src/public/vercel/index.ts b/packages/eve/src/public/vercel/index.ts
index 114c96178..40e80dc01 100644
--- a/packages/eve/src/public/vercel/index.ts
+++ b/packages/eve/src/public/vercel/index.ts
@@ -29,6 +29,7 @@ export interface EveVercelServiceConfig {
readonly entrypoint?: string;
readonly framework?: string;
readonly mount?: string | { readonly path?: string; readonly subdomain?: string };
+ readonly outputDirectory?: string;
readonly routes?: readonly EveVercelRouteConfig[];
readonly root?: string;
readonly type?: string;
@@ -48,7 +49,7 @@ export interface EveVercelConfig {
/** Options for composing an eve workspace into a programmatic Vercel configuration. */
export interface WithEveOptions {
- /** Eve workspace root. Defaults to the directory evaluating `vercel.ts`. */
+ /** Eve workspace root. Defaults to the workspace containing the directory evaluating `vercel.ts`. */
readonly root?: string;
}
@@ -97,13 +98,17 @@ export async function withEve<TConfig extends EveVercelConfig>(
readonly services: Readonly<Record<string, EveVercelServiceConfig>>;
}
> {
- const root = resolve(options.root ?? process.cwd());
- const context = await resolveEveProjectContext(root);
- if (context.kind !== "workspace" || context.workspace.root !== root) {
- throw new Error(`withEve must run at an eve workspace root; received ${root}.`);
+ const requestedRoot = resolve(options.root ?? process.cwd());
+ const context = await resolveEveProjectContext(requestedRoot);
+ if (
+ context.kind !== "workspace" ||
+ (options.root !== undefined && context.workspace.root !== requestedRoot)
+ ) {
+ throw new Error(`withEve must run at an eve workspace root; received ${requestedRoot}.`);
}
const { workspace } = context;
+ const root = workspace.root;
if (workspace.members.length === 0) {
throw new Error(
`withEve found no workspace agents under ${join(root, "agents")}. Add an agent or remove withEve from vercel.ts.`,
diff --git a/packages/eve/src/shared/vercel-services.integration.test.ts b/packages/eve/src/shared/vercel-services.integration.test.ts
index 2d7e6c6f1..e79e2d8d3 100644
--- a/packages/eve/src/shared/vercel-services.integration.test.ts
+++ b/packages/eve/src/shared/vercel-services.integration.test.ts
@@ -50,6 +50,7 @@ describe("ensureEveVercelServicesConfig", () => {
buildCommand:
"cd '../../..' && export EVE_INTERNAL_BUILD_OUTPUT_DIRECTORY='.eve/vercel-services/eve/.vercel/output' && export EVE_INTERNAL_HOST_BUILD_OUTPUT_DIRECTORY='.vercel/output' && node 'node_modules/eve/bin/eve.js' build",
framework: "eve",
+ outputDirectory: ".vercel/output",
routes: [
{
src: "^/eve/v1/(.*)$",
diff --git a/packages/eve/src/shared/vercel-services.test.ts b/packages/eve/src/shared/vercel-services.test.ts
index 338999ad9..3a7574cc1 100644
--- a/packages/eve/src/shared/vercel-services.test.ts
+++ b/packages/eve/src/shared/vercel-services.test.ts
@@ -13,6 +13,7 @@ const GENERATED: Extract<EnsureEveVercelServicesConfigResult, { mode: "generated
eve: {
buildCommand: "eve build",
framework: "eve",
+ outputDirectory: ".vercel/output",
routes: [createEveServiceRequestPathRoute()],
root: ".eve/vercel-services/eve",
},
diff --git a/packages/eve/src/shared/vercel-services.ts b/packages/eve/src/shared/vercel-services.ts
index ed35f7a0a..223d51131 100644
--- a/packages/eve/src/shared/vercel-services.ts
+++ b/packages/eve/src/shared/vercel-services.ts
@@ -84,6 +84,7 @@ export type EveVercelServiceRequestPathRoute = {
export type EveVercelGeneratedService = {
readonly buildCommand: string;
readonly framework: "eve";
+ readonly outputDirectory: ".vercel/output";
readonly routes: readonly VercelRouteConfig[];
readonly root: string;
};
@@ -356,6 +357,7 @@ export async function ensureEveVercelServicesConfig(input: {
[EVE_SERVICE_NAME]: {
buildCommand: generatedServiceBuild.buildCommand,
framework: "eve",
+ outputDirectory: ".vercel/output",
routes: [createEveServiceRequestPathRoute()],
root: generatedServiceBuild.root,
},