omitting namespaces in SOAP responses

[jweick]

Hi,

i'm looking for a way to tell the xml-parser that i'm not caring for namespaces.

My SOAP-responses have a dynamic namespace like

<u:GetBeaconTypeResponse xmlns:u="urn:dslforum-org:service:WLANConfiguration:1">

the :1 is the dynamic part here.

As i don't care for the namespace anyway i was looking for a way to express this to the parser by omitting the namespace-property in the annotation:

@Serializable @XmlSerialName("GetBeaconTypeResponse") class GetBeaconTypeResponse { ... }

But this results in a compiler-error:

org.jetbrains.kotlin.backend.common.BackendException: Backend Internal error: Exception during IR lowering
The root cause java.lang.RuntimeException was thrown at: org.jetbrains.kotlin.backend.jvm.codegen.FunctionCodegen.generate(FunctionCodegen.kt:50)
at org.jetbrains.kotlin.backend.common.CodegenUtil.reportBackendException(CodegenUtil.kt:239)
at org.jetbrains.kotlin.backend.common.CodegenUtil.reportBackendException$default(CodegenUtil.kt:235)
at org.jetbrains.kotlin.backend.common.phaser.PerformByIrFilePhase.invokeSequential(performByIrFile.kt:68)
at org.jetbrains.kotlin.backend.common.phaser.PerformByIrFilePhase.invoke(performByIrFile.kt:55)
at org.jetbrains.kotlin.backend.common.phaser.PerformByIrFilePhase.invoke(performByIrFile.kt:41)
at org.jetbrains.kotlin.backend.common.phaser.NamedCompilerPhase.invoke(CompilerPhase.kt:96)
at org.jetbrains.kotlin.backend.common.phaser.CompositePhase.invoke(PhaseBuilders.kt:29)
at org.jetbrains.kotlin.backend.common.phaser.NamedCompilerPhase.invoke(CompilerPhase.kt:96)
at org.jetbrains.kotlin.backend.common.phaser.CompilerPhaseKt.invokeToplevel(CompilerPhase.kt:43)
at org.jetbrains.kotlin.backend.jvm.JvmIrCodegenFactory.invokeCodegen(JvmIrCodegenFactory.kt:284)
at org.jetbrains.kotlin.cli.jvm.compiler.KotlinToJVMBytecodeCompiler.runCodegen(KotlinToJVMBytecodeCompiler.kt:355)
at org.jetbrains.kotlin.cli.jvm.compiler.KotlinToJVMBytecodeCompiler.compileModules$cli(KotlinToJVMBytecodeCompiler.kt:136)
at org.jetbrains.kotlin.cli.jvm.compiler.KotlinToJVMBytecodeCompiler.compileModules$cli$default(KotlinToJVMBytecodeCompiler.kt:60)
at org.jetbrains.kotlin.cli.jvm.K2JVMCompiler.doExecute(K2JVMCompiler.kt:157)
at org.jetbrains.kotlin.cli.jvm.K2JVMCompiler.doExecute(K2JVMCompiler.kt:52)
at org.jetbrains.kotlin.cli.common.CLICompiler.execImpl(CLICompiler.kt:94)
at org.jetbrains.kotlin.cli.common.CLICompiler.execImpl(CLICompiler.kt:43)
at org.jetbrains.kotlin.cli.common.CLITool.exec(CLITool.kt:101)
at org.jetbrains.kotlin.incremental.IncrementalJvmCompilerRunner.runCompiler(IncrementalJvmCompilerRunner.kt:477)
at org.jetbrains.kotlin.incremental.IncrementalJvmCompilerRunner.runCompiler(IncrementalJvmCompilerRunner.kt:127)
at org.jetbrains.kotlin.incremental.IncrementalCompilerRunner.compileIncrementally(IncrementalCompilerRunner.kt:366)
at org.jetbrains.kotlin.incremental.IncrementalCompilerRunner.compileIncrementally$default(IncrementalCompilerRunner.kt:311)
at org.jetbrains.kotlin.incremental.IncrementalCompilerRunner.compileImpl(IncrementalCompilerRunner.kt:175)
at org.jetbrains.kotlin.incremental.IncrementalCompilerRunner.compile(IncrementalCompilerRunner.kt:75)
at org.jetbrains.kotlin.daemon.CompileServiceImplBase.execIncrementalCompiler(CompileServiceImpl.kt:625)
at org.jetbrains.kotlin.daemon.CompileServiceImplBase.access$execIncrementalCompiler(CompileServiceImpl.kt:101)
at org.jetbrains.kotlin.daemon.CompileServiceImpl.compile(CompileServiceImpl.kt:1739)
at jdk.internal.reflect.GeneratedMethodAccessor102.invoke(Unknown Source)
at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.base/java.lang.reflect.Method.invoke(Method.java:566)
at java.rmi/sun.rmi.server.UnicastServerRef.dispatch(UnicastServerRef.java:359)
at java.rmi/sun.rmi.transport.Transport$1.run(Transport.java:200)
at java.rmi/sun.rmi.transport.Transport$1.run(Transport.java:197)
at java.base/java.security.AccessController.doPrivileged(Native Method)
at java.rmi/sun.rmi.transport.Transport.serviceCall(Transport.java:196)
at java.rmi/sun.rmi.transport.tcp.TCPTransport.handleMessages(TCPTransport.java:562)
at java.rmi/sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.run0(TCPTransport.java:796)
at java.rmi/sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.lambda$run$0(TCPTransport.java:677)
at java.base/java.security.AccessController.doPrivileged(Native Method)
at java.rmi/sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.run(TCPTransport.java:676)
at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
at java.base/java.lang.Thread.run(Thread.java:834)
Caused by: java.lang.RuntimeException: Exception while generating code for:
FUN CLASS_STATIC_INITIALIZER name: visibility:public/package/ modality:FINAL <> () returnType:kotlin.Unit
BLOCK_BODY
SET_FIELD 'FIELD FIELD_FOR_OBJECT_INSTANCE name:INSTANCE type:com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer visibility:public [final,static]' type=kotlin.Unit origin=INITIALIZE_FIELD
value: CONSTRUCTOR_CALL 'private constructor () [primary] declared in com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer' type=com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer origin=null
BLOCK type=kotlin.Unit origin=SYNTHESIZED_INIT_BLOCK
VAR IR_TEMPORARY_VARIABLE name:tmp0_serialDesc type:kotlinx.serialization.internal.PluginGeneratedSerialDescriptor [val]
CONSTRUCTOR_CALL 'public constructor (serialName: kotlin.String, generatedSerializer: kotlinx.serialization.internal.GeneratedSerializer<*>?, elementsCount: kotlin.Int) [primary] declared in kotlinx.serialization.internal.PluginGeneratedSerialDescriptor' type=kotlinx.serialization.internal.PluginGeneratedSerialDescriptor origin=null
serialName: CONST String type=kotlin.String value="com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse"
generatedSerializer: GET_FIELD 'FIELD FIELD_FOR_OBJECT_INSTANCE name:INSTANCE type:com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer visibility:public [final,static]' type=com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer origin=null
elementsCount: CONST Int type=kotlin.Int value=2
CALL 'public final fun addElement (name: kotlin.String, isOptional: kotlin.Boolean): kotlin.Unit declared in kotlinx.serialization.internal.PluginGeneratedSerialDescriptor' type=kotlin.Unit origin=null
$this: GET_VAR 'val tmp0_serialDesc: kotlinx.serialization.internal.PluginGeneratedSerialDescriptor [val] declared in com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer.' type=kotlinx.serialization.internal.PluginGeneratedSerialDescriptor origin=null
name: CONST String type=kotlin.String value="possibleBeaconTypes"
isOptional: CONST Boolean type=kotlin.Boolean value=true
CALL 'public final fun pushAnnotation (annotation: kotlin.Annotation): kotlin.Unit declared in kotlinx.serialization.internal.PluginGeneratedSerialDescriptor' type=kotlin.Unit origin=null
$this: GET_VAR 'val tmp0_serialDesc: kotlinx.serialization.internal.PluginGeneratedSerialDescriptor [val] declared in com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer.' type=kotlinx.serialization.internal.PluginGeneratedSerialDescriptor origin=null
annotation: CONSTRUCTOR_CALL 'public constructor (namespace: kotlin.String, prefix: kotlin.String, value: kotlin.String) declared in nl.adaptivity.xmlutil.serialization.XmlSerialName.Impl' type=nl.adaptivity.xmlutil.serialization.XmlSerialName.Impl origin=null
namespace: CONST String type=kotlin.String value="NewX_AVM-DE_PossibleBeaconTypes"
prefix: CONST String type=kotlin.String value=""
value: CONST String type=kotlin.String value=""
CALL 'public final fun pushAnnotation (annotation: kotlin.Annotation): kotlin.Unit declared in kotlinx.serialization.internal.PluginGeneratedSerialDescriptor' type=kotlin.Unit origin=null
$this: GET_VAR 'val tmp0_serialDesc: kotlinx.serialization.internal.PluginGeneratedSerialDescriptor [val] declared in com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer.' type=kotlinx.serialization.internal.PluginGeneratedSerialDescriptor origin=null
annotation: CONSTRUCTOR_CALL 'public constructor (value: kotlin.Boolean) declared in nl.adaptivity.xmlutil.serialization.XmlElement.Impl' type=nl.adaptivity.xmlutil.serialization.XmlElement.Impl origin=null
value: CONST Boolean type=kotlin.Boolean value=true
CALL 'public final fun addElement (name: kotlin.String, isOptional: kotlin.Boolean): kotlin.Unit declared in kotlinx.serialization.internal.PluginGeneratedSerialDescriptor' type=kotlin.Unit origin=null
$this: GET_VAR 'val tmp0_serialDesc: kotlinx.serialization.internal.PluginGeneratedSerialDescriptor [val] declared in com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer.' type=kotlinx.serialization.internal.PluginGeneratedSerialDescriptor origin=null
name: CONST String type=kotlin.String value="beaconType"
isOptional: CONST Boolean type=kotlin.Boolean value=true
CALL 'public final fun pushAnnotation (annotation: kotlin.Annotation): kotlin.Unit declared in kotlinx.serialization.internal.PluginGeneratedSerialDescriptor' type=kotlin.Unit origin=null
$this: GET_VAR 'val tmp0_serialDesc: kotlinx.serialization.internal.PluginGeneratedSerialDescriptor [val] declared in com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer.' type=kotlinx.serialization.internal.PluginGeneratedSerialDescriptor origin=null
annotation: CONSTRUCTOR_CALL 'public constructor (namespace: kotlin.String, prefix: kotlin.String, value: kotlin.String) declared in nl.adaptivity.xmlutil.serialization.XmlSerialName.Impl' type=nl.adaptivity.xmlutil.serialization.XmlSerialName.Impl origin=null
namespace: CONST String type=kotlin.String value="NewBeaconType"
prefix: CONST String type=kotlin.String value=""
value: CONST String type=kotlin.String value=""
CALL 'public final fun pushAnnotation (annotation: kotlin.Annotation): kotlin.Unit declared in kotlinx.serialization.internal.PluginGeneratedSerialDescriptor' type=kotlin.Unit origin=null
$this: GET_VAR 'val tmp0_serialDesc: kotlinx.serialization.internal.PluginGeneratedSerialDescriptor [val] declared in com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer.' type=kotlinx.serialization.internal.PluginGeneratedSerialDescriptor origin=null
annotation: CONSTRUCTOR_CALL 'public constructor (value: kotlin.Boolean) declared in nl.adaptivity.xmlutil.serialization.XmlElement.Impl' type=nl.adaptivity.xmlutil.serialization.XmlElement.Impl origin=null
value: CONST Boolean type=kotlin.Boolean value=true
CALL 'public final fun pushClassAnnotation (a: kotlin.Annotation): kotlin.Unit declared in kotlinx.serialization.internal.PluginGeneratedSerialDescriptor' type=kotlin.Unit origin=null
$this: GET_VAR 'val tmp0_serialDesc: kotlinx.serialization.internal.PluginGeneratedSerialDescriptor [val] declared in com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer.' type=kotlinx.serialization.internal.PluginGeneratedSerialDescriptor origin=null
a: CONSTRUCTOR_CALL 'public constructor (namespace: kotlin.String, prefix: kotlin.String, value: kotlin.String) declared in nl.adaptivity.xmlutil.serialization.XmlSerialName.Impl' type=nl.adaptivity.xmlutil.serialization.XmlSerialName.Impl origin=null
namespace: CONST String type=kotlin.String value="GetBeaconTypeResponse"
prefix: ERROR_EXPR 'Stub expression for default value of namespace' type=kotlin.String
value: ERROR_EXPR 'Stub expression for default value of prefix' type=kotlin.String
SET_FIELD 'FIELD SERIALIZER name:descriptor type:kotlinx.serialization.descriptors.SerialDescriptor visibility:public [final,static]' type=kotlin.Unit origin=null
value: GET_VAR 'val tmp0_serialDesc: kotlinx.serialization.internal.PluginGeneratedSerialDescriptor [val] declared in com.oneandone.avmtr64.api.wan.wlanconfiguration.getBeaconType.GetBeaconTypeResponse.$serializer.' type=kotlinx.serialization.internal.PluginGeneratedSerialDescriptor origin=null

