Added switcher.check context configuration to validate Switchers during start (#346)

* Added switcher.check context configuration to validate Switchers during start (#345)

* Added switcher.check context configuration to validate Switchers during start

* chore: removed unused env variable from master CI

* Fixed notFound serialization using Jackson lib

Author: petruki

.github/workflows/master-2.yml

@@ -0,0 +1,60 @@
+name: Master CI v2
+
+on:
+  push:
+    branches: [master-2]
+  pull_request:
+    branches: [master-2]
+
+jobs:
+  build-scan:
+    name: SonarCloud Scan
+    runs-on: ubuntu-latest
+    if: "! contains(toJSON(github.event.commits.*.message), '[skip ci]')"
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: 'temurin'
+          cache: maven
+
+      - name: Build/Test & SonarCloud Scan
+        run: mvn -B clean verify -Pcoverage,sonar -Dsonar.token=${{ secrets.SONAR_TOKEN }}
+
+  build-test:
+    name: Build & Test - JDK ${{ matrix.java }} on ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        java: ['11', '17', '21']
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    if: "! contains(toJSON(github.event.commits.*.message), '[skip ci]')"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: ${{ matrix.java }}
+
+      - name: Show Versions
+        run: mvn -version
+
+      - name: Cache Maven packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-m2-${{ matrix.java }}
+          restore-keys: ${{ runner.os }}-m2-
+
+      - name: Build/Test
+        run: mvn -B clean package

.github/workflows/master.yml

@@ -26,8 +26,6 @@ jobs:
 
       - name: Build/Test & SonarCloud Scan
         run: mvn -B clean verify -Pcoverage,sonar -Dsonar.token=${{ secrets.SONAR_TOKEN }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   build-test:
     name: Build & Test - JDK ${{ matrix.java }} on ${{ matrix.os }}

README.md

@@ -70,6 +70,7 @@ switcher.domain -> Domain name
 #optional
 switcher.environment -> Environment name
 switcher.local -> true/false When local, it will only use a local snapshot
+switcher.check -> true/false When true, it will check Switcher Keys
 switcher.relay.restrict -> true/false When true, it will check snapshot relay status
 switcher.snapshot.location -> Folder from where snapshots will be saved/read
 switcher.snapshot.auto -> true/false Automated lookup for snapshot when initializing the client
@@ -314,6 +315,16 @@ void testSwitchers() {
 }
 ```
 
+Alternatively, you can also set the Switcher Context configuration to check during the client initialization.
+
+```java
+MyAppFeatures.configure(ContextBuilder.builder()
+    ...
+    .checkSwitchers(true));
+
+MyAppFeatures.initializeClient();
+```
+
 #### SwitcherTest annotation - Requires JUnit 5 Jupiter
 Predefine Switchers result outside your test methods with the SwitcherTest annotation.
 </br>It encapsulates the test and makes sure that the Switcher returns to its original state after concluding the test.

src/main/java/com/github/switcherapi/client/ContextBuilder.java

@@ -182,6 +182,15 @@ public ContextBuilder local(boolean local) {
 		return this;
 	}
 
+	/**
+	 * @param checkSwitchers true/false When true, it will check switcher keys
+	 * @return ContextBuilder
+	 */
+	public ContextBuilder checkSwitchers(boolean checkSwitchers) {
+		switcherProperties.setValue(ContextKey.CHECK_SWITCHERS, checkSwitchers);
+		return this;
+	}
+
 	/**
 	 * @param restrictRelay true/false When true, it will check snapshot relay status
 	 * @return ContextBuilder

src/main/java/com/github/switcherapi/client/SwitcherConfig.java

@@ -11,14 +11,17 @@ abstract class SwitcherConfig {
 	protected String environment;
 
 	protected boolean local;
+	protected boolean check;
 	protected String silent;
 	protected Integer timeout;
 	protected Integer regexTimeout;
 	protected Integer poolSize;
+	protected RelayConfig relay;
 	protected SnapshotConfig snapshot;
 	protected TruststoreConfig truststore;
 
 	SwitcherConfig() {
+		this.relay = new RelayConfig();
 		this.snapshot = new SnapshotConfig();
 		this.truststore = new TruststoreConfig();
 	}
@@ -35,10 +38,15 @@ protected void updateSwitcherConfig(SwitcherProperties properties) {
 		setComponent(properties.getValue(ContextKey.COMPONENT));
 		setEnvironment(properties.getValue(ContextKey.ENVIRONMENT));
 		setLocal(properties.getBoolean(ContextKey.LOCAL_MODE));
+		setCheck(properties.getBoolean(ContextKey.CHECK_SWITCHERS));
 		setSilent(properties.getValue(ContextKey.SILENT_MODE));
 		setTimeout(properties.getInt(ContextKey.TIMEOUT_MS));
 		setPoolSize(properties.getInt(ContextKey.POOL_CONNECTION_SIZE));
 
+		RelayConfig relayConfig = new RelayConfig();
+		relayConfig.setRestrict(properties.getBoolean(ContextKey.RESTRICT_RELAY));
+		setRelay(relayConfig);
+
 		SnapshotConfig snapshotConfig = new SnapshotConfig();
 		snapshotConfig.setLocation(properties.getValue(ContextKey.SNAPSHOT_LOCATION));
 		snapshotConfig.setAuto(properties.getBoolean(ContextKey.SNAPSHOT_AUTO_LOAD));
@@ -93,6 +101,10 @@ public void setLocal(boolean local) {
 		this.local = local;
 	}
 
+	public void setCheck(boolean check) {
+		this.check = check;
+	}
+
 	public void setSilent(String silent) {
 		this.silent = silent;
 	}
@@ -109,6 +121,9 @@ public void setPoolSize(Integer poolSize) {
 		this.poolSize = poolSize;
 	}
 
+	public void setRelay(RelayConfig relay) {
+		this.relay = relay;
+	}
 	public void setSnapshot(SnapshotConfig snapshot) {
 		this.snapshot = snapshot;
 	}
@@ -117,6 +132,18 @@ public void setTruststore(TruststoreConfig truststore) {
 		this.truststore = truststore;
 	}
 
+	public static class RelayConfig {
+		private boolean restrict;
+
+		public boolean isRestrict() {
+			return restrict;
+		}
+
+		public void setRestrict(boolean restrict) {
+			this.restrict = restrict;
+		}
+	}
+
 	public static class SnapshotConfig {
 		private String location;
 		private boolean auto;

src/main/java/com/github/switcherapi/client/SwitcherContextBase.java

@@ -107,6 +107,8 @@ protected void configureClient() {
 				.environment(environment)
 				.component(component)
 				.local(local)
+				.checkSwitchers(check)
+				.restrictRelay(relay.isRestrict())
 				.silentMode(silent)
 				.regexTimeout(regexTimeout)
 				.timeoutMs(timeout)
@@ -181,7 +183,7 @@ public static void initializeClient() {
 		validateContext();
 		registerSwitcherKeys();
 		switcherExecutor = buildInstance();
-		
+
 		loadSwitchers();
 		scheduleSnapshotAutoUpdate(contextStr(ContextKey.SNAPSHOT_AUTO_UPDATE_INTERVAL));
 		ContextBuilder.preConfigure(switcherProperties);
@@ -250,8 +252,14 @@ private static void registerSwitcherKey(Field[] fields) {
 
 	/**
 	 * Load Switcher instances into a map cache
+	 *
+	 * @throws SwitchersValidationException if "switcher.check" is enabled and one or more Switcher Keys are not found
 	 */
-	private static void loadSwitchers() {
+	private static void loadSwitchers() throws SwitchersValidationException {
+		if (contextBol(ContextKey.CHECK_SWITCHERS)) {
+			checkSwitchers();
+		}
+
 		if (Objects.isNull(switchers)) {
 			switchers = new HashMap<>();
 		}
@@ -447,7 +455,7 @@ public static void stopWatchingSnapshot() {
 	 * 
 	 * @throws SwitchersValidationException when one or more Switcher Key is not found
 	 */
-	public static void checkSwitchers() {
+	public static void checkSwitchers() throws SwitchersValidationException {
 		switcherExecutor.checkSwitchers(switcherKeys);
 	}
 

src/main/java/com/github/switcherapi/client/SwitcherPropertiesImpl.java

@@ -23,6 +23,7 @@ public SwitcherPropertiesImpl() {
 		setValue(ContextKey.SNAPSHOT_AUTO_LOAD, false);
 		setValue(ContextKey.SNAPSHOT_SKIP_VALIDATION, false);
 		setValue(ContextKey.LOCAL_MODE, false);
+		setValue(ContextKey.CHECK_SWITCHERS, false);
 		setValue(ContextKey.RESTRICT_RELAY, true);
 	}
 
@@ -40,6 +41,7 @@ public void loadFromProperties(Properties prop) {
 		setValue(ContextKey.SNAPSHOT_AUTO_UPDATE_INTERVAL, SwitcherUtils.resolveProperties(ContextKey.SNAPSHOT_AUTO_UPDATE_INTERVAL.getParam(), prop));
 		setValue(ContextKey.SILENT_MODE, SwitcherUtils.resolveProperties(ContextKey.SILENT_MODE.getParam(), prop));
 		setValue(ContextKey.LOCAL_MODE, getBoolDefault(SwitcherUtils.resolveProperties(ContextKey.LOCAL_MODE.getParam(), prop), false));
+		setValue(ContextKey.CHECK_SWITCHERS, getBoolDefault(SwitcherUtils.resolveProperties(ContextKey.CHECK_SWITCHERS.getParam(), prop), false));
 		setValue(ContextKey.RESTRICT_RELAY, getBoolDefault(SwitcherUtils.resolveProperties(ContextKey.RESTRICT_RELAY.getParam(), prop), true));
 		setValue(ContextKey.REGEX_TIMEOUT, getIntDefault(SwitcherUtils.resolveProperties(ContextKey.REGEX_TIMEOUT.getParam(), prop), DEFAULT_REGEX_TIMEOUT));
 		setValue(ContextKey.TRUSTSTORE_PATH, SwitcherUtils.resolveProperties(ContextKey.TRUSTSTORE_PATH.getParam(), prop));

src/main/java/com/github/switcherapi/client/model/ContextKey.java

@@ -69,6 +69,11 @@ public enum ContextKey {
 	 */
 	LOCAL_MODE("switcher.local"),
 
+	/**
+	 * (boolean) Defines if client will check the switchers before using them (default is false).
+	 */
+	CHECK_SWITCHERS("switcher.check"),
+
 	/**
 	 * (boolean) Defines if client will trigger local snapshot relay verification (default is true)
 	 */

src/main/java/com/github/switcherapi/client/remote/dto/SwitchersCheck.java

@@ -1,10 +1,11 @@
 package com.github.switcherapi.client.remote.dto;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.github.switcherapi.client.remote.ClientWS;
+
 import java.util.Arrays;
 import java.util.Set;
 
-import com.github.switcherapi.client.remote.ClientWS;
-
 /**
  * Request/Response model to use with {@link ClientWS#checkSwitchers(Set, String)}
  * 
@@ -21,6 +22,7 @@ public class SwitchersCheck {
 	/**
 	 * Response field
 	 */
+	@JsonProperty("not_found")
 	private String[] notFound;
 
 	public SwitchersCheck() {}

src/test/java/com/github/switcherapi/client/SwitcherBasicCriteriaResponseTest.java

@@ -25,7 +25,6 @@ static void setup() throws IOException {
 		MockWebServerHelper.setupMockServer();
 
 		Switchers.loadProperties(); // Load default properties from resources
-		Switchers.initializeClient(); // SwitcherContext requires preload before config override
 		Switchers.configure(ContextBuilder.builder() // Override default properties
 				.url(String.format("http://localhost:%s", mockBackEnd.getPort()))
 				.local(false)