#194 Enable/Disable Cache Job per yaml configuration (#197)

pom.xml

@@ -5,7 +5,7 @@
 
 	<groupId>conorheffron</groupId>
 	<artifactId>ironoc</artifactId>
-	<version>5.5.1</version>
+	<version>5.5.2</version>
 	<packaging>war</packaging>
 
 	<distributionManagement>
@@ -22,15 +22,15 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>3.4.0</version>
+		<version>3.4.1</version>
 		<relativePath />
 	</parent>
 
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 		<java.version>21</java.version>
-		<spring.version>3.4.0</spring.version>
+		<spring.version>3.4.1</spring.version>
 		<frontend-maven-plugin.version>1.15.1</frontend-maven-plugin.version>
 		<node.version>v20.16.0</node.version>
 		<npm.version>10.8.1</npm.version>
@@ -147,7 +147,7 @@
 		<dependency>
 			<groupId>software.amazon.awssdk</groupId>
 			<artifactId>aws-sdk-java</artifactId>
-			<version>2.29.34</version>
+			<version>2.29.39</version>
 			<exclusions>
 				<exclusion>
 					<groupId>commons-logging</groupId>

src/main/java/net/ironoc/portfolio/config/Properties.java

@@ -9,6 +9,7 @@ public enum Properties {
     STATIC_CONF_HANDLE_EXT("net.ironoc.portfolio.config.handle-extensions"),
     STATIC_CONF_RESOURCE_HANDLER("net.ironoc.portfolio.config.resource-handler"),
     STATIC_CONF_RESOURCE_LOC("net.ironoc.portfolio.config.resource-loc"),
+    IS_GITHUB_JOB_ENABLED("net.ironoc.portfolio.github.job-enable"),
     GIT_API_ENDPOINT_REPOS("net.ironoc.portfolio.github.api.endpoint.repos"),
     GIT_API_ENDPOINT_REPOS_PARAM_CACHE("net.ironoc.portfolio.github.api.endpoint.user-ids-cache"),
     GIT_API_ENDPOINT_ISSUES("net.ironoc.portfolio.github.api.endpoint.issues"),
@@ -18,7 +19,7 @@ public enum Properties {
     GIT_INSTANCE_FOLLOW_REDIRECTS("net.ironoc.portfolio.github.instance-follow-redirects"),
     GIT_FOLLOW_REDIRECTS("net.ironoc.portfolio.github.follow-redirects");
 
-    private String key;
+    private final String key;
 
     Properties(String key) {
         this.key = key;

src/main/java/net/ironoc/portfolio/config/PropertyConfig.java

@@ -83,6 +83,11 @@ public List<String> getGitApiEndpointProjectsCache() {
         return extractValues(projects);
     }
 
+    @Override
+    public boolean isCacheJobEnabled() {
+        return Boolean.parseBoolean(environment.getRequiredProperty(propertyKey.isCacheJobEnabled()));
+    }
+
     private List<String> extractValues(String valuesStr) {
         return Arrays.stream(StringUtils.split(valuesStr, ",")).toList();
     }

src/main/java/net/ironoc/portfolio/config/PropertyConfigI.java

@@ -27,4 +27,6 @@ public interface PropertyConfigI {
     List<String>  getGitApiEndpointUserIdsCache();
 
     List<String> getGitApiEndpointProjectsCache();
+
+    boolean isCacheJobEnabled();
 }

src/main/java/net/ironoc/portfolio/config/PropertyKey.java

@@ -64,4 +64,9 @@ public String getGitApiEndpointUserIdsCache() {
     public String getGitApiEndpointProjectsCache() {
         return Properties.GIT_API_ENDPOINT_ISSUES_PARAM_CACHE.getKey();
     }
+
+    @Override
+    public String isCacheJobEnabled() {
+        return Properties.IS_GITHUB_JOB_ENABLED.getKey();
+    }
 }

src/main/java/net/ironoc/portfolio/config/PropertyKeyI.java

@@ -25,4 +25,6 @@ public interface PropertyKeyI {
     String getGitApiEndpointUserIdsCache();
 
     String getGitApiEndpointProjectsCache();
+
+    String isCacheJobEnabled();
 }

src/main/java/net/ironoc/portfolio/job/GitDetailsJob.java

@@ -1,6 +1,7 @@
 package net.ironoc.portfolio.job;
 
 import net.ironoc.portfolio.config.PropertyConfigI;
+import net.ironoc.portfolio.logger.AbstractLogger;
 import net.ironoc.portfolio.service.GitProjectCache;
 import net.ironoc.portfolio.service.GitRepoCache;
 import net.ironoc.portfolio.service.GitDetails;
@@ -10,7 +11,7 @@
 import org.springframework.stereotype.Component;
 
 @Component
-public class GitDetailsJob {
+public class GitDetailsJob extends AbstractLogger {
 
     private final GitRepoCache gitRepoCache;
 
@@ -33,12 +34,20 @@ public GitDetailsJob(GitDetails gitDetails,
 
     @PostConstruct
     public void populateCache() {
-        triggerJob();
+        if (propertyConfig.isCacheJobEnabled()) {
+            triggerJob();
+        } else {
+            warn("The job to pre-populate the cache of GitHub information is disabled.");
+        }
     }
 
     @Scheduled(cron = "${net.ironoc.portfolio.github.cron-job}")
     public void triggerGitDetailsJob() {
-        triggerJob();
+        if (propertyConfig.isCacheJobEnabled()) {
+            triggerJob();
+        } else {
+            warn("The job to update the cache of GitHub information is disabled.");
+        }
     }
 
     private void triggerJob() {

src/main/resources/application.yml

@@ -2,6 +2,7 @@ net:
   ironoc:
     portfolio:
       github:
+        job-enable: true
         cron-job: "0 1 1 ? * *"
         timeout:
           connect: 100000
@@ -16,7 +17,7 @@ net:
             projects-cache: "bio-cell-red-edge,booking-sys,cbio-skin-canc,fun-with-r,gene-expr,global-max-sim-matrix,graphql-box,ironoc,ironoc-db,ironoc-msg,ironoc-pytest,ironoc-rustt,ironoc-spark,mern-essential-training,mern-sandbox,nba-stats,netflix-movie-duration,normalise-fetalh,normalise-spotify,nyc-school-scores,python-sandbox,rabbitmq-tester,react-graphql-course,redis-tester,ronoc-packages"
       config:
         ignore-paths: api
-        handle-extensions: "html,js,json,csv,css,map,svg,eot,ttf,woff,appcache,png,jpg,jpeg,gif,ico,txt"
+        handle-extensions: "html,js,json,css,map,svg,eot,ttf,woff,png,jpg,jpeg,gif,ico"
         resource-handler: "/**"
         resource-loc: "classpath:/static/"
 

src/test/java/net/ironoc/portfolio/config/PropertyConfigTest.java

@@ -221,4 +221,20 @@ public void test_getGitApiEndpointProjectsCache_success() {
 
         assertThat(result, is(Arrays.stream(StringUtils.split(TEST_PROPS_VAL, ",")).toList()));
     }
+
+    @Test
+    public void test_isCacheJobEnabled_success() {
+        // given
+        when(propertyKeyMock.isCacheJobEnabled()).thenReturn(Properties.IS_GITHUB_JOB_ENABLED.getKey());
+        when(environmentMock.getRequiredProperty(Properties.IS_GITHUB_JOB_ENABLED.getKey())).thenReturn("true");
+
+        // when
+        boolean result = propertyConfig.isCacheJobEnabled();
+
+        // then
+        verify(propertyKeyMock).isCacheJobEnabled();
+        verify(environmentMock).getRequiredProperty(Properties.IS_GITHUB_JOB_ENABLED.getKey());
+
+        assertThat(result, is(Boolean.TRUE.booleanValue()));
+    }
 }

src/test/java/net/ironoc/portfolio/config/PropertyKeyTest.java

@@ -121,4 +121,13 @@ public void test_getGitApiEndpointUserIdsCache_success() {
         // then
         assertThat(result, is("net.ironoc.portfolio.github.api.endpoint.user-ids-cache"));
     }
+
+    @Test
+    public void test_isCacheJobEnabled_success() {
+        // when
+        String result = propertyKey.isCacheJobEnabled();
+
+        // then
+        assertThat(result, is("net.ironoc.portfolio.github.job-enable"));
+    }
 }

src/test/java/net/ironoc/portfolio/controller/GitProjectsControllerIntegrationTest.java

@@ -46,7 +46,8 @@
         "net.ironoc.portfolio.config.resource-loc=\"classpath:/static/\"",
         "net.ironoc.portfolio.github.api.endpoint.user-ids-cache=conorheffron",
         "net.ironoc.portfolio.github.api.endpoint.projects-cache=\"ironoc,ironoc-db,booking-sys\"",
-        "net.ironoc.portfolio.github.cron-job=0 1 1 ? * *"
+        "net.ironoc.portfolio.github.cron-job=0 1 1 ? * *",
+        "net.ironoc.portfolio.github.job-enable=true"
 })
 public class GitProjectsControllerIntegrationTest {
 

src/test/java/net/ironoc/portfolio/job/GitDetailsJobTest.java

@@ -17,9 +17,10 @@
 
 import static org.mockito.ArgumentMatchers.anyList;
 import static org.mockito.ArgumentMatchers.anyString;
-import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.when;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.never;
 
 @ExtendWith(MockitoExtension.class)
 public class GitDetailsJobTest {
@@ -48,6 +49,7 @@ public class GitDetailsJobTest {
     @Test
     public void test_triggerGitDetailsJob_success() {
         // given
+        when(propertyConfigMock.isCacheJobEnabled()).thenReturn(true);
         when(propertyConfigMock.getGitApiEndpointUserIdsCache()).thenReturn(List.of("conorheffron"));
         when(propertyConfigMock.getGitApiEndpointProjectsCache())
                 .thenReturn(List.of("ironoc", "booking-sys"));
@@ -60,6 +62,7 @@ public void test_triggerGitDetailsJob_success() {
         gitDetailsJob.triggerGitDetailsJob();
 
         // then
+        verify(propertyConfigMock).isCacheJobEnabled();
         verify(propertyConfigMock).getGitApiEndpointProjectsCache();
         verify(propertyConfigMock).getGitApiEndpointUserIdsCache();
         verify(gitDetailsMock).getRepoDetails(anyString());
@@ -71,6 +74,7 @@ public void test_triggerGitDetailsJob_success() {
     @Test
     public void test_populateCache_success() {
         // given
+        when(propertyConfigMock.isCacheJobEnabled()).thenReturn(true);
         when(propertyConfigMock.getGitApiEndpointUserIdsCache()).thenReturn(List.of("ironoc-test-id"));
         when(propertyConfigMock.getGitApiEndpointProjectsCache())
                 .thenReturn(List.of("ironoc", "booking-sys", "ironoc-db", "nba-stats"));
@@ -83,11 +87,48 @@ public void test_populateCache_success() {
         gitDetailsJob.populateCache();
 
         // then
+        verify(propertyConfigMock).isCacheJobEnabled();
         verify(propertyConfigMock).getGitApiEndpointProjectsCache();
         verify(propertyConfigMock).getGitApiEndpointUserIdsCache();
         verify(gitDetailsMock).getRepoDetails(anyString());
         verify(gitRepoCache).put(anyString(), anyList());
         verify(gitDetailsMock, times(4)).getIssues(anyString(), anyString());
         verify(gitProjectCache, times(4)).put(anyString(), anyString(), anyList());
     }
+
+    @Test
+    public void test_triggerGitDetailsJob_fail() {
+        // given
+        when(propertyConfigMock.isCacheJobEnabled()).thenReturn(false);
+
+        // when
+        gitDetailsJob.triggerGitDetailsJob();
+
+        // then
+        verify(propertyConfigMock).isCacheJobEnabled();
+        verify(propertyConfigMock, never()).getGitApiEndpointProjectsCache();
+        verify(propertyConfigMock, never()).getGitApiEndpointUserIdsCache();
+        verify(gitDetailsMock, never()).getRepoDetails(anyString());
+        verify(gitRepoCache, never()).put(anyString(), anyList());
+        verify(gitDetailsMock, never()).getIssues(anyString(), anyString());
+        verify(gitProjectCache, never()).put(anyString(), anyString(), anyList());
+    }
+
+    @Test
+    public void test_populateCache_fail() {
+        // given
+        when(propertyConfigMock.isCacheJobEnabled()).thenReturn(false);
+
+        // when
+        gitDetailsJob.populateCache();
+
+        // then
+        verify(propertyConfigMock).isCacheJobEnabled();
+        verify(propertyConfigMock, never()).getGitApiEndpointProjectsCache();
+        verify(propertyConfigMock, never()).getGitApiEndpointUserIdsCache();
+        verify(gitDetailsMock, never()).getRepoDetails(anyString());
+        verify(gitRepoCache, never()).put(anyString(), anyList());
+        verify(gitDetailsMock, never()).getIssues(anyString(), anyString());
+        verify(gitProjectCache, never()).put(anyString(), anyString(), anyList());
+    }
 }

src/test/java/net/ironoc/portfolio/config/PushStateResourceResolverTest.java → src/test/java/net/ironoc/portfolio/resolver/PushStateResourceResolverTest.java

@@ -1,7 +1,6 @@
-package net.ironoc.portfolio.config;
+package net.ironoc.portfolio.resolver;
 
 import jakarta.servlet.http.HttpServletRequest;
-import net.ironoc.portfolio.resolver.PushStateResourceResolver;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;