Merge pull request #327 from line-o/next

Update to node-exist v7

Author: duncdrum

commands/edit.js

@@ -9,7 +9,7 @@ import * as readline from 'node:readline'
 import chalk from 'chalk'
 import { execa } from 'execa'
 import { getEditor } from 'env-editor'
-import { connect } from '@existdb/node-exist'
+import { getXmlRpcClient } from '@existdb/node-exist'
 
 /**
  * @typedef { import("@existdb/node-exist").NodeExist } NodeExist
@@ -148,5 +148,5 @@ export async function handler (argv) {
     return 0
   }
   const { resource, connectionOptions, editor } = argv
-  return await edit(connect(connectionOptions), resource, editor)
+  return await edit(getXmlRpcClient(connectionOptions), resource, editor)
 }

commands/exec.js

@@ -1,4 +1,4 @@
-import { connect } from '@existdb/node-exist'
+import { getXmlRpcClient } from '@existdb/node-exist'
 import { readFileSync } from 'node:fs'
 
 /**
@@ -68,7 +68,7 @@ function getQuery (file, query) {
  * @param {NodeExist.BoundModules} db bound NodeExist modules
  * @param {string|Buffer} query the query to execute
  * @param {object} variables the bound variables
- * @returns {Number}
+ * @returns {Promise<Number>} exit code
  */
 async function execute (db, query, variables) {
   const result = await db.queries.readAll(query, { variables })
@@ -106,7 +106,7 @@ export async function handler (argv) {
   }
   const { file, bind, query } = argv
   const _query = getQuery(file, query)
-  const db = connect(argv.connectionOptions)
+  const db = getXmlRpcClient(argv.connectionOptions)
 
   return await execute(db, _query, bind)
 }

commands/get.js

@@ -1,7 +1,7 @@
 import { resolve, join, posix, dirname, basename } from 'node:path'
 import { statSync, existsSync, mkdirSync } from 'node:fs'
 import { writeFile } from 'node:fs/promises'
-import { connect } from '@existdb/node-exist'
+import { getXmlRpcClient } from '@existdb/node-exist'
 import Bottleneck from 'bottleneck'
 import { getGlobMatcher } from '../utility/glob.js'
 
