Unable to Make My Custom EXPath Module Work

On Sat, Jan 22, 2022 at 9:08 PM Eliot Kimber <eliot.kimber at servicenow.com> wrote: > > I’m packaging some XQuery modules into an EXPath XAR archive and then installing them using the repo install command. > > > > The command succeeds and my repo is listed by repo list but I’m unable to get the modules to import and I can’t see where I’ve gone wrong. I must have made some non-obvious (to me) error but so far I have not found it. > > > > I’ve checked that my expath-pkg.xml against the working examples I have (functx and Schematron BaseX) and I don’t see any difference. I’ve also carefully checked all my namespace URIs to make sure they match. > > > > Here is my expath-pkg.xml: > > > > <package xmlns="http://expath.org/ns/pkg" > name="http://servicenow.com/xquery" > abbrev="now-xquery" > version="0.1" > spec="1.0"> > <title>XQuery modules for ServiceNow Product Content processing and support</title> > > <xquery> > <namespace>http://servicenow.com/xquery/module/database-from-git</namespace> > <file>database-from-git.xqm</file> > </xquery> > > <xquery> > <namespace>http://servicenow.com/xquery/module/now-dita-utils</namespace> > <file>now-dita-utils.xqm</file> > </xquery> > <xquery> > <namespace>http://servicenow.com/xquery/module/now-relpath-utils</namespace> > <file>now-relpath-utils.xqm</file> > </xquery> > </package> > > > > And here is the structure of the resulting module directory after installation: > > > > main % ls ~/apps/basex/repo/http-servicenow.com-xquery-0.1 > > content expath-pkg.xml > > main % ls ~/apps/basex/repo/http-servicenow.com-xquery-0.1/content > > database-from-git.xqm now-dita-utils.xqm now-relpath-utils.xqm > > main % > > > > And the prolog for now-relpath-utils.xqm: > > > > module namespace relpath="http://servicenow.com/xquery/module/now-relpath-utils"; > > > > Trying to import in a trivial XQuery script, e.g.: > > import module namespace relpath="http://servicenow.com/xquery/module/now-relpath-utils"; > > count(/*) > > > > Produces this error: > > Error: > > Stopped at /Users/eliot.kimber/git/dita-build-tools/src/main/xquery/file, 1/88: > > [XQST0059] Module not found: http://servicenow.com/xquery/module/now-relpath-utils. > > > > So clearly something isn’t hooked up correctly but I don’t see any obvious breakage or violation of a required convention. > > > > Any idea where I’ve gone wrong or tips on debugging the resolution failure? > > > > This is 9.6.4 on macOS. > > > > Thanks, > > > > Eliot > > > > _____________________________________________ > > Eliot Kimber > > Sr Staff Content Engineer > > O: 512 554 9368 > > M: 512 554 9368 > > servicenow.com > > LinkedIn | Twitter | YouTube | Facebook

On Mon, Jan 24, 2022 at 4:08 PM Eliot Kimber <eliot.kimber at servicenow.com> wrote: > > I did confirm that if the package @name URI matches the URI of a module, then the module is resolved, i.e.: > > <package xmlns="http://expath.org/ns/pkg" > name="http://servicenow.com/xquery/module/now-dita-utils" > abbrev="now-xquery" > version="0.1" spec="1.0"> > <title>XQuery modules for ServiceNow Product Content processing and support</title> <xquery> > <namespace>http://servicenow.com/xquery/module/database-from-git</namespace> > <file>database-from-git.xqm</file> > </xquery> > > … > > </package> > > That implies that each module needs to be in a separate XAR file in order to also be in a separate namespace. > > I don’t think that is consistent with the EXPath packaging spec. > > In the description of the XQuery entry it says: > > An XQuery library module is referenced by its namespace URI. Thus the xquery element associates a namespace URI to an XQuery file. An importing module just need to use an import statement of the form import module namespace xx = "<namespace-uri>";. > An XQuery main module is associated a public URI. Usually an XQuery package will provide functions through library modules, but in some cases one can want to provide main modules as well. > This implies to me that the value of the <namespace> element in the <xquery> is what should be used to resolve the package reference, not the package’s @name value, which simply serves to identify the package. > > Is my analysis correct or have I misunderstood the package mechanism? > > Cheers, > E.

