Initialize RelaxNG support. #841

angelozerr · 2020-08-10T14:23:20Z

Initialize RelaxNG support (XML and compact syntax) with:

XML validation with RelaxNG
XML completion based on RelaxNG
Find Type definition from XML to RelaxNG
RelaxNG snippet support for XML and RelaxNG *.rng files

BalduinLandolt

I'll have a closer look as soon as I find time. One thing that struck me right away: You used the same maven dependency as I did in my PR. However, since then I found a more recent one:

<dependency>
    <groupId>org.relaxng</groupId>
    <artifactId>jing</artifactId>
    <version>20181222</version>
</dependency>

I don't think there has been really any development on Jing between 2009 and 2018, but it might stil be better to use the more current one.

adunning · 2022-03-10T11:12:06Z

It would be an immense help to have this. Is there anything preventing it from being merged?

angelozerr · 2022-03-10T12:50:07Z

@adunning thanks for your feedback.

At first please wote at redhat-developer/vscode-xml#450

The main problem is that RelaxNG is not our priority and it requires a lot of work (to support validation with error range and completion,hover, definition based on relaxng). Our current goal is to support robust support for XML, XSD and DTD.But if we see that we have more and more people(liek you) who are interested we could work.

This PR is based on Jing, but I know @svanteschubert wanted to provide a relaxng support based on MSV. See redhat-developer/vscode-xml#451 (comment)

@svanteschubert what is the status of your work?

rgrunber · 2022-09-26T14:02:19Z

org.eclipse.lemminx/pom.xml

+            <groupId>org.relaxng</groupId>
+            <artifactId>jing</artifactId>
+            <version>20220510</version>


After talking to @datho7561 , I noticed that https://repo1.maven.org/maven2/org/relaxng/jing/20220510/jing-20220510.pom depends on :

xerces:xercesImpl:2.9.1 & xml-apis:xml-apis:1.0.b2

while lemminx itself depends on :

xerces:xercesImpl:2.12.2 & xml-apis:xml-apis:1.4.01

We can't have multiple versions in the uber jar so would be good to ensure the latest versions are also supported by jing, and maybe contribute back upstream.

...eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/xerces/RelaxNGErrorHandler.java

datho7561 · 2022-09-26T14:11:59Z

We will need to do a bit of work in order to get the binary to work

rgrunber · 2022-09-27T14:10:41Z

For org.relaxng:jing, I couldn't find any recent entry on ClearlyDefined. https://clearlydefined.io/definitions/maven/mavencentral/org.relaxng/jing/20181222 doesn't have the necessary score.

$ mvn clean verify -DskipTests -Pverify-iplog
...
...
$ cat target/dash/summary | grep -v approved
maven/mavencentral/isorelax/isorelax/20030108, , restricted, clearlydefined
maven/mavencentral/org.relaxng/jing/20220510, , restricted, clearlydefined

So these libraries would need to be approved via. https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab .
You can use Create a request to vet Third-party content in order to do it manually. There's also an automated process that requires you to create at GitLab api token.

datho7561 · 2022-10-03T14:59:16Z

See https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/3540, https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/3539

datho7561 · 2022-10-05T19:15:24Z

Here's what's needed to get the binary working:

diff --git a/org.eclipse.lemminx/src/main/resources/META-INF/native-image/resource-config.json b/org.eclipse.lemminx/src/main/resources/META-INF/native-image/resource-config.json
index 12a4fcdb..18d3640d 100644
--- a/org.eclipse.lemminx/src/main/resources/META-INF/native-image/resource-config.json
+++ b/org.eclipse.lemminx/src/main/resources/META-INF/native-image/resource-config.json
@@ -50,6 +50,12 @@
                {
                        "name": "org.apache.xerces.impl.msg.XMLMessages"
                },
+               {
+                       "name": "com.thaiopensource.datatype.xsd.resources.Messages"
+               },
+               {
+                       "name": "com.thaiopensource.relaxng.pattern.resources.Messages"
+               },
                {
                        "name": "org.eclipse.lemminx.extensions.xerces.xmlmodel.msg.XMLMessages"
                },

angelozerr · 2022-10-05T20:59:22Z

Here's what's needed to get the binary working:

Thanksso much for your feedback. I'm surprised that there is just this fix to do. I think completion doesn't work with binary because I'm using Java reflection (for the moment).

datho7561

I got an NPE. Not sure what caused it, but I'll try to figure out steps to reproduce it:

