phet commented on code in PR #3878: URL: https://github.com/apache/gobblin/pull/3878#discussion_r1489023429
########## gobblin-service/src/main/java/org/apache/gobblin/service/modules/orchestration/DagManagementStateStore.java: ########## @@ -0,0 +1,100 @@ +/* + * 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.gobblin.service.modules.orchestration; + +import java.io.IOException; +import java.util.Collection; +import java.util.List; +import java.util.Set; + +import org.apache.gobblin.exception.QuotaExceededException; +import org.apache.gobblin.service.modules.flowgraph.Dag; +import org.apache.gobblin.service.modules.spec.JobExecutionPlan; + + +/** + * An interface to provide abstractions for managing {@link Dag} and {@link org.apache.gobblin.service.modules.flowgraph.Dag.DagNode} states + * and allows add/delete and other functions. + */ +public interface DagManagementStateStore { + Dag<JobExecutionPlan> getDag(String dagId) throws IOException; + Dag<JobExecutionPlan> getFailedDag(String dagId) throws IOException; + void addDag(String dagId, Dag<JobExecutionPlan> dag); + boolean containsDag(String dagId); + Dag.DagNode<JobExecutionPlan> getDagNode(String dagNodeId); + Dag<JobExecutionPlan> getParentDag(Dag.DagNode<JobExecutionPlan> dagNode); + List<Dag.DagNode<JobExecutionPlan>> getDagNodes(String dagId) throws IOException; + List<Dag.DagNode<JobExecutionPlan>> getAllDagNodes() throws IOException; + boolean addCleanUpDag(String dagId); + void addDagNodeState(String dagId, Dag.DagNode<JobExecutionPlan> dagNode); + void deleteDagNodeState(String dagId, Dag.DagNode<JobExecutionPlan> dagNode); + + /** + * Persist the {@link Dag} to the backing store. + * This is not an actual checkpoint but more like a Write-ahead log, where uncommitted job will be persisted + * and be picked up again when leader transition happens. + * @param dag The dag submitted to {@link DagManager} Review Comment: javadoc feels unclear, esp. since it provides so little guidance on when and where to use this in the course of managing a Dag. if that's challenging to state as an abstract rule, include an example. also specify inter-method guarantees--e.g. if we call `addDag`, can it call `writeCheckpoint` behind the scenes for us? rather than 'checkpoint', how about 'persist' or 'track'? -- 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]
