Add TraceParent extension (#146)

* Add TraceParent extension and test
* Add test for traceparent as extension of IQ, and fix name in parsing tests

Author: JulianGCalderon

src/main/java/org/jitsi/xmpp/extensions/colibri2/IqProviderUtils.java

@@ -183,5 +183,9 @@ private static void doRegisterProviders()
         ProviderManager.addExtensionProvider(Colibri2Error.ELEMENT,
                 Colibri2Error.NAMESPACE,
                 new Colibri2Error.Provider());
+
+        ProviderManager.addExtensionProvider(TraceParent.ELEMENT,
+                 TraceParent.NAMESPACE,
+                 new TraceParentProvider());
     }
 }

src/main/kotlin/org/jitsi/xmpp/extensions/TraceParent.kt

@@ -0,0 +1,59 @@
+/*
+ * Copyright @ 2023 - present 8x8, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.jitsi.xmpp.extensions
+
+import org.jivesoftware.smack.packet.XmlEnvironment
+import org.jivesoftware.smack.parsing.SmackParsingException
+import org.jivesoftware.smack.provider.ExtensionElementProvider
+import org.jivesoftware.smack.xml.XmlPullParser
+import org.jivesoftware.smack.xml.XmlPullParserException
+import java.io.IOException
+
+class TraceParent(val traceId: String, val parentId: String, val traceFlags: String) :
+    AbstractPacketExtension(NAMESPACE, ELEMENT) {
+    init {
+        setAttribute(TRACE_ID_ATTR_NAME, traceId)
+        setAttribute(PARENT_ID_ATTR_NAME, parentId)
+        setAttribute(TRACE_FLAGS_ATTR_NAME, traceFlags)
+    }
+
+    companion object {
+        const val ELEMENT = "traceparent"
+        const val NAMESPACE = "jitsi:opentelemetry"
+        const val TRACE_ID_ATTR_NAME = "trace_id"
+        const val PARENT_ID_ATTR_NAME = "parent_id"
+        const val TRACE_FLAGS_ATTR_NAME = "trace_flags"
+    }
+}
+
+class TraceParentProvider : ExtensionElementProvider<TraceParent>() {
+    @Throws(XmlPullParserException::class, IOException::class, SmackParsingException::class)
+    override fun parse(parser: XmlPullParser, depth: Int, xml: XmlEnvironment?): TraceParent {
+        val traceId = parser.getAttributeValue("", TraceParent.TRACE_ID_ATTR_NAME)
+            ?: throw SmackParsingException.RequiredAttributeMissingException(
+                "Missing '${TraceParent.TRACE_ID_ATTR_NAME}' attribute"
+            )
+        val parentId = parser.getAttributeValue("", TraceParent.PARENT_ID_ATTR_NAME)
+            ?: throw SmackParsingException.RequiredAttributeMissingException(
+                "Missing '${TraceParent.PARENT_ID_ATTR_NAME}' attribute"
+            )
+        val traceFlags = parser.getAttributeValue("", TraceParent.TRACE_FLAGS_ATTR_NAME)
+            ?: throw SmackParsingException.RequiredAttributeMissingException(
+                "Missing '${TraceParent.TRACE_FLAGS_ATTR_NAME}' attribute"
+            )
+        return TraceParent(traceId, parentId, traceFlags)
+    }
+}

src/test/kotlin/org/jitsi/xmpp/extensions/TraceParentTest.kt

@@ -0,0 +1,74 @@
+/*
+ * Copyright @ 2024 - present 8x8, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.jitsi.xmpp.extensions
+
+import io.kotest.assertions.throwables.shouldThrow
+import io.kotest.core.spec.style.ShouldSpec
+import io.kotest.matchers.shouldBe
+import org.jitsi.xmpp.extensions.colibri2.IqProviderUtils
+import org.jivesoftware.smack.parsing.SmackParsingException
+import org.jivesoftware.smack.util.PacketParserUtils
+
+class TraceParentTest : ShouldSpec() {
+    init {
+        IqProviderUtils.registerProviders()
+        val provider = TraceParentProvider()
+
+        context("Parsing a valid extension") {
+            val traceParent = provider.parse(
+                PacketParserUtils.getParserFor(
+                    "<traceparent trace_id='1586bb16ccd4475a9f494bf43563ce28' " +
+                        "parent_id='6e39899d78bfa0ae' trace_flags='35'/>"
+                )
+            )
+
+            traceParent.traceId shouldBe "1586bb16ccd4475a9f494bf43563ce28"
+            traceParent.parentId shouldBe "6e39899d78bfa0ae"
+            traceParent.traceFlags shouldBe "35"
+        }
+
+        context("Parsing with missing traceId") {
+            shouldThrow<SmackParsingException> {
+                provider.parse(
+                    PacketParserUtils.getParserFor(
+                        "<traceparent parent_id='6e39899d78bfa0ae' trace_flags='35'/>"
+                    )
+                )
+            }
+        }
+
+        context("Parsing with missing parentId") {
+            shouldThrow<SmackParsingException> {
+                provider.parse(
+                    PacketParserUtils.getParserFor(
+                        "<traceparent trace_id='1586bb16ccd4475a9f494bf43563ce28' trace_flags='35'/>"
+                    )
+                )
+            }
+        }
+
+        context("Parsing with missing traceFlags") {
+            shouldThrow<SmackParsingException> {
+                provider.parse(
+                    PacketParserUtils.getParserFor(
+                        "<traceparent trace_id='1586bb16ccd4475a9f494bf43563ce28' " +
+                            "parent_id='6e39899d78bfa0ae'/>"
+                    )
+                )
+            }
+        }
+    }
+}

src/test/kotlin/org/jitsi/xmpp/extensions/colibri2/ConferenceModifyIQTest.kt

@@ -18,12 +18,16 @@ package org.jitsi.xmpp.extensions.colibri2
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.ShouldSpec
 import io.kotest.matchers.shouldBe
+import io.kotest.matchers.shouldNotBe
 import org.jitsi.xmpp.extensions.IQUtils
+import org.jitsi.xmpp.extensions.TraceParent
 import org.jivesoftware.smack.parsing.SmackParsingException
 
 class ConferenceModifyIQTest : ShouldSpec() {
     val provider = ConferenceModifyIQProvider()
     init {
+        IqProviderUtils.registerProviders()
+
         context("Parse a simple IQ correctly") {
             val conferenceModifyIQ = IQUtils.parse(
                 """
@@ -59,5 +63,19 @@ class ConferenceModifyIQTest : ShouldSpec() {
                 )
             }
         }
+        context("Parse IQ with TraceParent extension") {
+            val conferenceModifyIQ = IQUtils.parse(
+                """
+                    <iq type='get' from='example.com' to='example.com'>
+                        <conference-modify xmlns='http://jitsi.org/protocol/colibri2' meeting-id='abc'>
+                            <traceparent xmlns='jitsi:opentelemetry' trace_id='1586bb16ccd4475a9f494bf43563ce28'
+                            parent_id='6e39899d78bfa0ae' trace_flags='35'/>
+                        </conference-modify>
+                    </iq>
+                """.trimIndent(),
+                provider
+            )
+            conferenceModifyIQ.getExtension(TraceParent::class.java) shouldNotBe null
+        }
     }
 }