refactor(soap): reuses parser schema type system instead of recompiling all schemas.

Author: outofcoffee

mock/soap/src/main/java/io/gatehill/imposter/plugin/soap/parser/AbstractWsdlParser.kt

@@ -43,11 +43,11 @@
 
 package io.gatehill.imposter.plugin.soap.parser
 
+import io.gatehill.imposter.plugin.soap.util.SchemaUtil
 import io.gatehill.imposter.plugin.soap.util.SoapUtil
 import io.gatehill.imposter.util.BodyQueryUtil
 import org.apache.logging.log4j.LogManager
 import org.apache.logging.log4j.Logger
-import org.apache.xmlbeans.SchemaTypeSystem
 import org.apache.xmlbeans.XmlBeans
 import org.apache.xmlbeans.XmlOptions
 import org.apache.xmlbeans.impl.xb.xsdschema.SchemaDocument
@@ -71,11 +71,8 @@ abstract class AbstractWsdlParser(
 
     override val schemaContext: SchemaContext by lazy {
         val schemas = discoverSchemas()
-        SchemaContext(
-            schemas = schemas,
-            sts = compileSchemas(schemas),
-            entityResolver = entityResolver,
-        )
+        val sts = SchemaUtil.compileSchemas(XmlBeans.getBuiltinTypeSystem(), entityResolver, schemas)
+        SchemaContext(schemas, sts, entityResolver)
     }
 
     private val unionTypeSystem by lazy { XmlBeans.typeLoaderUnion(XmlBeans.getBuiltinTypeSystem(), schemaContext.sts) }
@@ -126,21 +123,6 @@ abstract class AbstractWsdlParser(
 
     protected abstract fun findEmbeddedTypesSchemaNodes(): List<Element>
 
-    private fun compileSchemas(schemas: Array<SchemaDocument>): SchemaTypeSystem {
-        if (schemas.isEmpty()) {
-            throw IllegalStateException("Cannot build XSD from empty schema list")
-        }
-        val compileOptions = XmlOptions()
-            .setLoadLineNumbers()
-            .setLoadMessageDigest()
-            .setEntityResolver(entityResolver)
-        try {
-            return XmlBeans.compileXsd(schemas, XmlBeans.getBuiltinTypeSystem(), compileOptions)
-        } catch (e: Exception) {
-            throw RuntimeException("Schema compilation errors", e)
-        }
-    }
-
     protected fun selectSingleNodeWithName(context: Any, expressionTemplate: String, name: String): Element? {
         return selectSingleNode(context, String.format(expressionTemplate, name))
             ?: name.takeIf { it.contains(":") }?.let {

mock/soap/src/main/java/io/gatehill/imposter/plugin/soap/parser/Wsdl1Parser.kt

@@ -178,10 +178,10 @@ class Wsdl1Parser(
             name = operationName
         ) ?: throw IllegalStateException("No portType operation found for portType: $portTypeName and operation: $operationName")
 
-        val input = getMessage(operationName, portTypeOperation, "./wsdl:input")
+        val input = getMessage(portTypeOperation, "./wsdl:input")
             ?: throw IllegalStateException("No input found for portType operation: $operationName")
 
-        val output = getMessage(operationName, portTypeOperation, "./wsdl:output")
+        val output = getMessage(portTypeOperation, "./wsdl:output")
             ?: throw IllegalStateException("No output found for portType operation: $operationName")
 
         val style = soapOperation.getAttributeValue("style") ?: run {
@@ -219,7 +219,7 @@ class Wsdl1Parser(
      * Extract the WSDL message part element attribute, then attempt
      * to resolve it from within the XSD.
      */
-    private fun getMessage(operationName: String, context: Element, expression: String): OperationMessage? {
+    private fun getMessage(context: Element, expression: String): OperationMessage? {
         val inputOrOutputNode = selectSingleNode(context, expression)
             ?: throw IllegalStateException("No input or output found for: $expression")
 

mock/soap/src/main/java/io/gatehill/imposter/plugin/soap/parser/Wsdl2Parser.kt

@@ -165,10 +165,10 @@ class Wsdl2Parser(
 
     private fun parseOperation(operationName: String, operation: Element): WsdlOperation {
         val soapOperation = selectSingleNode(operation, "./soap:operation") ?: throw IllegalStateException(
-            "Unable to find soap:operation for operation ${operationName}"
+            "Unable to find soap:operation for operation $operationName"
         )
-        val input = getMessage(operationName, operation, "./wsdl:input")
-        val output = getMessage(operationName, operation, "./wsdl:output")
+        val input = getMessage(operation, "./wsdl:input")
+        val output = getMessage(operation, "./wsdl:output")
 
         return WsdlOperation(
             name = operation.getAttributeValue("name"),
@@ -183,7 +183,7 @@ class Wsdl2Parser(
      * Extract the WSDL message part element attribute, then attempt
      * to resolve it from within the XSD.
      */
-    private fun getMessage(operationName: String, context: Element, expression: String): OperationMessage? {
+    private fun getMessage(context: Element, expression: String): OperationMessage? {
         val inputOrOutputNode = selectSingleNode(context, expression) ?: throw IllegalStateException(
             "Unable to find message part: $expression"
         )

mock/soap/src/main/java/io/gatehill/imposter/plugin/soap/service/SoapExampleService.kt

@@ -54,18 +54,12 @@ import io.gatehill.imposter.plugin.soap.model.TypeOperationMessage
 import io.gatehill.imposter.plugin.soap.model.WsdlOperation
 import io.gatehill.imposter.plugin.soap.model.WsdlService
 import io.gatehill.imposter.plugin.soap.parser.SchemaContext
-import io.gatehill.imposter.plugin.soap.util.SchemaGenerator
+import io.gatehill.imposter.plugin.soap.util.SchemaUtil
 import io.gatehill.imposter.plugin.soap.util.SoapUtil
 import io.gatehill.imposter.util.LogUtil
 import org.apache.logging.log4j.LogManager
 import org.apache.logging.log4j.Logger
 import org.apache.xmlbeans.SchemaType
-import org.apache.xmlbeans.SchemaTypeSystem
-import org.apache.xmlbeans.XmlBeans
-import org.apache.xmlbeans.XmlError
-import org.apache.xmlbeans.XmlException
-import org.apache.xmlbeans.XmlOptions
-import org.apache.xmlbeans.impl.xb.xsdschema.SchemaDocument
 import org.apache.xmlbeans.impl.xsd2inst.SampleXmlUtil
 import javax.xml.namespace.QName
 
@@ -114,8 +108,6 @@ class SoapExampleService {
         service: WsdlService,
         operation: WsdlOperation,
     ): String {
-        val parts = operation.outputRef?.let { listOf(it) } ?: emptyList()
-
         // by convention, the suffix 'Response' is added to the operation name
         val rootElementName = operation.name + "Response"
         val rootElement = if (service.targetNamespace?.isNotBlank() == true) {
@@ -124,8 +116,9 @@ class SoapExampleService {
             QName(rootElementName)
         }
 
-        val elementSchema = SchemaGenerator.createCompositePartSchema(service.targetNamespace ?: "", rootElement, parts)
-        val sts: SchemaTypeSystem = buildSchemaTypeSystem(schemaContext, elementSchema)
+        val parts = operation.outputRef?.let { listOf(it) } ?: emptyList()
+        val elementSchema = SchemaUtil.createCompositePartSchema(service.targetNamespace ?: "", rootElement, parts)
+        val sts = SchemaUtil.compileSchemas(schemaContext.sts, schemaContext.entityResolver, arrayOf(elementSchema))
 
         val elem = sts.findDocumentType(rootElement)
             ?: throw RuntimeException("Could not find a generated element with name \"$rootElement\"")
@@ -164,9 +157,9 @@ class SoapExampleService {
 
     private fun generateElementExample(
         schemaContext: SchemaContext,
-        outputRef: ElementOperationMessage,
+        message: ElementOperationMessage,
     ): String {
-        val rootElementName = outputRef.elementName
+        val rootElementName = message.elementName
         val elem: SchemaType = schemaContext.sts.findDocumentType(rootElementName)
             ?: throw RuntimeException("Could not find a global element with name \"$rootElementName\"")
 
@@ -178,46 +171,16 @@ class SoapExampleService {
         service: WsdlService,
         message: TypeOperationMessage,
     ): String {
-        val elementName = QName(service.targetNamespace, message.partName)
-        val elementSchema = SchemaGenerator.createSinglePartSchema(service.targetNamespace ?: "", message)
-        val sts: SchemaTypeSystem = buildSchemaTypeSystem(schemaContext, elementSchema)
+        val elementSchema = SchemaUtil.createSinglePartSchema(service.targetNamespace ?: "", message)
+        val sts = SchemaUtil.compileSchemas(schemaContext.sts, schemaContext.entityResolver, arrayOf(elementSchema))
 
+        val elementName = QName(service.targetNamespace, message.partName)
         val elem = sts.findDocumentType(elementName)
             ?: throw RuntimeException("Could not find a generated element with name \"$elementName\"")
 
         return SampleXmlUtil.createSampleForType(elem)
     }
 
-    private fun buildSchemaTypeSystem(
-        schemaContext: SchemaContext,
-        vararg extraSchemas: SchemaDocument,
-    ): SchemaTypeSystem {
-        var sts: SchemaTypeSystem? = null
-
-        val schemas = schemaContext.schemas + extraSchemas
-        if (schemas.isNotEmpty()) {
-            val errors = mutableListOf<XmlError>()
-
-            val compileOptions = XmlOptions()
-                .setLoadLineNumbers()
-                .setLoadMessageDigest()
-                .setEntityResolver(schemaContext.entityResolver)
-                .setErrorListener(errors)
-
-            try {
-                // TODO consider reusing the SchemaTypeSystem from SchemaContext
-                sts = XmlBeans.compileXsd(schemas, XmlBeans.getBuiltinTypeSystem(), compileOptions)
-            } catch (e: Exception) {
-                if (errors.isEmpty() || e !is XmlException) {
-                    throw RuntimeException("Error compiling XSD", e)
-                }
-                throw RuntimeException("Schema compilation errors: " + errors.joinToString("\n"))
-            }
-        }
-        sts ?: throw IllegalStateException("No schemas to process")
-        return sts
-    }
-
     private fun transmitExample(httpExchange: HttpExchange, example: String?, bodyHolder: MessageBodyHolder) {
         example ?: run {
             logger.warn("No example found - returning empty response")

mock/soap/src/main/java/io/gatehill/imposter/plugin/soap/util/SchemaGenerator.kt renamed to mock/soap/src/main/java/io/gatehill/imposter/plugin/soap/util/SchemaUtil.kt

@@ -49,14 +49,50 @@ import io.gatehill.imposter.plugin.soap.model.OperationMessage
 import io.gatehill.imposter.plugin.soap.model.TypeOperationMessage
 import org.apache.logging.log4j.LogManager
 import org.apache.logging.log4j.Logger
+import org.apache.xmlbeans.SchemaTypeSystem
+import org.apache.xmlbeans.XmlBeans
+import org.apache.xmlbeans.XmlError
+import org.apache.xmlbeans.XmlException
+import org.apache.xmlbeans.XmlOptions
 import org.apache.xmlbeans.impl.xb.xsdschema.SchemaDocument
+import org.xml.sax.EntityResolver
 import javax.xml.namespace.QName
 
 /**
- * Generates schemas for elements.
+ * Compiles schemas and generates synthetic schemas for entities.
  */
-object SchemaGenerator {
-    private val logger: Logger = LogManager.getLogger(SchemaGenerator::class.java)
+object SchemaUtil {
+    private val logger: Logger = LogManager.getLogger(SchemaUtil::class.java)
+
+    /**
+     * Compiles the schemas, resolving against the base [SchemaTypeSystem] and
+     * using the specified [EntityResolver], where necessary.
+     */
+    fun compileSchemas(
+        baseSts: SchemaTypeSystem,
+        entityResolver: EntityResolver,
+        schemas: Array<SchemaDocument>,
+    ): SchemaTypeSystem {
+        if (schemas.isEmpty()) {
+            throw IllegalStateException("No schemas to compile")
+        }
+
+        val errors = mutableListOf<XmlError>()
+        val compileOptions = XmlOptions()
+            .setLoadLineNumbers()
+            .setLoadMessageDigest()
+            .setEntityResolver(entityResolver)
+            .setErrorListener(errors)
+
+        try {
+            return XmlBeans.compileXsd(schemas, baseSts, compileOptions)
+        } catch (e: Exception) {
+            if (errors.isEmpty() || e !is XmlException) {
+                throw RuntimeException("Error compiling schemas", e)
+            }
+            throw RuntimeException("Schema compilation errors: " + errors.joinToString("\n"))
+        }
+    }
 
     fun createSinglePartSchema(
         targetNamespace: String,