bkonold commented on a change in pull request #1366: URL: https://github.com/apache/samza/pull/1366#discussion_r430684873
########## File path: samza-core/src/main/java/org/apache/samza/container/RunLoopTask.java ########## @@ -0,0 +1,71 @@ +/* + * 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.samza.container; + +import java.util.Collections; +import java.util.Set; +import org.apache.samza.checkpoint.OffsetManager; +import org.apache.samza.scheduler.EpochTimeScheduler; +import org.apache.samza.system.IncomingMessageEnvelope; +import org.apache.samza.system.SystemStreamPartition; +import org.apache.samza.task.ReadableCoordinator; +import org.apache.samza.task.TaskCallbackFactory; + + +/** + * The interface required for a task's execution to be managed within {@link RunLoop}. + */ +public interface RunLoopTask { + + TaskName taskName(); + + Set<SystemStreamPartition> systemStreamPartitions(); + + TaskInstanceMetrics metrics(); + + void process(IncomingMessageEnvelope envelope, ReadableCoordinator coordinator, TaskCallbackFactory callbackFactory); + + void endOfStream(ReadableCoordinator coordinator); + + void window(ReadableCoordinator coordinator); + + void scheduler(ReadableCoordinator coordinator); + + void commit(); + + default boolean isWindowableTask() { + return false; + } + + default boolean isAsyncTask() { + return false; + } + + default EpochTimeScheduler epochTimeScheduler() { + return null; + } + + default Set<String> intermediateStreams() { + return Collections.emptySet(); + } + + default OffsetManager offsetManager() { + return null; + } Review comment: I agree; in retrospect this was motivated out of convenience rather than function. I'll remove the default modifiers. ########## File path: samza-core/src/main/java/org/apache/samza/container/RunLoopTask.java ########## @@ -0,0 +1,68 @@ +/* + * 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.samza.container; + +import java.util.Collections; +import org.apache.samza.checkpoint.OffsetManager; +import org.apache.samza.scheduler.EpochTimeScheduler; +import org.apache.samza.system.IncomingMessageEnvelope; +import org.apache.samza.system.SystemStreamPartition; +import org.apache.samza.task.ReadableCoordinator; +import org.apache.samza.task.TaskCallbackFactory; +import scala.collection.JavaConversions; + + +public interface RunLoopTask { Review comment: I've updated with better class-level and method-level docs. ########## File path: samza-core/src/main/java/org/apache/samza/container/RunLoopTask.java ########## @@ -0,0 +1,68 @@ +/* + * 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.samza.container; + +import java.util.Collections; +import org.apache.samza.checkpoint.OffsetManager; +import org.apache.samza.scheduler.EpochTimeScheduler; +import org.apache.samza.system.IncomingMessageEnvelope; +import org.apache.samza.system.SystemStreamPartition; +import org.apache.samza.task.ReadableCoordinator; +import org.apache.samza.task.TaskCallbackFactory; +import scala.collection.JavaConversions; + + +public interface RunLoopTask { Review comment: Regarding life cycle... RunLoop currently does not manage life cycle of the tasks it executes. This is done at the scope of SamzaContainer (i.e. the entity creating and running the RunLoop). Since this interface is targeted to the relationship between RunLoop and the tasks it executes, I don't think life cycle management belongs here. What do you think @mynameborat @cameronlee314 ? ########## File path: samza-core/src/main/java/org/apache/samza/container/RunLoopTask.java ########## @@ -0,0 +1,68 @@ +/* + * 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.samza.container; + +import java.util.Collections; +import org.apache.samza.checkpoint.OffsetManager; +import org.apache.samza.scheduler.EpochTimeScheduler; +import org.apache.samza.system.IncomingMessageEnvelope; +import org.apache.samza.system.SystemStreamPartition; +import org.apache.samza.task.ReadableCoordinator; +import org.apache.samza.task.TaskCallbackFactory; +import scala.collection.JavaConversions; + + +public interface RunLoopTask { Review comment: Discussed with @mynameborat and we think that unifying on lifecycle management will (eventually) be more necessary once we've moved side inputs back to using run loop (though a different instance at first). To consolidate to only a single RunLoop instance within container, we'd want some unified way to init/close a RunLoopTask whether it be a TaskInstance or "NotYetImplementedSideInputTask". @cameronlee314 Feel free to offer your thoughts but for now I think we can consider the life cycle issue out of scope for this PR. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected]
