The Open Framework for Building Agents
fix(eve): allow importing of sandbox provider installed during dev session (#3685)
OwenKephart136d3395a2b9
diff --git a/.changeset/load-installed-sandbox-providers.md b/.changeset/load-installed-sandbox-providers.mdnew file mode 100644index 000000000..e706f86d0--- /dev/null+++ b/.changeset/load-installed-sandbox-providers.md@@ -0,0 +1,5 @@+---+"eve": patch+---++Load optional sandbox provider packages consistently from the application during preparation, start, and resume. Providers installed automatically by `eve dev` can now be used immediately without restarting the development server.diff --git a/packages/eve/src/execution/sandbox/provider-host.test.ts b/packages/eve/src/execution/sandbox/provider-host.test.tsnew file mode 100644index 000000000..e7c2090cf--- /dev/null+++ b/packages/eve/src/execution/sandbox/provider-host.test.ts@@ -0,0 +1,34 @@+import { describe, expect, it, vi } from "vitest";++import { importInstalledEnginePackage } from "#internal/application/optional-package-import.js";+import { createSandboxProviderHost } from "#execution/sandbox/provider-host.js";++vi.mock("#internal/application/optional-package-import.js", () => ({+ importInstalledEnginePackage: vi.fn(),+}));++const mockedImportInstalledEnginePackage = vi.mocked(importInstalledEnginePackage);++describe("createSandboxProviderHost", () => {+ it("loads an application-installed package after its bundled import fails", async () => {+ const loadedModule = { ok: true };+ mockedImportInstalledEnginePackage.mockResolvedValueOnce(loadedModule);+ const host = createSandboxProviderHost("/repo/app");++ await expect(+ host.loadOptionalPackage({+ autoInstall: true,+ importModule: async () => {+ throw new Error("bundled dependency missing");+ },+ missingMessage: "missing dependency",+ packageName: "dependency",+ }),+ ).resolves.toBe(loadedModule);++ expect(mockedImportInstalledEnginePackage).toHaveBeenCalledWith({+ appRoot: "/repo/app",+ packageName: "dependency",+ });+ });+});diff --git a/packages/eve/src/execution/sandbox/provider-host.ts b/packages/eve/src/execution/sandbox/provider-host.tsindex 542f7f020..3cc0f72b1 100644--- a/packages/eve/src/execution/sandbox/provider-host.ts+++ b/packages/eve/src/execution/sandbox/provider-host.ts@@ -1,5 +1,6 @@import { resolve } from "node:path";+import { importInstalledEnginePackage } from "#internal/application/optional-package-import.js";import type { SandboxProviderHost } from "#shared/sandbox-provider.js";export function createSandboxProviderHost(appRoot: string): SandboxProviderHost {@@ -7,8 +8,17 @@ export function createSandboxProviderHost(appRoot: string): SandboxProviderHostasync loadOptionalPackage(input) {try {return await input.importModule();- } catch (error) {- throw new Error(input.missingMessage, { cause: error });+ } catch (importError) {+ try {+ return await importInstalledEnginePackage({+ appRoot,+ packageName: input.packageName,+ });+ } catch (installedImportError) {+ throw new Error(input.missingMessage, {+ cause: new AggregateError([importError, installedImportError]),+ });+ }}},resolveProjectPath(path) {diff --git a/packages/eve/src/internal/application/optional-package-import.ts b/packages/eve/src/internal/application/optional-package-import.tsnew file mode 100644index 000000000..16ad73ef3--- /dev/null+++ b/packages/eve/src/internal/application/optional-package-import.ts@@ -0,0 +1,101 @@+import { existsSync } from "node:fs";+import { readFile } from "node:fs/promises";+import { dirname, join } from "node:path";+import { pathToFileURL } from "node:url";++/** Imports an optional engine from the application without installing it. */+export async function importInstalledEnginePackage<T>(input: {+ readonly appRoot: string;+ readonly packageName: string;+}): Promise<T> {+ const entrypointHref = await resolveInstalledEnginePackageEntrypointHref(input);+ return (await import(entrypointHref)) as T;+}++export async function resolveInstalledEnginePackageEntrypointHref(input: {+ readonly appRoot: string;+ readonly packageName: string;+}): Promise<string> {+ const packageRoot = findInstalledPackageRoot(input);+ const packageJsonPath = join(packageRoot, "package.json");+ const packageJson = JSON.parse(await readFile(packageJsonPath, "utf8")) as {+ readonly exports?: unknown;+ readonly main?: unknown;+ readonly module?: unknown;+ };+ const entry = resolvePackageEntryPoint(packageJson);+ if (entry.startsWith("/")) {+ throw new Error(`Invalid absolute entrypoint for optional package "${input.packageName}".`);+ }+ return pathToFileURL(join(packageRoot, entry)).href;+}++function findInstalledPackageRoot(input: {+ readonly appRoot: string;+ readonly packageName: string;+}): string {+ const packagePathSegments = input.packageName.split("/");+ const checkedPaths: string[] = [];+ let current = input.appRoot;++ for (;;) {+ const packageRoot = join(current, "node_modules", ...packagePathSegments);+ checkedPaths.push(packageRoot);+ if (existsSync(join(packageRoot, "package.json"))) {+ return packageRoot;+ }++ const parent = dirname(current);+ if (parent === current) {+ throw new Error(+ `Could not find installed optional dependency "${input.packageName}". Checked: ${checkedPaths.join(", ")}`,+ );+ }+ current = parent;+ }+}++function resolvePackageEntryPoint(packageJson: {+ readonly exports?: unknown;+ readonly main?: unknown;+ readonly module?: unknown;+}): string {+ const dotExport = readDotExport(packageJson.exports);+ if (dotExport !== undefined) {+ return dotExport;+ }+ if (typeof packageJson.module === "string" && packageJson.module.length > 0) {+ return packageJson.module;+ }+ if (typeof packageJson.main === "string" && packageJson.main.length > 0) {+ return packageJson.main;+ }+ return "index.js";+}++function readDotExport(exportsValue: unknown): string | undefined {+ if (typeof exportsValue === "string" && exportsValue.length > 0) {+ return exportsValue;+ }+ if (typeof exportsValue !== "object" || exportsValue === null) {+ return undefined;+ }++ const dotExport =+ "." in exportsValue ? (exportsValue as { readonly ".": unknown })["."] : exportsValue;+ if (typeof dotExport === "string" && dotExport.length > 0) {+ return dotExport;+ }+ if (typeof dotExport !== "object" || dotExport === null) {+ return undefined;+ }++ const conditional = dotExport as { readonly import?: unknown; readonly default?: unknown };+ if (typeof conditional.import === "string" && conditional.import.length > 0) {+ return conditional.import;+ }+ if (typeof conditional.default === "string" && conditional.default.length > 0) {+ return conditional.default;+ }+ return undefined;+}diff --git a/packages/eve/src/internal/application/optional-package-install.ts b/packages/eve/src/internal/application/optional-package-install.tsindex af0df0753..bbf7d42a2 100644--- a/packages/eve/src/internal/application/optional-package-install.ts+++ b/packages/eve/src/internal/application/optional-package-install.ts@@ -1,13 +1,18 @@import { spawn } from "node:child_process";import { existsSync, realpathSync } from "node:fs";-import { mkdir, readFile, rm, stat, writeFile } from "node:fs/promises";+import { mkdir, rm, stat, writeFile } from "node:fs/promises";import { dirname, join, resolve } from "node:path";-import { pathToFileURL } from "node:url";import { Worker } from "node:worker_threads";import { ensurePnpmOptionalDependencyDefaults } from "#setup/primitives/pm/pnpm-build-policy.js";import { EVE_DEV_ENV_FLAG, isEveDevEnvironment } from "#internal/application/dev-environment.js";+import {+ importInstalledEnginePackage,+ resolveInstalledEnginePackageEntrypointHref,+} from "#internal/application/optional-package-import.js";++export { importInstalledEnginePackage } from "#internal/application/optional-package-import.js";export { EVE_DEV_ENV_FLAG, isEveDevEnvironment };@@ -192,15 +197,6 @@ export async function loadOptionalEnginePackage<T>(input: {}}-/** Imports an optional engine from the application without installing it. */-export async function importInstalledEnginePackage<T>(input: {- readonly appRoot: string;- readonly packageName: string;-}): Promise<T> {- const entrypointHref = await resolveInstalledEnginePackageEntrypointHref(input);- return (await import(entrypointHref)) as T;-}-async function isInstalledEnginePackageLoadable(input: {readonly appRoot: string;readonly packageName: string;@@ -214,24 +210,6 @@ async function isInstalledEnginePackageLoadable(input: {}}-async function resolveInstalledEnginePackageEntrypointHref(input: {- readonly appRoot: string;- readonly packageName: string;-}): Promise<string> {- const packageRoot = findInstalledPackageRoot(input);- const packageJsonPath = join(packageRoot, "package.json");- const packageJson = JSON.parse(await readFile(packageJsonPath, "utf8")) as {- readonly exports?: unknown;- readonly main?: unknown;- readonly module?: unknown;- };- const entry = resolvePackageEntryPoint(packageJson);- if (entry.startsWith("/")) {- throw new Error(`Invalid absolute entrypoint for optional package "${input.packageName}".`);- }- return pathToFileURL(join(packageRoot, entry)).href;-}-async function importEntrypointInWorker(entrypointHref: string): Promise<void> {const worker = new Worker(`@@ -299,76 +277,6 @@ const { parentPort, workerData } = require("node:worker_threads");});}-function findInstalledPackageRoot(input: {- readonly appRoot: string;- readonly packageName: string;-}): string {- const packagePathSegments = input.packageName.split("/");- const checkedPaths: string[] = [];- let current = input.appRoot;-- for (;;) {- const packageRoot = join(current, "node_modules", ...packagePathSegments);- checkedPaths.push(packageRoot);- if (existsSync(join(packageRoot, "package.json"))) {- return packageRoot;- }-- const parent = dirname(current);- if (parent === current) {- throw new Error(- `Could not find installed optional dependency "${input.packageName}". Checked: ${checkedPaths.join(", ")}`,- );- }- current = parent;- }-}--function resolvePackageEntryPoint(packageJson: {- readonly exports?: unknown;- readonly main?: unknown;- readonly module?: unknown;-}): string {- const dotExport = readDotExport(packageJson.exports);- if (dotExport !== undefined) {- return dotExport;- }- if (typeof packageJson.module === "string" && packageJson.module.length > 0) {- return packageJson.module;- }- if (typeof packageJson.main === "string" && packageJson.main.length > 0) {- return packageJson.main;- }- return "index.js";-}--function readDotExport(exportsValue: unknown): string | undefined {- if (typeof exportsValue === "string" && exportsValue.length > 0) {- return exportsValue;- }- if (typeof exportsValue !== "object" || exportsValue === null) {- return undefined;- }-- const dotExport =- "." in exportsValue ? (exportsValue as { readonly ".": unknown })["."] : exportsValue;- if (typeof dotExport === "string" && dotExport.length > 0) {- return dotExport;- }- if (typeof dotExport !== "object" || dotExport === null) {- return undefined;- }-- const conditional = dotExport as { readonly import?: unknown; readonly default?: unknown };- if (typeof conditional.import === "string" && conditional.import.length > 0) {- return conditional.import;- }- if (typeof conditional.default === "string" && conditional.default.length > 0) {- return conditional.default;- }- return undefined;-}-async function withOptionalPackageInstallLock(input: { readonly appRoot: string; readonly packageName: string },callback: () => Promise<void>,