Interaction delay improvements. (#18)

- onInteractionDelay for ViewConfig
- interactionDelay per Element
- onInteractionDelay per Element

Author: portlek

common/src/main/java/net/infumia/frame/element/Element.java

@@ -1,8 +1,11 @@
 package net.infumia.frame.element;
 
+import java.time.Duration;
 import java.util.Collection;
 import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
 import java.util.function.Predicate;
+import net.infumia.frame.context.element.ContextElementClick;
 import net.infumia.frame.context.element.ContextElementRender;
 import net.infumia.frame.service.ConsumerService;
 import net.infumia.frame.state.State;
@@ -16,6 +19,12 @@ public interface Element {
 
     boolean updateOnClick();
 
+    @Nullable
+    Duration interactionDelay();
+
+    @Nullable
+    Consumer<ContextElementClick> onInteractionDelay();
+
     @Nullable
     Predicate<ContextElementRender> displayIf();
 

common/src/main/java/net/infumia/frame/element/ElementBuilder.java

@@ -1,10 +1,14 @@
 package net.infumia.frame.element;
 
+import java.time.Duration;
 import java.util.function.BooleanSupplier;
+import java.util.function.Consumer;
 import java.util.function.Predicate;
+import net.infumia.frame.context.element.ContextElementClick;
 import net.infumia.frame.context.element.ContextElementRender;
 import net.infumia.frame.state.State;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 public interface ElementBuilder {
     @NotNull
@@ -25,6 +29,12 @@ public interface ElementBuilder {
     @NotNull
     ElementBuilder updateOnClick(boolean updateOnClick);
 
+    @NotNull
+    ElementBuilder interactionDelay(@Nullable Duration interactionDelay);
+
+    @NotNull
+    ElementBuilder onInteractionDelay(@NotNull Consumer<ContextElementClick> onInteractionDelay);
+
     @NotNull
     ElementBuilder updateOnStateChange(@NotNull State<?> state, @NotNull State<?>... otherStates);
 

common/src/main/java/net/infumia/frame/view/config/ViewConfig.java

@@ -3,6 +3,8 @@
 import java.time.Duration;
 import java.util.Collection;
 import java.util.Map;
+import java.util.function.Consumer;
+import net.infumia.frame.context.view.ContextClick;
 import net.infumia.frame.type.InvType;
 import net.infumia.frame.view.config.option.ViewConfigOption;
 import org.jetbrains.annotations.NotNull;
@@ -27,6 +29,9 @@ public interface ViewConfig {
     @Nullable
     Duration interactionDelay();
 
+    @Nullable
+    Consumer<ContextClick> onInteractionDelay();
+
     @NotNull
     @UnmodifiableView
     Map<ViewConfigOption<Object>, Object> options();

core/src/main/java/net/infumia/frame/config/ViewConfigBuilderImpl.java

@@ -6,6 +6,8 @@
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
+import java.util.function.Consumer;
+import net.infumia.frame.context.view.ContextClick;
 import net.infumia.frame.type.InvType;
 import net.infumia.frame.util.Preconditions;
 import net.infumia.frame.util.Reflection;
@@ -32,6 +34,7 @@ final class ViewConfigBuilderImpl implements ViewConfigBuilderRich {
     String[] layout;
     Duration updateInterval;
     Duration interactionDelay;
+    Consumer<ContextClick> onInteractionDelay;
 
     ViewConfigBuilderImpl(@NotNull final ViewConfigImpl config) {
         this.options = new HashMap<>(config.options);
@@ -42,6 +45,7 @@ final class ViewConfigBuilderImpl implements ViewConfigBuilderRich {
         this.layout = config.layout;
         this.updateInterval = config.updateInterval;
         this.interactionDelay = config.interactionDelay;
+        this.onInteractionDelay = config.onInteractionDelay;
     }
 
     ViewConfigBuilderImpl() {
@@ -84,6 +88,12 @@ public Duration interactionDelay() {
         return this.interactionDelay;
     }
 
+    @Nullable
+    @Override
+    public Consumer<ContextClick> onInteractionDelay() {
+        return this.onInteractionDelay;
+    }
+
     @NotNull
     @Override
     @UnmodifiableView

core/src/main/java/net/infumia/frame/config/ViewConfigImpl.java

@@ -5,6 +5,8 @@
 import java.util.Collections;
 import java.util.Map;
 import java.util.Optional;
+import java.util.function.Consumer;
+import net.infumia.frame.context.view.ContextClick;
 import net.infumia.frame.type.InvType;
 import net.infumia.frame.view.config.ViewConfigModifier;
 import net.infumia.frame.view.config.option.ViewConfigOption;
@@ -22,6 +24,7 @@ final class ViewConfigImpl implements ViewConfigRich {
     final String[] layout;
     final Duration updateInterval;
     final Duration interactionDelay;
+    final Consumer<ContextClick> onInteractionDelay;
 
     ViewConfigImpl(@NotNull final ViewConfigBuilderImpl builder) {
         this.options = Collections.unmodifiableMap(builder.options);
@@ -32,6 +35,7 @@ final class ViewConfigImpl implements ViewConfigRich {
         this.layout = builder.layout;
         this.updateInterval = builder.updateInterval;
         this.interactionDelay = builder.interactionDelay;
+        this.onInteractionDelay = builder.onInteractionDelay;
     }
 
     @Nullable
@@ -75,6 +79,12 @@ public Duration interactionDelay() {
         return this.interactionDelay;
     }
 
+    @Nullable
+    @Override
+    public Consumer<ContextClick> onInteractionDelay() {
+        return this.onInteractionDelay;
+    }
+
     @NotNull
     @Override
     @UnmodifiableView

core/src/main/java/net/infumia/frame/element/ElementBuilderImpl.java

@@ -1,21 +1,27 @@
 package net.infumia.frame.element;
 
+import java.time.Duration;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.function.BooleanSupplier;
+import java.util.function.Consumer;
 import java.util.function.Predicate;
 import net.infumia.frame.context.ContextBase;
+import net.infumia.frame.context.element.ContextElementClick;
 import net.infumia.frame.context.element.ContextElementRender;
 import net.infumia.frame.state.State;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 public class ElementBuilderImpl implements ElementBuilderRich {
 
     Element root;
     boolean cancelOnClick;
     boolean closeOnClick;
     boolean updateOnClick;
+    Duration interactionDelay;
+    Consumer<ContextElementClick> onInteractionDelay;
     Predicate<ContextElementRender> displayIf;
     Collection<State<?>> updateOnStateChange;
     Collection<State<?>> updateOnStateAccess;
@@ -25,6 +31,8 @@ public ElementBuilderImpl(@NotNull final Element element) {
         this.cancelOnClick = element.cancelOnClick();
         this.closeOnClick = element.closeOnClick();
         this.updateOnClick = element.updateOnClick();
+        this.interactionDelay = element.interactionDelay();
+        this.onInteractionDelay = element.onInteractionDelay();
         this.displayIf = element.displayIf();
         this.updateOnStateChange = element.updateOnStateChange();
         this.updateOnStateAccess = element.updateOnStateAccess();
@@ -84,6 +92,22 @@ public ElementBuilder updateOnClick(final boolean updateOnClick) {
         return this;
     }
 
+    @NotNull
+    @Override
+    public ElementBuilder interactionDelay(@Nullable final Duration interactionDelay) {
+        this.interactionDelay = interactionDelay;
+        return this;
+    }
+
+    @NotNull
+    @Override
+    public ElementBuilder onInteractionDelay(
+        @NotNull final Consumer<ContextElementClick> onInteractionDelay
+    ) {
+        this.onInteractionDelay = onInteractionDelay;
+        return this;
+    }
+
     @NotNull
     @Override
     public ElementBuilder updateOnStateChange(

core/src/main/java/net/infumia/frame/element/ElementImpl.java

@@ -1,10 +1,13 @@
 package net.infumia.frame.element;
 
+import java.time.Duration;
 import java.util.Collection;
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
 import java.util.function.Predicate;
 import net.infumia.frame.context.ContextBase;
+import net.infumia.frame.context.element.ContextElementClick;
 import net.infumia.frame.context.element.ContextElementRender;
 import net.infumia.frame.pipeline.executor.PipelineExecutorElement;
 import net.infumia.frame.service.ConsumerService;
@@ -20,6 +23,8 @@ public class ElementImpl implements ElementRich {
     final boolean cancelOnClick;
     final boolean updateOnClick;
     final boolean closeOnClick;
+    final Duration interactionDelay;
+    final Consumer<ContextElementClick> onInteractionDelay;
     final Predicate<ContextElementRender> displayIf;
     final Collection<State<?>> updateOnStateChange;
     final Collection<State<?>> updateOnStateAccess;
@@ -33,6 +38,8 @@ public ElementImpl(
         this.cancelOnClick = builder.cancelOnClick;
         this.updateOnClick = builder.updateOnClick;
         this.closeOnClick = builder.closeOnClick;
+        this.interactionDelay = builder.interactionDelay;
+        this.onInteractionDelay = builder.onInteractionDelay;
         this.displayIf = builder.displayIf;
         this.updateOnStateChange = builder.updateOnStateChange;
         this.updateOnStateAccess = builder.updateOnStateAccess;
@@ -98,6 +105,18 @@ public boolean updateOnClick() {
         return this.updateOnClick;
     }
 
+    @Nullable
+    @Override
+    public Duration interactionDelay() {
+        return this.interactionDelay;
+    }
+
+    @Nullable
+    @Override
+    public Consumer<ContextElementClick> onInteractionDelay() {
+        return this.onInteractionDelay;
+    }
+
     @Nullable
     @Override
     public Predicate<ContextElementRender> displayIf() {

core/src/main/java/net/infumia/frame/metadata/MetadataKeyHolder.java

@@ -29,4 +29,9 @@ public interface MetadataKeyHolder {
         new TypeToken<Map<String, Long>>() {},
         "last-interaction"
     );
+
+    TypedKey<Map<String, Long>> LAST_INTERACTION_ELEMENT = TypedKey.of(
+        new TypeToken<Map<String, Long>>() {},
+        "last-interaction-element"
+    );
 }

core/src/main/java/net/infumia/frame/pipeline/holder/PipelineHolderElement.java

@@ -10,6 +10,7 @@
 import net.infumia.frame.pipeline.service.element.ServiceClick;
 import net.infumia.frame.pipeline.service.element.ServiceClickCancelOnClick;
 import net.infumia.frame.pipeline.service.element.ServiceClickCloseOnClick;
+import net.infumia.frame.pipeline.service.element.ServiceClickInteractionDelay;
 import net.infumia.frame.pipeline.service.element.ServiceClickLogging;
 import net.infumia.frame.pipeline.service.element.ServiceClickUpdateOnClick;
 import net.infumia.frame.pipeline.service.element.ServiceRender;
@@ -42,6 +43,7 @@ public final class PipelineHolderElement implements Cloned<PipelineHolderElement
             .register(ServiceClickCloseOnClick.INSTANCE)
             .register(ServiceClickUpdateOnClick.INSTANCE)
             .register(ServiceClick.INSTANCE)
+            .register(ServiceClickInteractionDelay.INSTANCE)
             .register(ServiceClickCancelOnClick.INSTANCE),
         new PipelineConsumerImpl<>(
             new TypeToken<PipelineServiceConsumer<PipelineContextElement.Update>>() {},

core/src/main/java/net/infumia/frame/pipeline/service/element/ServiceClickInteractionDelay.java

@@ -0,0 +1,72 @@
+package net.infumia.frame.pipeline.service.element;
+
+import java.time.Duration;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.Consumer;
+import net.infumia.frame.context.element.ContextElementClick;
+import net.infumia.frame.element.ElementRich;
+import net.infumia.frame.metadata.MetadataAccess;
+import net.infumia.frame.metadata.MetadataKeyHolder;
+import net.infumia.frame.pipeline.PipelineServiceConsumer;
+import net.infumia.frame.pipeline.context.PipelineContextElement;
+import net.infumia.frame.viewer.Viewer;
+import org.jetbrains.annotations.NotNull;
+
+public final class ServiceClickInteractionDelay
+    implements PipelineServiceConsumer<PipelineContextElement.Click> {
+
+    public static final PipelineServiceConsumer<PipelineContextElement.Click> INSTANCE =
+        new ServiceClickInteractionDelay();
+
+    public static final String KEY = "interaction-delay";
+
+    @NotNull
+    @Override
+    public String key() {
+        return ServiceClickInteractionDelay.KEY;
+    }
+
+    @Override
+    public void accept(@NotNull final PipelineContextElement.Click ctx) {
+        final ContextElementClick context = ctx.context();
+        final ElementRich element = (ElementRich) context.element();
+        final Duration delay = element.interactionDelay();
+        if (delay == null || delay.isZero() || delay.isNegative()) {
+            return;
+        }
+        final Viewer clicker = context.clicker();
+        final MetadataAccess metadata = clicker.metadata();
+        Map<String, Long> lastInteractions = metadata.get(
+            MetadataKeyHolder.LAST_INTERACTION_ELEMENT
+        );
+        if (lastInteractions == null) {
+            lastInteractions = new HashMap<>();
+            metadata.setFixed(MetadataKeyHolder.LAST_INTERACTION_ELEMENT, lastInteractions);
+        }
+        final String key = element.key();
+        final Long lastInteraction = lastInteractions.get(key);
+        final long now = System.currentTimeMillis();
+        if (lastInteraction == null) {
+            lastInteractions.put(key, now);
+            return;
+        }
+        final long elapsed = now - lastInteraction;
+        if (elapsed > delay.toMillis()) {
+            lastInteractions.put(key, now);
+        } else {
+            context
+                .frame()
+                .logger()
+                .debug("Click event of viewer '%s' cancelled due to interaction delay.", clicker);
+            ctx.cancelled(true);
+            context.cancelled(true);
+            final Consumer<ContextElementClick> onInteractionDelay = element.onInteractionDelay();
+            if (onInteractionDelay != null) {
+                onInteractionDelay.accept(context);
+            }
+        }
+    }
+
+    private ServiceClickInteractionDelay() {}
+}