ui5-test-runner 5.0.0 → 5.1.0

package/jest.config.json

@@ -0,0 +1,27 @@
+{
+  "testTimeout": 15000,
+  "setupFilesAfterEnv": [
+    "./test/setup.js"
+  ],
+  "testPathIgnorePatterns": [
+    "/node_modules/",
+    "/capabilities/"
+  ],
+  "collectCoverage": true,
+  "collectCoverageFrom": [
+    "src/*.js"
+  ],
+  "coveragePathIgnorePatterns": [
+    "\\.spec\\.js",
+    "output\\.js",
+    "b\\capabilities\\b"
+  ],
+  "coverageThreshold": {
+    "global": {
+      "branches": 80,
+      "functions": 80,
+      "lines": 80,
+      "statements": 80
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui5-test-runner",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "Standalone test runner for UI5",
   "main": "index.js",
   "bin": {
@@ -21,7 +21,7 @@
     "test:report": "node ./src/defaults/report.js ./test/report && reserve --config ./test/report/reserve.json",
     "test:text-report": "node ./src/defaults/text-report.js ./test/report",
     "build:doc": "node build/doc",
-    "clean": "npm uninstall -g ui5-test-runner puppeteer nyc selenium-webdriver playwright webdriverio"
+    "clean": "npm uninstall -g ui5-test-runner puppeteer nyc selenium-webdriver playwright webdriverio jsdom"
   },
   "repository": {
     "type": "git",
@@ -43,25 +43,24 @@
   },
   "homepage": "https://github.com/ArnaudBuchholz/ui5-test-runner#readme",
   "dependencies": {
-    "commander": "^12.0.0",
-    "mime": "^3.0.0",
+    "commander": "^12.1.0",
     "punybind": "^1.2.1",
     "punyexpr": "^1.0.4",
-    "reserve": "^1.15.9"
+    "reserve": "2.0.1"
   },
   "devDependencies": {
-    "@openui5/types": "^1.123.0",
-    "@ui5/cli": "^3.10.0",
+    "@openui5/types": "^1.124.0",
+    "@ui5/cli": "^3.10.3",
     "@ui5/middleware-code-coverage": "^1.1.1",
     "dotenv": "^16.4.5",
     "jest": "^29.7.0",
     "nock": "^13.5.4",
     "nyc": "^15.1.0",
-    "rimraf": "^5.0.5",
+    "rimraf": "^5.0.7",
     "standard": "^17.1.0",
     "start-server-and-test": "^2.0.3",
     "typescript": "^5.4.5",
-    "ui5-tooling-transpile": "^3.4.0"
+    "ui5-tooling-transpile": "^3.4.2"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.3"
@@ -77,32 +76,5 @@
       "sap",
       "opaTest"
     ]
-  },
-  "jest": {
-    "testTimeout": 15000,
-    "setupFilesAfterEnv": [
-      "./test/setup.js"
-    ],
-    "testPathIgnorePatterns": [
-      "/node_modules/",
-      "/capabilities/"
-    ],
-    "collectCoverage": true,
-    "collectCoverageFrom": [
-      "src/*.js"
-    ],
-    "coveragePathIgnorePatterns": [
-      "\\.spec\\.js",
-      "output\\.js",
-      "b\\capabilities\\b"
-    ],
-    "coverageThreshold": {
-      "global": {
-        "branches": 80,
-        "functions": 80,
-        "lines": 80,
-        "statements": 80
-      }
-    }
   }
 }

package/src/capabilities/index.js

@@ -62,17 +62,23 @@ async function capabilities (job) {
             const listener = listeners[listenerIndex]
             await listener({
               endpoint,
-              body: JSON.parse(await body(request))
+              body: await body(request).json()
             })
             response.writeHead(200)
             response.end()
           }
         }, {
           match: '^/inject/(.*)',
-          file: join(__dirname, '../inject/$1')
+          cwd: join(__dirname, '../inject'),
+          file: '$1',
+          static: !job.debugDevMode
         }, {
           match: '^/(.*)',
-          file: join(__dirname, '$1')
+          cwd: __dirname,
+          file: '$1',
+          static: !job.debugDevMode
+        }, {
+          status: 404
         }]
     })
     const server = serve(configuration)

package/src/coverage.js

