Copilot commented on code in PR #27891: URL: https://github.com/apache/flink/pull/27891#discussion_r3083424535
########## flink-runtime/src/main/java/org/apache/flink/runtime/rest/handler/job/rescales/JobRescalesOverviewHandler.java: ########## @@ -0,0 +1,122 @@ +/* + * 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.runtime.rest.handler.job.rescales; + +import org.apache.flink.api.common.JobID; +import org.apache.flink.runtime.rest.handler.HandlerRequest; +import org.apache.flink.runtime.rest.handler.RestHandlerException; +import org.apache.flink.runtime.rest.handler.job.AbstractExecutionGraphHandler; +import org.apache.flink.runtime.rest.handler.legacy.ExecutionGraphCache; +import org.apache.flink.runtime.rest.messages.EmptyRequestBody; +import org.apache.flink.runtime.rest.messages.ErrorResponseBody; +import org.apache.flink.runtime.rest.messages.JobIDPathParameter; +import org.apache.flink.runtime.rest.messages.JobMessageParameters; +import org.apache.flink.runtime.rest.messages.MessageHeaders; +import org.apache.flink.runtime.rest.messages.ResponseBody; +import org.apache.flink.runtime.rest.messages.job.rescales.JobRescalesOverview; +import org.apache.flink.runtime.rest.messages.job.rescales.JobRescalesOverviewHeaders; +import org.apache.flink.runtime.scheduler.ExecutionGraphInfo; +import org.apache.flink.runtime.scheduler.adaptive.timeline.RescalesStatsSnapshot; +import org.apache.flink.runtime.webmonitor.RestfulGateway; +import org.apache.flink.runtime.webmonitor.history.ArchivedJson; +import org.apache.flink.runtime.webmonitor.history.JsonArchivist; +import org.apache.flink.runtime.webmonitor.retriever.GatewayRetriever; + +import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus; + +import java.io.IOException; +import java.time.Duration; +import java.util.Collection; +import java.util.Collections; +import java.util.Map; +import java.util.concurrent.Executor; + +/** Handler to response job rescales overview. */ Review Comment: The class-level JavaDoc has a grammatical error: "Handler to response ..." should be "Handler to respond ..." (or similar). Please adjust to avoid new typos in public code comments. ```suggestion /** Handler to respond with a job rescales overview. */ ``` ########## flink-runtime/src/main/java/org/apache/flink/runtime/rest/handler/job/rescales/JobRescalesOverviewHandler.java: ########## @@ -0,0 +1,122 @@ +/* + * 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.runtime.rest.handler.job.rescales; + +import org.apache.flink.api.common.JobID; +import org.apache.flink.runtime.rest.handler.HandlerRequest; +import org.apache.flink.runtime.rest.handler.RestHandlerException; +import org.apache.flink.runtime.rest.handler.job.AbstractExecutionGraphHandler; +import org.apache.flink.runtime.rest.handler.legacy.ExecutionGraphCache; +import org.apache.flink.runtime.rest.messages.EmptyRequestBody; +import org.apache.flink.runtime.rest.messages.ErrorResponseBody; +import org.apache.flink.runtime.rest.messages.JobIDPathParameter; +import org.apache.flink.runtime.rest.messages.JobMessageParameters; +import org.apache.flink.runtime.rest.messages.MessageHeaders; +import org.apache.flink.runtime.rest.messages.ResponseBody; +import org.apache.flink.runtime.rest.messages.job.rescales.JobRescalesOverview; +import org.apache.flink.runtime.rest.messages.job.rescales.JobRescalesOverviewHeaders; +import org.apache.flink.runtime.scheduler.ExecutionGraphInfo; +import org.apache.flink.runtime.scheduler.adaptive.timeline.RescalesStatsSnapshot; +import org.apache.flink.runtime.webmonitor.RestfulGateway; +import org.apache.flink.runtime.webmonitor.history.ArchivedJson; +import org.apache.flink.runtime.webmonitor.history.JsonArchivist; +import org.apache.flink.runtime.webmonitor.retriever.GatewayRetriever; + +import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus; + +import java.io.IOException; +import java.time.Duration; +import java.util.Collection; +import java.util.Collections; +import java.util.Map; +import java.util.concurrent.Executor; + +/** Handler to response job rescales overview. */ +public class JobRescalesOverviewHandler + extends AbstractExecutionGraphHandler<JobRescalesOverview, JobMessageParameters> + implements JsonArchivist { + + public JobRescalesOverviewHandler( + GatewayRetriever<? extends RestfulGateway> leaderRetriever, + Duration timeout, + Map<String, String> responseHeaders, + MessageHeaders<EmptyRequestBody, JobRescalesOverview, JobMessageParameters> + messageHeaders, + ExecutionGraphCache executionGraphCache, + Executor executor) { + super( + leaderRetriever, + timeout, + responseHeaders, + messageHeaders, + executionGraphCache, + executor); + } + + @Override + protected JobRescalesOverview handleRequest( + HandlerRequest<EmptyRequestBody> request, ExecutionGraphInfo executionGraphInfo) + throws RestHandlerException { + RescalesStatsSnapshot rescalesStatsSnapshot = executionGraphInfo.getRescalesStatsSnapshot(); + JobID jobId = executionGraphInfo.getJobId(); + + if (rescalesStatsSnapshot == null) { + throw new RestHandlerException( + "AdaptiveScheduler rescales was not enabled for job " + jobId + '.', + HttpResponseStatus.NOT_FOUND); + } + + return JobRescalesOverview.fromRescalesStatsSnapshot(rescalesStatsSnapshot); + } + + private JobRescalesOverview getJobRescalesOverview(ExecutionGraphInfo executionGraphInfo) + throws RestHandlerException { + if (executionGraphInfo.getRescalesStatsSnapshot() == null + || executionGraphInfo.getRescalesStatsSnapshot().getRescaleHistory() == null) { + throw new RestHandlerException( + "AdaptiveScheduler is not enabled for this job (" + + executionGraphInfo.getJobId() + + ").", + HttpResponseStatus.NOT_FOUND, + RestHandlerException.LoggingBehavior.IGNORE); + } + return JobRescalesOverview.fromRescalesStatsSnapshot( + executionGraphInfo.getRescalesStatsSnapshot()); + } Review Comment: `handleRequest()` and `getJobRescalesOverview()` duplicate the same enablement checks but currently diverge (different error messages and different logging behavior). This makes future changes error-prone and can lead to inconsistent REST vs archived responses. Consider having `handleRequest()` delegate to `getJobRescalesOverview()` (or removing the helper and using a single code path) so both live and archived endpoints behave identically. -- 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]