java.lang.NullPointerException
	at org.eclipse.lemminx.extensions.contentmodel.participants.diagnostics.LSPSAXParser.startDocument(LSPSAXParser.java:87)
	at org.eclipse.lemminx.extensions.relaxng.xml.validator.ExternalRelaxNGValidator.startDocument(ExternalRelaxNGValidator.java:68)
	at org.apache.xerces.impl.dtd.XMLDTDValidator.startDocument(Unknown Source)
	at org.eclipse.lemminx.extensions.xerces.ExternalXMLDTDValidator.startDocument(ExternalXMLDTDValidator.java:73)
	at org.eclipse.lemminx.extensions.xerces.xmlmodel.XMLModelHandler.startDocument(XMLModelHandler.java:170)
	at org.apache.xerces.impl.dtd.XMLDTDValidator.startDocument(Unknown Source)
	at org.apache.xerces.impl.XMLDocumentScannerImpl.startEntity(Unknown Source)
	at org.apache.xerces.impl.XMLVersionDetector.startDocumentParsing(Unknown Source)
	at org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source)
	at org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source)
	at org.apache.xerces.parsers.XMLParser.parse(Unknown Source)
	at org.apache.xerces.parsers.AbstractSAXParser.parse(Unknown Source)
	at org.eclipse.lemminx.extensions.contentmodel.participants.diagnostics.XMLValidator.parseXML(XMLValidator.java:318)
	at org.eclipse.lemminx.extensions.contentmodel.participants.diagnostics.XMLValidator.doDiagnostics(XMLValidator.java:132)
	at org.eclipse.lemminx.extensions.contentmodel.participants.diagnostics.ContentModelDiagnosticsParticipant.doDiagnostics(ContentModelDiagnosticsParticipant.java:58)
	at org.eclipse.lemminx.services.XMLDiagnostics.doExtensionsDiagnostics(XMLDiagnostics.java:67)
	at org.eclipse.lemminx.services.XMLDiagnostics.doDiagnostics(XMLDiagnostics.java:49)
	at org.eclipse.lemminx.services.XMLLanguageService.doDiagnostics(XMLLanguageService.java:173)
	at org.eclipse.lemminx.services.XMLLanguageService.publishDiagnostics(XMLLanguageService.java:187)
	at org.eclipse.lemminx.XMLTextDocumentService.validate(XMLTextDocumentService.java:662)
	at org.eclipse.lemminx.XMLTextDocumentService.lambda$validate$32(XMLTextDocumentService.java:637)
	at java.util.concurrent.CompletableFuture$AsyncRun.run(CompletableFuture.java:1804)
	at java.util.concurrent.CompletableFuture$AsyncRun.exec(CompletableFuture.java:1796)
	at java.util.concurrent.ForkJoinTask.doExec(ForkJoinTask.java:373)
	at java.util.concurrent.ForkJoinPool$WorkQueue.topLevelExec(ForkJoinPool.java:1182)
	at java.util.concurrent.ForkJoinPool.scan(ForkJoinPool.java:1655)
	at java.util.concurrent.ForkJoinPool.runWorker(ForkJoinPool.java:1622)
	at java.util.concurrent.ForkJoinWorkerThread.run(ForkJoinWorkerThread.java:165)
	at com.oracle.svm.core.thread.PlatformThreads.threadStartRoutine(PlatformThreads.java:704)
	at com.oracle.svm.core.posix.thread.PosixPlatformThreads.pthreadStartRoutine(PosixPlatformThreads.java:202)

org.eclipse.lemminx/src/main/resources/META-INF/native-image/resource-config.json

datho7561 · 2022-10-12T17:27:09Z

Given:

<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="asdf.rnc"?>
<addressBook>
  <card>
    <name>David</name>
    <email></email>
  </card>
</addressBook>

