Sheldan/abstracto
1
0
Fork 0
mirror of https://github.com/Sheldan/abstracto.git synced 2026-04-05 17:07:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

moved post targets to an enum, in order to have more type safety, this might be changed in the future

Browse Source 
added validation check when a feature is enabled, in order to notify which configuration is missing for this feature to function properly
This commit is contained in:
Sheldan
2020-05-15 17:43:39 +02:00
parent e4efc26740
commit f11232de05
60 changed files with 514 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/config/FeatureConfig.java
View File

@@ -1,5 +1,7 @@
package dev.sheldan.abstracto.core.config;
import dev.sheldan.abstracto.core.service.FeatureValidator;
import java.util.Collections;
import java.util.List;
@@ -11,4 +13,7 @@ public interface FeatureConfig {
default List<FeatureConfig> getDependantFeatures() {
return Collections.emptyList();
}
default List<PostTargetEnum> getRequiredPostTargets() { return Collections.emptyList();}
default List<String> getRequiredSystemConfigKeys() { return Collections.emptyList();}
default List<FeatureValidator> getAdditionalFeatureValidators() { return Collections.emptyList(); }
}

5
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/config/PostTargetEnum.java Normal file
View File

@@ -0,0 +1,5 @@
package dev.sheldan.abstracto.core.config;
public interface PostTargetEnum {
String getKey();
}

46
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/models/FeatureValidationResult.java Normal file
View File

@@ -0,0 +1,46 @@
package dev.sheldan.abstracto.core.models;
import dev.sheldan.abstracto.core.config.FeatureConfig;
import dev.sheldan.abstracto.core.models.database.ARole;
import dev.sheldan.abstracto.templating.Templatable;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import javax.persistence.GeneratedValue;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
@Builder
@Getter
@Setter
public class FeatureValidationResult implements Templatable {
private FeatureConfig feature;
private Boolean validationResult;
@Builder.Default
private List<ValidationError> validationErrors = new ArrayList<>();
public static FeatureValidationResult validationSuccessful(FeatureConfig featureConfig) {
return FeatureValidationResult
.builder()
.feature(featureConfig)
.validationResult(true)
.build();
}
@Override
public String getTemplateName() {
return "feature_not_setup_message";
}
@Override
public Object getTemplateModel() {
HashMap<String, Object> params = new HashMap<>();
params.put("featureTemplate", this.feature.getFeature().getKey() + "_feature");
params.put("errors", this.validationErrors);
return params;
}
}

27
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/models/PostTargetValidationError.java Normal file
View File

@@ -0,0 +1,27 @@
package dev.sheldan.abstracto.core.models;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import java.util.HashMap;
@Getter
@Setter
@Builder
public class PostTargetValidationError implements ValidationError {
private String postTargetName;
@Override
public String getTemplateName() {
return "post_target_not_setup";
}
@Override
public Object getTemplateModel() {
HashMap<String, String> params = new HashMap<>();
params.put("postTargetKey", postTargetName);
return params;
}
}

27
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/models/SystemConfigValidationError.java Normal file
View File

@@ -0,0 +1,27 @@
package dev.sheldan.abstracto.core.models;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import java.util.HashMap;
@Getter
@Setter
@Builder
public class SystemConfigValidationError implements ValidationError {
private String configKey;
@Override
public String getTemplateName() {
return "config_key_not_setup";
}
@Override
public Object getTemplateModel() {
HashMap<String, String> params = new HashMap<>();
params.put("configKey", configKey);
return params;
}
}

6
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/models/ValidationError.java Normal file
View File

@@ -0,0 +1,6 @@
package dev.sheldan.abstracto.core.models;
import dev.sheldan.abstracto.templating.Templatable;
public interface ValidationError extends Templatable {
}

4
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/service/FeatureFlagService.java
View File

@@ -2,6 +2,8 @@ package dev.sheldan.abstracto.core.service;
import dev.sheldan.abstracto.core.config.FeatureConfig;
import dev.sheldan.abstracto.core.config.FeatureEnum;
import dev.sheldan.abstracto.core.config.PostTargetEnum;
import dev.sheldan.abstracto.core.models.FeatureValidationResult;
import dev.sheldan.abstracto.core.models.database.AFeatureFlag;
import dev.sheldan.abstracto.core.models.database.AServer;
@@ -21,8 +23,10 @@ public interface FeatureFlagService {
boolean doesFeatureExist(FeatureConfig name);
List<String> getFeaturesAsList();
FeatureEnum getFeatureEnum(String key);
PostTargetEnum getPostTargetEnumByKey(String key);
boolean getFeatureFlagValue(FeatureEnum key, Long serverId);
boolean getFeatureFlagValue(FeatureEnum key, AServer server);
AFeatureFlag updateFeatureFlag(FeatureEnum key, Long serverId, Boolean newValue);
AFeatureFlag updateFeatureFlag(FeatureEnum key, AServer server, Boolean newValue);
FeatureValidationResult validateFeatureSetup(FeatureConfig featureConfig, AServer server);
}

9
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/service/FeatureValidator.java Normal file
View File

