ui5-test-runner 5.7.1 → 5.7.3

package/index.js

@@ -16,6 +16,8 @@ const { start } = require('./src/start')
 const { executeIf } = require('./src/if')
 const { batch } = require('./src/batch')
 const { end } = require('./src/end')
+const { checkLatest } = require('./src/npm')
+const { cleanHandles } = require('./src/clean')
 
 function send (message) {
   if (process.send) {
@@ -50,11 +52,12 @@ async function main () {
   job = fromCmdLine(process.cwd(), process.argv.slice(2))
   output = getOutput(job)
   await recreateDir(job.reportDir)
-  output.version()
+  const { name, version } = output.version()
   if (job.batchMode) {
     output.batchMode()
   }
   output.reportOnJobProgress()
+  checkLatest(job, name, version)
   if (job.mode === 'capabilities') {
     return capabilities(job)
   }
@@ -82,7 +85,10 @@ async function main () {
   output.debug('reserve', 'configuration', configuration)
   const server = serve(configuration)
   if (job.logServer) {
-    server.on('redirected', output.redirected)
+    server
+      .on('incoming', output.logServerIncoming)
+      .on('redirected', output.logServerRedirected)
+      .on('closed', output.logServerClosed)
   }
 
   const { promise: serverStarted, resolve: serverReady, reject: serverError } = allocPromise()
@@ -145,10 +151,16 @@ async function main () {
     await end(job)
   }
   output.stop()
-  await server.close()
+  await server.close({ close: true })
+  await new Promise(resolve => setTimeout(resolve, 100)) // wait for server handles to be released
+  if (job.logServer) {
+    output.logServerSummary()
+  }
   if (startedCommand) {
     await startedCommand.stop()
   }
+  output.debug('main', 'terminated')
+  cleanHandles(job)
 }
 
 main()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui5-test-runner",
-  "version": "5.7.1",
+  "version": "5.7.3",
   "description": "Standalone test runner for UI5",
   "main": "index.js",
   "bin": {
@@ -22,7 +22,8 @@
     "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 jsdom"
+    "clean": "npm uninstall -g ui5-test-runner puppeteer nyc selenium-webdriver playwright webdriverio jsdom",
+    "update": "ncu -i --format group"
   },
   "repository": {
     "type": "git",
@@ -47,21 +48,22 @@
     "commander": "^12.1.0",
     "ps-tree": "^1.2.0",
     "punybind": "^1.2.1",
-    "punyexpr": "1.0.4",
-    "reserve": "2.2.0"
+    "punyexpr": "1.1.1",
+    "reserve": "2.3.1"
   },
   "devDependencies": {
-    "@openui5/types": "^1.135.0",
-    "@ui5/cli": "^4.0.14",
+    "@openui5/types": "^1.136.0",
+    "@ui5/cli": "^4.0.18",
     "@ui5/middleware-code-coverage": "^2.0.1",
     "dotenv": "^16.5.0",
     "jest": "^29.7.0",
-    "nock": "^14.0.3",
+    "nock": "^14.0.5",
+    "npm-check-updates": "^18.0.1",
     "nyc": "^17.1.0",
     "rimraf": "^6.0.1",
     "standard": "^17.1.2",
     "typescript": "^5.8.3",
-    "ui5-tooling-transpile": "^3.7.5"
+    "ui5-tooling-transpile": "^3.8.0"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.3"

package/src/capabilities/index.js

@@ -81,8 +81,14 @@ async function capabilities (job) {
     })
     const server = serve(configuration)
     if (job.logServer) {
-      server.on('redirected', output.redirected)
+      server
+        .on('incoming', output.logServerIncoming)
+        .on('redirected', output.logServerRedirected)
+        .on('closed', output.logServerClosed)
     }
+    server.on('error', (error) => {
+      output.error('REserve error:', error)
+    })
     await new Promise(resolve => server
       .on('ready', ({ port }) => {
         job.port = port

package/src/capabilities/tests/basic/index.js

@@ -7,14 +7,12 @@ module.exports = [{
   url: 'basic/index.html'
 }, {
   label: 'Loads a UI5 example',
-  for: capabilities => !capabilities.modules.includes('jsdom'), // does not work anymore on JSDOM
   url: 'basic/ui5.html',
   endpoint: ({ body }) => {
     assert.strictEqual(body['sap.m.Button'], true)
   }
 }, {
   label: 'Loads a UI5 inside an iframe',
-  for: capabilities => !capabilities.modules.includes('jsdom'), // does not work anymore on JSDOM
   url: 'basic/iframe.html',
   endpoint: ({ body }) => {
     assert.strictEqual(body['sap.m.Button'], true)

package/src/capabilities/tests/basic/ui5.html

@@ -14,7 +14,7 @@
         sap.ui.getCore().attachInit(function() {
             const xhr = new XMLHttpRequest()
             xhr.open('POST', '/_/log')
-            if (parent !== window) {
+            if (parent !== window && parent.document.location.toString() !== 'about:blank') {
               xhr.setRequestHeader('x-page-url', parent.document.location.toString())
             }
             xhr.send('{"sap.m.Button":' + !!sap.m.Button + '}')

package/src/clean.js

@@ -0,0 +1,29 @@
+const { getOutput } = require('./output')
+
+module.exports = {
+  cleanHandles (job) {
+    const output = getOutput(job)
+    const activeHandles = process._getActiveHandles ? process._getActiveHandles() : []
+    let displayWarning = true
+    for (const handle of activeHandles) {
+      const className = handle && handle.constructor && handle.constructor.name
+      output.debug('handle', 'active handle', className)
+      if (className === 'TLSSocket') {
+        if (displayWarning) {
+          displayWarning = false
+          output.detectedLeakOfHandles()
+        }
+        let info
+        if (handle._httpMessage) {
+          const { path, method, host, protocol } = handle._httpMessage
+          info = `${method} ${protocol}//${host}${path}`
+        } else {
+          const { localAddress, localPort, remoteAddress, remotePort } = handle
+          info = `from ${localAddress}:${localPort} to ${remoteAddress}:${remotePort}`
+        }
+        output.debug('handle', 'TLS socket', info)
+        handle.destroy()
+      }
+    }
+  }
+}

package/src/defaults/happy-dom.js

@@ -0,0 +1,123 @@
+'use strict'
+
+const log = (attributes) => {
+  console.log(JSON.stringify(attributes, (key, value) => {
+    if (key === 'headers' && typeof value === 'object') {
+      const literal = {}
+      value.forEach((headerValue, headerName) => {
+        literal[headerName] = headerValue
+      })
+      return literal
+    }
+    return value
+  }, 2))
+}
+
+require('./browser')({
+  metadata: {
+    name: 'happy-dom',
+    options: [
+      ['--debug [flag]', 'Enable more traces', false]
+    ],
+    capabilities: {
+      modules: ['happy-dom'],
+      scripts: true,
+      traces: ['multiplex']
+    }
+  },
+
+  async run ({
+    settings: { url, scripts, modules }
+    // options
+  }) {
+    const happyDom = require(modules['happy-dom'])
+    const { Browser } = happyDom
+    const browser = new Browser({
+      settings: {
+        fetch: {
+          interceptor: {
+            beforeAsyncRequest: async ({ request: { method, url, headers } }) => {
+              log({
+                timestamp: new Date().toISOString(),
+                channel: 'network',
+                type: 'request',
+                async: true,
+                request: { method, url, headers }
+              })
+            },
+            beforeSyncRequest: ({ request: { method, url, headers } }) => {
+              log({
+                timestamp: new Date().toISOString(),
+                channel: 'network',
+                type: 'request',
+                async: false,
+                request: { method, url, headers }
+              })
+            },
+            afterAsyncResponse: async ({ request: { method, url, headers }, response, window }) => {
+              const body = await response.text()
+              log({
+                timestamp: new Date().toISOString(),
+                channel: 'network',
+                type: 'response',
+                async: true,
+                request: { method, url, headers },
+                response: {
+                  ...response,
+                  body
+                }
+              })
+              return new window.Response(body, {
+                status: response.status,
+                statusText: response.statusText,
+                headers: response.headers
+              })
+            },
+            afterSyncResponse: ({ request: { method, url, headers }, response }) => {
+              log({
+                timestamp: new Date().toISOString(),
+                channel: 'network',
+                type: 'response',
+                async: false,
+                request: { method, url, headers },
+                response: {
+                  ...response,
+                  body: response.body.toString('utf8')
+                }
+              })
+            }
+          }
+        }
+      },
+      console: {
+        error: (...args) => log({
+          timestamp: new Date().toISOString(),
+          channel: 'console',
+          type: 'error',
+          message: args.join(' ')
+        }),
+        warn: (...args) => log({
+          timestamp: new Date().toISOString(),
+          channel: 'console',
+          type: 'warning',
+          message: args.join(' ')
+        }),
+        info: (...args) => log({
+          timestamp: new Date().toISOString(),
+          channel: 'console',
+          type: 'info',
+          message: args.join(' ')
+        }),
+        log: (...args) => log({
+          timestamp: new Date().toISOString(),
+          channel: 'console',
+          type: 'log',
+          message: args.join(' ')
+        })
+      }
+    })
+    const page = browser.newPage()
+    scripts.forEach(script => page.mainFrame.window.eval(script))
+    page.goto(url)
+  }
+})

package/src/defaults/jsdom/compatibility.js

@@ -115,8 +115,8 @@ function fixCaseSensitiveSelectors ({ Document }) {
   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)) {
+      const result = querySelector.call(this, selectors)
+      if (result === null && selectors.match(uppercaseTag)) {
         console.log(JSON.stringify({
           timestamp: new Date().toISOString(),
           channel: 'debug',

package/src/defaults/jsdom.js

@@ -23,6 +23,12 @@ require('./browser')({
     const { JSDOM, VirtualConsole } = jsdom
 
     const virtualConsole = new VirtualConsole()
+    virtualConsole.on('jsdomError', (...args) => console.log(JSON.stringify({
+      timestamp: new Date().toISOString(),
+      channel: 'console',
+      type: 'jsdomError',
+      message: args.join(' ')
+    })))
     virtualConsole.on('error', (...args) => console.log(JSON.stringify({
       timestamp: new Date().toISOString(),
       channel: 'console',

package/src/defaults/report/default.html

@@ -2,7 +2,9 @@
   <head>
     <title>ui5-test-runner</title>
     <link rel="stylesheet" href="/_/report/styles.css">
+    <script>window.module = window.module || {}</script>
     <script src="/_/punyexpr.js"></script>
+    <script>window.punyexpr = module.exports.punyexpr</script>
     <script src="/_/punybind.js"></script>
     <script src="/_/report/common.js"></script>
     <script src="/_/report/main.js"></script>

package/src/job.js

@@ -150,7 +150,7 @@ function getCommand (cwd) {
     .option('--start-timeout <timeout>', '[💻🔗] Maximum waiting time for the start command (based on when the first URL becomes available)', timeout, 5000)
 
     .option('--end <script>', '[💻🔗] End script (will receive path to `job.js`)', string)
-    .option('--end-timeout <timeout>', '[💻🔗] Maximum waiting time for the end script', timeout, 5000)
+    .option('--end-timeout <timeout>', '[💻🔗] Maximum waiting time for the end script', timeout, 15000)
 
     // Specific to legacy (and might be used with url if pointing to local project)
     .option('--ui5 <url>', '[💻📡] UI5 url', url, 'https://ui5.sap.com')

package/src/npm.js

@@ -73,11 +73,41 @@ async function findDependencyPath (job, name) {
   return [globalPath, justInstalled]
 }
 
+const noop = () => {}
+
+function getSafeJobAndOutput (nullableJob) {
+  if (nullableJob) {
+    return { job: nullableJob, output: getOutput(nullableJob) }
+  }
+  return {
+    job: {},
+    output: {
+      debug: noop,
+      resolvedPackage: noop,
+      packageNotLatest: noop
+    }
+  }
+}
+
+async function checkLatest (nullableJob, name, installedVersion) {
+  const { job, output } = getSafeJobAndOutput(nullableJob)
+  if (!job.offline) {
+    output.debug('npm', `fetching latest version of package ${name}`)
+    const latestVersion = await npm(job, 'view', name, 'version')
+    if (latestVersion !== installedVersion) {
+      output.packageNotLatest(name, latestVersion)
+    }
+  } else {
+    output.debug('npm', `offline=${job.offline}`)
+  }
+}
+
 module.exports = {
   resolveDependencyPath,
+  checkLatest,
 
-  async resolvePackage (job, name) {
-    const output = getOutput(job)
+  async resolvePackage (nullableJob, name) {
+    const { job, output } = getSafeJobAndOutput(nullableJob)
     let modulePath
     let justInstalled = false
     output.debug('npm', `resolving dependency path of package ${name}...`)
@@ -94,14 +124,10 @@ module.exports = {
     const installedPackage = require(join(modulePath, 'package.json'))
     const { version: installedVersion } = installedPackage
     output.resolvedPackage(name, modulePath, installedVersion)
-    if (!justInstalled && !job.offline) {
-      output.debug('npm', `fetching latest version of package ${name}`)
-      const latestVersion = await npm(job, 'view', name, 'version')
-      if (latestVersion !== installedVersion) {
-        output.packageNotLatest(name, latestVersion)
-      }
+    if (!justInstalled) {
+      checkLatest(job, name, installedVersion)
     } else {
-      output.debug('npm', `justInstalled=${justInstalled} offline=${job.offline}`)
+      output.debug('npm', `justInstalled=${justInstalled}`)
     }
     return modulePath
   }

package/src/output.js

@@ -15,6 +15,10 @@ const interactive = process.stdout.columns !== undefined && !inJest
 const $output = Symbol('output')
 const $outputStart = Symbol('output-start')
 const $outputProgress = Symbol('output-progress')
+const $logServerIncomingCount = Symbol('log-server-incoming')
+const $logServerRedirectedCount = Symbol('log-server-redirected')
+const $logServerClosedCount = Symbol('log-server-closed')
+const $logServerRequests = Symbol('log-server-requests')
 
 if (!interactive) {
   const UTF8_BOM_CODE = '\ufeff'
@@ -270,6 +274,7 @@ function build (job) {
       if (job.debugDevMode) {
         log(job, p80()`⚠️  Development mode ⚠️`)
       }
+      return { name, version }
     },
 
     serving: url => {
@@ -294,8 +299,18 @@ function build (job) {
       }
     },
 
-    redirected: wrap(({ method, url, statusCode, timeSpent }) => {
-      if (url.startsWith('/_/progress')) {
+    logServerIncoming: wrap(({ id, method, url }) => {
+      if (url.startsWith('/_/')) {
+        return // avoids pollution
+      }
+      job[$logServerIncomingCount] = (job[$logServerIncomingCount] || 0) + 1
+      job[$logServerRequests] ??= {}
+      job[$logServerRequests][id] = { method, url }
+      log(job, p80()`🛜 INC ${id.toString(36).toUpperCase().padStart(4, ' ')} ${method.padEnd(7, ' ')} ${pad.lt(url)}`)
+    }),
+
+    logServerRedirected: wrap(({ id, method, url, statusCode, timeSpent }) => {
+      if (url.startsWith('/_/')) {
         return // avoids pollution
       }
       let statusText
@@ -304,7 +319,33 @@ function build (job) {
       } else {
         statusText = statusCode
       }
-      log(job, p80()`${method.padEnd(7, ' ')} ${pad.lt(url)} ${statusText} ${timeSpent.toString().padStart(4, ' ')}ms`)
+      job[$logServerRedirectedCount] = (job[$logServerRedirectedCount] || 0) + 1
+      const request = job[$logServerRequests][id]
+      request.redirected = true
+      if (request.closed) {
+        delete job[$logServerRequests][id]
+      }
+      log(job, p80()`🛜 SRV ${id.toString(36).toUpperCase().padStart(4, ' ')} ${method.padEnd(7, ' ')} ${pad.lt(url)} ${statusText} ${timeSpent.toString().padStart(4, ' ')}ms`)
+    }),
+
+    logServerClosed: wrap(({ id, method, url }) => {
+      if (url.startsWith('/_/')) {
+        return // avoids pollution
+      }
+      job[$logServerClosedCount] = (job[$logServerClosedCount] || 0) + 1
+      const request = job[$logServerRequests][id]
+      request.closed = true
+      if (request.redirected) {
+        delete job[$logServerRequests][id]
+      }
+      log(job, p80()`🛜 CLS ${id.toString(36).toUpperCase().padStart(4, ' ')} ${method.padEnd(7, ' ')} ${pad.lt(url)}`)
+    }),
+
+    logServerSummary: wrap(() => {
+      log(job, p80()`🛜  requests: ${job[$logServerIncomingCount] || 0} incoming, ${job[$logServerRedirectedCount] || 0} redirected, ${job[$logServerClosedCount] || 0} closed.`)
+      if (job[$logServerRequests] && Object.keys(job[$logServerRequests]).length) {
+        log(job, job[$logServerRequests])
+      }
     }),
 
     status (status) {
@@ -384,6 +425,10 @@ function build (job) {
       wrap(() => log(job, `⚠️ [PKGVRS] latest version of ${name} is ${latestVersion}`))()
     },
 
+    detectedLeakOfHandles () {
+      wrap(() => log(job, '⚠️ [HDLEAK] leaking Node.js handle(s) detected. This may cause issues with the shutdown'))()
+    },
+
     browserStart (url) {
       const text = p80()`${getElapsed(job)} >> ${pad.lt(url)} [${filename(url)}]`
       if (interactive) {

package/src/report.js

@@ -53,9 +53,14 @@ module.exports = {
     job.end = new Date()
     job.failed = !!job.failed
     job.testPageHashes = job.testPageUrls.map(url => filename(url))
+    output.debug('report', 'saving job...')
     await save(job)
+    output.debug('report', 'job saved.')
+    output.debug('report', 'generating text report...')
     await generateTextReport(job)
+    output.debug('report', 'text report generated.')
     const promises = job.reportGenerator.map(generator => {
+      output.debug('report', 'launching', generator, '...')
       const { promise, resolve } = allocPromise()
       const childProcess = fork(
         generator,
@@ -70,13 +75,16 @@ module.exports = {
       )
       const buffers = output.monitor(childProcess, false)
       childProcess.on('close', exitCode => {
+        output.debug('report', generator, 'ended with exit code', exitCode)
         if (exitCode !== 0) {
           output.reportGeneratorFailed(generator, exitCode, buffers)
         }
         resolve()
+        output.debug('report', generator, 'resolved')
       })
       return promise
     })
+    output.debug('report', 'generators count:', promises.length)
     await Promise.all(promises)
     job.status = 'Reports generated'
   }