at org.jetbrains.kotlin.backend.jvm.codegen.FunctionCodegen.generate(FunctionCodegen.kt:50)
at org.jetbrains.kotlin.backend.jvm.codegen.FunctionCodegen.generate$default(FunctionCodegen.kt:43)
at org.jetbrains.kotlin.backend.jvm.codegen.ClassCodegen.generateMethodNode(ClassCodegen.kt:380)
at org.jetbrains.kotlin.backend.jvm.codegen.ClassCodegen.generateMethod(ClassCodegen.kt:397)
at org.jetbrains.kotlin.backend.jvm.codegen.ClassCodegen.generate(ClassCodegen.kt:152)
at org.jetbrains.kotlin.backend.jvm.codegen.ClassCodegen.generate(ClassCodegen.kt:161)
at org.jetbrains.kotlin.backend.jvm.FileCodegen.lower(JvmPhases.kt:44)
at org.jetbrains.kotlin.backend.common.phaser.FileLoweringPhaseAdapter.invoke(PhaseBuilders.kt:120)
at org.jetbrains.kotlin.backend.common.phaser.FileLoweringPhaseAdapter.invoke(PhaseBuilders.kt:116)
at org.jetbrains.kotlin.backend.common.phaser.NamedCompilerPhase.invoke(CompilerPhase.kt:96)
at org.jetbrains.kotlin.backend.common.phaser.PerformByIrFilePhase.invokeSequential(performByIrFile.kt:65)
... 40 more

