zhdev/oblak
1
0
Fork 0
Code Issues Pull requests Activity

✨ Add a system for creating task chains

Browse source 
This will make it easier to use the asynchronous coordinator.
This commit is contained in:
Alexander Söderberg 2020-10-06 15:50:16 +02:00 • committed by Alexander Söderberg
parent 8e52bf705c
commit aaa6386ca3
13 changed files with 660 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

44
cloud-tasks/src/main/java/cloud/commandframework/tasks/TaskConsumer.java Normal file
View file

@ -0,0 +1,44 @@
//
// MIT License
//
// Copyright (c) 2020 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.tasks;
import org.checkerframework.checker.nullness.qual.NonNull;
import java.util.function.Consumer;
/**
* Task step that does not produce any output
*
* @param <I> Input type
*/
@FunctionalInterface
public interface TaskConsumer<I> extends Consumer<@NonNull I>, TaskRecipeStep {
/**
* {@inheritDoc}
*/
@Override
void accept(@NonNull I input);
}

53
cloud-tasks/src/main/java/cloud/commandframework/tasks/TaskFactory.java Normal file
View file

@ -0,0 +1,53 @@
//
// MIT License
//
// Copyright (c) 2020 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.tasks;
import org.checkerframework.checker.nullness.qual.NonNull;
/**
* Factory that produces {@link TaskRecipe recipes}
*/
public final class TaskFactory {
private final TaskSynchronizer synchronizer;
/**
* Construct a new task factory
*
* @param synchronizer Synchronizer that will be passed onto the task recipes
*/
public TaskFactory(final @NonNull TaskSynchronizer synchronizer) {
this.synchronizer = synchronizer;
}
/**
* Create a new {@link TaskRecipe}
*
* @return New recipe instance
*/
public @NonNull TaskRecipe recipe() {
return new TaskRecipe(this.synchronizer);
}
}

54
cloud-tasks/src/main/java/cloud/commandframework/tasks/TaskFunction.java Normal file
View file

@ -0,0 +1,54 @@
//
// MIT License
//
// Copyright (c) 2020 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.tasks;
import org.checkerframework.checker.nullness.qual.NonNull;
import java.util.function.Function;
/**
* Task step that produces output from given input
*
* @param <I> Input type
* @param <O> Output type
*/
public interface TaskFunction<I, O> extends Function<@NonNull I, @NonNull O>, TaskRecipeStep {
/**
* {@inheritDoc}
*/
@Override
@NonNull O apply(@NonNull I input);
/**
* Equivalent to {@link Function#identity()}
*
* @param <I> Input type
* @return Function that maps the input to itself
*/
static <I> TaskFunction<I, I> identity() {
return i -> i;
}
}

237
cloud-tasks/src/main/java/cloud/commandframework/tasks/TaskRecipe.java Normal file
View file

