feat: add access guide (#21)

jianggang · web-flow · commit 66a4ea0602e2 · 2022-07-27T14:40:41.000+08:00
* feat: add access guide
diff --git a/src/main/java/com/featureprobe/api/base/enums/ResourceType.java b/src/main/java/com/featureprobe/api/base/enums/ResourceType.java
@@ -6,7 +6,7 @@
 
 public enum ResourceType {
     PROJECT("projectKey"), TOGGLE("toggleKey"), ENVIRONMENT("environmentKey"),
-    MEMBER("account"),SEGMENT("segment");
+    MEMBER("account"),SEGMENT("segment"),DICTIONARY("dictionary");
 
     private String paramName;
 
diff --git a/src/main/java/com/featureprobe/api/base/enums/VisitFilter.java b/src/main/java/com/featureprobe/api/base/enums/VisitFilter.java
@@ -0,0 +1,6 @@
+package com.featureprobe.api.base.enums;
+
+public enum VisitFilter {
+
+    IN_WEEK_VISITED, OUT_WEEK_VISITED, NOT_VISITED
+}
diff --git a/src/main/java/com/featureprobe/api/controller/DictionaryController.java b/src/main/java/com/featureprobe/api/controller/DictionaryController.java
@@ -0,0 +1,33 @@
+package com.featureprobe.api.controller;
+
+import com.featureprobe.api.base.doc.DefaultApiResponses;
+import com.featureprobe.api.dto.DictionaryResponse;
+import com.featureprobe.api.service.DictionaryService;
+import lombok.AllArgsConstructor;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RequestMapping("/dictionaries")
+@RestController
+@DefaultApiResponses
+@AllArgsConstructor
+public class DictionaryController {
+
+    private DictionaryService dictionaryService;
+
+    @GetMapping("/{key}")
+    public DictionaryResponse query(@PathVariable("key") String key) {
+        return dictionaryService.query(key);
+    }
+
+    @PostMapping("/{key}")
+    public DictionaryResponse save(@PathVariable("key") String key,
+                                   @RequestBody String value) {
+        return dictionaryService.save(key, value);
+    }
+
+}
diff --git a/src/main/java/com/featureprobe/api/dto/DictionaryResponse.java b/src/main/java/com/featureprobe/api/dto/DictionaryResponse.java
@@ -0,0 +1,18 @@
+package com.featureprobe.api.dto;
+
+import lombok.Data;
+
+import java.util.Date;
+
+@Data
+public class DictionaryResponse {
+
+    private String key;
+
+    private String value;
+
+    private Date modifiedTime;
+
+    private Date createdTime;
+
+}
diff --git a/src/main/java/com/featureprobe/api/dto/TargetingVersionResponse.java b/src/main/java/com/featureprobe/api/dto/TargetingVersionResponse.java
@@ -23,4 +23,6 @@ public class TargetingVersionResponse {
     private Long version;
 
     private Date createdTime;
+
+    private String createdBy;
 }
diff --git a/src/main/java/com/featureprobe/api/dto/ToggleSearchRequest.java b/src/main/java/com/featureprobe/api/dto/ToggleSearchRequest.java
@@ -1,5 +1,6 @@
 package com.featureprobe.api.dto;
 
+import com.featureprobe.api.base.enums.VisitFilter;
 import lombok.Data;
 
 import javax.validation.constraints.NotBlank;
@@ -11,7 +12,7 @@ public class ToggleSearchRequest extends PaginationRequest {
     @NotBlank
     private String environmentKey;
 
-    private Boolean isVisited;
+    private VisitFilter visitFilter;
 
     private Boolean disabled;
 
diff --git a/src/main/java/com/featureprobe/api/entity/Dictionary.java b/src/main/java/com/featureprobe/api/entity/Dictionary.java
@@ -0,0 +1,36 @@
+package com.featureprobe.api.entity;
+
+import com.featureprobe.api.base.entity.AbstractAuditEntity;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+import org.hibernate.annotations.DynamicInsert;
+import org.hibernate.annotations.Where;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.Table;
+
+@EqualsAndHashCode(callSuper = true)
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+@Builder
+@Entity
+@Table(name = "dictionary")
+@ToString(callSuper = true)
+@Where(clause = "deleted = 0")
+@DynamicInsert
+public class Dictionary extends AbstractAuditEntity {
+
+    private String value;
+
+    @Column(name = "[key]")
+    private String key;
+
+    private String account;
+
+}
diff --git a/src/main/java/com/featureprobe/api/entity/MetricsCache.java b/src/main/java/com/featureprobe/api/entity/MetricsCache.java
@@ -0,0 +1,44 @@
+package com.featureprobe.api.entity;
+
+import com.featureprobe.api.base.constants.MetricType;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+import org.hibernate.annotations.DynamicInsert;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.Table;
+import java.util.Date;
+
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+@Entity
+@Table(name = "metrics_cache")
+@DynamicInsert
+@ToString(callSuper = true)
+public class MetricsCache {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(name = "sdk_key")
+    private String sdkKey;
+
+    @Column(name = "toggle_key")
+    private String toggleKey;
+
+    private String data;
+
+    @Column(name = "start_date")
+    private Date startDate;
+
+    @Column(name = "end_date")
+    private Date endDate;
+}
diff --git a/src/main/java/com/featureprobe/api/mapper/DictionaryMapper.java b/src/main/java/com/featureprobe/api/mapper/DictionaryMapper.java
@@ -0,0 +1,14 @@
+package com.featureprobe.api.mapper;
+
+import com.featureprobe.api.dto.DictionaryResponse;
+import com.featureprobe.api.entity.Dictionary;
+import org.mapstruct.Mapper;
+import org.mapstruct.factory.Mappers;
+
+@Mapper
+public interface DictionaryMapper {
+
+    DictionaryMapper INSTANCE = Mappers.getMapper(DictionaryMapper.class);
+
+    DictionaryResponse entityToResponse(Dictionary dictionary);
+}
diff --git a/src/main/java/com/featureprobe/api/mapper/TargetingVersionMapper.java b/src/main/java/com/featureprobe/api/mapper/TargetingVersionMapper.java
@@ -9,12 +9,13 @@
 import org.mapstruct.factory.Mappers;
 
 @Mapper
-public interface TargetingVersionMapper {
+public interface TargetingVersionMapper extends BaseMapper {
 
     TargetingVersionMapper INSTANCE = Mappers.getMapper(TargetingVersionMapper.class);
 
     @Mapping(target = "content",
             expression = "java(toTargetingContent(targetingVersion.getContent()))")
+    @Mapping(target = "createdBy", expression = "java(getAccount(targetingVersion.getCreatedBy()))")
     TargetingVersionResponse entityToResponse(TargetingVersion targetingVersion);
 
     default TargetingContent toTargetingContent(String content) {
diff --git a/src/main/java/com/featureprobe/api/model/AccessEventPoint.java b/src/main/java/com/featureprobe/api/model/AccessEventPoint.java
@@ -12,4 +12,5 @@ public class AccessEventPoint {
     String name;
     List<VariationAccessCounter> values;
     Long lastChangeVersion;
+    Integer sorted;
 }
diff --git a/src/main/java/com/featureprobe/api/repository/DictionaryRepository.java b/src/main/java/com/featureprobe/api/repository/DictionaryRepository.java
@@ -0,0 +1,14 @@
+package com.featureprobe.api.repository;
+
+
+import com.featureprobe.api.entity.Dictionary;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
+
+import java.util.Optional;
+
+public interface DictionaryRepository extends JpaRepository<Dictionary, Long>, JpaSpecificationExecutor<Dictionary> {
+
+    Optional<Dictionary> findByAccountAndKey(String account, String key);
+
+}
diff --git a/src/main/java/com/featureprobe/api/repository/MetricsCacheRepository.java b/src/main/java/com/featureprobe/api/repository/MetricsCacheRepository.java
@@ -0,0 +1,18 @@
+package com.featureprobe.api.repository;
+
+import com.featureprobe.api.entity.MetricsCache;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
+import org.springframework.stereotype.Repository;
+
+import java.util.Date;
+import java.util.Optional;
+
+@Repository
+public interface MetricsCacheRepository extends JpaRepository<MetricsCache, Long>,
+        JpaSpecificationExecutor<MetricsCache> {
+
+    Optional<MetricsCache> findBySdkKeyAndToggleKeyAndStartDateAndEndDate(String sdkKey, String toggleKey,
+                                                                          Date startDate, Date endDate);
+
+}
diff --git a/src/main/java/com/featureprobe/api/service/DictionaryService.java b/src/main/java/com/featureprobe/api/service/DictionaryService.java
@@ -0,0 +1,58 @@
+package com.featureprobe.api.service;
+
+import com.featureprobe.api.auth.UserPasswordAuthenticationToken;
+import com.featureprobe.api.base.enums.ResourceType;
+import com.featureprobe.api.base.exception.ForbiddenException;
+import com.featureprobe.api.base.exception.ResourceNotFoundException;
+import com.featureprobe.api.dto.DictionaryResponse;
+import com.featureprobe.api.entity.Dictionary;
+import com.featureprobe.api.mapper.DictionaryMapper;
+import com.featureprobe.api.repository.DictionaryRepository;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.stereotype.Service;
+
+import java.util.Objects;
+import java.util.Optional;
+
+@AllArgsConstructor
+@Service
+@Slf4j
+public class DictionaryService {
+
+    private DictionaryRepository dictionaryRepository;
+
+
+    public DictionaryResponse save(String key, String value) {
+        Optional<Dictionary> dictionaryOptional = dictionaryRepository.findByAccountAndKey(findLoggedInAccount(), key);
+        if(dictionaryOptional.isPresent()) {
+            Dictionary dictionary = dictionaryOptional.get();
+            dictionary.setValue(value);
+            dictionary.setAccount(findLoggedInAccount());
+            return DictionaryMapper.INSTANCE.entityToResponse(dictionaryRepository.save(dictionary));
+        }
+        Dictionary dictionary = new Dictionary();
+        dictionary.setKey(key);
+        dictionary.setValue(value);
+        dictionary.setAccount(findLoggedInAccount());
+        return DictionaryMapper.INSTANCE.entityToResponse(dictionaryRepository.save(dictionary));
+    }
+    
+    public DictionaryResponse query(String key) {
+        Dictionary dictionary = dictionaryRepository.findByAccountAndKey(findLoggedInAccount(), key).orElseThrow(() ->
+                new ResourceNotFoundException(ResourceType.DICTIONARY, key));
+        return DictionaryMapper.INSTANCE.entityToResponse(dictionary);
+    }
+
+
+
+    private String findLoggedInAccount() {
+        UserPasswordAuthenticationToken authentication =
+                (UserPasswordAuthenticationToken) SecurityContextHolder.getContext().getAuthentication();
+        if (Objects.isNull(authentication)) {
+            throw new ForbiddenException();
+        }
+        return authentication.getAccount();
+    }
+}
diff --git a/src/main/java/com/featureprobe/api/service/MetricService.java b/src/main/java/com/featureprobe/api/service/MetricService.java
diff --git a/src/main/java/com/featureprobe/api/service/ToggleService.java b/src/main/java/com/featureprobe/api/service/ToggleService.java
diff --git a/src/main/resources/db/migration/V14__add_dictionary_table.sql b/src/main/resources/db/migration/V14__add_dictionary_table.sql
diff --git a/src/main/resources/db/migration/V15__add_metrics_cache_table.sql b/src/main/resources/db/migration/V15__add_metrics_cache_table.sql
diff --git a/src/test/groovy/com/featureprobe/api/service/MetricServiceSpec.groovy b/src/test/groovy/com/featureprobe/api/service/MetricServiceSpec.groovy
diff --git a/src/test/groovy/com/featureprobe/api/service/ToggleServiceSpec.groovy b/src/test/groovy/com/featureprobe/api/service/ToggleServiceSpec.groovy

Original file line number	Diff line number	Diff line change
`@@ -23,4 +23,6 @@ public class TargetingVersionResponse {`
`23`	`23`	`private Long version;`
`24`	`24`
`25`	`25`	`private Date createdTime;`
	`26`	`+`
	`27`	`+ private String createdBy;`
`26`	`28`	`}`