@open-xchange/soap-client 0.0.6 → 0.0.8

package/bin/provision.js

@@ -30,7 +30,7 @@ function checkEnvironmentVariables () {
   }
 }
 
-async function getOrCreateContext (data) {
+async function getOrCreateContext (data, accessCombinationName = 'all') {
   const contextData = {
     ...{ maxQuota: -1 },
     ...data
@@ -44,7 +44,7 @@ async function getOrCreateContext (data) {
       context = existingContext[0]
     } else {
       console.log('Creating new context')
-      context = await contextService.create(contextData, contextAdmin.admin)
+      context = await contextService.create(contextData, contextAdmin.admin, accessCombinationName)
     }
     return {
       ...context,
@@ -116,10 +116,10 @@ async function provisionFromFile (configPath) {
   for (const contexts of config.contexts || []) {
     try {
       const contextData = contexts.data
-      const context = await getOrCreateContext({ name: contexts.data.name, admin: contexts.data.admin })
-      if (contextData.capabilities) {
+      const context = await getOrCreateContext({ name: contexts.data.name, admin: contexts.data.admin, }, contextData.accessCombinationName || 'all')
+      if (contextData.capabilities || contextData.capabilitiesToRemove) {
         try {
-          await contextService.changeCapabilities(context.id, contextData.capabilities, undefined)
+          await contextService.changeCapabilities(context.id, contextData.capabilities, contextData.capabilitiesToRemove)
           console.log('Changed capabilities for context:', context.id)
         } catch (capError) {
           console.error('Error changing capabilities for context', context.id, capError)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/soap-client",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "SOAP client for OX App Suite",
   "main": "index.js",
   "type": "module",

package/services/common/context.js

@@ -20,23 +20,23 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXContextService = createClientAsync('OXContextService').then(client => client)
+const OXContextService = createClientAsync('OXContextService')
 
 /**
  * This function retrieves the default context from the OXContextService.
  * @returns {Promise<Object>} The first result from the listAsync method call.
  */
 export async function getDefault () {
-  return (await (await OXContextService).listAsync({ search_pattern: 'defaultcontext' }))[0]
+  return (await OXContextService).listAsync({ search_pattern: 'defaultcontext' })[0]
 }
 
 /**
  * This function removes the context with the specified ID.
+ * Fire-and-forget operation - spawns a separate process to avoid blocking.
  * @param {number} id The ID of the context to remove.
- * @returns {Promise<Boolean>} Returns true if it could remove the context and false if it could not
  */
 export async function remove (id) {
-  return !!await (await OXContextService).deleteAsync({ ctx: { id } }).then(() => true).catch(logSoapError)
+  return (await OXContextService).deleteAsync({ ctx: { id } })
 }
 
 /**
@@ -58,8 +58,8 @@ export async function remove (id) {
       ```
  * @returns {Promise<Object>} The created context.
  */
-export async function create (ctx = {}, adminUser = {}) {
-  return await (await OXContextService)
+export async function create (ctx = {}, adminUser = {}, accessCombinationName = 'all') {
+  return (await OXContextService)
     .createAsync({
       ctx,
       admin_user: Object.assign({
@@ -73,7 +73,7 @@ export async function create (ctx = {}, adminUser = {}) {
       }, adminUser)
     })
     .then(async context => {
-      await changeModuleAccessByName(context.id, 'all')
+      await changeModuleAccessByName(context.id, accessCombinationName)
       return context
     })
     .catch(e => {
@@ -91,7 +91,7 @@ export async function create (ctx = {}, adminUser = {}) {
 // eslint-disable-next-line camelcase
 export async function changeModuleAccessByName (id, access_combination_name) {
   // eslint-disable-next-line camelcase
-  return await (await OXContextService).changeModuleAccessByNameAsync({ ctx: { id }, access_combination_name })
+  return (await OXContextService).changeModuleAccessByNameAsync({ ctx: { id }, access_combination_name })
 }
 
 /**
@@ -105,7 +105,7 @@ export async function changeCapabilities (id, capsToAdd, capsToRemove) {
   const data = {}
   if (capsToAdd) data.capsToAdd = capsToAdd
   if (capsToRemove) data.capsToRemove = capsToRemove
-  return await (await OXContextService).changeCapabilitiesAsync({ ctx: { id }, ...data })
+  return (await OXContextService).changeCapabilitiesAsync({ ctx: { id }, ...data })
 }
 
 /**
@@ -114,7 +114,7 @@ export async function changeCapabilities (id, capsToAdd, capsToRemove) {
  * @returns {Promise<Object>} The module access of the specified context.
  */
 export async function getModuleAccess (id) {
-  return await (await OXContextService).getModuleAccessAsync({ ctx: { id } })
+  return (await OXContextService).getModuleAccessAsync({ ctx: { id } })
 }
 /**
  * This function changes the module access of the specified context.
@@ -124,7 +124,7 @@ export async function getModuleAccess (id) {
  */
 export async function changeModuleAccess (id, moduleAccess) {
   const currentAccess = await getModuleAccess(id)
-  return await (await OXContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...moduleAccess } })
+  return (await OXContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...moduleAccess } })
 }
 
 /**
@@ -135,7 +135,10 @@ export async function changeModuleAccess (id, moduleAccess) {
  * @returns {Promise<Array<Object>>} The list of contexts that match the search pattern.
  */
 export async function list (searchPattern, { excludeDisabled } = { excludeDisabled: true }) {
-  return await (await OXContextService).listAsync({ search_pattern: searchPattern, exclude_disabled: excludeDisabled })
+  return (await OXContextService).listAsync({ search_pattern: searchPattern, exclude_disabled: excludeDisabled }).catch(e => {
+    logSoapError(e)
+    return []
+  })
 }
 
 /**
@@ -144,7 +147,7 @@ export async function list (searchPattern, { excludeDisabled } = { excludeDisabl
  * @returns {Promise<Object>} The context with the specified ID.
  */
 export async function get (id) {
-  return await (await OXContextService).getDataAsync({ ctx: { id } })
+  return (await OXContextService).getDataAsync({ ctx: { id } })
 }
 
 /**
@@ -153,5 +156,5 @@ export async function get (id) {
  * @returns {Promise<void>}
  */
 export async function change (ctx) {
-  return await (await OXContextService).changeAsync({ ctx })
+  return (await OXContextService).changeAsync({ ctx })
 }

package/services/common/user.js

@@ -20,7 +20,7 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXUserService = createClientAsync('OXUserService').then(client => client)
+const OXUserService = createClientAsync('OXUserService')
 
 /**
  * This function removes the user with the specified context and user ID.
@@ -29,11 +29,11 @@ const OXUserService = createClientAsync('OXUserService').then(client => client)
  * @returns {Promise<Boolean>} Returns true if it could remove the user and false if it could not
  */
 export async function remove (context, userId) {
-  return !!await (await OXUserService).deleteAsync({
+  return (await OXUserService).deleteAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: context.admin
-  }).then(() => true).catch(logSoapError)
+  }).catch(logSoapError)
 }
 
 /**
@@ -43,7 +43,7 @@ export async function remove (context, userId) {
  * @returns {Promise<Object>} The created user.
  */
 export async function create (context, usrdata) {
-  return await (await OXUserService).createAsync({
+  return (await OXUserService).createAsync({
     ctx: { id: context.id },
     usrdata,
     auth: context.admin
@@ -57,7 +57,7 @@ export async function create (context, usrdata) {
  * @returns {Promise<void>}
  */
 export async function change (context, usrdata) {
-  return await (await OXUserService).changeAsync({
+  return (await OXUserService).changeAsync({
     ctx: { id: context.id },
     usrdata,
     auth: context.admin
@@ -65,7 +65,7 @@ export async function change (context, usrdata) {
 }
 
 export async function changeByModuleAccess (context, userId, currentAccess, moduleAccess) {
-  return await (await OXUserService).changeByModuleAccessAsync({
+  return (await OXUserService).changeByModuleAccessAsync({
     ctx: { id: context.id },
     moduleAccess: Object.assign({}, currentAccess, moduleAccess),
     user: { id: userId },
@@ -74,7 +74,7 @@ export async function changeByModuleAccess (context, userId, currentAccess, modu
 }
 
 export async function changeByModuleAccessName (context, userId, accessCombinationName) {
-  return await (await OXUserService).changeByModuleAccessNameAsync({
+  return (await OXUserService).changeByModuleAccessNameAsync({
     ctx: { id: context.id },
     access_combination_name: accessCombinationName,
     user: { id: userId },
@@ -83,7 +83,7 @@ export async function changeByModuleAccessName (context, userId, accessCombinati
 }
 
 export async function getModuleAccess (context, userId) {
-  return await (await OXUserService).getModuleAccessAsync({
+  return (await OXUserService).getModuleAccessAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: context.admin
@@ -100,11 +100,11 @@ export async function changeCapabilities (context, userId, capsToAdd, capsToRemo
   }
   if (capsToAdd) data.capsToAdd = capsToAdd
   if (capsToRemove) data.capsToRemove = capsToRemove
-  return await (await OXUserService).changeCapabilitiesAsync(data)
+  return (await OXUserService).changeCapabilitiesAsync(data)
 }
 
 export async function exists (context, userId) {
-  return await (await OXUserService).existsAsync({
+  return (await OXUserService).existsAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: context.admin
@@ -112,7 +112,7 @@ export async function exists (context, userId) {
 }
 
 export async function list (context, searchPattern, includeGuests = false) {
-  return await (await OXUserService).listAsync({
+  return (await OXUserService).listAsync({
     ctx: { id: context.id },
     search_pattern: searchPattern,
     include_guests: includeGuests,
@@ -121,7 +121,7 @@ export async function list (context, searchPattern, includeGuests = false) {
 }
 
 export async function listAll (context, includeGuests = false, excludeUsers = []) {
-  return await (await OXUserService).listAsync({
+  return (await OXUserService).listAsync({
     ctx: { id: context.id },
     include_guests: includeGuests,
     exclude_users: excludeUsers,

package/services/common/util.js

@@ -27,7 +27,7 @@ import { createClientAsync } from '../../soap.js'
 let fileStoreId
 
 export async function getFilestorageId () {
-  const OXUtilService = createClientAsync('OXUtilService').then(client => client)
+  const OXUtilService = createClientAsync('OXUtilService')
 
   if (fileStoreId) return fileStoreId
   fileStoreId = (await (await OXUtilService).listFilestoreAsync())[0]?.id

package/services/reseller/oxaas.js

@@ -23,9 +23,9 @@ import { createClientAsync } from '../../soap.js'
 const OXaaSService = createClientAsync('OXaaSService').then(client => client)
 
 export async function setMailQuota (data) {
-  return await (await OXaaSService).setMailQuotaAsync(data)
+  return (await OXaaSService).setMailQuotaAsync(data)
 }
 
 export async function createSharedDomain (data) {
-  return await (await OXaaSService).createSharedDomain(data)
+  return (await OXaaSService).createSharedDomain(data)
 }

package/services/reseller/resellerContext.js

@@ -20,36 +20,36 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXResellerContextService = createClientAsync('OXResellerContextService').then(client => client)
+const OXResellerContextService = createClientAsync('OXResellerContextService')
 
 export async function create (data) {
-  return await (await OXResellerContextService).createAsync(data)
+  return (await OXResellerContextService).createAsync(data)
 }
 
 export async function remove (contextId) {
-  return !!await (await OXResellerContextService).deleteAsync({
+  return (await OXResellerContextService).deleteAsync({
     ctx: { id: contextId }
-  }).then(() => true).catch(logSoapError)
+  }).catch(logSoapError)
 }
 
 export async function change (ctx) {
-  return await (await OXResellerContextService).changeAsync({ ctx })
+  return (await OXResellerContextService).changeAsync({ ctx })
 }
 
 export async function get (id) {
-  return await (await OXResellerContextService).getDataAsync({ ctx: { id } })
+  return (await OXResellerContextService).getDataAsync({ ctx: { id } })
 }
 
 export async function getModuleAccess (id) {
-  return await (await OXResellerContextService).getModuleAccessAsync({ ctx: id })
+  return (await OXResellerContextService).getModuleAccessAsync({ ctx: id })
 }
 
 export async function changeModuleAccess (id, access) {
   const currentAccess = await getModuleAccess(id)
 
-  return await (await OXResellerContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...access } })
+  return (await OXResellerContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...access } })
 }
 
 export async function listAll (data) {
-  return await (await OXResellerContextService).listAllAsync(data)
+  return (await OXResellerContextService).listAllAsync(data)
 }

package/services/reseller/resellerUser.js

@@ -23,10 +23,10 @@ import { createClientAsync, logSoapError } from '../../soap.js'
 const OXResellerUserService = createClientAsync('OXResellerUserService').then(client => client)
 
 export async function remove (contextId, userId) {
-  return !!await (await OXResellerUserService).deleteAsync({
+  return (await OXResellerUserService).deleteAsync({
     ctx: { id: contextId },
     user: { id: userId }
-  }).then(() => true).catch(logSoapError)
+  }).catch(logSoapError)
 }
 
 /**
@@ -36,7 +36,7 @@ export async function remove (contextId, userId) {
  * @returns {Promise<void>}
  */
 export async function change (context, usrdata) {
-  return await (await OXResellerUserService).changeAsync({
+  return (await OXResellerUserService).changeAsync({
     ctx: { id: context.id },
     usrdata,
     auth: { login: context.admin.name, password: context.admin.password }
@@ -44,11 +44,11 @@ export async function change (context, usrdata) {
 }
 
 export async function get (data) {
-  return await (await OXResellerUserService).getDataAsync(data)
+  return (await OXResellerUserService).getDataAsync(data)
 }
 
 export async function getModuleAccess (context, userId) {
-  return await (await OXResellerUserService).getModuleAccessAsync({
+  return (await OXResellerUserService).getModuleAccessAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: { login: context.admin.name, password: context.admin.password }
@@ -58,7 +58,7 @@ export async function getModuleAccess (context, userId) {
 }
 
 export async function changeByModuleAccess (context, userId, currentAccess, moduleAccess) {
-  return await (await OXResellerUserService).changeByModuleAccessAsync({
+  return (await OXResellerUserService).changeByModuleAccessAsync({
     ctx: { id: context.id },
     moduleAccess: Object.assign({}, currentAccess, moduleAccess),
     user: { id: userId },
@@ -67,7 +67,7 @@ export async function changeByModuleAccess (context, userId, currentAccess, modu
 }
 
 export async function changeByModuleAccessName (context, userId, accessCombinationName) {
-  return await (await OXResellerUserService).changeByModuleAccessNameAsync({
+  return (await OXResellerUserService).changeByModuleAccessNameAsync({
     ctx: { id: context.id },
     access_combination_name: accessCombinationName,
     user: { id: userId },
@@ -76,7 +76,7 @@ export async function changeByModuleAccessName (context, userId, accessCombinati
 }
 
 export async function createByModuleAccessName (context, usrdata) {
-  return await (await OXResellerUserService).createByModuleAccessNameAsync({
+  return (await OXResellerUserService).createByModuleAccessNameAsync({
     ctx: { id: context.id },
     usrdata,
     access_combination_name: 'all',

package/services/secondaryAccount.js

@@ -1,6 +1,6 @@
 import { createClientAsync } from '../soap.js'
 
-const OXSecondaryAccountService = createClientAsync('OXSecondaryAccountService').then(client => client)
+const OXSecondaryAccountService = createClientAsync('OXSecondaryAccountService')
 
 /**
  * Creates a secondary account using the OX Secondary Account Service
@@ -13,7 +13,7 @@ const OXSecondaryAccountService = createClientAsync('OXSecondaryAccountService')
  * @throws {Error} If the account creation fails
  */
 export async function create (accountData, context, users = [], groups = []) {
-  return await (await OXSecondaryAccountService).createAsync({
+  return (await OXSecondaryAccountService).createAsync({
     accountDataOnCreate: accountData,
     context: { id: context.id },
     users: users || [],
@@ -22,13 +22,13 @@ export async function create (accountData, context, users = [], groups = []) {
 }
 
 export async function list (context) {
-  return await (await OXSecondaryAccountService).listAsync({
+  return (await OXSecondaryAccountService).listAsync({
     context: { id: context.id },
     auth: context.admin
   })
 }
 export async function remove (primaryAddress, context, users, groups) {
-  return await (await OXSecondaryAccountService).deleteAsync({
+  return (await OXSecondaryAccountService).deleteAsync({
     primaryAddress,
     context: { id: context.id },
     users,
@@ -37,7 +37,7 @@ export async function remove (primaryAddress, context, users, groups) {
 }
 
 export async function update (primaryAddress, accountData, context, users, groups) {
-  return await (await OXSecondaryAccountService).updateAsync({
+  return (await OXSecondaryAccountService).updateAsync({
     primaryAddress,
     accountDataUpdate: accountData,
     context: { id: context.id },

package/soap.js

@@ -31,6 +31,16 @@ dotenv.config({ path: ['.env', '.env.defaults'], quiet: true })
 // This flag enables debug output including timing information.
 const debug = process.env.DEBUG_SOAP === 'true'
 
+// Handle specifically timeout-related unhandled promise rejections as fallback
+process.on('unhandledRejection', (reason, promise) => {
+  if (reason?.code === 'ECONNABORTED' && (reason?.message?.includes('timeout') || reason?.message?.includes('exceeded'))) {
+    return
+  }
+
+  // Log other unhandled rejections as they indicate real problems
+  console.error('Unhandled promise rejection:', reason?.message || reason)
+})
+
 // This URL is used to create the SOAP client.
 const provisioningUrl = String(process.env.PROVISIONING_URL).replace(/\/$/, '')
 
@@ -70,6 +80,16 @@ async function logSoapError (e) {
  **/
 function shouldAbortRetry (error) {
   try {
+    // Handle timeout errors - these should NOT abort retry, let them retry
+    if (error?.code === 'ETIMEDOUT' || error?.code === 'ECONNRESET' || error?.code === 'ECONNABORTED' || error?.message?.includes('timeout')) {
+      return false // Allow retry for timeout errors
+    }
+
+    // Handle cases where error doesn't have the expected structure
+    if (!error?.root?.Envelope?.Body?.Fault) {
+      return false // Let it retry for unexpected error structures
+    }
+
     const fault = error.root.Envelope.Body.Fault
     const details = fault.detail
     const blockedFaultStrings = [
@@ -144,21 +164,27 @@ async function createClientAsync (type) {
             soapOptions.auth = { login: soapOptions.auth.login, password: soapOptions.auth.password }
           }
 
-          const result = await pRetry(() => origMethod.apply(this, [soapOptions, { timeout: 30000, ...clientOptions }, ...args]), {
-            retries: 3,
-            onFailedAttempt: async error => {
-              if (shouldAbortRetry(error)) throw new AbortError(error)
-              console.log(`Attempt ${error.attemptNumber} failed. There are ${error.retriesLeft} retries left.`)
-            }
-          }).catch(e => {
+          try {
+            const result = await pRetry(() => origMethod.apply(this, [soapOptions, { timeout: 30000, ...clientOptions }, ...args]), {
+              retries: 3,
+              onFailedAttempt: async error => {
+                if (shouldAbortRetry(error)) throw new AbortError(error)
+                console.log(`Retrying ${String(prop)} in ${error.retriesLeft} attempts (${error.message})`)
+              }
+            })
+
+            performance.mark(endMark)
+            performance.measure(`  ⏱ SOAP: ${type} -> ${String(prop)}`, startMark, endMark)
+
+            if (!result || !result[0]) return
+            return result[0]?.return
+          } catch (e) {
             const soapError = e?.originalError?.root?.Envelope?.Body?.Fault
-            throw new Error(soapError?.faultstring || e.message)
-          })
-          performance.mark(endMark)
-          performance.measure(`  ⏱ SOAP: ${type} -> ${String(prop)}`, startMark, endMark)
-          // Return only the first result from the SOAP method call, as we don't need the SOAP envelope and other stuff.
-          if (!result || !result[0]) return
-          return result[0]?.return
+            if (soapError) {
+              throw new Error(`SOAP Fault: ${soapError.faultstring}`)
+            }
+            throw e
+          }
         }
       } else {
         return origMethod