Caused by: java.lang.AssertionError: Unexpected IR element found during code generation. Either code generation for it is not implemented, or it should have been lowered:
ERROR_EXPR 'Stub expression for default value of namespace' type=kotlin.String
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitElement(ExpressionCodegen.kt:864)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitElement(ExpressionCodegen.kt:130)
at org.jetbrains.kotlin.ir.visitors.IrElementVisitor$DefaultImpls.visitExpression(IrElementVisitor.kt:54)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitExpression(ExpressionCodegen.kt:130)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitExpression(ExpressionCodegen.kt:130)
at org.jetbrains.kotlin.ir.visitors.IrElementVisitor$DefaultImpls.visitErrorExpression(IrElementVisitor.kt:124)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitErrorExpression(ExpressionCodegen.kt:130)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitErrorExpression(ExpressionCodegen.kt:130)
at org.jetbrains.kotlin.ir.expressions.IrErrorExpression.accept(IrErrorExpression.kt:14)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.gen(ExpressionCodegen.kt:211)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.generateConstructorArguments(ExpressionCodegen.kt:642)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitConstructorCall(ExpressionCodegen.kt:630)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitConstructorCall(ExpressionCodegen.kt:130)
at org.jetbrains.kotlin.ir.expressions.IrConstructorCall.accept(IrConstructorCall.kt:20)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.gen(ExpressionCodegen.kt:211)
at org.jetbrains.kotlin.backend.jvm.codegen.IrCallGenerator$DefaultImpls.genValueAndPut(IrCallGenerator.kt:50)
at org.jetbrains.kotlin.backend.jvm.codegen.IrCallGenerator$DefaultCallGenerator.genValueAndPut(IrCallGenerator.kt:53)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitCall$handleValueParameter(ExpressionCodegen.kt:500)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitCall(ExpressionCodegen.kt:514)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitCall(ExpressionCodegen.kt:130)
at org.jetbrains.kotlin.ir.expressions.IrCall.accept(IrCall.kt:17)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitStatementContainer(ExpressionCodegen.kt:457)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitContainerExpression(ExpressionCodegen.kt:470)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitContainerExpression(ExpressionCodegen.kt:130)
at org.jetbrains.kotlin.ir.visitors.IrElementVisitor$DefaultImpls.visitBlock(IrElementVisitor.kt:64)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitBlock(ExpressionCodegen.kt:399)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitBlock(ExpressionCodegen.kt:130)
at org.jetbrains.kotlin.ir.expressions.IrBlock.accept(IrBlock.kt:15)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitStatementContainer(ExpressionCodegen.kt:457)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitBlockBody(ExpressionCodegen.kt:461)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.visitBlockBody(ExpressionCodegen.kt:130)
at org.jetbrains.kotlin.ir.expressions.IrBlockBody.accept(IrBlockBody.kt:17)
at org.jetbrains.kotlin.backend.jvm.codegen.ExpressionCodegen.generate(ExpressionCodegen.kt:234)
at org.jetbrains.kotlin.backend.jvm.codegen.FunctionCodegen.doGenerate(FunctionCodegen.kt:122)
at org.jetbrains.kotlin.backend.jvm.codegen.FunctionCodegen.generate(FunctionCodegen.kt:48)
... 50 more