@@ -0,0 +1,9 @@
package dev.sheldan.abstracto.core.service;
import dev.sheldan.abstracto.core.config.FeatureConfig;
import dev.sheldan.abstracto.core.models.FeatureValidationResult;
import dev.sheldan.abstracto.core.models.database.AServer;
public interface FeatureValidator {
void featureIsSetup(FeatureConfig featureConfig, AServer server, FeatureValidationResult validationResult);
}

10
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/service/FeatureValidatorService.java Normal file
View File

@@ -0,0 +1,10 @@
package dev.sheldan.abstracto.core.service;
import dev.sheldan.abstracto.core.config.PostTargetEnum;
import dev.sheldan.abstracto.core.models.FeatureValidationResult;
import dev.sheldan.abstracto.core.models.database.AServer;
public interface FeatureValidatorService {
void checkPostTarget(PostTargetEnum postTargetEnum, AServer server, FeatureValidationResult featureValidationResult);
void checkSystemConfig(String name, AServer server, FeatureValidationResult featureValidationResult);
}

15
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/service/PostTargetService.java
View File

@@ -1,5 +1,6 @@
package dev.sheldan.abstracto.core.service;
import dev.sheldan.abstracto.core.config.PostTargetEnum;
import dev.sheldan.abstracto.core.models.database.PostTarget;
import dev.sheldan.abstracto.templating.model.MessageToSend;
import net.dv8tion.jda.api.entities.Message;
@@ -11,17 +12,17 @@ import java.util.concurrent.CompletableFuture;
public interface PostTargetService {
CompletableFuture<Message> sendTextInPostTarget(String text, PostTarget target);
CompletableFuture<Message> sendEmbedInPostTarget(MessageEmbed embed, PostTarget target);
CompletableFuture<Message> sendTextInPostTarget(String text, String postTargetName, Long serverId);
CompletableFuture<Message> sendEmbedInPostTarget(MessageEmbed embed, String postTargetName, Long serverId);
CompletableFuture<Message> sendMessageInPostTarget(Message message, String postTargetName, Long serverId);
CompletableFuture<Message> sendTextInPostTarget(String text, PostTargetEnum postTargetName, Long serverId);
CompletableFuture<Message> sendEmbedInPostTarget(MessageEmbed embed, PostTargetEnum postTargetName, Long serverId);
CompletableFuture<Message> sendMessageInPostTarget(Message message, PostTargetEnum postTargetName, Long serverId);
CompletableFuture<Message> sendMessageInPostTarget(Message message, PostTarget target);
List<CompletableFuture<Message>> sendEmbedInPostTarget(MessageToSend message, String postTargetName, Long serverId);
List<CompletableFuture<Message>> sendEmbedInPostTarget(MessageToSend message, PostTargetEnum postTargetName, Long serverId);
List<CompletableFuture<Message>> sendEmbedInPostTarget(MessageToSend message, PostTarget target);
List<CompletableFuture<Message>> editEmbedInPostTarget(Long messageId, MessageToSend message, PostTarget target);
List<CompletableFuture<Message>> editEmbedInPostTarget(Long messageId, MessageToSend message, String postTargetName, Long serverId);
List<CompletableFuture<Message>> editEmbedInPostTarget(Long messageId, MessageToSend message, PostTargetEnum postTargetName, Long serverId);
void editOrCreatedInPostTarget(Long messageId, MessageToSend messageToSend, PostTarget target, List<CompletableFuture<Message>> future);
void editOrCreatedInPostTarget(Long messageId, MessageToSend messageToSend, String postTarget, Long serverId, List<CompletableFuture<Message>> future);
void throwIfPostTargetIsNotDefined(String name, Long serverId);
void editOrCreatedInPostTarget(Long messageId, MessageToSend messageToSend, PostTargetEnum postTarget, Long serverId, List<CompletableFuture<Message>> future);
void throwIfPostTargetIsNotDefined(PostTargetEnum name, Long serverId);
boolean validPostTarget(String name);
List<String> getAvailablePostTargets();
}

2
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/service/management/ConfigManagementService.java
View File

@@ -1,6 +1,7 @@
package dev.sheldan.abstracto.core.service.management;
import dev.sheldan.abstracto.core.models.database.AConfig;
import dev.sheldan.abstracto.core.models.database.AServer;
public interface ConfigManagementService {
AConfig setOrCreateStringValue(Long serverId, String name, String value);
@@ -13,6 +14,7 @@ public interface ConfigManagementService {
AConfig createIfNotExists(Long serverId, String name, Double value);
AConfig loadConfig(Long serverId, String name);
boolean configExists(Long serverId, String name);
boolean configExists(AServer server, String name);
AConfig setDoubleValue(Long serverId, String name, Double value);
AConfig setLongValue(Long serverId, String name, Long value);
AConfig setStringValue(Long serverId, String name, String value);

2
abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/service/management/PostTargetManagement.java
View File

@@ -11,5 +11,7 @@ public interface PostTargetManagement {
PostTarget createOrUpdate(String name, Long serverId, Long channelId);
PostTarget getPostTarget(String name, AServer server);
PostTarget getPostTarget(String name, Long serverId);
Boolean postTargetExists(String name, AServer server);
Boolean postTargetExists(String name, Long serverId);
PostTarget updatePostTarget(PostTarget target, AServer server, AChannel newTargetChannel);
}