@@ -379,7 +379,7 @@ export async function handler (argv) {
 
   const target = argv.target ? argv.target : '.'
 
-  const db = connect(argv.connectionOptions)
+  const db = getXmlRpcClient(argv.connectionOptions)
   const version = await db.server.version()
   argv.version = version
 

commands/info.js

@@ -1,4 +1,4 @@
-import { connect } from '@existdb/node-exist'
+import { getXmlRpcClient } from '@existdb/node-exist'
 import { readXquery } from '../utility/xq.js'
 
 /**
@@ -59,5 +59,5 @@ export async function handler (argv) {
     return 0
   }
   const { connectionOptions } = argv
-  return info(connect(connectionOptions), argv)
+  return info(getXmlRpcClient(connectionOptions), argv)
 }

commands/list.js

@@ -1,5 +1,5 @@
 import chalk from 'chalk'
-import { connect, getMimeType } from '@existdb/node-exist'
+import { getXmlRpcClient, getMimeType } from '@existdb/node-exist'
 import { readXquery } from '../utility/xq.js'
 import { getDateFormatter } from '../utility/colored-date.js'
 import { multiSort } from '../utility/sorter.js'
@@ -592,7 +592,7 @@ export async function handler (argv) {
     return 1
   }
 
-  const db = connect(argv.connectionOptions)
+  const db = getXmlRpcClient(argv.connectionOptions)
 
   return ls(db, collection, argv)
 }

commands/package/install/github.js

@@ -1,8 +1,8 @@
-import { got } from 'got'
+import { Client, interceptors, fetch } from 'undici'
 import { valid, gt, lt, eq } from 'semver'
 import chalk from 'chalk'
 
-import { connect, getRestClient } from '@existdb/node-exist'
+import { getXmlRpcClient, getRestClient } from '@existdb/node-exist'
 
 import { isDBAdmin, getUserInfo } from '../../../utility/connection.js'
 import {
@@ -12,9 +12,24 @@ import {
 } from '../../../utility/package.js'
 import { logFailure, logSuccess, logSkipped } from '../../../utility/message.js'
 
-async function getRelease (api, owner, repo, release, assetFilter, verbose) {
+/**
+ * @typedef { import("undici").Dispatcher.ComposedDispatcher } Dispatcher.ComposedDispatcher
+ */
+
+/**
+ * get the release information from Github API
+ * @param {Dispatcher.ComposedDispatcher} api
+ * @param {String} address the api address
+ * @param {String} owner the owner of the repo
+ * @param {String} repo the name of the repo
+ * @param {String} [release] the specific release naem (optional)
+ * @param {String} assetFilter the pattern to find the XAR
+ * @param {boolean} verbose display more information
+ * @returns {Promise<{ xarName: string, packageContents: string, releaseName: string, tagName:string }>} release info
+ */
+async function getRelease (api, origin, owner, repo, release, assetFilter, verbose) {
   const tag = release === 'latest' ? release : 'tags/' + release
-  const path = `repos/${owner}/${repo}/releases/${tag}`
+  const path = `/repos/${owner}/${repo}/releases/${tag}`
   /**
    * @type {unknown[]}
    */
@@ -28,14 +43,15 @@ async function getRelease (api, owner, repo, release, assetFilter, verbose) {
    */
   let tagName
   try {
-    const result = await got.get(path, { prefixUrl: api }).json()
+    const { body } = await api.request({ method: 'GET', path })
+    const result = await body.json()
     // The name is not always filled in. Fall back to the tag_name if it is absent
     releaseName = result.name || result.tag_name
     assets = result.assets
     tagName = result.tag_name
   } catch (e) {
     throw Error(
-      `Could not get release from: ${e.options.url} ${e.response.statusCode}: ${e.response.statusMessage}`
+      `Could not get release from: ${origin}${path} ${e.statusCode}: ${e.body.message}`
     )
   }
   const filteredAssets = assets.filter(assetFilter)
@@ -59,6 +75,15 @@ async function getRelease (api, owner, repo, release, assetFilter, verbose) {
   }
 }
 
+/**
+ * Install a package after it was uploaded
+ * @param {import('@existdb/node-exist').NodeExistXmlRpcClient} db the XML-RPC client connected to an exist-db
+ * @param {Function} upload a function uploading the XAR package
+ * @param {string} xarName the name of the XAR package
+ * @param {Readable} contents the ReadableStream that will be put to the database
+ * @param {string} registry the URL to the registry that will be used ot resolve dependencies
+ * @returns {Promise<{ success: boolean, error?: Error }>} the result of the installation
+ */
 async function install (db, upload, xarName, contents, registry) {
   const xarDisplay = chalk.dim(xarName)
   const uploadResult = await upload(contents, xarName)
@@ -128,6 +153,14 @@ export const builder = (yargs) => {
     .options(options)
 }
 
+const requestHeaderInterceptor = (baseheaders) => dispatch => {
+  return (opts, handler) => {
+    const { headers } = opts
+    opts.headers = { ...headers, ...baseheaders }
+    return dispatch(opts, handler)
+  }
+}
+
 export async function handler (argv) {
   if (argv.help) {
     return 0
@@ -148,7 +181,7 @@ export async function handler (argv) {
   } = argv
 
   const repo = argv.repo && argv.repo !== '' ? argv.repo : abbrev
-  const db = connect(connectionOptions)
+  const db = getXmlRpcClient(connectionOptions)
 
   // check permissions (and therefore implicitly the connection)
   const user = await getUserInfo(db)
@@ -158,7 +191,7 @@ export async function handler (argv) {
     )
   }
 
-  const restClient = await getRestClient(connectionOptions)
+  const restClient = getRestClient(connectionOptions)
   // check rest connection
   await restClient.get('db')
   const upload = putPackage.bind(null, db, restClient)
@@ -170,11 +203,16 @@ export async function handler (argv) {
   }
 
   const installedVersion = (await getInstalledPackageMeta(db, abbrev)).version
+  const apiClient = new Client(api).compose([
+    requestHeaderInterceptor({ 'User-Agent': 'xst/undici.Client' }),
+    interceptors.responseError({ throwOnError: true })
+  ])
 
   if (verbose) {
     console.log(`Preparing to install ${owner}/${repo} at version ${release}`)
   }
   const { xarName, packageContents, releaseName, tagName } = await getRelease(
+    apiClient,
     api,
     owner,
     repo,
@@ -219,8 +257,10 @@ export async function handler (argv) {
   }
 
   try {
-    const contentStream = got.stream.get(packageContents)
-    const result = await install(db, upload, xarName, contentStream, registry)
+    // using fetch here as the packageContents could be anywhere on the internet
+    // and the contents might be gzipped, so we benefit from automatic decompression
+    const { body } = await fetch(packageContents, { method: 'GET' })
+    const result = await install(db, upload, xarName, body, registry)
     let action
     if (isDowngrade) {
       action = `${chalk.yellow('downgraded')} to`

commands/package/install/local.js

@@ -3,7 +3,7 @@ import { basename } from 'node:path'
 import { valid, gt, lt, eq } from 'semver'
 import chalk from 'chalk'
 
-import { connect } from '@existdb/node-exist'
+import { getXmlRpcClient } from '@existdb/node-exist'
 
 import { isDBAdmin, getUserInfo } from '../../../utility/connection.js'
 import {
@@ -15,12 +15,12 @@ import {
 import { logFailure, logSuccess, logSkipped } from '../../../utility/message.js'
 
 /**
- * @typedef { import("@existdb/node-exist").NodeExist } NodeExist
+ * @typedef { import("@existdb/node-exist").NodeExistXmlRpcClient } NodeExistXmlRpcClient
  */
 
 /**
- *
- * @param {NodeExist} db
+ * Upload and install a xar package from the local filesystem
+ * @param {NodeExistXmlRpcClient} db
  * @param {Function} upload
  * @param {String} localFilePath
  * @param {Boolean} force
@@ -84,7 +84,9 @@ async function install (db, upload, localFilePath, force, verbose) {
     logSuccess(message)
     return installResult
   } catch (e) {
-    logFailure(`${xarDisplay} ${e.message}`)
+    // catch request errors
+    const message = e.statusCode ? `Request failed with status code ${e.statusCode}` : e.message
+    logFailure(`${xarDisplay} ${message}`)
     return { success: false, error: e }
   }
 }
@@ -133,7 +135,7 @@ export async function handler (argv) {
     }
   })
 
-  const db = connect(connectionOptions)
+  const db = getXmlRpcClient(connectionOptions)
 
   // check permissions (and therefore implicitly the connection)
   const user = await getUserInfo(db)

commands/package/install/registry.js

@@ -1,6 +1,6 @@
 import chalk from 'chalk'
 
-import { connect } from '@existdb/node-exist'
+import { getXmlRpcClient } from '@existdb/node-exist'
 
 import { isDBAdmin, getUserInfo } from '../../../utility/connection.js'
 import {
@@ -34,10 +34,9 @@ export async function handler (argv) {
   if (argv.help) {
     return 0
   }
-
   // main
   const { connectionOptions, registry, force, verbose } = argv
-  const db = connect(connectionOptions)
+  const db = getXmlRpcClient(connectionOptions)
 
   // check permissions (and therefore implicitly the connection)
   const user = await getUserInfo(db)
@@ -51,7 +50,7 @@ export async function handler (argv) {
 
   if (verbose) {
     const installedOrNot = info.version ? `already installed in version ${info.version}` : 'not installed yet'
-    console.error(`Package ${info.name} is ${installedOrNot}.`)
+    console.error(`Package ${info.name || argv.package} is ${installedOrNot}.`)
   }
 
   let pkgInfo

commands/package/list.js

@@ -1,5 +1,5 @@
 import chalk from 'chalk'
-import { connect } from '@existdb/node-exist'
+import { getXmlRpcClient } from '@existdb/node-exist'
 import { multiSort } from '../../utility/sorter.js'
 import { padReducer } from '../../utility/padding.js'
 import { getDateFormatter } from '../../utility/colored-date.js'
@@ -598,6 +598,6 @@ export async function handler (argv) {
     return 0
   }
 
-  const db = connect(argv.connectionOptions)
+  const db = getXmlRpcClient(argv.connectionOptions)
   return await listPackages(db, argv)
 }

commands/package/uninstall.js

@@ -1,11 +1,11 @@
 import chalk from 'chalk'
-import { connect } from '@existdb/node-exist'
+import { getXmlRpcClient } from '@existdb/node-exist'
 import { readXquery } from '../../utility/xq.js'
 
 const query = readXquery('uninstall.xq')
 
 async function getUserInfo (db) {
-  const { user } = db.client.options.basic_auth
+  const { user } = db.connection
   return await db.users.getUserInfo(user)
 }
 
@@ -58,7 +58,7 @@ export async function handler (argv) {
   }
 
   // check permissions (and therefore implicitly the connection)
-  const db = connect(argv.connectionOptions)
+  const db = getXmlRpcClient(argv.connectionOptions)
   const accountInfo = await getUserInfo(db)
   const isAdmin = accountInfo.groups.includes('dba')
   if (!isAdmin) {