@ -0,0 +1,237 @@
//
// MIT License
//
// Copyright (c) 2020 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.tasks;
import org.checkerframework.checker.nullness.qual.NonNull;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.function.BiConsumer;
/**
* A task recipe is a chain of tasks with optional synchronization steps,
* that can be used to produce some sort of result from some input
*/
@SuppressWarnings("ALL")
public final class TaskRecipe {
private final TaskSynchronizer synchronizer;
private final LinkedHashMap<TaskRecipeStep, Boolean> recipeSteps = new LinkedHashMap<>();
TaskRecipe(final @NonNull TaskSynchronizer synchronizer) {
this.synchronizer = synchronizer;
}
/**
* Begin the recipe. This step always runs asynchronously.
*
* @param input Input
* @param <I> Input type
* @return Function that maps the input to itself
*/
public <I> @NonNull TaskRecipeComponentOutputting<I, I> begin(final @NonNull I input) {
this.addAsynchronous(TaskFunction.identity());
return new TaskRecipeComponentOutputting<>(input);
}
private void addAsynchronous(final TaskRecipeStep taskRecipeStep) {
this.recipeSteps.put(taskRecipeStep, false);
}
private void addSynchronous(final TaskRecipeStep taskRecipeStep) {
this.recipeSteps.put(taskRecipeStep, true);
}
private void execute(final @NonNull Object initialInput, final @NonNull Runnable callback) {
final Iterator<Map.Entry<TaskRecipeStep, Boolean>> iterator = new LinkedHashMap<>(this.recipeSteps).entrySet().iterator();
CompletableFuture completableFuture = CompletableFuture.completedFuture(initialInput);
completableFuture.whenComplete(this.execute(iterator, callback));
}
private BiConsumer execute(final @NonNull Iterator<Map.Entry<TaskRecipeStep, Boolean>> iterator,
final @NonNull Runnable callback) {
return (o, o2) -> {
if (iterator.hasNext()) {
final Map.Entry<TaskRecipeStep, Boolean> entry = iterator.next();
final boolean synchronous = entry.getValue();
CompletableFuture other;
if (entry.getKey() instanceof TaskFunction) {
final TaskFunction function = (TaskFunction<?, ?>) entry.getKey();
if (synchronous) {
other = this.synchronizer.runSynchronous(o, function);
} else {
other = this.synchronizer.runAsynchronous(o, function);
}
} else {
final TaskConsumer consumer = (TaskConsumer<?>) entry.getKey();
if (synchronous) {
other = this.synchronizer.runSynchronous(o, consumer);
} else {
other = this.synchronizer.runAsynchronous(o, consumer);
}
}
other.whenComplete(this.execute(iterator, callback));
} else {
callback.run();
}
};
}
/**
* Represents a partial recipe
*
* @param <I> Input type
* @param <O> Output type
*/
public final class TaskRecipeComponentOutputting<I, O> {
private final Object initialInput;
private TaskRecipeComponentOutputting(final @NonNull Object initialInput) {
this.initialInput = initialInput;
}
/**
* Add a new synchronous step, consuming the input of the earlier step
*
* @param function Function mapping the input to some output
* @param <T> Output type
* @return New task recipe component
*/
public <T> TaskRecipeComponentOutputting<O, T> synchronous(final @NonNull TaskFunction<O, T> function) {
addSynchronous(function);
return new TaskRecipeComponentOutputting<>(this.initialInput);
}
/**
* Add a new asynchronous step, consuming the input of the earlier step
*
* @param function Function mapping the input to some output
* @param <T> Output type
* @return New task recipe component
*/
public <T> TaskRecipeComponentOutputting<O, T> asynchronous(final @NonNull TaskFunction<O, T> function) {
addAsynchronous(function);
return new TaskRecipeComponentOutputting<>(this.initialInput);
}
/**
* Add a new synchronous step, consuming the input of the earlier step
*
* @param consumer Consumer that consumes the input
* @return New task recipe component
*/
public TaskRecipeComponentVoid<O> synchronous(final @NonNull TaskConsumer<O> consumer) {
addSynchronous(consumer);
return new TaskRecipeComponentVoid<>(initialInput);
}
/**
* Add a new asynchronous step, consuming the input of the earlier step
*
* @param consumer Consumer that consumes the input
* @return New task recipe component
*/
public TaskRecipeComponentVoid<O> asynchronous(final @NonNull TaskConsumer<O> consumer) {
addSynchronous(consumer);
return new TaskRecipeComponentVoid<>(initialInput);
}
/**
* Execute the recipe
*
* @param callback Callback function
*/
public void execute(final @NonNull Runnable callback) {
TaskRecipe.this.execute(initialInput, callback);
}
/**
* Execute the recipe
*/
public void execute() {
this.execute(() -> {});
}
}
/**
* Represents a partial recipe
*
* @param <I> Input type
*/
public final class TaskRecipeComponentVoid<I> {
private final Object initialInput;
private TaskRecipeComponentVoid(final @NonNull Object initialInput) {
this.initialInput = initialInput;
}
/**
* Add a new synchronous step, consuming the input of the earlier step
*
* @param consumer Consumer that consumes the input
* @return New task recipe component
*/
public TaskRecipeComponentVoid<I> synchronous(final @NonNull TaskConsumer<I> consumer) {
addSynchronous(consumer);
return new TaskRecipeComponentVoid<>(initialInput);
}
/**
* Add a new asynchronous step, consuming the input of the earlier step
*
* @param consumer Consumer that consumes the input
* @return New task recipe component
*/
public TaskRecipeComponentVoid<I> asynchronous(final @NonNull TaskConsumer<I> consumer) {
addSynchronous(consumer);
return new TaskRecipeComponentVoid<>(initialInput);
}
/**
* Execute the recipe
*
* @param callback Callback function
*/
public void execute(final @NonNull Runnable callback) {
TaskRecipe.this.execute(initialInput, callback);
}
/**
* Execute the recipe
*/
public void execute() {
this.execute(() -> {});
}
}
}

30
cloud-tasks/src/main/java/cloud/commandframework/tasks/TaskRecipeStep.java Normal file
View file

@ -0,0 +1,30 @@
//
// MIT License
//
// Copyright (c) 2020 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.tasks;
/**
* Part of a {@link TaskRecipe}
*/
public interface TaskRecipeStep {
}

77
cloud-tasks/src/main/java/cloud/commandframework/tasks/TaskSynchronizer.java Normal file
View file

@ -0,0 +1,77 @@
//
// MIT License
//
// Copyright (c) 2020 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.tasks;
import org.checkerframework.checker.nullness.qual.NonNull;
import java.util.concurrent.CompletableFuture;
/**
* Utility responsible for synchronizing {@link TaskRecipeStep task recipe steps}
*/
public interface TaskSynchronizer {
/**
* Accept input into the consumer synchronously
*
* @param input Input to pass to the consumer
* @param consumer Consumer of the input
* @param <I> Input type
* @return Future that completes when the consumer is done
*/
<I> CompletableFuture<Void> runSynchronous(@NonNull I input, @NonNull TaskConsumer<I> consumer);
/**
* Produce output from accepted input synchronously
*
* @param input Input to pass to the function
* @param function Function that produces the output
* @param <I> Input type
* @param <O> Output type
* @return Future that completes with the output
*/
<I, O> CompletableFuture<O> runSynchronous(@NonNull I input, @NonNull TaskFunction<I, O> function);
/**
* Accept input into the consumer asynchronously
*
* @param input Input to pass to the consumer
* @param consumer Consumer of the input
* @param <I> Input type
* @return Future that completes when the consumer is done
*/
<I> CompletableFuture<Void> runAsynchronous(@NonNull I input, @NonNull TaskConsumer<I> consumer);
/**
* Produce output from accepted input asynchronously
*
* @param input Input to pass to the function
* @param function Function that produces the output
* @param <I> Input type
* @param <O> Output type
* @return Future that completes with the output
*/
<I, O> CompletableFuture<O> runAsynchronous(@NonNull I input, @NonNull TaskFunction<I, O> function);
}

28
cloud-tasks/src/main/java/cloud/commandframework/tasks/package-info.java Normal file
View file

@ -0,0 +1,28 @@
//
// MIT License
//
// Copyright (c) 2020 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
/**
* Cloud task library
*/
package cloud.commandframework.tasks;