Merge pull request #106 from FlowCI/feature/api/branches_cache

add branches cache

Author: yang.guo

platform-api/pom.xml

@@ -65,6 +65,11 @@
       <artifactId>gson</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-context-support</artifactId>
+    </dependency>
+
     <dependency>
       <groupId>org.hibernate</groupId>
       <artifactId>hibernate-validator</artifactId>

platform-api/src/main/java/com/flow/platform/api/config/CachingConfig.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2017 flow.ci
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.flow.platform.api.config;
+
+import com.google.common.cache.CacheBuilder;
+import java.util.concurrent.TimeUnit;
+import org.springframework.cache.CacheManager;
+import org.springframework.cache.annotation.EnableCaching;
+import org.springframework.cache.guava.GuavaCacheManager;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * @author yh@firim
+ */
+@Configuration
+@EnableCaching
+public class CachingConfig {
+
+    private final static int EXPIRE_CACHE_SECOND = 3600 * 24;
+
+    private final static int MAX_CACHE_NUM = 100;
+
+    private CacheBuilder cacheBuilder = CacheBuilder
+        .newBuilder()
+        .expireAfterAccess(EXPIRE_CACHE_SECOND, TimeUnit.SECONDS)
+        .maximumSize(MAX_CACHE_NUM);
+
+
+    @Bean
+    public CacheManager cacheManager() {
+        GuavaCacheManager guavaCacheManager = new GuavaCacheManager();
+        guavaCacheManager.setCacheBuilder(cacheBuilder);
+        return guavaCacheManager;
+    }
+}

platform-api/src/main/java/com/flow/platform/api/config/WebConfig.java

@@ -64,7 +64,7 @@
     "com.flow.platform.api.util",
     "com.flow.platform.api.consumer",
     "com.flow.platform.api.initializers"})
-@Import({AppConfig.class})
+@Import({AppConfig.class, CachingConfig.class})
 public class WebConfig extends WebMvcConfigurerAdapter {
 
     private final static Gson GSON_CONFIG_FOR_RESPONE = new GsonBuilder()

platform-api/src/main/java/com/flow/platform/api/controller/FlowController.java

@@ -16,9 +16,9 @@
 
 package com.flow.platform.api.controller;
 
-import com.flow.platform.api.domain.permission.Actions;
 import com.flow.platform.api.domain.node.Flow;
 import com.flow.platform.api.domain.node.Node;
+import com.flow.platform.api.domain.permission.Actions;
 import com.flow.platform.api.domain.request.ListParam;
 import com.flow.platform.api.domain.response.BooleanValue;
 import com.flow.platform.api.domain.user.User;
@@ -235,6 +235,7 @@ public BooleanValue isFlowNameExist() {
     /**
      * @api {get} /flows/:root/branches List Branches
      * @apiParam {String} root flow node name
+     * @apiParam {Boolean} [refresh] true or false, the default is false
      * @apiGroup Flows
      *
      * @apiSuccessExample {json} Success-Response
@@ -246,9 +247,13 @@ public BooleanValue isFlowNameExist() {
      *  ]
      */
     @GetMapping("/{root}/branches")
-    public List<String> listBranches() {
+    public List<String> listBranches(@RequestParam(required = false) Boolean refresh) {
+        if (refresh == null) {
+            refresh = false;
+        }
+
         Node root = nodeService.find(currentNodePath.get());
-        return gitService.branches(root);
+        return gitService.branches(root, refresh);
     }
 
     /**
@@ -266,7 +271,7 @@ public List<String> listBranches() {
     @GetMapping("/{root}/tags")
     public List<String> listTags() {
         Node root = nodeService.find(currentNodePath.get());
-        return gitService.tags(root);
+        return gitService.tags(root, false);
     }
 
     /**
@@ -415,7 +420,7 @@ public Node createFromYml(@RequestBody String yml) {
      */
     @PostMapping("/{root}/users/auth")
     @WebSecurity(action = Actions.FLOW_AUTH)
-    public List<User> flowAuthUsers(@RequestBody ListParam<String> listParam){
+    public List<User> flowAuthUsers(@RequestBody ListParam<String> listParam) {
         return nodeService.authUsers(listParam.getArrays(), currentNodePath.get());
     }
 }

platform-api/src/main/java/com/flow/platform/api/service/GitService.java

@@ -61,12 +61,12 @@ interface ProgressListener {
     /**
      * Fetch branches from git repo
      */
-    List<String> branches(Node node);
+    List<String> branches(Node node, boolean refresh);
 
     /**
      * Fetch tags from git repo
      */
-    List<String> tags(Node node);
+    List<String> tags(Node node, boolean refresh);
 
     /**
      * Fetch latest commit from git repo

platform-api/src/main/java/com/flow/platform/api/service/GitServiceImpl.java

@@ -42,6 +42,7 @@
 import javax.annotation.PostConstruct;
 import org.eclipse.jgit.lib.ProgressMonitor;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.cache.annotation.Cacheable;
 import org.springframework.stereotype.Service;
 
 /**
@@ -101,7 +102,8 @@ public String fetch(Node node, String filePath, ProgressListener progressListene
     }
 
     @Override
-    public List<String> branches(Node node) {
+    @Cacheable(value = "git.branches", key = "#node.getPath()", condition = "#refresh == false")
+    public List<String> branches(Node node, boolean refresh) {
         GitClient client = gitClientInstance(node);
         try {
             return client.branches();
@@ -111,7 +113,8 @@ public List<String> branches(Node node) {
     }
 
     @Override
-    public List<String> tags(Node node) {
+    @Cacheable(value = "git.tags", key = "#node.getPath()", condition = "#refresh == false")
+    public List<String> tags(Node node, boolean refresh) {
         GitClient client = gitClientInstance(node);
         try {
             return client.tags();

platform-api/src/test/java/com/flow/platform/api/test/service/GitServiceTest.java

@@ -94,15 +94,23 @@ public void onFinishTask(String task) {
 
     @Test
     public void should_list_branches_of_git_repo() {
-        List<String> branches = gitService.branches(node);
+        List<String> branches = gitService.branches(node, false);
         Assert.assertNotNull(branches);
         Assert.assertEquals("develop", branches.get(0));
         Assert.assertEquals("master", branches.get(1));
+
+        // should load branches from cache
+        branches = gitService.branches(node, false);
+        Assert.assertNotNull(branches);
+
+        // should load branched from git repo for refresh
+        branches = gitService.branches(node, true);
+        Assert.assertNotNull(branches);
     }
 
     @Test
     public void should_list_tags_of_git_repo() {
-        List<String> tags = gitService.tags(node);
+        List<String> tags = gitService.tags(node, false);
         Assert.assertNotNull(tags);
     }
 

pom.xml

@@ -57,6 +57,7 @@
     <javax.mail.version>1.5.5</javax.mail.version>
     <yamlbeans.version>1.12</yamlbeans.version>
     <velocity.version>1.5</velocity.version>
+    <spring-context-support.version>4.3.8.RELEASE</spring-context-support.version>
   </properties>
 
   <build>
@@ -102,6 +103,13 @@
 
   <dependencyManagement>
     <dependencies>
+
+      <dependency>
+        <groupId>org.springframework</groupId>
+        <artifactId>spring-context-support</artifactId>
+        <version>${spring-context-support.version}</version>
+      </dependency>
+
       <dependency>
         <groupId>javax.mail</groupId>
         <artifactId>javax.mail-api</artifactId>