GH-930 Msg placeholders & Async placeholder for future #1203
+329
−73
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| package com.eternalcode.core.feature.msg; | ||
|
|
||
| import com.eternalcode.core.feature.msg.toggle.MsgState; | ||
| import com.eternalcode.core.feature.msg.toggle.MsgToggleRepository; | ||
| import com.eternalcode.core.injector.annotations.Inject; | ||
| import com.eternalcode.core.injector.annotations.component.Controller; | ||
| import com.eternalcode.core.placeholder.PlaceholderRegistry; | ||
| import com.eternalcode.core.placeholder.Placeholder; | ||
| import com.eternalcode.core.placeholder.watcher.PlaceholderWatcherKey; | ||
| import com.eternalcode.core.publish.Subscribe; | ||
| import com.eternalcode.core.publish.event.EternalInitializeEvent; | ||
| import com.eternalcode.core.translation.Translation; | ||
| import com.eternalcode.core.translation.TranslationManager; | ||
| import java.util.UUID; | ||
|
|
||
| @Controller | ||
| public class MsgPlaceholderSetup { | ||
|
|
||
| public static final PlaceholderWatcherKey<MsgState> MSG_STATE = PlaceholderWatcherKey.of("msg_state", MsgState.class); | ||
|
|
||
| private final MsgService msgService; | ||
| private final MsgToggleRepository msgToggleRepository; | ||
| private final TranslationManager translationManager; | ||
|
|
||
| @Inject | ||
| MsgPlaceholderSetup( | ||
| MsgService msgService, | ||
| MsgToggleRepository msgToggleRepository, | ||
| TranslationManager translationManager | ||
| ) { | ||
| this.msgService = msgService; | ||
| this.msgToggleRepository = msgToggleRepository; | ||
| this.translationManager = translationManager; | ||
| } | ||
|
|
||
| @Subscribe(EternalInitializeEvent.class) | ||
| void setUpPlaceholders(PlaceholderRegistry registry) { | ||
| Translation translation = this.translationManager.getMessages(); | ||
|
|
||
| registry.register(Placeholder.ofBoolean( | ||
| "socialspy_status", | ||
| player -> this.msgService.isSpy(player.getUniqueId()) | ||
| )); | ||
|
|
||
| registry.register(Placeholder.of( | ||
| "socialspy_status_formatted", | ||
| player -> { | ||
| UUID uuid = player.getUniqueId(); | ||
| return this.msgService.isSpy(uuid) | ||
| ? translation.msg().placeholders().socialSpyEnabled() | ||
| : translation.msg().placeholders().socialSpyDisabled(); | ||
| } | ||
| )); | ||
|
|
||
| registry.register(Placeholder.async( | ||
| "msg_status", | ||
| MSG_STATE, | ||
| player -> msgToggleRepository.getPrivateChatState(player), | ||
| state -> state.name().toLowerCase() | ||
| )); | ||
|
|
||
| registry.register(Placeholder.async( | ||
| "msg_status_formatted", | ||
| MSG_STATE, | ||
| player -> msgToggleRepository.getPrivateChatState(player), | ||
| state -> state == MsgState.ENABLED | ||
| ? translation.msg().placeholders().msgEnabled() | ||
| : translation.msg().placeholders().msgDisabled() | ||
| ) | ||
| ); | ||
|
Comment on lines
+55
to
+70
Contributor
There was a problem hiding this comment. You are registering two asynchronous placeholders, To fix this, the data loading logic should be shared. A possible solution is to adjust the async placeholder API to allow sharing a data source or cache for a given The best approach is to fix the root cause in the async placeholder design to avoid redundant data fetching for related placeholders. |
||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,4 +17,16 @@ public interface MsgMessages { | |
| Notice otherMessagesDisabled(); | ||
| Notice otherMessagesEnabled(); | ||
|
|
||
| Placeholders placeholders(); | ||
|
|
||
| interface Placeholders { | ||
| String loading(); | ||
|
|
||
| String msgEnabled(); | ||
| String msgDisabled(); | ||
|
|
||
| String socialSpyEnabled(); | ||
| String socialSpyDisabled(); | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -38,4 +38,21 @@ public class PLMsgMessages extends OkaeriConfig implements MsgMessages { | |
| Notice otherMessagesEnabled = Notice.chat( | ||
| "<color:#9d6eef>► <white>Wiadomości prywatne zostały <color:#9d6eef>włączone <white>dla gracza <color:#9d6eef>{PLAYER}<white>!"); | ||
|
|
||
| @Comment("# Formatowanie placeholderów") | ||
| public PLPlaceholders placeholders = new PLPlaceholders(); | ||
|
|
||
| @Getter | ||
| @Accessors(fluent = true) | ||
| public static class PLPlaceholders extends OkaeriConfig implements MsgMessages.Placeholders { | ||
| private String loading = "<yellow>Ładowanie..."; | ||
CitralFlo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private String msgEnabled = "<green>Włączone"; | ||
| private String msgDisabled = "<red>Wyłączone"; | ||
| private String socialSpyEnabled = "<green>Włączony"; | ||
| private String socialSpyDisabled = "<red>Wyłączony"; | ||
| } | ||
|
|
||
| public PLPlaceholders placeholders() { | ||
| return this.placeholders; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,10 +4,10 @@ | |
| import java.util.UUID; | ||
| import java.util.concurrent.CompletableFuture; | ||
|
|
||
| public interface MsgToggleRepository { | ||
|
|
||
| CompletableFuture<MsgState> getPrivateChatState(UUID uuid); | ||
|
|
||
| CompletableFuture<MsgState> setPrivateChatState(UUID uuid, MsgState state); | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,8 +28,8 @@ public CompletableFuture<MsgState> getPrivateChatState(UUID uuid) { | |
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<MsgState> setPrivateChatState(UUID uuid, MsgState state) { | ||
| return this.save(MsgStateTable.class, new MsgStateTable(uuid, state)) | ||
| .thenApply(status -> state); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,43 @@ | ||
| package com.eternalcode.core.feature.msg.toggle; | ||
|
|
||
| import com.eternalcode.core.feature.msg.MsgPlaceholderSetup; | ||
| import com.eternalcode.core.injector.annotations.Inject; | ||
| import com.eternalcode.core.injector.annotations.component.Service; | ||
| import com.eternalcode.core.placeholder.PlaceholderRegistry; | ||
| import com.eternalcode.core.placeholder.watcher.PlaceholderWatcher; | ||
| import java.util.UUID; | ||
| import java.util.concurrent.CompletableFuture; | ||
|
|
||
| @Service | ||
| class MsgToggleServiceImpl implements MsgToggleService { | ||
Rollczi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private final MsgToggleRepository msgToggleRepository; | ||
| private final PlaceholderWatcher<MsgState> watcher; | ||
|
|
||
| @Inject | ||
| MsgToggleServiceImpl(MsgToggleRepository msgToggleRepository, PlaceholderRegistry registry) { | ||
| this.msgToggleRepository = msgToggleRepository; | ||
| this.watcher = registry.createWatcher(MsgPlaceholderSetup.MSG_STATE); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<MsgState> getState(UUID player) { | ||
| return watcher.track(player, msgToggleRepository.getPrivateChatState(player)); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Void> setState(UUID player, MsgState state) { | ||
| return watcher.track(player, msgToggleRepository.setPrivateChatState(player, state)) | ||
| .thenApply(unused -> null); | ||
| } | ||
|
Comment on lines
23
to
32
Contributor
There was a problem hiding this comment. The previous implementation of this service used a The new |
||
|
|
||
| @Override | ||
| public CompletableFuture<MsgState> toggleState(UUID playerUniqueId) { | ||
| return this.getState(playerUniqueId).thenCompose(state -> { | ||
| MsgState newState = state.invert(); | ||
| return this.setState(playerUniqueId, newState) | ||
| .thenApply(unused -> newState); | ||
| }); | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package com.eternalcode.core.placeholder; | ||
|
|
||
| import org.bukkit.entity.Player; | ||
|
|
||
| public interface NamedPlaceholder extends Placeholder { | ||
|
|
||
| @Override | ||
| default String apply(String text, Player targetPlayer) { | ||
| return text.replace("{" + this.getName() + "}", this.provideValue(targetPlayer)); | ||
| } | ||
|
|
||
| String getName(); | ||
|
|
||
| String provideValue(Player targetPlayer); | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,8 @@ | ||
| package com.eternalcode.core.placeholder; | ||
|
|
||
| import com.eternalcode.core.placeholder.watcher.PlaceholderWatcherKey; | ||
| import java.util.UUID; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import org.bukkit.entity.Player; | ||
|
|
||
| import java.util.function.Function; | ||
|
|
@@ -9,27 +12,36 @@ public interface Placeholder { | |
| String apply(String text, Player targetPlayer); | ||
|
|
||
| static Placeholder of(String target, String replacement) { | ||
| return new StaticValuePlaceholder(target, player -> replacement); | ||
| } | ||
|
|
||
| static Placeholder of(String target, Function<Player, String> replacement) { | ||
| return new StaticValuePlaceholder(target, replacement); | ||
| } | ||
|
|
||
| static Placeholder ofInt(String target, Function<Player, Integer> replacement) { | ||
| return new StaticValuePlaceholder(target, player -> String.valueOf(replacement.apply(player))); | ||
| } | ||
|
|
||
| static Placeholder ofBoolean(String target, Function<Player, Boolean> replacement) { | ||
| return new StaticValuePlaceholder(target, player -> String.valueOf(replacement.apply(player))); | ||
| } | ||
|
|
||
| static Placeholder ofLong(String target, Function<Player, Long> replacement) { | ||
| return new StaticValuePlaceholder(target, player -> String.valueOf(replacement.apply(player))); | ||
| } | ||
|
|
||
| static Placeholder of(String target, Placeholder placeholder) { | ||
| return new StaticValuePlaceholder(target, player -> placeholder.apply(target, player)); | ||
| } | ||
|
|
||
| static <T> Placeholder async( | ||
| String target, | ||
|
Member
There was a problem hiding this comment. I would rename target to sth like "placeholderName" |
||
| PlaceholderWatcherKey<T> key, | ||
| Function<UUID, CompletableFuture<T>> loading, | ||
| Function<T, String> mapper | ||
| ) { | ||
| return new PlaceholderAsync<>(target, key, loading, mapper); | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rename to
PlaceholderApiPlaceholder, or rename other domain classes to have PlaceholderAPI instead of the Api