Tutorials edits - Terminate on configuration error - Terminal Color (#2368)

* refactor: minor

* feat: terminal colors

* feat: reorganized utility classes into 'text' and 'xml' packages, added new `TerminalColors` and `XMLTextUtil` classes

- Moved text-related utilities to `com.predic8.membrane.core.util.text` package.
- Introduced `TerminalColors` class for ANSI terminal color handling.
- Added `XMLTextUtil` class with utilities for XML formatting and validation.
- Updated class references and imports across the codebase to reflect package restructuring.
- Enhanced logging configuration to support color highlighting.

* refactor: cleanup unused methods, enhance type-checking, and suppress warnings

- Removed redundant methods no longer in use (`waitForAsynchronousInitialization`, `isAsynchronousInitialization`).
- Improved type-checking with modern Java features (e.g., `instanceof` with variable binding).
- Refined helper method signatures to reduce unnecessary parameters.
- Suppressed unused warning in `TerminalColors`.
- Updated exception types to match method requirements.

* refactor: adjust default behavior in `TerminalColors` and improve code consistency

- Changed fallback return value in `TerminalColors` to `false` for safer behavior.
- Updated exception type in `XMLTextUtil` to match method operations.
- Refined imports in `GrammarMock` for conciseness.
- Removed unused exceptions in `HttpServerHandler` to simplify method signatures.

* fix: improve OS detection logic and update roadmap for 7.1.0 prep

- Corrected OS detection for Windows by using full "windows" string match.
- Added 7.1.0 section to the roadmap, noting JSON Schema registration.

* refactor: Fixed OSUtil win vs. windows, consolidate `StringUtil` and `TextUtil` usage, reorganize utility imports, and fix minor inconsistencies

* refactor: simplify imports in `TextUtilTest` and `TerminalColors` by consolidating wildcard usage

* feat: enhance logging with terminal color support and improve OS utility methods

- Added colorized logging for different log levels using `TerminalColors`.
- Refined `OSUtil` with new constants, IntelliJ/VSCode detection, and JVM argument helper.
- Simplified ANSI support detection logic in `TerminalColors`.

* refactor: streamline OS utility methods and terminal color logic

- Removed redundant imports and simplified method calls in `TerminalColors` and `OSUtil`.
- Unified OS detection patterns for macOS, Windows, and Linux/Unix systems.
- Improved readability and consistency in terminal color support logic.

* feat: enhance terminal color support and fix OS detection issues

- Added system property `MEMBRANE_COLORS` to enable/disable terminal color logging explicitly.
- Fixed null-safe access in OS detection methods.
- Corrected method naming inconsistencies in `OSUtil` and `TerminalColors`.

* feat: improve terminal environment handling and simplify ANSI support detection

- Added new constants for terminal environment variables in `OSUtil`.
- Introduced `isDumbTerminal` method for enhanced Linux/Unix support.
- Refactored `detectAnsiSupport` in `TerminalColors` for better readability and logic reuse.

* refactor: rename terminal color environment variable and property for consistency

- Updated `MEMBRANE_COLORS` to `MEMBRANE_TERM_COLORS` and added new system property `membrane.term.colors`.
- Adjusted references in `LogInterceptor`, `TerminalColors`, and `Constants`.
- Improved logic in `TerminalColors` for explicit fallback handling.

* feat: add support for disabling terminal colors via environment variable and property

- Introduced `MEMBRANE_DISABLE_TERM_COLORS` environment variable and `membrane.disable.term.colors` system property.
- Updated `TerminalColors`, `Constants`, and log4j2 configuration files to support new variables.
- Adjusted ANSI support detection logic to accommodate the disable feature.

* refactor: remove `isDumbTerminal` method and inline logic in `TerminalColors`

- Simplified terminal color detection by inlining `isDumbTerminal` logic directly into `TerminalColors`.
- Removed unused method from `OSUtil`.

* feat: enhance and standardize terminal color support

- Implemented detailed environment-based terminal color detection in shell and batch scripts.
- Deprecated redundant methods in `OSUtil` while streamlining color detection logic in `TerminalColors`.
- Updated log configuration files to support standardized `membrane.disable.term.colors` system property.
- Improved user control over terminal colors with clear case-insensitive environment overrides.

* feat: add `membrane.disable.term.colors` system property to batch script

- Extended `start_router.cmd` to include `JAVA_OPTS` for disabling terminal colors.

* feat: extend terminal compatibility detection in shell script

- Added support for WezTerm, Alacritty, and Kitty in `start_router.sh`.
- Minor formatting adjustment in `TerminalColors`.

* feat: extend terminal compatibility detection in shell script

- Added support for WezTerm, Alacritty, and Kitty in `start_router.sh`.
- Minor formatting adjustment in `TerminalColors`.

Author: predic8

annot/src/main/java/com/predic8/membrane/annot/generator/JsonSchemaGenerator.java

@@ -39,6 +39,8 @@
  */
 public class JsonSchemaGenerator extends AbstractGrammar {
 
+    public static final String MEMBRANE_SCHEMA_JSON_FILENAME = "membrane.schema.json";
+
     private final Map<String, Boolean> topLevelAdded = new HashMap<>();
 
     public JsonSchemaGenerator(ProcessingEnvironment processingEnv) {
@@ -166,7 +168,7 @@ private FileObject createFile(MainInfo main) throws IOException {
                 .createResource(
                         CLASS_OUTPUT,
                         main.getAnnotation().outputPackage().replaceAll("\\.spring$", ".json"),
-                        "membrane.schema.json",
+                        MEMBRANE_SCHEMA_JSON_FILENAME,
                         sources.toArray(new Element[0])
                 );
     }

annot/src/main/java/com/predic8/membrane/annot/yaml/BeanRegistryImplementation.java

@@ -143,6 +143,7 @@ private void activationRun() {
                 uidsToRemove.add(bd.getUid());
             } catch (Exception e) {
                 log.error("Could not handle {} {}/{}", bd.getAction(), bd.getNamespace(), bd.getName(), e);
+                throw new RuntimeException(e);
             }
         }
         for (String uid : uidsToRemove)

core/src/main/java/com/predic8/membrane/core/Constants.java

@@ -25,7 +25,15 @@ public class Constants {
 
 	public static final String MEMBRANE_HOME = "MEMBRANE_HOME";
 
-	public static final String CRLF = "" + ((char) 13) + ((char) 10);
+    // Java System Properties
+
+    /**
+     * System property set by start script based on MEMBRANE_DISABLE_TERM_COLORS detection.
+     * Users should use the environment variable instead.
+     */
+    public static final String MEMBRANE_DISABLE_TERM_COLORS_PROPERTY = "membrane.disable.term.colors";
+
+    public static final String CRLF = "" + ((char) 13) + ((char) 10);
 
 	public static final byte[] CRLF_BYTES = { 13, 10 };
 
@@ -42,7 +50,7 @@ public class Constants {
 				Properties p = new Properties(); // Development
 				p.load(new FileInputStream("target/maven-archiver/pom.properties"));
 				version = p.getProperty("version") + " - DEVELOPMENT";
-			} catch (Exception e2) {
+			} catch (Exception ignored) {
 			}
 		}
 		VERSION = version;

core/src/main/java/com/predic8/membrane/core/Router.java

@@ -52,6 +52,7 @@
 import com.predic8.membrane.core.util.DNSCache;
 import com.predic8.membrane.core.util.TimerManager;
 import com.predic8.membrane.core.util.URIFactory;
+import com.predic8.membrane.core.util.text.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.BeansException;
@@ -67,10 +68,11 @@
 import java.util.*;
 import java.util.concurrent.ExecutorService;
 
-import static com.predic8.membrane.core.Constants.PRODUCT_NAME;
-import static com.predic8.membrane.core.Constants.VERSION;
+import static com.predic8.membrane.core.Constants.*;
 import static com.predic8.membrane.core.jmx.JmxExporter.JMX_EXPORTER_NAME;
 import static com.predic8.membrane.core.util.DLPUtil.displayTraceWarning;
+import static com.predic8.membrane.core.util.text.TerminalColors.BRIGHT_CYAN;
+import static com.predic8.membrane.core.util.text.TerminalColors.RESET;
 import static java.util.concurrent.Executors.newSingleThreadExecutor;
 
 /**
@@ -355,7 +357,11 @@ public void start() {
 
         ApiInfo.logInfosAboutStartedProxies(ruleManager);
         if (!asynchronousInitialization)
-            log.info("{} {} up and running!", PRODUCT_NAME, VERSION);
+            logStartupMessage();
+    }
+
+    private static void logStartupMessage() {
+        log.info("{}{} {} up and running!{}", BRIGHT_CYAN(), PRODUCT_NAME, VERSION, RESET());
     }
 
     private void startJmx() {
@@ -662,40 +668,25 @@ public GlobalInterceptor getGlobalInterceptor() {
         return globalInterceptor;
     }
 
-    public synchronized boolean isAsynchronousInitialization() {
-        return asynchronousInitialization;
-    }
-
     public synchronized void setAsynchronousInitialization(boolean asynchronousInitialization) {
         this.asynchronousInitialization = asynchronousInitialization;
         notifyAll();
     }
 
-    public synchronized void waitForAsynchronousInitialization() {
-        while (asynchronousInitialization) {
-            try {
-                wait();
-            } catch (InterruptedException e) {
-                Thread.currentThread().interrupt();
-            }
-        }
-    }
-
     public void handleAsynchronousInitializationResult(boolean success) {
         if (!success && !retryInit)
             System.exit(1);
         ApiInfo.logInfosAboutStartedProxies(ruleManager);
-        log.info("{} {} up and running!", PRODUCT_NAME, VERSION);
+        logStartupMessage();
         setAsynchronousInitialization(false);
     }
 
     @Override
     public void handleBeanEvent(BeanDefinition bd, Object bean, Object oldBean) throws IOException {
-        if (!(bean instanceof Proxy)) {
+        if (!(bean instanceof Proxy newProxy)) {
             throw new IllegalArgumentException("Bean must be a Proxy instance, but got: " + bean.getClass().getName());
         }
 
-        Proxy newProxy = (Proxy) bean;
         if (newProxy.getName() == null)
             newProxy.setName(bd.getName());
 

core/src/main/java/com/predic8/membrane/core/exchangestore/FileExchangeStore.java

@@ -29,7 +29,7 @@
 import java.util.*;
 import java.util.concurrent.atomic.*;
 
-import static com.predic8.membrane.core.util.TextUtil.*;
+import static com.predic8.membrane.core.util.xml.XMLTextUtil.*;
 import static java.nio.charset.StandardCharsets.*;
 import static java.util.Calendar.*;
 

core/src/main/java/com/predic8/membrane/core/graphql/GraphQLProtectionInterceptor.java

@@ -21,6 +21,7 @@
 import com.predic8.membrane.core.http.*;
 import com.predic8.membrane.core.interceptor.*;
 import com.predic8.membrane.core.util.*;
+import com.predic8.membrane.core.util.text.*;
 import org.slf4j.*;
 
 import java.security.*;
@@ -29,6 +30,7 @@
 import static com.predic8.membrane.core.http.Request.METHOD_GET;
 import static com.predic8.membrane.core.http.Request.METHOD_POST;
 import static com.predic8.membrane.core.interceptor.Outcome.*;
+import static com.predic8.membrane.core.util.text.TextUtil.*;
 
 /**
  * @description Check GraphQL-over-HTTP requests, enforcing several limits and/or restrictions. This effectively helps to reduce
@@ -187,7 +189,7 @@ public String getLongDescription() {
                 "graphql-over-http/blob/a1e6d8ca248c9a19eb59a2eedd988c204909ee3f/spec/GraphQLOverHTTP.md\">" +
                 "GraphQL-over-HTTP</a> specs).<br/>" +
                 "GraphQL extensions: " + (allowExtensions ? "Allowed." : "Forbidden.") + "<br/>" +
-                "Allowed HTTP verbs: " + TextUtil.toEnglishList("and", allowedMethods.toArray(new String[0])) + ".<br/>" +
+                "Allowed HTTP verbs: " + toEnglishList("and", allowedMethods.toArray(new String[0])) + ".<br/>" +
                 "Maximum allowed nested query levels: " + maxDepth + "<br/>" +
                 "Maximum allowed recursion levels (nested repetitions of the same word): " + maxRecursion + ".</div>";
     }

core/src/main/java/com/predic8/membrane/core/http/Message.java

@@ -25,7 +25,7 @@
 import static com.predic8.membrane.core.http.Header.*;
 import static com.predic8.membrane.core.util.ContentTypeDetector.EffectiveContentType.*;
 import static com.predic8.membrane.core.util.ContentTypeDetector.*;
-import static com.predic8.membrane.core.util.TextUtil.getCharset;
+import static com.predic8.membrane.core.util.text.TextUtil.getCharset;
 
 /**
  * A HTTP message (request or response).

core/src/main/java/com/predic8/membrane/core/interceptor/acl/Resource.java

@@ -28,7 +28,7 @@
 import com.predic8.membrane.core.Router;
 import com.predic8.membrane.core.config.AbstractXmlElement;
 import com.predic8.membrane.core.config.GenericComplexElement;
-import com.predic8.membrane.core.util.TextUtil;
+import com.predic8.membrane.core.util.text.TextUtil;
 
 public class Resource extends AbstractXmlElement {
 

core/src/main/java/com/predic8/membrane/core/interceptor/acl/matchers/GlobMatcher.java

@@ -15,7 +15,7 @@
 
 import com.predic8.membrane.core.interceptor.acl.TypeMatcher;
 
-import static com.predic8.membrane.core.util.TextUtil.globToRegExp;
+import static com.predic8.membrane.core.util.text.TextUtil.globToRegExp;
 import static java.util.regex.Pattern.compile;
 
 public class GlobMatcher implements TypeMatcher {

core/src/main/java/com/predic8/membrane/core/interceptor/administration/AdminPageBuilder.java

@@ -24,7 +24,6 @@
 import com.predic8.membrane.core.proxies.*;
 import com.predic8.membrane.core.proxies.Proxy;
 import com.predic8.membrane.core.transport.http.*;
-import com.predic8.membrane.core.util.*;
 import org.apache.commons.text.*;
 
 import java.io.*;
@@ -36,6 +35,7 @@
 import static com.predic8.membrane.core.interceptor.balancer.BalancerUtil.*;
 import static com.predic8.membrane.core.interceptor.balancer.Node.Status.*;
 import static com.predic8.membrane.core.util.URLParamUtil.*;
+import static com.predic8.membrane.core.util.xml.XMLTextUtil.isValidXMLSnippet;
 import static java.nio.charset.StandardCharsets.*;
 import static java.util.Objects.requireNonNull;
 import static org.apache.commons.lang3.time.DurationFormatUtils.*;
@@ -618,12 +618,12 @@ private void createInterceptorVisualization(Interceptor i, int columnSpan, Strin
             String longDescription = i.getLongDescription();
             boolean same = longDescription.equals(shortDescription);
 
-            if (!TextUtil.isValidXMLSnippet(shortDescription)) {
+            if (!isValidXMLSnippet(shortDescription)) {
                 shortDescription = StringEscapeUtils.escapeHtml4(shortDescription).replace("\n", "<br/>");
                 if (same)
                     longDescription = shortDescription;
             }
-            if (!same && !TextUtil.isValidXMLSnippet(longDescription)) {
+            if (!same && !isValidXMLSnippet(longDescription)) {
                 longDescription = StringEscapeUtils.escapeHtml4(longDescription).replace("\n", "<br/>");
             }
 
@@ -636,9 +636,9 @@ private void createInterceptorVisualization(Interceptor i, int columnSpan, Strin
 
             String iid = "i" + id;
             div().id("i" + id);
-            createHelpIcon(i, id);
+            createHelpIcon(i);
             if (!shortDescription.isEmpty() && !longDescription.equals(shortDescription)) {
-                createExpandIcon(i, id);
+                createExpandIcon(id);
             }
             end();
             createShowIconsScript(did, iid);
@@ -700,7 +700,7 @@ private void createInterceptorVisualization(Interceptor i, int columnSpan, Strin
         end();
     }
 
-    private void createExpandIcon(Interceptor i, String id) {
+    private void createExpandIcon(String id) {
         div().style("float:right;");
         span().id("e" + id).classAttr("ui-icon ui-icon-triangle-1-w").title("expand").end();
         end();
@@ -709,7 +709,7 @@ private void createExpandIcon(Interceptor i, String id) {
         end();
     }
 
-    private void createHelpIcon(Interceptor i, String id) {
+    private void createHelpIcon(Interceptor i) {
         String helpId = i.getHelpId();
         if (helpId != null) {
             div().style("float:right;");