Use enum set of ConfigurationParserOption to customize ConfigurationParser behaviour

Author: DSouzaM

substratevm/src/com.oracle.svm.configure.test/src/com/oracle/svm/configure/test/config/ResourceConfigurationTest.java

@@ -29,6 +29,7 @@
 import java.io.PipedReader;
 import java.io.PipedWriter;
 import java.util.Collection;
+import java.util.EnumSet;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Locale;
@@ -38,6 +39,7 @@
 import org.junit.Assert;
 import org.junit.Test;
 
+import com.oracle.svm.configure.ConfigurationParserOption;
 import com.oracle.svm.configure.ResourceConfigurationParser;
 import com.oracle.svm.configure.ResourcesRegistry;
 import com.oracle.svm.configure.config.ResourceConfiguration;
@@ -135,7 +137,8 @@ public void addClassBasedResourceBundle(UnresolvedConfigurationCondition conditi
                 }
             };
 
-            ResourceConfigurationParser<UnresolvedConfigurationCondition> rcp = ResourceConfigurationParser.create(false, ConfigurationConditionResolver.identityResolver(), registry, true);
+            ResourceConfigurationParser<UnresolvedConfigurationCondition> rcp = ResourceConfigurationParser.create(false, ConfigurationConditionResolver.identityResolver(), registry,
+                            EnumSet.of(ConfigurationParserOption.STRICT_CONFIGURATION));
             writerThread.start();
             rcp.parseAndRegister(pr);
 

substratevm/src/com.oracle.svm.configure/src/com/oracle/svm/configure/ConfigurationBase.java

@@ -25,6 +25,7 @@
 package com.oracle.svm.configure;
 
 import java.io.IOException;
+import java.util.EnumSet;
 import java.util.function.Consumer;
 
 import org.graalvm.nativeimage.impl.UnresolvedConfigurationCondition;
@@ -70,7 +71,7 @@ public T copyAndFilter(P predicate) {
         return copyAnd(copy -> copy.removeIf(predicate));
     }
 
-    public abstract ConfigurationParser createParser(boolean strictMetadata);
+    public abstract ConfigurationParser createParser(boolean strictMetadata, EnumSet<ConfigurationParserOption> parserOptions);
 
     public abstract boolean supportsCombinedFile();
 

substratevm/src/com.oracle.svm.configure/src/com/oracle/svm/configure/ConfigurationParser.java

@@ -24,9 +24,6 @@
  */
 package com.oracle.svm.configure;
 
-import static org.graalvm.nativeimage.impl.UnresolvedConfigurationCondition.TYPE_REACHABLE_KEY;
-import static org.graalvm.nativeimage.impl.UnresolvedConfigurationCondition.TYPE_REACHED_KEY;
-
 import java.io.BufferedReader;
 import java.io.FileNotFoundException;
 import java.io.IOException;
@@ -37,6 +34,7 @@
 import java.net.URL;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.EnumSet;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
@@ -62,7 +60,6 @@ public static InputStream openStream(URI uri) throws IOException {
         throw new IllegalArgumentException("For security reasons, reading configurations is not supported from URIs with protocol: " + url.getProtocol());
     }
 
-    public static final String CONDITIONAL_KEY = "condition";
     public static final String NAME_KEY = "name";
     public static final String TYPE_KEY = "type";
     public static final String PROXY_KEY = "proxy";
