Skip to content

赵月辉 / fastgpt-migrated

Go to a project
Commit 6173a745 by Jon Committed by GitHub
Options

Refactor/unify sandbox client (#6735) 

* chore: update sandbox-adapter to version 0.0.35

* refactor: unify sandbox creation through getSandboxClient

* refactor: Simplify sandbox instance handling logic

* feat: Add support for custom create config in sandbox
parent cd75ee16
Showing with 108 additions and 81 deletions
packages/service/core/agentSkills/sandboxConfig.ts
......@@ -340,6 +340,39 @@ export function buildVolumeConfig(
}
/**
* Poll the sandbox endpoint until the service inside the container is accepting connections.
*
* Uses HTTP HEAD to avoid triggering application logic; any HTTP response
* (including 4xx/5xx) means the port is open and the service is ready.
* Retries on network errors (ECONNREFUSED / fetch failure) until timeout.
*/
export async function waitForEndpointReady(
endpoint: SkillSandboxEndpointType,
options?: { timeoutMs?: number; intervalMs?: number }
): Promise<void> {
const timeoutMs = options?.timeoutMs ?? 30_000;
const intervalMs = options?.intervalMs ?? 500;
const deadline = Date.now() + timeoutMs;
while (Date.now() < deadline) {
try {
await fetch(endpoint.url, {
method: 'HEAD',
signal: AbortSignal.timeout(3_000)
});
return; // any response means port is open
} catch {
// ECONNREFUSED or timeout — service not ready yet
}
await new Promise((resolve) => setTimeout(resolve, intervalMs));
}
throw new Error(
`Sandbox endpoint ${endpoint.url} did not become ready within ${timeoutMs / 1000}s`
);
}
/**
* Build container env vars for the sandbox process.
*/
export function buildBaseContainerEnv(
......
packages/service/core/ai/sandbox/config.ts
......@@ -45,9 +45,10 @@ export const buildOpenSandboxCreateConfig = (
opts: {
volumes?: OpenSandboxConfigType['volumes'];
resourceLimits?: OpenSandboxConfigType['resourceLimits'];
createConfig?: OpenSandboxConfigType;
} = {}
): OpenSandboxConfigType => {
if (!env.AGENT_SANDBOX_OPENSANDBOX_IMAGE_REPO) {
if (!env.AGENT_SANDBOX_OPENSANDBOX_IMAGE_REPO && !opts.createConfig?.image) {
throw new Error('AGENT_SANDBOX_OPENSANDBOX_IMAGE_REPO is required for opensandbox provider');
}
return {
......@@ -56,6 +57,7 @@ export const buildOpenSandboxCreateConfig = (
tag: env.AGENT_SANDBOX_OPENSANDBOX_IMAGE_TAG
},
...(opts.resourceLimits ? { resourceLimits: opts.resourceLimits } : {}),
...opts.createConfig,
...(opts.volumes ? { volumes: opts.volumes } : {})
};
};
......
packages/service/core/ai/sandbox/controller.ts
......@@ -9,7 +9,8 @@ import {
createSandbox,
type ExecuteResult,
type ISandbox,
type ResourceLimits
type ResourceLimits,
type OpenSandboxConfigType
} from '@fastgpt-sdk/sandbox-adapter';
import {
getOpenSandboxConnectionConfig,
......@@ -49,6 +50,7 @@ export class SandboxClient {
private readonly opts: {
resourceLimits?: ResourceLimits;
vmConfig?: VolumeManagerResult | undefined;
createConfig?: OpenSandboxConfigType;
}
) {
this.sandboxId = props.sandboxId;
......@@ -62,13 +64,15 @@ export class SandboxClient {
const config = getSealosConnectionConfig(this.sandboxId);
this.provider = createSandbox('sealosdevbox', config, undefined);
} else if (providerName === 'opensandbox') {
// volumes 在 ensureAvailable 中异步获取后重建 provider，此处用基础 createConfig
// volumes always come from vmConfig (ensures PVC binding is correct);
// custom createConfig takes priority for image/entrypoint/env/metadata
this.provider = createSandbox(
'opensandbox',
getOpenSandboxConnectionConfig({ sessionId: this.sandboxId }),
buildOpenSandboxCreateConfig({
resourceLimits: opts?.resourceLimits,
volumes: opts?.vmConfig?.volumes
volumes: opts?.vmConfig?.volumes,
createConfig: opts?.createConfig
})
);
} else if (providerName === 'e2b') {
......@@ -170,6 +174,7 @@ export const getSandboxClient = async (
| UnionIdType,
opts: {
resourceLimits?: ResourceLimits;
createConfig?: OpenSandboxConfigType;
} = {}
) => {
const sandboxId = (() => {
......
packages/service/core/workflow/dispatch/ai/agent/sub/sandbox/lifecycle.ts
......@@ -8,7 +8,7 @@
* - releaseAgentSandbox：断开 SDK 连接，不销毁容器
*/
import type { ISandbox, OpenSandboxVolume } from '@fastgpt-sdk/sandbox-adapter';
import type { ISandbox } from '@fastgpt-sdk/sandbox-adapter';
import type { HydratedDocument } from 'mongoose';
import { MongoAgentSkills } from '../../../../../../agentSkills/schema';
import { MongoSandboxInstance } from '../../../../../../ai/sandbox/schema';
......@@ -19,16 +19,12 @@ import {
getSandboxProviderConfig,
getSandboxDefaults,
validateSandboxConfig,
buildSandboxAdapter,
connectToProviderSandbox,
disconnectFromProviderSandbox,
getVolumeManagerConfig,
ensureSessionVolume,
buildVolumeConfig,
buildBaseContainerEnv
} from '../../../../../../agentSkills/sandboxConfig';
import { SandboxTypeEnum } from '@fastgpt/global/core/agentSkills/constants';
import { SandboxStatusEnum } from '@fastgpt/global/core/ai/sandbox/constants';
import { getSandboxClient, type SandboxClient } from '../../../../../../ai/sandbox/controller';
import { env } from '../../../../../../../env';
import type {
AgentSkillSchemaType,
......@@ -202,21 +198,11 @@ export async function createAgentSandbox(
});
onProgress?.({ sandboxId: sessionId, phase: 'connecting', isWarmStart: true });
const sandbox = await connectToProviderSandbox(providerConfig, existingInstance.sandboxId);
if (existingInstance.status === SandboxStatusEnum.stopped) {
logger.info('[Agent Sandbox] Resuming stopped sandbox', {
sessionId,
providerSandboxId: existingInstance.sandboxId
});
await sandbox.start();
await sandbox.waitUntilReady(60000);
}
await MongoSandboxInstance.updateOne(
{ _id: existingInstance._id },
{ lastActiveAt: new Date() }
);
// getSandboxClient internally calls ensureAvailable():
// - updates DB status=running, lastActiveAt
// - calls provider.ensureRunning() to ensure container is running (handles stopped→running)
const client = await getSandboxClient({ sandboxId: existingInstance.sandboxId });
const reusedSkillIds = existingInstance.metadata?.skillIds
? existingInstance.metadata.skillIds.map(String)
......@@ -227,10 +213,9 @@ export async function createAgentSandbox(
const mergedSkills = skills.map((skill) =>
mergeSkillWithVersion(skill.toJSON(), versionMap.get(String(skill._id)))
);
// Dynamically discover deployed skills instead of reconstructing from DB name assumptions
const deployedSkills = await discoverSkillsInSandbox(sandbox, defaults.workDirectory);
const deployedSkills = await discoverSkillsInSandbox(client.provider, defaults.workDirectory);
return {
sandbox,
sandbox: client.provider,
providerSandboxId: existingInstance.sandboxId,
sessionId,
skills: mergedSkills,
......@@ -284,26 +269,22 @@ export async function createAgentSandbox(
}
}
// Step 3: Create sandbox container, inject SESSION_ID
let sandbox: ISandbox | null = null;
// Step 3: Create sandbox container via getSandboxClient (handles volumes internally)
let sandboxClient: SandboxClient | null = null;
try {
const createEntrypoint = defaults.entrypoint;
let volumes: OpenSandboxVolume[] | undefined;
if (providerConfig.provider === 'opensandbox' && env.AGENT_SANDBOX_ENABLE_VOLUME) {
const vmConfig = getVolumeManagerConfig();
const claimName = await ensureSessionVolume(sessionId, vmConfig);
volumes = [
buildVolumeConfig(providerConfig.runtime, sessionId, claimName, vmConfig.mountPath)
];
}
onProgress?.({ sandboxId: sessionId, phase: 'creatingContainer', isWarmStart: false });
const createConfig = {
// getSandboxClient handles volumes internally (via getVolumeManagerConfig) and calls
// provider.ensureRunning() which creates the container when it doesn't exist
const client = await getSandboxClient(
{ sandboxId: sessionId },
{
createConfig: {
image: image ?? defaults.defaultImage,
entrypoint: [entrypoint ?? createEntrypoint],
entrypoint: [entrypoint ?? defaults.entrypoint],
env: buildBaseContainerEnv(sessionId, defaults.workDirectory, false),
volumes,
// volumes: handled internally by getSandboxClient via getVolumeManagerConfig
metadata: {
teamId,
tmbId,
......@@ -311,19 +292,12 @@ export async function createAgentSandbox(
skillIds: skillIds.join('-'),
sessionId
}
};
sandbox = buildSandboxAdapter(providerConfig, {
providerSandboxId: sessionId,
createConfig
});
onProgress?.({ sandboxId: sessionId, phase: 'creatingContainer', isWarmStart: false });
await sandbox.create();
await sandbox.waitUntilReady(60000);
}
}
);
sandboxClient = client;
const sandboxInfo = await sandbox.getInfo();
const sandboxInfo = await client.provider.getInfo();
if (!sandboxInfo) throw new Error('Failed to get sandbox info after creation');
logger.info('[Agent Sandbox] Sandbox created', {
......@@ -334,7 +308,7 @@ export async function createAgentSandbox(
// Step 4: Deploy skill packages (only when skills are configured)
if (hasSkills) {
await deploySkillsToSandbox(
sandbox,
client.provider,
deployableSkills,
versionMap,
defaults.workDirectory,
......@@ -343,19 +317,19 @@ export async function createAgentSandbox(
);
}
const deployedSkills = hasSkills
? await discoverSkillsInSandbox(sandbox, defaults.workDirectory)
? await discoverSkillsInSandbox(client.provider, defaults.workDirectory)
: [];
// Step 5: Persist to MongoDB
await MongoSandboxInstance.create({
provider: providerConfig.provider,
sandboxId: sandboxInfo.id,
// Step 5: Enrich the DB record created by getSandboxClient.ensureAvailable() with full metadata.
// Use sessionId (the client-side key) because ensureAvailable() stores the record with
// sandboxId=sessionId, not with the provider-assigned sandboxInfo.id.
await MongoSandboxInstance.findOneAndUpdate(
{ sandboxId: sessionId },
{
$set: {
appId: teamId, // session-runtime uses teamId as appId
userId: tmbId,
chatId: sessionId,
status: SandboxStatusEnum.running,
lastActiveAt: new Date(),
createdAt: new Date(),
metadata: {
sandboxType: SandboxTypeEnum.sessionRuntime,
teamId,
......@@ -371,13 +345,15 @@ export async function createAgentSandbox(
},
providerCreatedAt: sandboxInfo.createdAt
}
});
}
}
);
logger.info('[Agent Sandbox] Sandbox info saved to MongoDB', { sessionId });
onProgress?.({ sandboxId: sessionId, phase: 'ready', isWarmStart: false });
return {
sandbox,
sandbox: client.provider,
providerSandboxId: sandboxInfo.id,
sessionId,
skills: hasSkills
......@@ -392,13 +368,14 @@ export async function createAgentSandbox(
} catch (error) {
logger.error('[Agent Sandbox] Failed to create sandbox', { error });
if (sandbox) {
if (sandboxClient) {
try {
await sandbox.delete();
// sandboxClient.delete() cleans up: provider container + session volume + DB record
await sandboxClient.delete();
} catch (cleanupError) {
logger.error('[Agent Sandbox] Cleanup failed after creation error', { cleanupError });
}
await disconnectFromProviderSandbox(sandbox);
await disconnectFromProviderSandbox(sandboxClient.provider);
}
throw error;
......@@ -436,9 +413,7 @@ export async function connectEditDebugSandbox(
params: ConnectEditDebugSandboxParams
): Promise<AgentSandboxContext> {
const { skillId, teamId } = params;
const providerConfig = getSandboxProviderConfig();
const defaults = getSandboxDefaults();
validateSandboxConfig(providerConfig);
const instanceDoc = await MongoSandboxInstance.findOne({
appId: skillId,
......@@ -458,9 +433,10 @@ export async function connectEditDebugSandbox(
throw new Error('Skill not found');
}
const sandbox = await connectToProviderSandbox(providerConfig, instanceDoc.sandboxId);
await MongoSandboxInstance.updateOne({ _id: instanceDoc._id }, { lastActiveAt: new Date() });
// getSandboxClient internally calls ensureAvailable():
// - updates DB status=running, lastActiveAt
// - calls provider.ensureRunning() to ensure container is running (handles stopped→running)
const client = await getSandboxClient({ sandboxId: instanceDoc.sandboxId });
logger.info('[Agent Sandbox] Connected to edit-debug sandbox', {
skillId,
......@@ -468,10 +444,10 @@ export async function connectEditDebugSandbox(
});
// Dynamically discover deployed skills instead of reading from persisted metadata
const deployedSkills = await discoverSkillsInSandbox(sandbox, defaults.workDirectory);
const deployedSkills = await discoverSkillsInSandbox(client.provider, defaults.workDirectory);
return {
sandbox,
sandbox: client.provider,
providerSandboxId: instanceDoc.sandboxId,
sessionId: String(instanceDoc._id), // editDebug sandbox uses its own _id as sessionId
skills: [skill.toJSON()],
......
packages/service/package.json
......@@ -8,7 +8,7 @@
},
"dependencies": {
"@apidevtools/json-schema-ref-parser": "^11.7.2",
"@fastgpt-sdk/sandbox-adapter": "^0.0.34",
"@fastgpt-sdk/sandbox-adapter": "^0.0.35",
"@fastgpt-sdk/otel": "catalog:",
"@fastgpt-sdk/storage": "catalog:",
"@fastgpt/global": "workspace:*",
......
pnpm-lock.yaml
......@@ -250,8 +250,8 @@ importers:
specifier: 'catalog:'
version: 0.1.2
'@fastgpt-sdk/sandbox-adapter':
specifier: ^0.0.34
version: 0.0.34
specifier: ^0.0.35
version: 0.0.35
'@fastgpt-sdk/storage':
specifier: 'catalog:'
version: 0.6.15(@opentelemetry/api@1.9.0)(@types/node@24.0.13)(jiti@2.6.0)(lightningcss@1.30.1)(proxy-agent@6.5.0)(sass@1.85.1)(terser@5.39.0)(tsx@4.20.6)(yaml@2.8.1)
......@@ -1213,6 +1213,10 @@ importers:
packages:
'@alibaba-group/opensandbox@0.1.6':
resolution: {integrity: sha512-mZ2Q2qXNC0dgctoPIlcotnlPSJ1ODMG4DKQ3AA2lTO4ZoC/vWU3CzSL5pNEU7hakfMOotQiZVxunNItVGY4W8w==}
engines: {node: '>=20'}
'@alloc/quick-lru@5.2.0':
resolution: {integrity: sha512-UrcABB+4bUrFABwbluTIBErXwvbsU/V7TZWfmbgJfbkwiBuziS9gxdODUyuiecfdGQ85jglMW6juS3+z5TsKLw==}
engines: {node: '>=10'}
......@@ -2747,8 +2751,8 @@ packages:
'@fastgpt-sdk/plugin@0.3.8':
resolution: {integrity: sha512-GjKrXMHxeF5UMkYGXawrUpzZjVRw3DICNYODeYwsUVOy+/ltu5zuwsqLkuuGQ7Arp/SBCmYRjG/MHmeNp4xxfw==}
'@fastgpt-sdk/sandbox-adapter@0.0.34':
resolution: {integrity: sha512-YXCwycqs2yByOPUMMjm2tf0BYUJfLR9D4bvHDv6xIbfKT5btT+hR1pujW5nVawXJDefYNsDfLy8dQ+IkMd21xQ==}
'@fastgpt-sdk/sandbox-adapter@0.0.35':
resolution: {integrity: sha512-pgK4qRqt24xhs4tz5oZfYK7GYloYbJrFsONWZMiFvuRvPVF7hn0BRN0er3akXhX10gUj3ASFwLnWxycEsggapQ==}
engines: {node: '>=18'}
'@fastgpt-sdk/storage@0.6.15':
......@@ -11772,6 +11776,11 @@ packages:
snapshots:
'@alibaba-group/opensandbox@0.1.6':
dependencies:
openapi-fetch: 0.14.1
undici: 7.18.2
'@alloc/quick-lru@5.2.0': {}
'@ampproject/remapping@2.3.0':
......@@ -13767,8 +13776,9 @@ snapshots:
'@fortaine/fetch-event-source': 3.0.6
zod: 4.1.12
'@fastgpt-sdk/sandbox-adapter@0.0.34':
'@fastgpt-sdk/sandbox-adapter@0.0.35':
dependencies:
'@alibaba-group/opensandbox': 0.1.6
'@e2b/code-interpreter': 2.4.0
'@fastgpt-sdk/storage@0.6.15(@opentelemetry/api@1.9.0)(@types/node@20.17.24)(jiti@2.6.0)(lightningcss@1.30.1)(sass@1.85.1)(terser@5.39.0)(tsx@4.20.6)(yaml@2.8.1)':
......
projects/app/.env.template
......@@ -50,6 +50,7 @@ AGENT_SANDBOX_OPENSANDBOX_IMAGE_TAG=v0.1
AGENT_SANDBOX_ENABLE_VOLUME=true
AGENT_SANDBOX_VOLUME_MANAGER_URL=http://localhost:3005
AGENT_SANDBOX_VOLUME_MANAGER_TOKEN=vmtoken
# Recommended to set mount path to /home/sandbox when sandbox provider is opensandbox
AGENT_SANDBOX_VOLUME_MANAGER_MOUNT_PATH=/workspace
# E2B 配置（PROVIDER=e2b 时生效）
AGENT_SANDBOX_E2B_API_KEY=
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment