Flaky ScalaXmlSuite

[rossabaker]

Seen on this build.

==> X org.http4s.fs2data.xml.scalaxml.ScalaXmlSuite.round trips utf-8 1.01s java.lang.IllegalArgumentException: 덓뉃ਥ닼몑蚊崈℮욒혰 must be an XML Name
    at scala.xml.ProcInstr.<init>(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:240791)
    at <jscode>.{anonymous}()(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:49776)
    at delay @ <jscode>.{anonymous}()(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:28883)
    at flatMap @ fs2.Compiler$Target$ConcurrentTarget.flatMap(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:227963)
    at flatMap @ fs2.Compiler$Target$ConcurrentTarget.flatMap(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:227963)
    at flatMap @ fs2.Compiler$Target$ConcurrentTarget.flatMap(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:227963)
    at flatMap @ fs2.Compiler$Target$ConcurrentTarget.flatMap(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:227963)
    at flatMap @ fs2.Compiler$Target$ConcurrentTarget.flatMap(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:227963)
    at flatMap @ fs2.Compiler$Target$ConcurrentTarget.flatMap(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:227963)
    at modify @ fs2.internal.Scope.close(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:14611)
    at flatMap @ fs2.Compiler$Target$ConcurrentTarget.flatMap(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:227963)
    at rethrow$extension @ <jscode>.{anonymous}()(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:226345)
    at as @ org.scalacheck.effect.PropF$.effectOfUnitToPropF(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:56545)
    at get @ fs2.internal.Scope.openScope(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:14149)
    at flatMap @ fs2.Compiler$Target$ConcurrentTarget.flatMap(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:227963)
    at flatMap @ <jscode>.{anonymous}()(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:75621)
    at update @ fs2.internal.Scope.releaseChildScope(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:14135)
    at flatMap @ fs2.Compiler$Target$ConcurrentTarget.flatMap(/home/runner/work/http4s-fs2-data/http4s-fs2-data/xml-scala/.js/target/scala-3.3.0/http4s-fs2-data-xml-scala-test-fastopt/main.js:227963)

[ybasket]

It may be a bug in fs2-data itself, investigating via gnieh/fs2-data#503

[shivamsingh8883]

I have worked on the flaky test issue in ScalaXmlSuite and found the root cause. The problem occurs in the genText function in generators.scala where special XML characters are not being properly handled.
Current behavior:
The test generates random text that may contain special characters like "&" and "<"
These characters are being removed entirely, which can lead to invalid XML and flaky test behavior

Fixes are -
Instead of removing special characters, we properly escape them using XML entities
"&" is replaced with "&"
"<" is replaced with "<"
This ensures valid XML while preserving the actual content

I've implemented this fix in the branch fix/issue-#88-scalaxml-suite-flaky-test. The changes:

1. Maintain the original Gen[Text] return type
2. Properly handle XML special characters
3. Follow XML 1.0 specification for character escaping

Would you like me to push these changes for review(If the changes seem correct to you)?

[ybasket]

@shivamsingh8883 If you think you have a good fix, I'd be happy to review a PR!