-
Notifications
You must be signed in to change notification settings - Fork 1.3k
feat(harness): allow direct artifact delivery without host buffering #3031
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
q827505931
wants to merge
3
commits into
agentscope-ai:main
Choose a base branch
from
q827505931:codex/direct-artifact-delivery
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
...pe-harness/src/main/java/io/agentscope/harness/agent/artifact/ArtifactDeliverySource.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * Copyright 2024-2026 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.agentscope.harness.agent.artifact; | ||
|
|
||
| /** | ||
| * Metadata for an artifact delivered without downloading its bytes into the host JVM. | ||
| * | ||
| * @param filePath normalized path in the supplied agent filesystem, not a host path | ||
| * @param fileName validated plain destination file name | ||
| * @param description optional artifact description | ||
| * @param force whether an existing artifact may be overwritten | ||
| */ | ||
| public record ArtifactDeliverySource( | ||
| String filePath, String fileName, String description, boolean force) {} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
...ness/src/main/java/io/agentscope/harness/agent/artifact/DirectArtifactDeliveryTarget.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| * Copyright 2024-2026 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.agentscope.harness.agent.artifact; | ||
|
|
||
| import io.agentscope.core.agent.RuntimeContext; | ||
| import io.agentscope.harness.agent.filesystem.AbstractFilesystem; | ||
|
|
||
| /** | ||
| * Opt-in delivery SPI that receives a source path instead of materialized file bytes. | ||
| * | ||
| * <p>Configure through the existing {@code artifactDeliveryTarget} builder method. The tool | ||
| * invokes {@link #deliverFromFilesystem} without calling {@code downloadFiles}. Implementations | ||
| * can upload within the sandbox using a backend SDK or shell, or stream from their backing store. | ||
| * Existing byte-based targets continue to use {@link ArtifactDeliveryTarget} unchanged. | ||
| * Direct targets are supported only by the framework's {@code deliver_artifact} tool; callers that | ||
| * invoke them solely through the base {@link ArtifactDeliveryTarget#deliver} method receive a | ||
| * failure result because that method has no source filesystem. | ||
| * | ||
| * <p>The target must resolve the source in the supplied filesystem and runtime context, respecting | ||
| * its routing and access policy; a normalized path is not necessarily a native sandbox path. | ||
| * It must check source existence and report upload failures and destination conflicts. Do not | ||
| * interpolate untrusted paths into shell commands or expose upload credentials in tool results. | ||
| * A failure never triggers an automatic byte-download fallback. | ||
| */ | ||
| @FunctionalInterface | ||
| public interface DirectArtifactDeliveryTarget extends ArtifactDeliveryTarget { | ||
|
|
||
| /** | ||
| * Delivers a file directly from its backing environment. | ||
| * | ||
| * @param runtimeContext per-call runtime, possibly {@code null}; use it for sandbox resolution | ||
| * @param filesystem the active agent filesystem, potentially an overlay or routed filesystem | ||
| * @param source validated destination metadata and normalized source path; contains no bytes. | ||
| * The source path is not guaranteed to exist. The implementation must check existence and | ||
| * any size limit, and enforce the requested overwrite/conflict behavior. | ||
| * @return delivery result, never {@code null} | ||
| */ | ||
| ArtifactDeliveryResult deliverFromFilesystem( | ||
| RuntimeContext runtimeContext, | ||
| AbstractFilesystem filesystem, | ||
| ArtifactDeliverySource source); | ||
|
|
||
| /** Direct targets require the source filesystem rather than a byte-based request. */ | ||
| @Override | ||
| default ArtifactDeliveryResult deliver( | ||
| RuntimeContext runtimeContext, ArtifactDeliveryRequest request) { | ||
| return ArtifactDeliveryResult.fail("Direct artifact delivery requires a source filesystem"); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.