@open-xchange/appsuite-codeceptjs 0.6.2 → 0.6.4

package/README.md

@@ -1,3 +1,72 @@
 # Open-Xchange App Suite: CodeceptJS
 
-TBD
+App Suite specific CodeceptJS tooling.
+
+## Custom Helpers
+
+The file `src/helpers.js` contains App Suite specific CodeceptJS helpers. It is possible to overwrite any of these helpers or add new ones in projects that use this package. This might be useful for maintenance work on existing helpers or when developing new ones and can be achieved with the following changes:
+
+```js
+// CodeceptJS configuration of a local package
+// file: e2e/codecept.conf.js
+
+const { config } = require('@open-xchange/appsuite-codeceptjs')
+
+// import local helpers
+config.helpers.AppSuite = {
+  require: './helper'
+}
+
+module.exports.config = config
+```
+
+```js
+// Local helpers
+// file: e2e/helper.js
+
+const Helper = require('@open-xchange/appsuite-codeceptjs/src/helper')
+
+class CustomHelper extends Helper {
+  // This overwrites the existing `selectFolder` helper
+  async selectFolder (locator) {
+    locator = '.folder-tree ' + locator
+    await this.helpers.Playwright.page.locator(locator).click()
+  }
+
+  // This creates the new helper `newCostumHelper`
+  async newCostumHelper () {
+    await this.helpers.Playwright.waitForVisible({ css: 'html.complete' }, 10)
+  }
+}
+
+module.exports = CustomHelper
+```
+
+## Local Configuration Overwrite
+
+You can use the config object for local customization of the default CodeceptJS configuration provided by this package. For example you can change the tests directory the following way:
+
+```js
+// CodeceptJS configuration of a local package
+// file: e2e/codecept.conf.js
+
+const { config } = require('@open-xchange/appsuite-codeceptjs')
+
+config.tests = './costum_directory/*_test.js'
+
+module.exports.config = config
+```
+
+## Known Issues
+
+Add this to your `package.json` to ignore CVE-2025-5889 when installing this package with `pnpm`:
+
+```
+"pnpm": {
+  "auditConfig": {
+    "ignoreCves": [
+      "CVE-2025-5889"
+    ]
+  }
+}
+```

package/container/Dockerfile

@@ -1 +1 @@
-FROM registry.gitlab.open-xchange.com/appsuite/web-foundation/base-images/playwright:v1.49.1-jammy
+FROM registry.gitlab.com/openxchange/appsuite/web-foundation/base-images/playwright:v1.53.0-jammy

package/eslint.config.mjs

