weiqingy commented on code in PR #938: URL: https://github.com/apache/flink-agents/pull/938#discussion_r3780383385
########## api/src/main/java/org/apache/flink/agents/api/subagent/Result.java: ########## @@ -0,0 +1,98 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.flink.agents.api.subagent; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonProperty; + +import java.io.PrintWriter; +import java.io.Serializable; +import java.io.StringWriter; + +/** + * Outcome of a {@link Subagent} call. + * + * <p>Sub-agent implementations should capture internal failures into a {@code Result} (via {@link + * #error}) instead of throwing, so callers can inspect {@link #isSuccess()} without try/catch. + * + * <p>The failure cause is carried as a serializable {@code errorMessage} — the full stack trace of + * the failure — rather than a live exception, so that a {@code Result} can be persisted through + * durable execution. + */ +public class Result implements Serializable { + + private static final long serialVersionUID = 1L; + + private final boolean success; + private final Object result; + private final String errorMessage; + + @JsonCreator + public Result( + @JsonProperty("success") boolean success, + @JsonProperty("result") Object result, + @JsonProperty("errorMessage") String errorMessage) { + this.success = success; + this.result = result; + this.errorMessage = errorMessage; + } + + /** Creates a successful result carrying the given value. */ + public static Result ok(Object result) { + return new Result(true, result, null); + } + + /** Creates a failed result carrying the full stack trace of the given exception. */ + public static Result error(Exception exception) { + return new Result(false, null, exception == null ? null : stackTraceOf(exception)); Review Comment: Capturing into `Result` rather than throwing seems right to me, and `SUCCEEDED` at the durable layer reads correctly for the same reason: the record says the call completed and returned a value, and whether that value is a failure is the sub-agent's concern. The stack-trace half is already handled in 519816dd6, which logs the full trace and persists just type plus message (`Result.java:79,88`). Nothing further from me. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