So my 1st question is, if this is the intended way to "opt out of caring for namespaces"

And if so, i appreciate any help in understanding what causes the compiler-error.

im using:
org.jetbrains.kotlin.plugin.serialization version 1.7.10

implementation("io.github.pdvrieze.xmlutil:core:0.84.3")
implementation("io.github.pdvrieze.xmlutil:serialization:0.84.3")

implementation("com.jakewharton.retrofit:retrofit2-kotlinx-serialization-converter:0.8.0")

Best regards,
Jerg

[jweick]

After digging a bit deeper, i found this issue you opened at JB a year ago:
https://youtrack.jetbrains.com/issue/KT-48888/Using-the-serialization-plugin-there-is-an-issue-with-code-generation-in-incremental-mode-in-combination-with-default-annotation

looks like its still not resolved.

What was your workaround? Not using default-parameters in the annotations?

Best regards,
Jerg

[pdvrieze]

The way to solve this is to use a filter (dynamic namespaces are invalid in XML - different from updating the namespace on an update) to filter the XML before feeding it to serialization. To do this you need to implement XmlReader (probably actually a subclass of XmlDelegatingReader) and make it return the "right" values. Then you can use XmlStreaming, PlatformXmlReader or KtXmlReader to create a reader from whatever source is appropriate, and pass it to the filter. The filter can then be passed to the format to parse (rather than a raw string).

[jweick]

Thank you for the quick response!

best,
Jerg