@@ -48,7 +48,7 @@ export default [
     languageOptions: {
       globals: {
         ...codeceptjs[0].languageOptions.globals,
-        ...mocha.configs.flat.recommended.languageOptions.globals,
+        ...mocha.configs.recommended.languageOptions.globals,
         Feature: true,
         Scenario: true,
         Before: true,

package/global.d.ts

@@ -1,6 +1,3 @@
-/* eslint-disable no-var, camelcase, @typescript-eslint/no-unused-vars */
-// IMPORTANT: This solution only works by declaring variables with var (do not use let or const)
-var expect: Chai.ExpectStatic
-var assert: Chai.AssertStatic
-const codecept_dir: string
-const output_dir: string
+/* eslint-disable camelcase */
+declare const codecept_dir: string
+declare const output_dir: string

package/package.json

@@ -1,44 +1,48 @@
 {
   "name": "@open-xchange/appsuite-codeceptjs",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "description": "OX App Suite CodeceptJS Configuration and Helpers",
   "main": "index.js",
   "bin": {
     "e2e-rerun": "./customRerun.js"
   },
-  "repository": "https://gitlab.open-xchange.com/appsuite/web-foundation/tools.git",
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/openxchange/appsuite/web-foundation/tools",
+    "directory": "packages/appsuite-codeceptjs"
+  },
   "license": "AGPL-3.0-or-later",
   "private": false,
   "dependencies": {
     "@axe-core/playwright": "^4.10.1",
     "@codeceptjs/helper": "^2.0.4",
     "@influxdata/influxdb-client": "^1.35.0",
-    "@open-xchange/codecept-horizontal-scaler": "^0.1.11",
-    "@playwright/test": "1.49.1",
+    "@playwright/test": "1.53.0",
     "allure-codeceptjs": "2.15.1",
-    "chai": "^5.1.2",
-    "chai-subset": "^1.6.0",
+    "chai": "^5.2.0",
     "chalk": "^4.1.2",
     "chalk-table": "^1.0.2",
-    "codeceptjs": "3.6.10",
+    "codeceptjs": "3.7.3",
     "dotenv": "^16.4.7",
-    "mocha": "^11.0.1",
+    "mocha": "^11.1.0",
     "mocha-junit-reporter": "^2.2.1",
     "mocha-multi": "^1.1.7",
     "moment": "^2.30.1",
-    "moment-timezone": "^0.5.46",
+    "moment-timezone": "^0.6.0",
     "p-retry": "^6.2.1",
-    "playwright-core": "1.49.1",
+    "playwright-core": "1.53.0",
     "short-uuid": "^5.2.0",
-    "soap": "^1.1.7"
+    "@open-xchange/soap-client": "0.0.1",
+    "@open-xchange/codecept-horizontal-scaler": "0.1.12"
   },
   "devDependencies": {
-    "@types/node": "^22.10.2",
+    "@types/node": "^24.0.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.7.2",
+    "typescript": "^5.8.2",
     "@open-xchange/lint": "0.2.0"
   },
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "test": "mocha --color 'spec/**/*.test.js'"
   }
 }

package/pnpm-workspace.yaml

@@ -0,0 +1,4 @@
+packages:
+  - '../lint'
+  - '../soap-client'
+  - '../codecept-horizontal-scaler'

package/spec/pageobjects/calendar.test.js

@@ -0,0 +1,123 @@
+const { expect } = require('chai')
+const { getMonday } = require('../../src/pageobjects/util')
+const moment = require('moment')
+
+const FORMAT = 'YYYY-MM-DD'
+
+describe('Calendar', function () {
+  describe('getMonday()', function () {
+    describe('Week starts on Monday (locale=de)', function () {
+      it('should see the week starting on Monday (1)', function () {
+        expect(moment.localeData('de').firstDayOfWeek()).to.equal(1)
+      })
+      it('should return 2025-06-02 on 2025-06-06 (last Friday)', function () {
+        const date = moment('2025-06-06').locale('de')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-02')
+      })
+      it('should return 2025-06-02 on 2025-06-07 (Saturday)', function () {
+        const date = moment('2025-06-07').locale('de')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-02')
+      })
+      it('should return 2025-06-02 on 2025-06-08 (Sunday)', function () {
+        const date = moment('2025-06-08').locale('de')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-02')
+      })
+      it('should return 2025-06-09 on 2025-06-09 (Monday)', function () {
+        const date = moment('2025-06-09').locale('de')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-13 on 2025-06-09 (Friday)', function () {
+        const date = moment('2025-06-13').locale('de')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-02 on 2025-06-14 (next Saturday)', function () {
+        const date = moment('2025-06-14').locale('de')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-02 on 2025-06-15 (next Sunday)', function () {
+        const date = moment('2025-06-15').locale('de')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-02 on 2025-06-16 (next Monday)', function () {
+        const date = moment('2025-06-16').locale('de')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-16')
+      })
+    })
+
+    describe('Week starts on Sunday (locale=en)', function () {
+      it('should see the week starting on Sunday (0)', function () {
+        expect(moment.localeData('en').firstDayOfWeek()).to.equal(0)
+      })
+      it('should return 2025-06-02 on 2025-06-06 (last Friday)', function () {
+        const date = moment('2025-06-06').locale('en')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-02')
+      })
+      it('should return 2025-06-02 on 2025-06-07 (Saturday)', function () {
+        const date = moment('2025-06-07').locale('en')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-02')
+      })
+      it('should return 2025-06-09 on 2025-06-08 (Sunday)', function () {
+        const date = moment('2025-06-08').locale('en')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-09 on 2025-06-09 (Monday)', function () {
+        const date = moment('2025-06-09').locale('en')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-13 on 2025-06-09 (Friday)', function () {
+        const date = moment('2025-06-13').locale('en')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-02 on 2025-06-14 (next Saturday)', function () {
+        const date = moment('2025-06-14').locale('en')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-02 on 2025-06-15 (next Sunday)', function () {
+        const date = moment('2025-06-15').locale('en')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-16')
+      })
+      it('should return 2025-06-02 on 2025-06-16 (next Monday)', function () {
+        const date = moment('2025-06-16').locale('en')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-16')
+      })
+    })
+
+    describe('Week starts on Saturday (locale=tzm-latn)', function () {
+      it('should see the week starting on Saturday (6)', function () {
+        expect(moment.localeData('tzm-latn').firstDayOfWeek()).to.equal(6)
+      })
+      it('should return 2025-06-02 on 2025-06-06 (last Friday)', function () {
+        const date = moment('2025-06-06').locale('tzm-latn')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-02')
+      })
+      it('should return 2025-06-09 on 2025-06-07 (Saturday)', function () {
+        const date = moment('2025-06-07').locale('tzm-latn')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-09 on 2025-06-08 (Sunday)', function () {
+        const date = moment('2025-06-08').locale('tzm-latn')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-09 on 2025-06-09 (Monday)', function () {
+        const date = moment('2025-06-09').locale('tzm-latn')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-13 on 2025-06-09 (Friday)', function () {
+        const date = moment('2025-06-13').locale('tzm-latn')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-09')
+      })
+      it('should return 2025-06-02 on 2025-06-14 (next Saturday)', function () {
+        const date = moment('2025-06-14').locale('tzm-latn')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-16')
+      })
+      it('should return 2025-06-02 on 2025-06-15 (next Sunday)', function () {
+        const date = moment('2025-06-15').locale('tzm-latn')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-16')
+      })
+      it('should return 2025-06-02 on 2025-06-16 (next Monday)', function () {
+        const date = moment('2025-06-16').locale('tzm-latn')
+        expect(getMonday(date).format(FORMAT)).to.equal('2025-06-16')
+      })
+    })
+  })
+})

package/src/actor.js

@@ -107,7 +107,7 @@ module.exports = function () {
      *
      * @param {string} locator - The locator of the element. Only accepts css selectors.
      */
-    waitForFocus (locator) {
+    async waitForFocus (locator) {
       this.waitForElement(locator)
       this.waitForVisible(locator)
       return this.usePlaywrightTo('wait for focus', async ({ page }) => {

package/src/chai.js

@@ -19,9 +19,6 @@
  */
 
 import('chai').then(chai => {
-  const chaiSubset = require('chai-subset')
-  chai.use(chaiSubset)
-
   chai.util.addProperty(chai.Assertion.prototype, 'accessible', function () {
     const problems = ['\n', 'Accessibility Violations (' + this._obj.violations.length + ')', '---']
     const pad = '\n        '

package/src/contexts/contexts.js

@@ -22,7 +22,7 @@ const created = []
 const users = require('../users/users')()
 const util = require('../util')
 const event = require('../event')
-const contextService = require('../soap/services/context')
+const { contextService } = require('@open-xchange/soap-client/common')
 const crypto = require('node:crypto')
 
 class Context {

package/src/contexts/reseller.js

@@ -21,8 +21,7 @@
 const event = require('../event')
 const users = require('../users/reseller')()
 const util = require('../util')
-const resellerContextService = require('../soap/services/resellerContext')
-const resellerUserService = require('../soap/services/resellerUser')
+const { resellerContextService, resellerUserService } = require('@open-xchange/soap-client/reseller')
 const contexts = []
 const created = []
 

package/src/pageobjects/calendar.js

@@ -19,19 +19,21 @@
  */
 
 const { I, contactpicker, autocomplete, dialogs } = inject()
-const moment = require('moment')
+const { getMonday } = require('./util')
 
 module.exports = {
 
   editWindow: '.io-ox-calendar-edit-window',
   miniCalendar: '.window-sidepanel .date-picker',
   title: '[data-extension-point="io.ox/calendar/edit/section"] input[name="summary"]',
+  location: '[data-extension-point="io.ox/calendar/edit/section"] input[name="location"]',
+  description: '[data-extension-point="io.ox/calendar/edit/section"] textarea[name="description"]',
 
   async newAppointment () {
     I.wait(1)
     I.clickPrimary('New appointment')
     I.waitForVisible(this.editWindow)
-    await I.waitForFocus('.io-ox-calendar-edit-window input[type="text"][name="summary"]')
+    return I.waitForFocus('.io-ox-calendar-edit-window input[type="text"][name="summary"]')
   },
 
   clickAppointment (title, position = 1) {
@@ -43,9 +45,7 @@ module.exports = {
   },
 
   getNextMonday () {
-    // isoWeekday is Monday=1 ... Sunday=7
-    // 8 means next Monday; also over the weekend before
-    return moment().isoWeekday(8).set('hour', 8)
+    return getMonday().add(1, 'week').set('hour', 8)
   },
 
   startNextMonday () {
@@ -106,17 +106,14 @@ module.exports = {
     }, attr)
   },
 
-  async addParticipant (name, exists, context, addedParticipants) {
+  addParticipant (name, exists = true, context) {
     if (!context) context = '*'
-    if (!addedParticipants) addedParticipants = 1
 
     // does suggestion exists (for contact, user, ...)
-    exists = typeof exists === 'boolean' ? exists : true
-    const number = await I.grabNumberOfVisibleElements(locate('.attendee').inside(context).as('Attendee')) + addedParticipants
     const addParticipantsLocator = locate('.add-participant.tt-input').inside(context).as('Add participant field')
     // input field
     I.waitForVisible(addParticipantsLocator)
-    I.waitForEnabled(addParticipantsLocator)
+    // I.waitForEnabled(addParticipantsLocator)
     I.fillField(addParticipantsLocator, name)
     I.seeInField(addParticipantsLocator, name)
     // tokenfield/typeahead
@@ -128,7 +125,6 @@ module.exports = {
 
     I.waitForInvisible(autocomplete.suggestions)
     // note: might be more than one that get's added (group)
-    I.waitForElement(locate('.attendee').inside(context).at(number).as(`Attendee ${number}`))
   },
 
   async addParticipantByPicker (name) {
@@ -139,11 +135,18 @@ module.exports = {
   },
 
   switchView (view) {
+    const viewMap = {
+      Day: 'week:day',
+      Week: 'week:week',
+      Workweek: 'week:workweek',
+      Month: 'month',
+      List: 'list'
+    }
     I.waitForElement('.page.current .calendar-header > .dropdown button')
     I.click('.page.current .calendar-header > .dropdown button')
     I.waitForText(view, undefined, '.open .dropdown-menu')
     I.click(locate('.dropdown.open a').withText(view).as('Switch to ' + view))
-    I.wait(2)
+    I.waitForVisible(`.io-ox-pagecontroller.page.current[data-page-id="io.ox/calendar/${viewMap[view]}"]`)
   },
 
   getFullname (user) {
@@ -171,8 +174,8 @@ module.exports = {
 
       if (startDate) {
         I.click('~Date (M/D/YYYY)')
-        I.pressKey(['Control', 'a'])
-        I.pressKey(startDate)
+        I.pressKey(['CommandOrControl', 'a'])
+        I.type(startDate)
         I.pressKey('Enter')
       }
 
@@ -183,8 +186,8 @@ module.exports = {
 
       if (endDate) {
         I.click('~Date (M/D/YYYY)', '.dateinput[data-attribute="endDate"]')
-        I.pressKey(['Control', 'a'])
-        I.pressKey(startDate)
+        I.pressKey(['CommandOrControl', 'a'])
+        I.type(endDate)
         I.pressKey('Enter')
       }
 

package/src/pageobjects/contacts.js

@@ -23,6 +23,8 @@ const { I, dialogs } = inject()
 module.exports = {
 
   editWindow: '.io-ox-contacts-edit-window',
+  title: '.io-ox-contacts-edit-window input[name="title"]',
+  note: '.io-ox-contacts-edit-window textarea[name="note"]',
 
   selectContact (text) {
     I.waitForElement(`.vgrid [aria-label="${text}"]`)

package/src/pageobjects/mail.js

@@ -36,7 +36,6 @@ module.exports = {
     I.wait(1)
     I.click(item)
     await I.waitForFocus('.list-view li.list-item.selected')
-    I.waitForElement('.mail-detail-frame')
   },
   async selectMailByIndex (index) {
     const item = locate('.list-view li.list-item').withAttr({ 'data-index': index.toString() }).as('Mail item')

package/src/pageobjects/mobile/mobileContacts.js

@@ -26,8 +26,7 @@ module.exports = {
     I.wait(0.5) // prevent clicking a detached element caused by the bottom toolbar being re-rendered multiple times
     I.waitForElement('~New contact')
     I.click({ css: '[data-action="io.ox/contacts/actions/create"]' })
-    I.waitForElement('.io-ox-contacts-edit-window')
-    I.waitForVisible('.io-ox-contacts-edit-window.complete')
+    I.waitForVisible('.io-ox-contacts-edit-window input[name="first_name"]')
     I.waitForText('Add personal info')
   },
 

package/src/{soap/services/oxaas.js → pageobjects/util.js}

@@ -18,19 +18,17 @@
  * Any use of the work other than as authorized under this license or copyright law is prohibited.
  */
 
-const { createClientAsync } = require('../soap.js')
-
-const OXaaSService = createClientAsync('OXaaSService').then(client => client)
-
-async function setMailQuota (data) {
-  return await (await OXaaSService).setMailQuotaAsync(data)
-}
-
-async function createSharedDomain (data) {
-  return await (await OXaaSService).createSharedDomain(data)
-}
+const moment = require('moment')
 
 module.exports = {
-  setMailQuota,
-  createSharedDomain
+
+  // return the (standard) workweek start on the current week depending on the locale
+  getMonday (date = moment()) {
+    // robust approach that also works:
+    // a) over the weekend (!)
+    // b) if firstDayOfWeek is Sunday or Saturday
+    const firstDayOfWeek = moment.localeData(date.locale()).firstDayOfWeek()
+    const localeWeekday = (8 - firstDayOfWeek) % 7
+    return date.startOf('week').weekday(localeWeekday)
+  }
 }

package/src/users/reseller.js

@@ -25,8 +25,7 @@ const usersToRemove = []
 const preprovisionedUsers = []
 const util = require('../util')
 const short = require('short-uuid')
-const resellerUserService = require('../soap/services/resellerUser')
-const oxaasService = require('../soap/services/oxaas')
+const { resellerUserService, oxaasService } = require('@open-xchange/soap-client/reseller')
 
 class User {
   constructor (opt) {

package/src/users/users.js

@@ -24,7 +24,7 @@ const event = require('../event')
 const users = []
 const util = require('../util')
 const short = require('short-uuid')
-const userService = require('../soap/services/user')
+const { userService } = require('@open-xchange/soap-client/common')
 
 class User {
   constructor (opt) {

package/src/util.js

@@ -20,7 +20,7 @@
 
 const codecept = require('codeceptjs')
 const url = require('node:url')
-const { getFilestorageId } = require('./soap/services/util')
+const { getFilestorageId } = require('@open-xchange/soap-client/common')
 
 module.exports = {
 

package/chai.d.ts

@@ -1,5 +0,0 @@
-declare module Chai {
-  interface Assertion {
-    accessible: void;
-  }
-}

package/src/chai.d.ts

@@ -1,6 +0,0 @@
-declare module Chai {
-  interface Assertion {
-    accessible: void;
-  }
-}
-export {}

package/src/soap/services/context.js

@@ -1,170 +0,0 @@
-/**
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- */
-
-const { createClientAsync, logSoapError } = require('../soap.js')
-
-const OXContextService = createClientAsync('OXContextService').then(client => client)
-
-/**
- * This function retrieves the default context from the OXContextService.
- * @returns {Promise<Object>} The first result from the listAsync method call.
- */
-async function getDefault () {
-  return (await (await OXContextService).listAsync({ search_pattern: 'defaultcontext' }))[0]
-}
-
-/**
- * This function removes the context with the specified ID.
- * @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
- */
-async function remove (id) {
-  return !!await (await OXContextService).deleteAsync({ ctx: { id } }).then(() => true).catch(logSoapError)
-}
-
-/**
- * This function creates a new context.
- * @param {Object} ctx The context to create.
- * @param {Object} adminUser The admin user of the context.
- *    Defaults to:
- *    ```JSON
- *    {
-        name: 'oxadmin',
-        password: 'secret',
-        display_name: 'context admin',
-        sur_name: 'admin',
-        given_name: 'context',
-        email1: `oxadmin@${process.env.MX_DOMAIN}`,
-        primaryEmail: `oxadmin@${process.env.MX_DOMAIN}`
-      }
-      All properties are needed and will be inserted if not provided.
-      ```
- * @returns {Promise<Object>} The created context.
- */
-async function create (ctx = {}, adminUser = {}) {
-  return await (await OXContextService)
-    .createAsync({
-      ctx,
-      admin_user: Object.assign({
-        name: 'oxadmin',
-        password: 'secret',
-        display_name: 'context admin',
-        sur_name: 'admin',
-        given_name: 'context',
-        email1: `oxadmin@${process.env.MX_DOMAIN}`,
-        primaryEmail: `oxadmin@${process.env.MX_DOMAIN}`
-      }, adminUser)
-    })
-    .then(async context => {
-      await changeModuleAccessByName(context.id, 'all')
-      return context
-    })
-    .catch(e => {
-      logSoapError(e)
-      throw e
-    })
-}
-
-/**
- * This function changes the module access of the specified context.
- * @param {number} id The ID of the context.
- * @param {string} access_combination_name The name of the access combination to set.
- * @returns {Promise<void>}
- */
-// eslint-disable-next-line camelcase
-async function changeModuleAccessByName (id, access_combination_name) {
-  // eslint-disable-next-line camelcase
-  return await (await OXContextService).changeModuleAccessByNameAsync({ ctx: { id }, access_combination_name })
-}
-
-/**
- * This function changes the capabilities of the specified context.
- * @param {number} id The ID of the context.
- * @param {string} capsToAdd The capabilities to add.
- * @param {string} capsToRemove The capabilities to remove.
- * @returns {Promise<void>}
- */
-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 })
-}
-
-/**
- * This function retrieves the module access of the specified context.
- * @param {number} id The ID of the context.
- * @returns {Promise<Object>} The module access of the specified context.
- */
-async function getModuleAccess (id) {
-  return await (await OXContextService).getModuleAccessAsync({ ctx: { id } })
-}
-/**
- * This function changes the module access of the specified context.
- * @param {number} id The ID of the context.
- * @param {Object} moduleAccess The module access to set.
- * @returns {Promise<void>}
- */
-async function changeModuleAccess (id, moduleAccess) {
-  const currentAccess = await getModuleAccess(id)
-  return await (await OXContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...moduleAccess } })
-}
-
-/**
- * Search for contexts.
- * @param {String} searchPattern The pattern to search for
- * @param {Object} options Additional options
- * @param {Boolean} options.excludeDisabled Exclude disabled contexts from the search results (default: true)
- * @returns {Promise<Array<Object>>} The list of contexts that match the search pattern.
- */
-async function list (searchPattern, { excludeDisabled } = { excludeDisabled: true }) {
-  return await (await OXContextService).listAsync({ search_pattern: searchPattern, exclude_disabled: excludeDisabled })
-}
-
-/**
- * This function retrieves the context with the specified ID.
- * @param {number} id The ID of the context to retrieve.
- * @returns {Promise<Object>} The context with the specified ID.
- */
-async function get (id) {
-  return await (await OXContextService).getDataAsync({ ctx: { id } })
-}
-
-/**
- * This function changes the context with the specified ID.
- * @param {Object} ctx The context to change.
- * @returns {Promise<void>}
- */
-async function change (ctx) {
-  return await (await OXContextService).changeAsync({ ctx })
-}
-
-module.exports = {
-  getDefault,
-  remove,
-  create,
-  changeModuleAccessByName,
-  changeCapabilities,
-  getModuleAccess,
-  changeModuleAccess,
-  get,
-  list,
-  change
-}

package/src/soap/services/resellerContext.js

@@ -1,65 +0,0 @@
-/**
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- */
-
-const { createClientAsync, logSoapError } = require('../soap.js')
-
-const OXResellerContextService = createClientAsync('OXResellerContextService').then(client => client)
-
-async function create (data) {
-  return await (await OXResellerContextService).createAsync(data)
-}
-
-async function remove (contextId) {
-  return !!await (await OXResellerContextService).deleteAsync({
-    ctx: { id: contextId }
-  }).then(() => true).catch(logSoapError)
-}
-
-async function change (ctx) {
-  return await (await OXResellerContextService).changeAsync({ ctx })
-}
-
-async function get (id) {
-  return await (await OXResellerContextService).getDataAsync({ ctx: { id } })
-}
-
-async function getModuleAccess (id) {
-  return await (await OXResellerContextService).getModuleAccessAsync({ ctx: id })
-}
-
-async function changeModuleAccess (id, access) {
-  const currentAccess = await getModuleAccess(id)
-
-  return await (await OXResellerContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...access } })
-}
-
-async function listAll (data) {
-  return await (await OXResellerContextService).listAllAsync(data)
-}
-
-module.exports = {
-  create,
-  remove,
-  change,
-  get,
-  getModuleAccess,
-  changeModuleAccess,
-  listAll
-}

package/src/soap/services/resellerUser.js

@@ -1,100 +0,0 @@
-/**
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- */
-
-const { createClientAsync, logSoapError } = require('../soap.js')
-
-const OXResellerUserService = createClientAsync('OXResellerUserService').then(client => client)
-
-async function remove (contextId, userId) {
-  return !!await (await OXResellerUserService).deleteAsync({
-    ctx: { id: contextId },
-    user: { id: userId }
-  }).then(() => true).catch(logSoapError)
-}
-
-/**
- * This function changes the context with the specified ID.
- * @param {Object} context The context of the user to be changed.
- * @param {Object} usrdata The user to change.
- * @returns {Promise<void>}
- */
-async function change (context, usrdata) {
-  return await (await OXResellerUserService).changeAsync({
-    ctx: { id: context.id },
-    usrdata,
-    auth: { login: context.admin.name, password: context.admin.password }
-  })
-}
-
-async function get (data) {
-  return await (await OXResellerUserService).getDataAsync(data)
-}
-
-async function getModuleAccess (context, userId) {
-  return await (await OXResellerUserService).getModuleAccessAsync({
-    ctx: { id: context.id },
-    user: { id: userId },
-    auth: { login: context.admin.name, password: context.admin.password }
-  }).then(
-    (res) => res
-  )
-}
-
-async function changeByModuleAccess (context, userId, currentAccess, moduleAccess) {
-  return await (await OXResellerUserService).changeByModuleAccessAsync({
-    ctx: { id: context.id },
-    moduleAccess: Object.assign({}, currentAccess, moduleAccess),
-    user: { id: userId },
-    auth: { login: context.admin.name, password: context.admin.password }
-  })
-}
-
-async function changeByModuleAccessName (context, userId, accessCombinationName) {
-  return await (await OXResellerUserService).changeByModuleAccessNameAsync({
-    ctx: { id: context.id },
-    access_combination_name: accessCombinationName,
-    user: { id: userId },
-    auth: { login: context.admin.name, password: context.admin.password }
-  }).catch(error => console.error('Module access change error: ', error))
-}
-
-async function createByModuleAccessName (context, usrdata) {
-  return await (await OXResellerUserService).createByModuleAccessNameAsync({
-    ctx: { id: context.id },
-    usrdata,
-    access_combination_name: 'all',
-    auth: { login: context.admin.name, password: context.admin.password }
-  })
-}
-
-async function listAll (data) {
-  return await (await OXResellerUserService).listAllAsync(data)
-}
-
-module.exports = {
-  remove,
-  change,
-  get,
-  getModuleAccess,
-  changeByModuleAccess,
-  changeByModuleAccessName,
-  createByModuleAccessName,
-  listAll
-}

package/src/soap/services/user.js

@@ -1,114 +0,0 @@
-/**
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- */
-
-const { createClientAsync, logSoapError } = require('../soap.js')
-
-const OXUserService = createClientAsync('OXUserService').then(client => client)
-
-/**
- * This function removes the user with the specified context and user ID.
- * @param {Object} context The context of the user to be removed.
- * @param {number} userId The ID of the user to be removed.
- * @returns {Promise<Boolean>} Returns true if it could remove the user and false if it could not
- */
-async function remove (context, userId) {
-  return !!await (await OXUserService).deleteAsync({
-    ctx: { id: context.id },
-    user: { id: userId },
-    auth: context.admin
-  }).then(() => true).catch(logSoapError)
-}
-
-/**
- * This function creates a new user.
- * @param {Object} context The context of the user to be created.
- * @param {Object} usrdata The user to create.
- * @returns {Promise<Object>} The created user.
- */
-async function create (context, usrdata) {
-  return await (await OXUserService).createAsync({
-    ctx: { id: context.id },
-    usrdata,
-    auth: context.admin
-  })
-}
-
-/**
- * This function changes the context with the specified ID.
- * @param {Object} context The context of the user to be changed.
- * @param {Object} usrdata The user to change.
- * @returns {Promise<void>}
- */
-async function change (context, usrdata) {
-  return await (await OXUserService).changeAsync({
-    ctx: { id: context.id },
-    usrdata,
-    auth: context.admin
-  })
-}
-
-async function changeByModuleAccess (context, userId, currentAccess, moduleAccess) {
-  return await (await OXUserService).changeByModuleAccessAsync({
-    ctx: { id: context.id },
-    moduleAccess: Object.assign({}, currentAccess, moduleAccess),
-    user: { id: userId },
-    auth: context.admin
-  })
-}
-
-async function changeByModuleAccessName (context, userId, accessCombinationName) {
-  return await (await OXUserService).changeByModuleAccessNameAsync({
-    ctx: { id: context.id },
-    access_combination_name: accessCombinationName,
-    user: { id: userId },
-    auth: context.admin
-  }).catch(error => console.error('Module access change error:', error))
-}
-
-async function getModuleAccess (context, userId) {
-  return await (await OXUserService).getModuleAccessAsync({
-    ctx: { id: context.id },
-    user: { id: userId },
-    auth: context.admin
-  }).then(
-    (res) => res
-  )
-}
-
-async function changeCapabilities (context, userId, capsToAdd, capsToRemove) {
-  const data = {
-    ctx: { id: context.id },
-    user: { id: userId },
-    auth: context.admin
-  }
-  if (capsToAdd) data.capsToAdd = capsToAdd
-  if (capsToRemove) data.capsToRemove = capsToRemove
-  return await (await OXUserService).changeCapabilitiesAsync(data)
-}
-
-module.exports = {
-  create,
-  change,
-  changeByModuleAccess,
-  changeByModuleAccessName,
-  changeCapabilities,
-  getModuleAccess,
-  remove
-}

package/src/soap/services/util.js

@@ -1,39 +0,0 @@
-/**
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- */
-
-const { createClientAsync } = require('../soap.js')
-
-/**
- * This function retrieves the ID of the first filestorage.
- * @returns {Promise<number>} The ID of the first filestorage.
- */
-let fileStoreId
-
-async function getFilestorageId () {
-  const OXUtilService = createClientAsync('OXUtilService').then(client => client)
-
-  if (fileStoreId) return fileStoreId
-  fileStoreId = (await (await OXUtilService).listFilestoreAsync())[0]?.id
-  return fileStoreId
-}
-
-module.exports = {
-  getFilestorageId
-}

package/src/soap/soap.js

@@ -1,176 +0,0 @@
-/**
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- */
-
-const { performance, PerformanceObserver } = require('node:perf_hooks')
-const SOAP = require('soap')
-const dotenv = require('dotenv')
-
-let AbortError
-const pRetry = import('p-retry').then(module => {
-  AbortError = module.AbortError
-  return module.default
-})
-
-dotenv.config({ path: '.env' })
-dotenv.config({ path: '.env.defaults' })
-
-// This flag enables debug output including timing information.
-const debug = process.env.DEBUG_SOAP === 'true'
-
-// This URL is used to create the SOAP client.
-const provisioningUrl = String(process.env.PROVISIONING_URL).replace(/\/$/, '')
-
-// This user is used to authenticate against the provisioning API.
-const provisioningAuth = {
-  auth: {
-    login: process.env.E2E_ADMIN_USER,
-    password: process.env.E2E_ADMIN_PW
-  }
-}
-
-/**
- * This code creates a PerformanceObserver instance which asynchronously observes
- * performance measurement events. It logs the name of the event (which is the name
- * of the SOAP method in this context) and the time it took to execute in milliseconds.
- *
- * This is used for performance tracking of the SOAP methods.
- * @see https://nodejs.org/api/perf_hooks.html
- * @params {PerformanceObserverEntryList} items The list of performance entries.
- * @returns {void}
- */
-const obs = new PerformanceObserver((items) => {
-  items.getEntries().forEach((entry) => {
-    if (debug) console.log(`${entry.name} took ${Math.round(entry.duration)}ms`)
-  })
-})
-obs.observe({ entryTypes: ['measure'] })
-
-async function logSoapError (e) {
-  console.error(e?.originalError?.root?.Envelope?.Body?.Fault?.faultstring || e.message)
-}
-
-/**
- * This function checks if the specified error should abort the retry.
- * @param {Error} error The error to check.
- * @returns {boolean} True if the error should abort the retry, false otherwise.
- **/
-function shouldAbortRetry (error) {
-  try {
-    const fault = error.root.Envelope.Body.Fault
-    const details = fault.detail
-    const blockedFaultStrings = [
-      /Context \d+ already exists/,
-      /Authentication failed/,
-      /Context \d+ does not exist/,
-      /CloudPluginException: username .* already exists/,
-      /CloudPluginException: context name must begin/,
-      /The displayname is already used/,
-      /already exists in this context/,
-      /Shared Domain already exists/,
-      /Shared Domain already in use/,
-      /No such user/,
-      /Mandatory fields in context not set/,
-      /A mapping with login info .* already exists/,
-      /Id must not be set if pre-assembled context should be used/,
-      /Unmarshalling Error/
-    ]
-    const blockedExceptions = [
-      'ContextExistsException',
-      'InvalidCredentialsException',
-      'NoSuchContextException'
-    ]
-    // return "details object contains any of the blocked items"
-    return blockedFaultStrings.some(msg => msg.test(fault.faultstring)) ||
-      blockedExceptions.some(exception => Object.hasOwnProperty.call(details, exception))
-  } catch (e) {
-    // some other error which is never blocked
-    return false
-  }
-}
-
-/**
- * This function creates a SOAP client for the specified service type.
- * @param {string} type The name of the service type.
- * @returns {Promise<Object>} The SOAP client.
- */
-async function createClientAsync (type) {
-  const startMark = `${type}-start`
-  const endMark = `${type}-end`
-  performance.mark(startMark)
-  const endpoint = `${provisioningUrl}/webservices/${type}`
-  const url = `${endpoint}/?wsdl`
-  const client = await SOAP.createClientAsync(url, {
-    endpoint,
-    suppressStack: true,
-    wsdl_options: {
-      forever: true
-    },
-    gzip: true
-  })
-
-  // https://stackoverflow.com/questions/30740415/namespace-for-array-field-in-node-soap-client-node-js
-  client.wsdl.definitions.xmlns.ns1 = 'http://dataobjects.soap.admin.openexchange.com/xsd'
-  client.wsdl.xmlnsInEnvelope = client.wsdl._xmlnsMap()
-  performance.mark(endMark)
-  performance.measure(`  ⏱ SOAP: ${type} -> createClientAsync`, startMark, endMark)
-
-  // This proxy effectively adds error handling, authentication and performance measurements to all methods of the SOAP client.
-  return new Proxy(client, {
-    get (target, prop, receiver) {
-      const origMethod = Reflect.get(target, prop, receiver)
-      if (typeof origMethod === 'function') {
-        return async function (options, clientOptions, ...args) {
-          const startMark = `${prop}-start`
-          const endMark = `${prop}-end`
-          performance.mark(startMark)
-          const soapOptions = { ...provisioningAuth, ...options }
-          if (soapOptions.auth) {
-            // only send login and password instead of complete admin object.
-            // this can fail because of ambiguous namespacing
-            soapOptions.auth = { login: soapOptions.auth.login, password: soapOptions.auth.password }
-          }
-
-          const result = await (await pRetry)(() => origMethod.apply(this, [soapOptions, { timeout: 10000, ...clientOptions }, ...args]), {
-            retries: 3,
-            onFailedAttempt: async error => {
-              if (shouldAbortRetry(error)) throw new (await AbortError)(error)
-              console.log(`Attempt ${error.attemptNumber} failed. There are ${error.retriesLeft} retries left.`)
-            }
-          }).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
-        }
-      } else {
-        return origMethod
-      }
-    }
-  })
-}
-
-module.exports = {
-  createClientAsync,
-  logSoapError
-}