and an empty asdf.rnc, the "schema invalid" error is placed on the first line of the file (it's not adjusted properly), and 2 NPE appear in the console.

datho7561 · 2022-10-12T17:38:08Z

If you reference an empty .rng file, then the error message that appears is ::::-1:-1:-1:Premature end of file.xml(RelaxNGNotFound). It would be nice if we could remove the ::::-1:-1:-1: part

datho7561 · 2022-10-12T17:44:17Z

It would be nice to associate all .rng files with the relaxng.rng or relaxng.xsd schema. Do you want to do this in a future PR?

...eclipse/lemminx/extensions/contentmodel/participants/diagnostics/MultipleContentHandler.java

...minx/src/main/java/org/eclipse/lemminx/extensions/relaxng/jing/toremove/MyCombineSchema.java

...minx/src/main/java/org/eclipse/lemminx/extensions/relaxng/jing/toremove/MyPatternSchema.java

...main/java/org/eclipse/lemminx/extensions/relaxng/xml/validator/ExternalRelaxNGValidator.java

datho7561 · 2022-10-12T18:54:13Z

.../src/main/java/org/eclipse/lemminx/extensions/relaxng/xml/validator/RelaxNGErrorHandler.java

+ * @author Angelo ZERR
+ *
+ */
+public class RelaxNGErrorHandler implements XMLErrorHandler {


Is the SAX interface not enough to get good diagnostics?

No it is not enough because we need the error code key.

datho7561 · 2022-10-12T19:31:05Z

...se.lemminx/src/main/java/org/eclipse/lemminx/extensions/xerces/xmlmodel/XMLModelHandler.java

+
+	static {
+		MODEL_VALIDATOR_FACTORIES = new ArrayList<>();
+		Iterator<XMLModelValidatorFactory> factories = ServiceLoader.load(XMLModelValidatorFactory.class).iterator();


In some places, the different validators are loaded dynamically, but in others, like LSPErrorReporterForXML, they are hard coded. I think we should eventually get a clean separation between the different validators. This would let us do things like add a new validator that uses the lemminx grammar cache using the extension point mechanism, or compile a version of LemMinX with only specific validators in order to reduce the size.

However, I think maybe it makes more sense to do this in a future PR?

However, I think maybe it makes more sense to do this in a future PR?

I agree it is not perfect but XSD and DTD validator does that too. Please do that in an another PR.

angelozerr · 2022-10-12T22:04:07Z

and an empty asdf.rnc, the "schema invalid" error is placed on the first line of the file (it's not adjusted properly), and 2 NPE appear in the console.

If you reference an empty .rng file, then the error message that appears is ::::-1:-1:-1:Premature end of file.xml(RelaxNGNotFound). It would be nice if we could remove the ::::-1:-1:-1: part

It should be fixed now and you should see the error as referenced diagnostic because the error comes from the schema and not from the XML:

angelozerr · 2022-10-12T22:11:08Z

It would be nice to associate all .rng files with the relaxng.rng or relaxng.xsd schema. Do you want to do this in a future PR?

done, now you should have validation and completion for relaxng grammar:

fbricon · 2022-10-13T07:09:03Z

Don't say "This class is a copy paste of", say "This class is a copy of "

angelozerr · 2022-10-13T12:07:38Z

Don't say "This class is a copy paste of", say "This class is a copy of "

fixed

angelozerr · 2022-10-13T12:12:40Z

I add 2 snippets support for RelaxNG:

one to create an XML file bound with RelaxNG
one to create a RelaxNG *.rng grammar file

Here a demo which show how it is easy to create an XML bound with a RelaxNG grammar created by snippets:

datho7561 · 2022-10-13T13:34:27Z

If you reference an empty .rng file, the SAXParseException appears in the logs.

* XML validation with RelaxNG * XML completion based on RelaxNG * Find Type definition from XML to RelaxNG * RelaxNG snippet support for XML and RelaxNG *.rng files Signed-off-by: azerr <azerr@redhat.com>

angelozerr · 2022-10-13T16:05:35Z

If you reference an empty .rng file, the SAXParseException appears in the logs.

It should be fixed.

datho7561

Works very well. Thank you, Angelo!

This was referenced Aug 10, 2020

RelaxNG Validation with Jing #829

Closed

Initialize RelaxNG support with validation/completion/hover #828

Closed

BalduinLandolt suggested changes Aug 10, 2020

View reviewed changes

angelozerr force-pushed the relaxng branch 2 times, most recently from b6dfb97 to 5701262 Compare August 17, 2020 09:08

fbricon mentioned this pull request Apr 8, 2021

Support RELAX NG validation redhat-developer/vscode-xml#450

Closed

angelozerr mentioned this pull request May 6, 2021

Support Schematron validation redhat-developer/vscode-xml#451

Open

angelozerr force-pushed the relaxng branch 4 times, most recently from cac6f36 to 6d009b1 Compare September 26, 2022 13:36

rgrunber reviewed Sep 26, 2022

View reviewed changes

datho7561 reviewed Sep 26, 2022

View reviewed changes

...eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/xerces/RelaxNGErrorHandler.java Outdated Show resolved Hide resolved

angelozerr force-pushed the relaxng branch 6 times, most recently from e689512 to 27b771c Compare September 29, 2022 19:27

angelozerr force-pushed the relaxng branch 3 times, most recently from 6c81de3 to 9c5ba42 Compare October 5, 2022 10:20

angelozerr force-pushed the relaxng branch from 9c5ba42 to c94c2b9 Compare October 5, 2022 20:57

angelozerr force-pushed the relaxng branch 2 times, most recently from a9c8e67 to 01d1ef5 Compare October 12, 2022 15:33

datho7561 requested changes Oct 12, 2022

View reviewed changes

org.eclipse.lemminx/src/main/resources/META-INF/native-image/resource-config.json Outdated Show resolved Hide resolved

angelozerr force-pushed the relaxng branch from 01d1ef5 to 5cb065a Compare October 12, 2022 19:29

datho7561 requested changes Oct 12, 2022

View reviewed changes

angelozerr force-pushed the relaxng branch from 5cb065a to 2f0f184 Compare October 12, 2022 22:01

angelozerr force-pushed the relaxng branch 2 times, most recently from cc4ee18 to 3ebe288 Compare October 12, 2022 22:29

angelozerr force-pushed the relaxng branch 2 times, most recently from fcc2f3c to a6ac347 Compare October 13, 2022 12:07

datho7561 self-requested a review October 13, 2022 12:19

angelozerr force-pushed the relaxng branch from a6ac347 to ae71883 Compare October 13, 2022 12:31

angelozerr force-pushed the relaxng branch from ae71883 to 972f99e Compare October 13, 2022 16:03

Initialize RelaxNG support (XML and compact syntax) with:

972f99e

* XML validation with RelaxNG * XML completion based on RelaxNG * Find Type definition from XML to RelaxNG * RelaxNG snippet support for XML and RelaxNG *.rng files Signed-off-by: azerr <azerr@redhat.com>

datho7561 approved these changes Oct 13, 2022

View reviewed changes

datho7561 added this to the 0.22.0 milestone Oct 13, 2022

datho7561 linked an issue Oct 13, 2022 that may be closed by this pull request

Initialize RelaxNG support with validation/completion/hover #828

Closed

6 tasks

datho7561 removed this from the 0.22.0 milestone Oct 13, 2022

datho7561 merged commit 61599b5 into eclipse:main Oct 13, 2022

angelozerr mentioned this pull request Oct 19, 2022

Support for Relax NG #237

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initialize RelaxNG support. #841

Initialize RelaxNG support. #841

angelozerr commented Aug 10, 2020 •

edited

Loading

BalduinLandolt left a comment

adunning commented Mar 10, 2022

angelozerr commented Mar 10, 2022

rgrunber Sep 26, 2022

datho7561 commented Sep 26, 2022

rgrunber commented Sep 27, 2022

datho7561 commented Oct 3, 2022

datho7561 commented Oct 5, 2022

angelozerr commented Oct 5, 2022

datho7561 left a comment

datho7561 commented Oct 12, 2022

datho7561 commented Oct 12, 2022 •

edited

Loading

datho7561 commented Oct 12, 2022

datho7561 Oct 12, 2022

angelozerr Oct 12, 2022

datho7561 Oct 12, 2022

angelozerr Oct 12, 2022

angelozerr commented Oct 12, 2022 •

edited

Loading

angelozerr commented Oct 12, 2022

fbricon commented Oct 13, 2022

angelozerr commented Oct 13, 2022

angelozerr commented Oct 13, 2022

datho7561 commented Oct 13, 2022

angelozerr commented Oct 13, 2022

datho7561 left a comment

Initialize RelaxNG support. #841

Initialize RelaxNG support. #841

Conversation

angelozerr commented Aug 10, 2020 • edited Loading

BalduinLandolt left a comment

Choose a reason for hiding this comment

adunning commented Mar 10, 2022

angelozerr commented Mar 10, 2022

rgrunber Sep 26, 2022

Choose a reason for hiding this comment

datho7561 commented Sep 26, 2022

rgrunber commented Sep 27, 2022

datho7561 commented Oct 3, 2022

datho7561 commented Oct 5, 2022

angelozerr commented Oct 5, 2022

datho7561 left a comment

Choose a reason for hiding this comment

datho7561 commented Oct 12, 2022

datho7561 commented Oct 12, 2022 • edited Loading

datho7561 commented Oct 12, 2022

datho7561 Oct 12, 2022

Choose a reason for hiding this comment

angelozerr Oct 12, 2022

Choose a reason for hiding this comment

datho7561 Oct 12, 2022

Choose a reason for hiding this comment

angelozerr Oct 12, 2022

Choose a reason for hiding this comment

angelozerr commented Oct 12, 2022 • edited Loading

angelozerr commented Oct 12, 2022

fbricon commented Oct 13, 2022

angelozerr commented Oct 13, 2022

angelozerr commented Oct 13, 2022

datho7561 commented Oct 13, 2022

angelozerr commented Oct 13, 2022

datho7561 left a comment

Choose a reason for hiding this comment

angelozerr commented Aug 10, 2020 •

edited

Loading

datho7561 commented Oct 12, 2022 •

edited

Loading

angelozerr commented Oct 12, 2022 •

edited

Loading