@@ -202,7 +202,7 @@ async function checkAllSourcesAreAvailable (job, coverageFilename) {
   output.debug('coverage', 'Checking remote source files...')
   const coverageData = require(coverageFilename)
   const filenames = Object.keys(coverageData)
-  let changes = 0
+  let changes = false
   let basePath
   for (const filename of filenames) {
     const fileData = coverageData[filename]
@@ -213,7 +213,12 @@ async function checkAllSourcesAreAvailable (job, coverageFilename) {
     }
     if (filePath && filePath !== fileData.path) {
       fileData.path = filePath
-      ++changes
+      changes = true
+    }
+    if (filename !== filePath) {
+      delete coverageData[filename]
+      coverageData[filePath] = fileData
+      changes = true
     }
     const fileFolder = dirname(filePath)
     if (basePath === undefined) {
@@ -229,7 +234,7 @@ async function checkAllSourcesAreAvailable (job, coverageFilename) {
     job.nycSettings.cwd = basePath
     await writeFile(job[$nycSettingsPath], JSON.stringify(job.nycSettings))
   }
-  if (changes > 0) {
+  if (changes) {
     await writeFile(coverageFilename, JSON.stringify(coverageData))
   }
 }
@@ -292,8 +297,8 @@ module.exports = {
     const instrumentedBasePath = join(job.coverageTempDir, 'instrumented')
     const instrumentedMapping = {
       match: /(.*\.js)(\?.*)?$/,
-      file: join(instrumentedBasePath, '$1'),
-      'ignore-if-not-found': true
+      cwd: instrumentedBasePath,
+      file: '$1'
     }
     if (job.mode === 'legacy' || job[$remoteOnLegacy]) {
       return [{

package/src/defaults/jsdom/compatibility.js

@@ -8,32 +8,64 @@ function fakeMatchMedia () {
   }
 }
 
-function wrapXHR (window, networkWriter) {
-  const { XMLHttpRequest } = window
-  const { open } = XMLHttpRequest.prototype
+function wrapXHR ({ XMLHttpRequest }) {
+  const { open, send } = XMLHttpRequest.prototype
+  const $async = Symbol('async')
   XMLHttpRequest.prototype.open = function (...args) {
-    const [method, url] = args
+    const [method, url, async] = args
     const log = () => {
       const { status } = this
-      networkWriter.append({
+      console.log(JSON.stringify({
+        timestamp: new Date().toISOString(),
+        channel: 'network',
+        initiator: 'xhr',
         method,
         url,
+        async,
         status
-      })
+      }))
     }
     this.addEventListener('load', log)
     this.addEventListener('error', log)
+    if (async === false) {
+      this[$async] = { method, url }
+    }
     return open.call(this, ...args)
   }
+  XMLHttpRequest.prototype.send = function (...args) {
+    if (this[$async]) {
+      const { method, url } = this[$async]
+      console.log(JSON.stringify({
+        timestamp: new Date().toISOString(),
+        channel: 'debug',
+        message: '>> XMLHttpRequest.prototype.send',
+        method,
+        url,
+        async: false
+      }))
+    }
+    const result = send.call(this, ...args)
+    if (this[$async]) {
+      const { method, url } = this[$async]
+      console.log(JSON.stringify({
+        timestamp: new Date().toISOString(),
+        channel: 'debug',
+        message: '<< XMLHttpRequest.prototype.send',
+        method,
+        url,
+        async: false
+      }))
+    }
+    return result
+  }
 }
 
-function adjustXPathResult (window) {
+function adjustXPathResult ({ Document }) {
   /* https://ui5.sap.com/resources/sap/ui/model/odata/AnnotationParser-dbg.js
      getXPath: function() {
        xmlNodes.length = xmlNodes.snapshotLength;
   */
-  const { Document } = window
-  const evaluate = Document.prototype.evaluate
+  const { evaluate } = Document.prototype
   Document.prototype.evaluate = function () {
     const result = evaluate.apply(this, arguments)
     let length = result.length
@@ -48,10 +80,10 @@ function adjustXPathResult (window) {
   }
 }
 
-function fixMatchesDontThrow (window) {
-  // https://github.com/jsdom/jsdom/issues/3057
-  // Fix _nwsapiDontThrow which throws :-(
-  const { document } = window
+function fixMatchesDontThrow ({ document }) {
+  /* https://github.com/jsdom/jsdom/issues/3057
+     Fix _nwsapiDontThrow which throws :-(
+  */
   const [impl] = Object.getOwnPropertySymbols(document)
   const documentImpl = document[impl]
   let _nwsapiDontThrow
@@ -74,10 +106,45 @@ function fixMatchesDontThrow (window) {
   })
 }
 
-module.exports = ({
-  window,
-  networkWriter
-}) => {
+function fixCaseSensitiveSelectors ({ Document }) {
+  /* https://github.com/SAP/openui5/blob/f41ed5504db1dc576dae7e7d403aaa02b918fef5/src/sap.ui.core/src/ui5loader-autoconfig.js#L75
+     oResult = check(globalThis.document.querySelector('SCRIPT[src][id=sap-ui-bootstrap]'), rResources);
+     jsdom uses case sensitive implementation of querySelector
+  */
+  const uppercaseTag = /\bSCRIPT\b/g
+  const { querySelector, querySelectorAll } = Document.prototype
+  Object.assign(Document.prototype, {
+    querySelector (selectors) {
+      const result = querySelector.call(this, selectors) || { length: 0 }
+      if (result.length === 0 && selectors.match(uppercaseTag)) {
+        console.log(JSON.stringify({
+          timestamp: new Date().toISOString(),
+          channel: 'debug',
+          message: 'overriding selectors upon empty result of document.querySelector',
+          selectors
+        }))
+        return querySelector.call(this, selectors.replace(uppercaseTag, tag => tag.toLowerCase()))
+      }
+      return result
+    },
+
+    querySelectorAll (selectors) {
+      const result = querySelectorAll.call(this, selectors) || { length: 0 }
+      if (result.length === 0 && selectors.match(uppercaseTag)) {
+        console.log(JSON.stringify({
+          timestamp: new Date().toISOString(),
+          channel: 'debug',
+          message: 'overriding selectors upon empty result of document.querySelectorAll',
+          selectors
+        }))
+        return querySelectorAll.call(this, selectors.replace(uppercaseTag, tag => tag.toLowerCase()))
+      }
+      return result
+    }
+  })
+}
+
+module.exports = window => {
   window.addEventListener('error', event => {
     const { message, filename, lineno, colno } = event
     window.console.error(`${filename}@${lineno}:${colno}: ${message}`)
@@ -89,7 +156,8 @@ module.exports = ({
   }
   window.matchMedia = window.matchMedia || fakeMatchMedia
 
-  wrapXHR(window, networkWriter)
+  wrapXHR(window)
   adjustXPathResult(window)
   fixMatchesDontThrow(window)
+  fixCaseSensitiveSelectors(window)
 }

package/src/defaults/jsdom/resource-loader.js

@@ -1,8 +1,4 @@
-module.exports = ({
-  jsdom,
-  networkWriter,
-  consoleWriter
-}) => {
+module.exports = jsdom => {
   const { ResourceLoader: JSDOMResourceLoader } = jsdom
 
   const { readFile } = require('fs/promises')
@@ -15,19 +11,24 @@ module.exports = ({
         const { response } = request
         let status
         if (response === undefined) {
-          consoleWriter.append({
+          console.log(JSON.stringify({
+            timestamp: new Date().toISOString(),
+            channel: 'console',
             type: 'error',
             message: 'NETWORK ERROR : ' + (reason ? reason.toString() : 'unknown reason')
-          })
+          }))
           status = 599
         } else {
           status = response.statusCode
         }
-        networkWriter.append({
+        console.log(JSON.stringify({
+          timestamp: new Date().toISOString(),
+          channel: 'network',
+          initiator: 'resource-loader',
           method: 'GET',
           url,
           status
-        })
+        }))
       }
       request.then(log, log)
       if (url.match(/sap\/ui\/test\/matchers\/Visible(-dbg)?.js/)) {

package/src/defaults/jsdom.js

@@ -11,24 +11,42 @@ require('./browser')({
     capabilities: {
       modules: ['jsdom'],
       scripts: true,
-      traces: ['console', 'network']
+      traces: ['multiplex']
     }
   },
 
   async run ({
     settings: { url, scripts, modules },
-    options,
-    consoleWriter,
-    networkWriter
+    options
   }) {
     const jsdom = require(modules.jsdom)
     const { JSDOM, VirtualConsole } = jsdom
 
     const virtualConsole = new VirtualConsole()
-    virtualConsole.on('error', (...args) => consoleWriter.append({ type: 'error', text: args.join(' ') }))
-    virtualConsole.on('warn', (...args) => consoleWriter.append({ type: 'warning', text: args.join(' ') }))
-    virtualConsole.on('info', (...args) => consoleWriter.append({ type: 'info', text: args.join(' ') }))
-    virtualConsole.on('log', (...args) => consoleWriter.append({ type: 'log', text: args.join(' ') }))
+    virtualConsole.on('error', (...args) => console.log(JSON.stringify({
+      timestamp: new Date().toISOString(),
+      channel: 'console',
+      type: 'error',
+      message: args.join(' ')
+    })))
+    virtualConsole.on('warn', (...args) => console.log(JSON.stringify({
+      timestamp: new Date().toISOString(),
+      channel: 'console',
+      type: 'warning',
+      message: args.join(' ')
+    })))
+    virtualConsole.on('info', (...args) => console.log(JSON.stringify({
+      timestamp: new Date().toISOString(),
+      channel: 'console',
+      type: 'info',
+      message: args.join(' ')
+    })))
+    virtualConsole.on('log', (...args) => console.log(JSON.stringify({
+      timestamp: new Date().toISOString(),
+      channel: 'console',
+      type: 'log',
+      message: args.join(' ')
+    })))
 
     let mainWindow
 
@@ -41,7 +59,7 @@ require('./browser')({
           writable: false
         })
       }
-      require('./jsdom/compatibility')({ window, networkWriter })
+      require('./jsdom/compatibility')(window)
       if (options.debug) {
         require('./jsdom/debug')(window)
       }
@@ -64,11 +82,7 @@ require('./browser')({
       runScripts: 'dangerously',
       pretendToBeVisual: true,
       virtualConsole,
-      resources: require('./jsdom/resource-loader')({
-        jsdom,
-        networkWriter,
-        consoleWriter
-      }),
+      resources: require('./jsdom/resource-loader')(jsdom),
       beforeParse
     })
   }

package/src/endpoints.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { join } = require('path')
+const { join, dirname, basename } = require('path')
 const { body } = require('reserve')
 const { extractPageUrl } = require('./tools')
 const { Request, Response } = require('reserve')
@@ -18,7 +18,7 @@ const punybindBinPath = join(resolveDependencyPath('punybind'), 'dist/punybind.j
 module.exports = job => {
   async function endpointImpl (api, implementation, request) {
     const url = extractPageUrl(request.headers)
-    const data = JSON.parse(await body(request))
+    const data = await body(request)
     try {
       await implementation.call(this, url, data)
     } catch (error) {
@@ -75,7 +75,9 @@ module.exports = job => {
       }, {
       // QUnit hooks
         match: '^/_/qunit-hooks.js',
-        file: join(__dirname, './inject/qunit-hooks.js')
+        cwd: __dirname,
+        file: 'inject/qunit-hooks.js',
+        static: !job.debugDevMode
       }, {
       // Concatenate qunit.js source with hooks
         match: /\/thirdparty\/(qunit(?:-2)?(?:-dbg)?\.js)/,
@@ -123,23 +125,33 @@ module.exports = job => {
       }, {
       // UI to follow progress
         match: '^/_/progress.html',
-        file: job.progressPage
+        cwd: dirname(job.progressPage),
+        file: basename(job.progressPage),
+        static: !job.debugDevMode
       }, {
       // Report 'main' substituted for progress
         match: '^/_/report/main.js',
-        file: join(__dirname, 'defaults/report/progress.js')
+        cwd: __dirname,
+        file: 'defaults/report/progress.js',
+        static: !job.debugDevMode
       }, {
       // Other report resources
         match: '^/_/report/(.*)',
-        file: join(__dirname, 'defaults/report/$1')
+        cwd: __dirname,
+        file: 'defaults/report/$1',
+        static: !job.debugDevMode
       }, {
       // punybind
         match: '^/_/punybind.js',
-        file: punybindBinPath
+        cwd: dirname(punybindBinPath),
+        file: basename(punybindBinPath),
+        static: !job.debugDevMode
       }, {
       // punyexpr
         match: '^/_/punyexpr.js',
-        file: punyexprBinPath
+        cwd: dirname(punyexprBinPath),
+        file: basename(punyexprBinPath),
+        static: !job.debugDevMode
       }, {
       // Endpoint to retry on progress
         method: 'INFO',
@@ -155,15 +167,21 @@ module.exports = job => {
       }, {
       // Endpoint to coverage files
         match: '^/_/coverage/(.*)',
-        file: join(job.coverageReportDir, '$1')
+        cwd: job.coverageReportDir,
+        file: '$1',
+        static: false
       }, {
       // Endpoint to report
         match: '^/_/report.html',
-        file: join(__dirname, 'report.html')
+        cwd: __dirname,
+        file: 'report.html',
+        static: !job.debugDevMode
       }, {
       // Endpoint to report files
         match: '^/_/(.*)',
-        file: join(job.reportDir, '$1')
+        cwd: job.reportDir,
+        file: '$1',
+        static: false
       }]
     : []
 }

package/src/inject/post.js

@@ -83,7 +83,10 @@
         })
         xhr.open('POST', base + '/_/' + url)
         xhr.setRequestHeader('x-page-url', top.location)
-        xhr.send(stringify(data))
+        xhr.setRequestHeader('content-type', 'application/json')
+        const json = stringify(data)
+        xhr.setRequestHeader('content-length', json.length)
+        xhr.send(json)
       })
     }
     lastPost = lastPost

package/src/job-mode.js

@@ -28,6 +28,7 @@ function buildAndCheckMode (job) {
       'reportDir',
       'pageTimeout',
       'browserCloseTimeout',
+      'browserRetry',
       'failFast',
       'keepAlive',
       'alternateNpmPath',

package/src/job.js

@@ -150,6 +150,7 @@ function getCommand (cwd) {
     .option('-cpi, --coverage-proxy-include <regexp>', `[🔗] ${EXPERIMENTAL_OPTION} urls to instrument for coverage`, regex, '.*')
     .option('-cpe, --coverage-proxy-exclude <regexp>', `[🔗] ${EXPERIMENTAL_OPTION} urls to ignore for coverage`, regex, '/((test-)?resources|tests?)/')
 
+    .addOption(new Option('--debug-dev-mode', DEBUG_OPTION, boolean).hideHelp())
     .addOption(new Option('--debug-probe-only', DEBUG_OPTION, boolean).hideHelp())
     .addOption(new Option('--debug-keep-browser-open', DEBUG_OPTION, boolean).hideHelp())
     .addOption(new Option('--debug-memory', DEBUG_OPTION, boolean).hideHelp())

package/src/output.js

@@ -260,6 +260,9 @@ function build (job) {
     version: () => {
       const { name, version } = require(join(__dirname, '../package.json'))
       log(job, p80()`${name}@${version}`)
+      if (job.debugDevMode) {
+        log(job, p80()`⚠️  Development mode ⚠️`)
+      }
     },
 
     serving: url => {

package/src/reserve.js

@@ -1,4 +1,3 @@
-const { join } = require('path')
 const cors = require('./cors')
 const endpoints = require('./endpoints')
 const { mappings: coverage } = require('./coverage')
@@ -17,9 +16,9 @@ module.exports = async job => check({
     {
       // Project mapping
       match: /^\/(.*)/,
-      file: join(job.webapp, '$1'),
-      strict: true,
-      'ignore-if-not-found': true
+      cwd: job.webapp,
+      file: '$1',
+      static: !job.watch && !job.debugDevMode
     },
     ...job.serveOnly ? [{ status: 404 }] : unhandled(job)
   ]

package/src/ui5.js

@@ -63,7 +63,7 @@ module.exports = {
 
     const cacheBase = buildCacheBase(job)
     const match = /\/((?:test-)?resources\/.*)/
-    const ifCacheEnabled = (request, url, match) => job.cache ? match : false
+    const ifCacheEnabled = (request, url, match) => job.cache
     const uncachable = {}
     const cachingInProgress = {}
 
@@ -90,8 +90,9 @@ module.exports = {
       // UI5 from cache
       match,
       'if-match': ifCacheEnabled,
-      file: join(cacheBase, '$1'),
-      'ignore-if-not-found': true
+      cwd: cacheBase,
+      file: '$1',
+      static: !job.debugDevMode
     }, {
       // UI5 caching
       method: 'GET',
@@ -130,8 +131,12 @@ module.exports = {
     job.libs.forEach(({ relative, source }) => {
       mappings.unshift({
         match: new RegExp(`\\/resources\\/${relative.replace(/\//g, '\\/')}(.*)`),
-        file: join(source, '$1'),
-        'ignore-if-not-found': true
+        cwd: source,
+        file: '$1',
+        static: !job.watch && !job.debugDevMode
+      }, {
+        match: new RegExp(`\\/resources\\/${relative.replace(/\//g, '\\/')}(.*)`),
+        status: 404
       })
     })