From: Christian Grün <christian.gruen at gmail.com> Date: Monday, January 24, 2022 at 9:12 AM To: Eliot Kimber <eliot.kimber at servicenow.com>, BaseX <basex-talk at mailman.uni-konstanz.de> Subject: Re: [basex-talk] Unable to Make My Custom EXPath Module Work [External Email] I guess you’re right. We haven’t revised EXPath packaging for a long time now. Actually, I’m not sure how many people use it at all ;) Anyone out there? On Mon, Jan 24, 2022 at 4:08 PM Eliot Kimber <eliot.kimber at servicenow.com> wrote: > > I did confirm that if the package @name URI matches the URI of a module, then the module is resolved, i.e.: > > <package xmlns="https://urldefense.com/v3/__http://expath.org/ns/pkg__;!!N4vogdjhuJM!X1Svs1NMbhha-Yl2b5x5PNQfgZ-8EXu16wMMrk9avEmbi5ZqNoJAAROi9eg1OHdTuFt6qA$ " > name="http://servicenow.com/xquery/module/now-dita-utils" > abbrev="now-xquery" > version="0.1" spec="1.0"> > <title>XQuery modules for ServiceNow Product Content processing and support</title> <xquery> > <namespace>http://servicenow.com/xquery/module/database-from-git</namespace> > <file>database-from-git.xqm</file> > </xquery> > > … > > </package> > > That implies that each module needs to be in a separate XAR file in order to also be in a separate namespace. > > I don’t think that is consistent with the EXPath packaging spec. > > In the description of the XQuery entry it says: > > An XQuery library module is referenced by its namespace URI. Thus the xquery element associates a namespace URI to an XQuery file. An importing module just need to use an import statement of the form import module namespace xx = "<namespace-uri>";. > An XQuery main module is associated a public URI. Usually an XQuery package will provide functions through library modules, but in some cases one can want to provide main modules as well. > This implies to me that the value of the <namespace> element in the <xquery> is what should be used to resolve the package reference, not the package’s @name value, which simply serves to identify the package. > > Is my analysis correct or have I misunderstood the package mechanism? > > Cheers, > E.

> How best to manage deployment of XQuery modules and top-level scripts from a source environment to a running remote server so that using scripts can import modules using just the module namespace?

> I looked quickly at the code for EXPath package processing but I didn’t spent much time in it, but it probably wouldn’t be too hard to enhance it to behave as I expected. I could possibly pursue that if anyone else would use it.

>the URL of the expath-pkg.xml library module which will be imported from

On Mon, 24 Jan 2022 at 17:43, Christian Grün <christian.gruen at gmail.com> wrote: > > How best to manage deployment of XQuery modules and top-level scripts > from a source environment to a running remote server so that using scripts > can import modules using just the module namespace? > > If you don’t care about version conflicts and other potential > dependency errors, you could use the following expression (the > argument of fetch:binary can be an arbitrary URI): > > basex "archive:extract-to(db:option('repopath'), fetch:binary('....zip'))" > > > I looked quickly at the code for EXPath package processing but I didn’t > spent much time in it, but it probably wouldn’t be too hard to enhance it > to behave as I expected. I could possibly pursue that if anyone else would > use it. > > Thanks for the offer, that would certainly be appreciated. >

From: Christian Grün <christian.gruen at gmail.com> Date: Monday, January 24, 2022 at 11:43 AM To: Eliot Kimber <eliot.kimber at servicenow.com> Cc: BaseX <basex-talk at mailman.uni-konstanz.de> Subject: Re: [basex-talk] Unable to Make My Custom EXPath Module Work [External Email] > How best to manage deployment of XQuery modules and top-level scripts from a source environment to a running remote server so that using scripts can import modules using just the module namespace? If you don’t care about version conflicts and other potential dependency errors, you could use the following expression (the argument of fetch:binary can be an arbitrary URI): basex "archive:extract-to(db:option('repopath'), fetch:binary('....zip'))" > I looked quickly at the code for EXPath package processing but I didn’t spent much time in it, but it probably wouldn’t be too hard to enhance it to behave as I expected. I could possibly pursue that if anyone else would use it. Thanks for the offer, that would certainly be appreciated.

> I see that I can just directly install the individual module files, i.e.: > repo install file:/Users/eliot.kimber/git/dita-build-tools/src/main/xquery/modules/now-dita-utils.xqm

>

>

>

>

From: Christian Grün <christian.gruen at gmail.com> Date: Monday, January 24, 2022 at 1:31 PM To: Eliot Kimber <eliot.kimber at servicenow.com> Cc: BaseX <basex-talk at mailman.uni-konstanz.de> Subject: Re: [basex-talk] Unable to Make My Custom EXPath Module Work [External Email] > I see that I can just directly install the individual module files, i.e.: > repo install file:/Users/eliot.kimber/git/dita-build-tools/src/main/xquery/modules/now-dita-utils.xqm True! I overlooked that one. With the repo:install, it can optionally be combined with a FLWOR expression.