feat(get): add an option to not expand xincludes

DrRataplan · line-o · commit 5f595d51eaf5 · 2025-07-30T14:20:28.000+02:00
diff --git a/commands/get.js b/commands/get.js
@@ -51,19 +51,19 @@ const xmlBooleanOptionValue = new Map([
 const xmlBooleanSetting = {
   type: 'string',
   coerce: (value) => {
-    console.log(value)
     if (value === null) {
       return value
     }
     if (!xmlBooleanOptionValue.has(value)) {
       throw Error('Unsupported XML serialization option value: ' + value)
     }
-    return value
+    return xmlBooleanOptionValue.get(value)
   }
 }
-const serializationOptionNames = ['insert-final-newline', 'omit-xml-declaration']
+const serializationOptionNames = ['insert-final-newline', 'omit-xml-declaration', 'expand-xincludes']
 
 const serializationDefaults = {
+  'expand-xincludes': 'yes'
   // "exist:indent": "no",
   // "indent": "no",
   // "output.indent": "no",
@@ -214,6 +214,9 @@ async function downloadCollectionOrResource (db, source, target, options) {
       console.error('Exclude:\n', ...options.exclude, '\n')
     }
     console.error(`Downloading up to ${options.threads} resources at a time`)
+    if (options['expand-xincludes'] === 'false') {
+      console.error('Skipping XInclude expansion')
+    }
   }
 
   // initial file
@@ -295,6 +298,12 @@ export function builder (yargs) {
       default: [],
       ...stringList
     })
+    .option('x', {
+      group: 'serialization',
+      alias: 'expand-xincludes',
+      describe: 'Skip expanding XInclude elements when set to "false"',
+      ...xmlBooleanSetting
+    })
     .option('X', {
       group: 'serialization',
       alias: 'omit-xml-declaration',
diff --git a/spec/tests/get.js b/spec/tests/get.js
@@ -1,6 +1,8 @@
 import { test } from 'tape'
 import { run, asAdmin } from '../test.js'
 import { readdirSync } from 'node:fs'
+import { readFile } from 'node:fs/promises'
+import path from 'node:path'
 
 const testCollectionName = 'get-test'
 const testCollection = '/db/' + testCollectionName
@@ -34,7 +36,8 @@ const expectedDirectoryListing = [
   'empty-subcollection',
   'index.html',
   'subcollection',
-  'test.xq'
+  'test.xq',
+  'xincludes.xml'
 ]
 
 async function prepare (t) {
@@ -52,7 +55,14 @@ async function prepare (t) {
     storeResourceQuery(testCollection, 'a20.txt', '"test"'),
     storeResourceQuery(testCollection, 'a22.xml', '<test />'),
     storeResourceQuery(testCollection, 'index.html', '<html><body>1</body></html>'),
-    storeResourceQuery(testCollection, 'test.xq', '"1"')
+    storeResourceQuery(testCollection, 'test.xq', '"1"'),
+    storeResourceQuery(
+      testCollection,
+      'xincludes.xml',
+      `<xml xmlns:xi="http://www.w3.org/2001/XInclude">
+  <xi:include href="./a22.xml"><xi:fallback><p>I am an x include</p></xi:fallback></xi:include>
+</xml>`
+    )
   ].join(',')
   const { stderr, stdout } = await run('xst', ['run', query], asAdmin)
   if (stderr) {
@@ -93,6 +103,43 @@ test('with test collection', async (t) => {
     await removeLocalDownload()
   })
 
+  t.test(`can get ${testCollection} as admin without expanding xincludes`, async (st) => {
+    const { stderr, stdout } = await run('xst', ['get', testCollection, '.', '--expand-xincludes=no'], asAdmin)
+    if (stderr) {
+      return st.fail(stderr)
+    }
+    st.plan(4)
+
+    st.notOk(stdout, 'no output')
+    st.deepEqual(readdirSync(testCollectionName), expectedDirectoryListing, 'all files were downloaded')
+    st.deepEqual(readdirSync(testCollectionName + '/subcollection'), ['b'], 'subcollection contents were downloaded')
+
+    const contents = await readFile(path.join(testCollectionName, 'xincludes.xml'), 'utf-8')
+    st.strictEqual(
+      contents,
+      '<xml xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="./a22.xml"><xi:fallback><p>I am an x include</p></xi:fallback></xi:include></xml>'
+    )
+
+    await removeLocalDownload()
+  })
+
+  t.test(`can get ${testCollection} as admin with expanding xincludes`, async (st) => {
+    const { stderr, stdout } = await run('xst', ['get', testCollection, '.', '--expand-xincludes', 'yes'], asAdmin)
+    if (stderr) {
+      return st.fail(stderr)
+    }
+    st.plan(4)
+
+    st.notOk(stdout, 'no output')
+    st.deepEqual(readdirSync(testCollectionName), expectedDirectoryListing, 'all files were downloaded')
+    st.deepEqual(readdirSync(testCollectionName + '/subcollection'), ['b'], 'subcollection contents were downloaded')
+
+    const contents = await readFile(path.join(testCollectionName, 'xincludes.xml'), 'utf-8')
+    st.strictEqual(contents, '<xml xmlns:xi="http://www.w3.org/2001/XInclude"><test/></xml>')
+
+    await removeLocalDownload()
+  })
+
   t.test(`can get ${testCollection} as admin with just one thread`, async (st) => {
     const { stderr, stdout } = await run('xst', ['get', testCollection, '.', '--threads', '1'], asAdmin)
     if (stderr) {
@@ -141,8 +188,8 @@ test('with test collection', async (t) => {
     )
     st.equal(
       lines.filter((l) => /^✔︎ downloaded resource [/\w]+\/get-test/.exec(l)).length,
-      9,
-      'notify 9 resources downloaded'
+      10,
+      'notify 10 resources downloaded'
     )
 
     st.deepEqual(readdirSync(testCollectionName), expectedDirectoryListing, 'all files were downloaded')