@@ -75,10 +72,25 @@ public static InputStream openStream(URI uri) throws IOException {
     public static final String MODULE_KEY = "module";
     public static final String GLOB_KEY = "glob";
     private final Map<String, Set<String>> seenUnknownAttributesByType = new HashMap<>();
-    private final boolean strictSchema;
+    private final EnumSet<ConfigurationParserOption> parserOptions;
+
+    protected ConfigurationParser(EnumSet<ConfigurationParserOption> parserOptions) {
+        this.parserOptions = parserOptions;
+    }
 
-    protected ConfigurationParser(boolean strictConfiguration) {
-        this.strictSchema = strictConfiguration;
+    /**
+     * Defines the options supported by this parser. A subclass can override this method to declare
+     * additional supported options.
+     */
+    protected EnumSet<ConfigurationParserOption> supportedOptions() {
+        return EnumSet.of(ConfigurationParserOption.STRICT_CONFIGURATION);
+    }
+
+    protected final boolean checkOption(ConfigurationParserOption option) {
+        if (!supportedOptions().contains(option)) {
+            throw new IllegalArgumentException(String.format("Tried to check option %s but it was not declared as a supported option", option));
+        }
+        return parserOptions.contains(option);
     }
 
     public void parseAndRegister(URI uri) throws IOException {
@@ -175,7 +187,7 @@ public static void checkHasExactlyOneAttribute(EconomicMap<String, Object> map,
      * @param message message to be displayed.
      */
     protected void warnOrFailOnSchemaError(String message) {
-        if (strictSchema) {
+        if (checkOption(ConfigurationParserOption.STRICT_CONFIGURATION)) {
             failOnSchemaError(message);
         } else {
             LogUtils.warning(message);
@@ -221,40 +233,7 @@ protected static long asLong(Object value, String propertyName) {
         throw new JsonParserException("Invalid long value '" + value + "' for element '" + propertyName + "'");
     }
 
-    protected UnresolvedConfigurationCondition parseCondition(EconomicMap<String, Object> data, boolean runtimeCondition) {
-        Object conditionData = data.get(CONDITIONAL_KEY);
-        if (conditionData != null) {
-            EconomicMap<String, Object> conditionObject = asMap(conditionData, "Attribute 'condition' must be an object");
-            if (conditionObject.containsKey(TYPE_REACHABLE_KEY) && conditionObject.containsKey(TYPE_REACHED_KEY)) {
-                failOnSchemaError("condition can not have both '" + TYPE_REACHED_KEY + "' and '" + TYPE_REACHABLE_KEY + "' set.");
-            }
-
-            if (conditionObject.containsKey(TYPE_REACHED_KEY)) {
-                if (!runtimeCondition) {
-                    failOnSchemaError("'" + TYPE_REACHED_KEY + "' condition cannot be used in older schemas. Please migrate the file to the latest schema.");
-                }
-                Object object = conditionObject.get(TYPE_REACHED_KEY);
-                var condition = parseTypeContents(object);
-                if (condition.isPresent()) {
-                    String className = ((NamedConfigurationTypeDescriptor) condition.get()).name();
-                    return UnresolvedConfigurationCondition.create(className);
-                }
-            } else if (conditionObject.containsKey(TYPE_REACHABLE_KEY)) {
-                if (runtimeCondition && !Options.TreatAllTypeReachableConditionsAsTypeReached.getValue()) {
-                    failOnSchemaError("'" + TYPE_REACHABLE_KEY + "' condition can not be used with the latest schema. Please use '" + TYPE_REACHED_KEY + "'.");
-                }
-                Object object = conditionObject.get(TYPE_REACHABLE_KEY);
-                var condition = parseTypeContents(object);
-                if (condition.isPresent()) {
-                    String className = ((NamedConfigurationTypeDescriptor) condition.get()).name();
-                    return UnresolvedConfigurationCondition.create(className, Options.TreatAllTypeReachableConditionsAsTypeReached.getValue());
-                }
-            }
-        }
-        return UnresolvedConfigurationCondition.alwaysTrue();
-    }
-
-    private static JsonParserException failOnSchemaError(String message) {
+    protected static JsonParserException failOnSchemaError(String message) {
         throw new JsonParserException(message);
     }
 

substratevm/src/com.oracle.svm.configure/src/com/oracle/svm/configure/ConfigurationParserOption.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2025, 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package com.oracle.svm.configure;
+
+/**
+ * {@link ConfigurationParser} options that control parsing behaviour. Options are not necessarily
+ * supported by all parsers.
+ */
+public enum ConfigurationParserOption {
+    /**
+     * Fail when a configuration file has incorrect schema (e.g., extraneous fields).
+     */
+    STRICT_CONFIGURATION,
+
+    /**
+     * Log a warning for each reflection element (e.g., class, field) that could not be resolved.
+     */
+    PRINT_MISSING_ELEMENTS,
+
+    /**
+     * Treat the legacy "typeReachable" condition as a "typeReached" condition checked at run time.
+     */
+    TREAT_ALL_TYPE_REACHABLE_CONDITIONS_AS_TYPE_REACHED,
+
+    /**
+     * Treat the "name" entry in a legacy reflection configuration as a "type" entry.
+     */
+    TREAT_ALL_NAME_ENTRIES_AS_TYPE
+}

substratevm/src/com.oracle.svm.configure/src/com/oracle/svm/configure/LegacyReflectionConfigurationParser.java

@@ -26,6 +26,7 @@
 
 import java.net.URI;
 import java.util.Arrays;
+import java.util.EnumSet;
 import java.util.List;
 import java.util.Optional;
 
@@ -44,12 +45,15 @@ final class LegacyReflectionConfigurationParser<C, T> extends ReflectionConfigur
                     "allPublicClasses", "methods", "queriedMethods", "fields", CONDITIONAL_KEY,
                     "queryAllDeclaredConstructors", "queryAllPublicConstructors", "queryAllDeclaredMethods", "queryAllPublicMethods", "unsafeAllocated", "serializable");
 
-    private final boolean treatAllNameEntriesAsType;
+    LegacyReflectionConfigurationParser(ConfigurationConditionResolver<C> conditionResolver, ReflectionConfigurationParserDelegate<C, T> delegate, EnumSet<ConfigurationParserOption> parserOptions) {
+        super(conditionResolver, delegate, parserOptions);
+    }
 
-    LegacyReflectionConfigurationParser(ConfigurationConditionResolver<C> conditionResolver, ReflectionConfigurationParserDelegate<C, T> delegate, boolean strictConfiguration,
-                    boolean printMissingElements, boolean treatAllNameEntriesAsType) {
-        super(conditionResolver, delegate, strictConfiguration, printMissingElements);
-        this.treatAllNameEntriesAsType = treatAllNameEntriesAsType;
+    @Override
+    protected EnumSet<ConfigurationParserOption> supportedOptions() {
+        EnumSet<ConfigurationParserOption> base = super.supportedOptions();
+        base.add(ConfigurationParserOption.TREAT_ALL_NAME_ENTRIES_AS_TYPE);
+        return base;
     }
 
     @Override
@@ -61,7 +65,7 @@ public void parseAndRegister(Object json, URI origin) {
     protected void parseClass(EconomicMap<String, Object> data) {
         checkAttributes(data, "reflection class descriptor object", List.of(NAME_KEY), OPTIONAL_REFLECT_CONFIG_OBJECT_ATTRS);
 
-        Optional<TypeDescriptorWithOrigin> type = parseName(data, treatAllNameEntriesAsType);
+        Optional<TypeDescriptorWithOrigin> type = parseName(data, checkOption(ConfigurationParserOption.TREAT_ALL_NAME_ENTRIES_AS_TYPE));
         if (type.isEmpty()) {
             return;
         }

substratevm/src/com.oracle.svm.configure/src/com/oracle/svm/configure/LegacyResourceConfigurationParser.java

@@ -26,6 +26,7 @@
 
 import java.net.URI;
 import java.util.Collections;
+import java.util.EnumSet;
 import java.util.List;
 import java.util.function.BiConsumer;
 
@@ -38,8 +39,8 @@
 import com.oracle.svm.util.TypeResult;
 
 final class LegacyResourceConfigurationParser<C> extends ResourceConfigurationParser<C> {
-    LegacyResourceConfigurationParser(ConfigurationConditionResolver<C> conditionResolver, ResourcesRegistry<C> registry, boolean strictConfiguration) {
-        super(conditionResolver, registry, strictConfiguration);
+    LegacyResourceConfigurationParser(ConfigurationConditionResolver<C> conditionResolver, ResourcesRegistry<C> registry, EnumSet<ConfigurationParserOption> parserOptions) {
+        super(conditionResolver, registry, parserOptions);
     }
 
     @Override

substratevm/src/com.oracle.svm.configure/src/com/oracle/svm/configure/LegacySerializationConfigurationParser.java

@@ -27,6 +27,7 @@
 import java.net.URI;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.EnumSet;
 import java.util.List;
 
 import org.graalvm.collections.EconomicMap;
@@ -46,9 +47,9 @@ final class LegacySerializationConfigurationParser<C> extends SerializationConfi
 
     private final ProxyConfigurationParser<C> proxyConfigurationParser;
 
-    LegacySerializationConfigurationParser(ConfigurationConditionResolver<C> conditionResolver, RuntimeSerializationSupport<C> serializationSupport, boolean strictConfiguration) {
-        super(conditionResolver, serializationSupport, strictConfiguration);
-        this.proxyConfigurationParser = new ProxyConfigurationParser<>(conditionResolver, strictConfiguration, serializationSupport::registerProxyClass);
+    LegacySerializationConfigurationParser(ConfigurationConditionResolver<C> conditionResolver, RuntimeSerializationSupport<C> serializationSupport, EnumSet<ConfigurationParserOption> parserOptions) {
+        super(conditionResolver, serializationSupport, parserOptions);
+        this.proxyConfigurationParser = new ProxyConfigurationParser<>(conditionResolver, parserOptions, serializationSupport::registerProxyClass);
     }
 
     @Override

substratevm/src/com.oracle.svm.configure/src/com/oracle/svm/configure/PredefinedClassesConfigurationParser.java

@@ -33,6 +33,7 @@
 import java.nio.file.Path;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.EnumSet;
 
 import org.graalvm.collections.EconomicMap;
 
@@ -46,8 +47,8 @@ public static InputStream openClassdataStream(URI baseUri, String providedHash)
 
     private final PredefinedClassesRegistry registry;
 
-    public PredefinedClassesConfigurationParser(PredefinedClassesRegistry registry, boolean strictConfiguration) {
-        super(strictConfiguration);
+    public PredefinedClassesConfigurationParser(PredefinedClassesRegistry registry, EnumSet<ConfigurationParserOption> parserOptions) {
+        super(parserOptions);
         this.registry = registry;
     }
 

substratevm/src/com.oracle.svm.configure/src/com/oracle/svm/configure/ProxyConfigurationParser.java

@@ -26,6 +26,7 @@
 
 import java.net.URI;
 import java.util.Collections;
+import java.util.EnumSet;
 import java.util.List;
 import java.util.function.BiConsumer;
 import java.util.stream.Collectors;
@@ -42,15 +43,14 @@
  * Parses JSON describing lists of interfaces and passes them to the given consumer (e.g., to add
  * them to a registry).
  */
-public final class ProxyConfigurationParser<C> extends ConfigurationParser {
+public final class ProxyConfigurationParser<C> extends ConditionalConfigurationParser {
 
     private final ConfigurationConditionResolver<C> conditionResolver;
 
     private final BiConsumer<C, List<String>> proxyConfigConsumer;
 
-    public ProxyConfigurationParser(ConfigurationConditionResolver<C> conditionResolver, boolean strictConfiguration,
-                    BiConsumer<C, List<String>> proxyConfigConsumer) {
-        super(strictConfiguration);
+    public ProxyConfigurationParser(ConfigurationConditionResolver<C> conditionResolver, EnumSet<ConfigurationParserOption> parserOptions, BiConsumer<C, List<String>> proxyConfigConsumer) {
+        super(parserOptions);
         this.proxyConfigConsumer = proxyConfigConsumer;
         this.conditionResolver = conditionResolver;
     }

substratevm/src/com.oracle.svm.configure/src/com/oracle/svm/configure/ReflectionConfigurationParser.java

@@ -27,6 +27,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.EnumSet;
 import java.util.List;
 import java.util.stream.Collectors;
 
@@ -42,28 +43,32 @@
  * Parses JSON describing classes, methods and fields and delegates their registration to a
  * {@link ReflectionConfigurationParserDelegate}.
  */
-public abstract class ReflectionConfigurationParser<C, T> extends ConfigurationParser {
+public abstract class ReflectionConfigurationParser<C, T> extends ConditionalConfigurationParser {
     private static final String CONSTRUCTOR_NAME = "<init>";
 
     protected final ConfigurationConditionResolver<C> conditionResolver;
     protected final ReflectionConfigurationParserDelegate<C, T> delegate;
-    private final boolean printMissingElements;
 
-    public ReflectionConfigurationParser(ConfigurationConditionResolver<C> conditionResolver, ReflectionConfigurationParserDelegate<C, T> delegate, boolean strictConfiguration,
-                    boolean printMissingElements) {
-        super(strictConfiguration);
+    public ReflectionConfigurationParser(ConfigurationConditionResolver<C> conditionResolver, ReflectionConfigurationParserDelegate<C, T> delegate, EnumSet<ConfigurationParserOption> parserOptions) {
+        super(parserOptions);
         this.conditionResolver = conditionResolver;
-        this.printMissingElements = printMissingElements;
         this.delegate = delegate;
     }
 
+    @Override
+    protected EnumSet<ConfigurationParserOption> supportedOptions() {
+        EnumSet<ConfigurationParserOption> base = super.supportedOptions();
+        base.add(ConfigurationParserOption.PRINT_MISSING_ELEMENTS);
+        return base;
+    }
+
     public static <C, T> ReflectionConfigurationParser<C, T> create(String combinedFileKey, boolean strictMetadata,
                     ConfigurationConditionResolver<C> conditionResolver, ReflectionConfigurationParserDelegate<C, T> delegate,
-                    boolean strictConfiguration, boolean printMissingElements, boolean treatAllEntriesAsType) {
+                    EnumSet<ConfigurationParserOption> parserOptions) {
         if (strictMetadata) {
-            return new ReflectionMetadataParser<>(combinedFileKey, conditionResolver, delegate, strictConfiguration, printMissingElements);
+            return new ReflectionMetadataParser<>(combinedFileKey, conditionResolver, delegate, parserOptions);
         } else {
-            return new LegacyReflectionConfigurationParser<>(conditionResolver, delegate, strictConfiguration, printMissingElements, treatAllEntriesAsType);
+            return new LegacyReflectionConfigurationParser<>(conditionResolver, delegate, parserOptions);
         }
     }
 
@@ -189,7 +194,7 @@ private void handleMissingElement(String message) {
     }
 
     protected void handleMissingElement(String msg, Throwable cause) {
-        if (printMissingElements) {
+        if (checkOption(ConfigurationParserOption.PRINT_MISSING_ELEMENTS)) {
             String message = msg;
             if (cause != null) {
                 message += " Reason: " + formatError(cause) + '.';