Support for 'Module Location Configuration'

[rlouapre]

Ability to register some modules.

[grtjn]

Looking into this. Also missing: schemas, and request-blackouts..

[rlouapre]

@grtjn
How to use this feature?

I try to add in ml-confg.xml:

<configuration>
  <module-locations xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://marklogic.com/xdmp/group">
    <module-location>
      <namespace-uri>http://github.com/robwhitby/xray/assertions</namespace-uri>
      <location>/_framework/lib/xray/src/assertions.xqy</location>
    </module-location>
    <module-location>
      <namespace-uri>http://github.com/robwhitby/xray</namespace-uri>
      <location>/_framework/lib/xray/src/xray.xqy</location>
    </module-location>
  </module-locations>

And execute ml local boostrap

[rlouapre]

I forget to put module-locations inside http-server.
It is working fine with one module-location element [1] but not with multiple [2].

    <http-server>
      <module-locations>
      <module-location>
        <namespace-uri>http://github.com/robwhitby/xray</namespace-uri>
        <location>/_framework/lib/xray/src/xray.xqy</location>
      </module-location>
    </module-locations>
...
    </http-server>

    <http-server>
      <module-locations>
      <module-location>
        <namespace-uri>http://github.com/robwhitby/xray</namespace-uri>
        <location>/_framework/lib/xray/src/xray.xqy</location>
      </module-location>
      <module-location>
        <namespace-uri>http://github.com/robwhitby/xray/assertions</namespace-uri>
        <location>/_framework/lib/xray/src/assertions.xqy</location>
      </module-location>
    </module-locations>
...
    </http-server>

I get the error message:
ERROR: [{"qid":null, "type":"string", "result":"XDMP-NONMIXEDCOMPLEXCONT: fn:data(<module-location xmlns="http://marklogic.com/xdmp/group" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">http://github.com/robwhitby/xray/assertions</name...</module-location>) -- Node has complex type with non-mixed complex content\nSee MarkLogic Server error log for more details."}]
ERROR: ... Bootstrap FAILED

[grtjn]

Auch, classic mistake trying to pass a sequence of values into xdmp:eval..

[rlouapre]

If module-location/location is updated ml bootstrap will fail with the error:

ERROR: [{"qid":null, "type":"string", "result":"ADMIN-NOSUCHITEM: (err:FOER0000) Appserver Module Location does not exist: <module-location xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xmlns=\"http:\/\/marklogic.com\/xdmp\/group\">\n  <namespace-uri>http:\/\/marklogic.com\/metadata\/import\/test\/setup<\/namespace-uri>\n  <location>\/test\/app\/lib\/test\/setup\/setup.xqy<\/location>\n<\/module-location>\nSee MarkLogic Server error log for more details."}]
ERROR: ... Bootstrap FAILED

Is it expected or should bootstrap delete and recreate module location ?

[dmcassel]

That's a bug. Typical operation is to update the $config by removing those settings, then adding the specified ones. If there's no change, then there's no difference.

[grtjn]

Hmm, the self-test doesn't cover changing settings at the moment. Maybe a good moment to build that in..

[grtjn]

The logic is a little 'smarter' actually. It tries to detect which ones should be added, which ones should be removed. Taking the blunt approach might indeed be more robust..

[grtjn]

Ah, it is actually is silly mistake. The mechanism for ns, schemas, and modules is same: ns-prefix, schema-ns, and module-ns need to be unique. So, those with matching prefix or ns-uri are removed first, before adding missing ones. But the logic to delete them passed through the new spec instead of the old one, making delete fail.

By explicitly removing those that need to be deleted, and only adding those that are missing, any existing ns, schema or module-location will be preserved..

[rlouapre]

How do I add module-location to XCC configuration?

[grtjn]

Bootstrap normally replaces @ml.xdbc-server in ml-config.xml with the following:

      <xdbc-server>
        <xdbc-server-name>@ml.app-name-xcc</xdbc-server-name>
        <port>@ml.xcc-port</port>
        <database name="@ml.content-db"/>
        <modules name="@ml.modules-db"/>
        <authentication>digest</authentication>
      </xdbc-server>

That does not contain module-locations, and doesn't allow you to add them this way.

Bootstrap should however support module-locations for any server type. You could replace the placeholder with the above replacement in ml-config.xml yourself. That way you should be able to add module-locations to it. Haven't tested though..

[rlouapre]

Adding module-locations node in your snippet works.