npm - ui5-test-runner - Versions diffs - 1.1.5 → 2.0.1 - Mend

ui5-test-runner 1.1.5 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (93) hide show

package/README.md +32 -188
package/index.js +47 -16
package/package.json +28 -10
package/src/add-test-pages.js +35 -0
package/src/add-test-pages.spec.js +95 -0
package/src/browser.spec.js +724 -0
package/src/browsers.js +220 -59
package/src/capabilities/index.js +194 -0
package/src/capabilities/tests/basic/iframe.html +8 -0
package/src/capabilities/tests/basic/index.html +12 -0
package/src/capabilities/tests/basic/index.js +20 -0
package/src/capabilities/tests/basic/ui5.html +24 -0
package/src/capabilities/tests/dynamic-include/index.js +21 -0
package/src/capabilities/tests/dynamic-include/mix.html +11 -0
package/src/capabilities/tests/dynamic-include/one.html +11 -0
package/src/capabilities/tests/dynamic-include/post.js +3 -0
package/src/capabilities/tests/dynamic-include/test.js +1 -0
package/src/capabilities/tests/dynamic-include/two.html +11 -0
package/src/capabilities/tests/index.js +16 -0
package/src/capabilities/tests/local-storage/index.html +16 -0
package/src/capabilities/tests/local-storage/index.js +21 -0
package/src/capabilities/tests/screenshot/index.html +13 -0
package/src/capabilities/tests/screenshot/index.js +18 -0
package/src/capabilities/tests/scripts/index.js +50 -0
package/src/capabilities/tests/scripts/qunit.html +22 -0
package/src/capabilities/tests/scripts/testsuite.html +10 -0
package/src/capabilities/tests/scripts/testsuite.js +8 -0
package/src/capabilities/tests/timeout/index.html +21 -0
package/src/capabilities/tests/timeout/index.js +19 -0
package/src/capabilities/tests/traces/index.html +18 -0
package/src/capabilities/tests/traces/index.js +81 -0
package/src/cors.js +1 -1
package/src/cors.spec.js +41 -0
package/src/coverage.js +30 -18
package/src/coverage.spec.js +79 -0
package/src/csv-reader.js +36 -0
package/src/csv-reader.spec.js +42 -0
package/src/csv-writer.js +52 -0
package/src/csv-writer.spec.js +77 -0
package/src/defaults/browser.js +144 -0
package/src/defaults/jsdom/compatibility.js +95 -0
package/src/defaults/jsdom/debug.js +23 -0
package/src/defaults/jsdom/resource-loader.js +43 -0
package/src/defaults/jsdom/sap.ui.test.matchers.visible.js +39 -0
package/src/defaults/jsdom.js +64 -0
package/src/defaults/junit-xml-report.js +64 -0
package/src/defaults/puppeteer.js +111 -0
package/src/defaults/report/common.js +38 -0
package/src/defaults/report/default.html +84 -0
package/src/defaults/report/main.js +44 -0
package/src/defaults/report/progress.js +49 -0
package/src/defaults/report/styles.css +66 -0
package/src/defaults/report.js +69 -0
package/src/defaults/selenium-webdriver/chrome.js +38 -0
package/src/defaults/selenium-webdriver/edge.js +25 -0
package/src/defaults/selenium-webdriver/firefox.js +31 -0
package/src/defaults/selenium-webdriver.js +138 -0
package/src/endpoints.js +70 -124
package/src/error.js +52 -0
package/src/error.spec.js +17 -0
package/src/get-job-progress.js +69 -0
package/src/get-job-progress.spec.js +175 -0
package/src/inject/post.js +96 -0
package/src/inject/post.spec.js +147 -0
package/src/inject/qunit-hooks.js +6 -21
package/src/inject/qunit-intercept.js +30 -0
package/src/inject/qunit-redirect.js +15 -7
package/src/job-mode.js +45 -0
package/src/job.js +254 -108
package/src/job.spec.js +413 -0
package/src/npm.js +73 -0
package/src/npm.spec.js +98 -0
package/src/options.js +73 -0
package/src/options.spec.js +125 -0
package/src/output.js +450 -131
package/src/qunit-hooks.js +116 -0
package/src/qunit-hooks.spec.js +687 -0
package/src/report.js +47 -0
package/src/reserve.js +3 -4
package/src/simulate.spec.js +466 -0
package/src/symbols.js +8 -0
package/src/tests.js +127 -84
package/src/timeout.spec.js +39 -0
package/src/tools.js +111 -4
package/src/tools.spec.js +90 -0
package/src/ui5.js +3 -3
package/src/unhandled.js +6 -6
package/src/unhandled.spec.js +63 -0
package/defaults/chromium.js +0 -62
package/src/progress.html +0 -71
package/src/proxies.js +0 -8
package/src/report.html +0 -202
/package/{defaults → src/defaults}/nyc.json +0 -0

package/src/capabilities/tests/local-storage/index.html ADDED Viewed

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+  <body>
+    <H1>localStorage</H1>
+    <p>Check if the localStorage is isolated</p>
+    <script>
+      const initial = localStorage.value
+      const parameters = new URLSearchParams(location.search)
+      localStorage.value = parameters.get('value')
+      const modified = localStorage.value
+      const xhr = new XMLHttpRequest()
+      xhr.open('POST', '/_/log')
+      xhr.send(JSON.stringify({initial, modified}))
+    </script>
+  </body>
+</html>

package/src/capabilities/tests/local-storage/index.js ADDED Viewed

@@ -0,0 +1,21 @@
+'use strict'
+const assert = require('assert')
+module.exports = [{
+  label: 'Local storage (1)',
+  url: 'local-storage/index.html?value=1',
+  endpoint: ({ body }) => {
+    const { initial, modified } = body
+    assert.ok(initial === undefined, 'The local storage starts empty')
+    assert.ok(modified === '1', 'The local storage can be used')
+  }
+}, {
+  label: 'Local storage (2)',
+  url: 'local-storage/index.html?value=2',
+  endpoint: ({ body }) => {
+    const { initial, modified } = body
+    assert.ok(initial === undefined, 'The local storage starts empty')
+    assert.ok(modified === '2', 'The local storage can be used')
+  }
+}]

package/src/capabilities/tests/screenshot/index.html ADDED Viewed

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <body>
+    <H1>screenshot</H1>
+    <p>Checks if the browser supports screenshot</p>
+    <span style="font-size: 32rem;">&#128521;</span>
+    <script>
+      const xhr = new XMLHttpRequest()
+      xhr.open('POST', '/_/log')
+      xhr.send('{}')
+    </script>
+  </body>
+</html>

package/src/capabilities/tests/screenshot/index.js ADDED Viewed

@@ -0,0 +1,18 @@
+'use strict'
+const assert = require('assert')
+const { screenshot } = require('../../../browsers')
+const { stat } = require('fs/promises')
+module.exports = {
+  label: 'Screenshot',
+  for: capabilities => !!capabilities.screenshot,
+  url: 'screenshot/index.html',
+  endpoint: async function (_, url) {
+    const { job } = this
+    const fileName = await screenshot(job, url, 'screenshot')
+    const fileInfo = await stat(fileName)
+    assert.ok(fileInfo.isFile(), 'The file was generated')
+    assert.ok(fileInfo.size > 1024, 'The file contains something')
+  }
+}

package/src/capabilities/tests/scripts/index.js ADDED Viewed

@@ -0,0 +1,50 @@
+'use strict'
+const assert = require('assert')
+function qUnitEndpoints (data) {
+  const { endpoint } = data
+  if (!this.calls) {
+    this.calls = {}
+  }
+  if (!this.calls[endpoint]) {
+    this.calls[endpoint] = 1
+  } else {
+    ++this.calls[endpoint]
+  }
+  if (endpoint === 'QUnit/done') {
+    assert.ok(this.calls['QUnit/begin'], 'QUnit/begin was triggered')
+    assert.ok(this.calls['QUnit/log'], 'QUnit/log was triggered')
+    assert.ok(this.calls['QUnit/testDone'], 'QUnit/testDone was triggered')
+    return true
+  }
+  return false
+}
+module.exports = [{
+  label: 'Scripts (QUnit)',
+  for: capabilities => !!capabilities.scripts,
+  url: 'scripts/qunit.html',
+  scripts: ['qunit-intercept.js', 'post.js', 'qunit-hooks.js'],
+  endpoint: qUnitEndpoints
+}, {
+  label: 'Scripts (TestSuite)',
+  for: capabilities => !!capabilities.scripts,
+  url: 'scripts/testsuite.html',
+  scripts: ['post.js', 'qunit-redirect.js'],
+  endpoint: function (data) {
+    assert(data.endpoint === 'addTestPages', 'addTestPages was triggered')
+    assert(data.body.length === 2, 'Two pages received')
+    const pages = [
+      '/unit/unitTests.qunit.html',
+      '/integration/opaTests.iframe.qunit.html'
+    ]
+    pages.forEach((page, index) => assert(data.body[index].endsWith(page), page))
+  }
+}, {
+  label: 'Scripts (External QUnit)',
+  for: capabilities => !!capabilities.scripts,
+  url: 'https://ui5.sap.com/test-resources/sap/m/demokit/orderbrowser/webapp/test/unit/unitTests.qunit.html',
+  scripts: ['qunit-intercept.js', 'post.js', 'qunit-hooks.js'],
+  endpoint: qUnitEndpoints
+}]

package/src/capabilities/tests/scripts/qunit.html ADDED Viewed

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>qunit</title>
+    <script id="sap-ui-bootstrap"
+      src="https://ui5.sap.com/resources/sap-ui-core.js"
+    ></script>
+    <link rel="stylesheet" type="text/css" href="https://ui5.sap.com/resources/sap/ui/thirdparty/qunit-2.css">
+    <script src="https://ui5.sap.com/resources/sap/ui/thirdparty/qunit-2.js"></script>
+  </head>
+  <body>
+    <div id="qunit"></div>
+    <div id="qunit-fixture"></div>
+    <script>
+      QUnit.module('module', function () {
+        QUnit.test("test", function (assert) {
+          assert.ok(true, 'assert')
+        })
+      })
+    </script>
+  </body>
+</html>

package/src/capabilities/tests/scripts/testsuite.html ADDED Viewed

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title>testsuite</title>
+		<script src="https://ui5.sap.com/resources/sap/ui/qunit/qunit-redirect.js"></script>
+		<script src="testsuite.js" data-sap-ui-testsuite></script>
+	</head>
+	<body>
+	</body>
+</html>

package/src/capabilities/tests/scripts/testsuite.js ADDED Viewed

@@ -0,0 +1,8 @@
+window.suite = function () {
+  'use strict'
+  const suite = new window.parent.jsUnitTestSuite() // eslint-disable-line new-cap
+  const path = window.location.pathname.substring(0, window.location.pathname.lastIndexOf('/') + 1)
+  suite.addTestPage(`${path}unit/unitTests.qunit.html`)
+  suite.addTestPage(`${path}integration/opaTests.iframe.qunit.html`)
+  return suite
+}

package/src/capabilities/tests/timeout/index.html ADDED Viewed

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+  <body>
+    <H1>timeout</H1>
+    <p>Check if the ping rate is ensured</p>
+    <script>
+      const parameters = new URLSearchParams(location.search)
+      const rate = parseInt(parameters.get('rate'), 10)
+      const wait = parseInt(parameters.get('wait'), 10)
+      const steps = []
+      setTimeout(() => {
+        const xhr = new XMLHttpRequest()
+        xhr.open('POST', '/_/log')
+        xhr.send(JSON.stringify({ steps }))
+      }, wait)
+      setInterval(() => {
+        steps.push(Date.now())
+      }, rate)
+    </script>
+  </body>
+</html>

package/src/capabilities/tests/timeout/index.js ADDED Viewed

@@ -0,0 +1,19 @@
+'use strict'
+const assert = require('assert')
+module.exports = [{
+  label: 'Timeout (100ms)',
+  url: 'timeout/index.html?rate=100&wait=1000',
+  endpoint: ({ body }) => {
+    const { steps } = body
+    assert.ok(steps.length > 8, 'The right number of steps is generated')
+  }
+}, {
+  label: 'Timeout (250ms)',
+  url: 'timeout/index.html?rate=250&wait=1250',
+  endpoint: ({ body }) => {
+    const { steps } = body
+    assert.ok(steps.length > 3, 'The right number of steps is generated')
+  }
+}]

package/src/capabilities/tests/traces/index.html ADDED Viewed

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+  <body>
+    <H1>console</H1>
+    <p>Checks if the browser supports traces</p>
+    <script>
+      console.log('A simple string')
+      console.log('A quoted "string"')
+      console.log('complex parameters', 1, true, { property: 'value' })
+      console.warn('A warning')
+      console.error('An error')
+      console.info('An info')
+      const xhr = new XMLHttpRequest()
+      xhr.open('POST', '/_/log')
+      xhr.send('{}')
+    </script>
+  </body>
+</html>

package/src/capabilities/tests/traces/index.js ADDED Viewed

@@ -0,0 +1,81 @@
+'use strict'
+const { $browsers } = require('../../../symbols')
+const { join } = require('path')
+const { stat } = require('fs/promises')
+const { stop } = require('../../../browsers')
+const { buildCsvReader } = require('../../../csv-reader')
+const assert = require('assert')
+const expectedLogs = [{
+  type: 'log',
+  text: 'A simple string'
+}, {
+  type: 'log',
+  text: 'A quoted "string"'
+}, {
+  type: 'log',
+  text: /^"?complex parameters"? 1 true / // Not sure how objects are handled
+}, {
+  type: 'warning',
+  text: 'A warning'
+}, {
+  type: 'error',
+  text: 'An error'
+}, {
+  type: /info|log/, // selenium-webdriver
+  text: 'An info'
+}]
+function equal (value, expected, label) {
+  if (typeof expected === 'string') {
+    return value === expected
+  }
+  return !!value.match(expected)
+}
+function unquote (string) {
+  if (string.startsWith('"') && string.endsWith('"')) {
+    return string.substring(1, string.length - 1)
+      .replace(/\\"/g, '"')
+  }
+  return string
+}
+module.exports = {
+  label: 'Console logs',
+  for: capabilities => Array.isArray(capabilities.traces) && capabilities.traces.includes('console'),
+  url: 'traces/index.html',
+  endpoint: async function (_, url) {
+    const { job } = this
+    const { reportDir } = job[$browsers][url]
+    this.stopExpected = true
+    await stop(this.job, url)
+    const consolePath = join(reportDir, 'console.csv')
+    const consoleStat = await stat(consolePath)
+    if (!consoleStat.isFile()) {
+      throw new Error('missing console.csv')
+    }
+    const logsReader = buildCsvReader(consolePath)
+    let logIndex = 0
+    for await (const log of logsReader) {
+      assert.strictEqual(typeof log.timestamp, 'string', 'timestamp exists')
+      assert.ok(log.timestamp.match(/^[0-9]+$/), 'timestamp is a number')
+      const {
+        type: expectedType,
+        text: expectedText
+      } = expectedLogs[logIndex]
+      let { text } = log
+      const match = text.match(/^https?[^ ]+ (\d+:\d+ )?(.*)/)
+      if (match) {
+        text = unquote(match[2])
+      }
+      if (equal(log.type, expectedType) && equal(text, expectedText)) {
+        if (++logIndex === expectedLogs.length) {
+          break
+        }
+      }
+    }
+    assert.strictEqual(logIndex, expectedLogs.length, 'All expected logs were found')
+  }
+}

package/src/cors.js CHANGED Viewed

@@ -7,7 +7,7 @@ module.exports = {
       response.writeHead(200, {
         'Access-Control-Allow-Origin': origin,
         Vary: 'Origin',
-        'Access-Control-Allow-Headers': 'content-type, content-length',
+        'Access-Control-Allow-Headers': 'content-type, content-length, x-page-url',
         'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
         'Access-Control-Allow-Credentials': 'true'
       })

package/src/cors.spec.js ADDED Viewed

@@ -0,0 +1,41 @@
+'use script'
+const Request = require('reserve/mock/Request')
+const Response = require('reserve/mock/Response')
+const cors = require('./cors')
+const origin = 'npmjs.com'
+describe('src/cors', () => {
+  it('handles CORS attributes', async () => {
+    const request = new Request('GET', '/', { origin })
+    const response = new Response()
+    cors.custom(request, response)
+    expect(response.statusCode).toBeUndefined()
+    expect(response.headers).toMatchObject({
+      'access-control-allow-origin': origin,
+      'access-control-allow-credentials': 'true'
+    })
+  })
+  it('does not impact response if origin is missing', async () => {
+    const request = new Request('GET', '/')
+    const response = new Response()
+    cors.custom(request, response)
+    expect(response.statusCode).toBeUndefined()
+    expect(response.headers).toMatchObject({})
+  })
+  it('handles CORS preflight', async () => {
+    const request = new Request('OPTIONS', '/', { origin })
+    const response = new Response()
+    cors.custom(request, response)
+    expect(response.statusCode).toStrictEqual(200)
+    expect(response.headers).toMatchObject({
+      'access-control-allow-origin': origin,
+      'access-control-allow-headers': 'content-type, content-length, x-page-url',
+      'access-control-allow-methods': 'GET, POST, PUT, DELETE, OPTIONS',
+      'access-control-allow-credentials': 'true'
+    })
+  })
+})

package/src/coverage.js CHANGED Viewed

@@ -2,14 +2,18 @@
 const { join } = require('path')
 const { fork } = require('child_process')
-const { cleanDir, createDir } = require('./tools')
+const { cleanDir, createDir, filename } = require('./tools')
 const { readdir, readFile, stat, writeFile } = require('fs').promises
 const { Readable } = require('stream')
-const output = require('./output')
+const { getOutput } = require('./output')
+const { resolvePackage } = require('./npm')
-const nycScript = require.resolve('nyc/bin/nyc.js')
+const $nycSettingsPath = Symbol('nycSettingsPath')
-function nyc (...args) {
+let nycScript
+async function nyc (job, ...args) {
+  const output = getOutput(job)
   output.nyc(...args)
   const childProcess = fork(nycScript, args, { stdio: 'pipe' })
   output.monitor(childProcess)
@@ -39,39 +43,47 @@ const customFileSystem = {
 async function instrument (job) {
   job.status = 'Instrumenting'
-  job.nycSettingsPath = join(job.covTempDir, 'settings/nyc.json')
-  await cleanDir(job.covTempDir)
-  await createDir(join(job.covTempDir, 'settings'))
-  const settings = JSON.parse((await readFile(job.covSettings)).toString())
+  if (!nycScript) {
+    const nyc = await resolvePackage(job, 'nyc')
+    nycScript = join(nyc, 'bin/nyc.js')
+  }
+  job[$nycSettingsPath] = join(job.coverageTempDir, 'settings/nyc.json')
+  await cleanDir(job.coverageTempDir)
+  await createDir(join(job.coverageTempDir, 'settings'))
+  const settings = JSON.parse((await readFile(job.coverageSettings)).toString())
   settings.cwd = job.cwd
   if (!settings.exclude) {
     settings.exclude = []
   }
-  settings.exclude.push(join(job.covTempDir, '**'))
+  settings.exclude.push(join(job.coverageTempDir, '**'))
   if (job.cache) {
     settings.exclude.push(join(job.cache, '**'))
   }
-  settings.exclude.push(join(job.tstReportDir, '**'))
-  settings.exclude.push(join(job.covReportDir, '**'))
-  await writeFile(job.nycSettingsPath, JSON.stringify(settings))
-  await nyc('instrument', job.webapp, join(job.covTempDir, 'instrumented'), '--nycrc-path', job.nycSettingsPath)
+  settings.exclude.push(join(job.reportDir, '**'))
+  settings.exclude.push(join(job.coverageReportDir, '**'))
+  await writeFile(job[$nycSettingsPath], JSON.stringify(settings))
+  await nyc(job, 'instrument', job.webapp, join(job.coverageTempDir, 'instrumented'), '--nycrc-path', job[$nycSettingsPath])
 }
 async function generateCoverageReport (job) {
   job.status = 'Generating coverage report'
-  await cleanDir(job.covReportDir)
-  await nyc('merge', job.covTempDir, join(job.covTempDir, 'coverage.json'))
-  const reporters = job.covReporters.split(',').map(reporter => `--reporter=${reporter}`)
-  await nyc('report', ...reporters, '--temp-dir', job.covTempDir, '--report-dir', job.covReportDir, '--nycrc-path', job.nycSettingsPath)
+  await cleanDir(job.coverageReportDir)
+  await nyc(job, 'merge', job.coverageTempDir, join(job.coverageTempDir, 'coverage.json'))
+  const reporters = job.coverageReporters.map(reporter => `--reporter=${reporter}`)
+  await nyc(job, 'report', ...reporters, '--temp-dir', job.coverageTempDir, '--report-dir', job.coverageReportDir, '--nycrc-path', job[$nycSettingsPath])
 }
 module.exports = {
   instrument: job => job.coverage && instrument(job),
+  async collect (job, url, coverageData) {
+    const coverageFileName = join(job.coverageTempDir, `${filename(url)}.json`)
+    await writeFile(coverageFileName, JSON.stringify(coverageData))
+  },
   generateCoverageReport: job => job.coverage && generateCoverageReport(job),
   mappings: job => job.coverage
     ? [{
         match: /^\/(.*\.js)$/,
-        file: join(job.covTempDir, 'instrumented', '$1'),
+        file: join(job.coverageTempDir, 'instrumented', '$1'),
         'ignore-if-not-found': true,
         'custom-file-system': customFileSystem
       }]

package/src/coverage.spec.js ADDED Viewed

@@ -0,0 +1,79 @@
+const { join } = require('path')
+const { fromObject } = require('./job')
+const { instrument, generateCoverageReport, mappings } = require('./coverage')
+const { stat } = require('fs/promises')
+const { cleanDir, createDir } = require('./tools')
+describe('src/coverage', () => {
+  const cwd = join(__dirname, '../test/project')
+  const path = join(__dirname, '../tmp/coverage')
+  beforeAll(() => {
+    return cleanDir(path)
+  })
+  describe('disabled', () => {
+    const basePath = join(path, 'disabled')
+    let job
+    beforeAll(async () => {
+      const reportDir = join(basePath, 'report')
+      await createDir(reportDir)
+      job = fromObject(cwd, {
+        reportDir,
+        coverageTempDir: join(basePath, 'coverage/temp'),
+        coverageReportDir: join(basePath, 'coverage/report'),
+        coverage: false
+      })
+    })
+    it('does not instrument sources', async () => {
+      await instrument(job)
+      await expect(() => stat(join(basePath, 'coverage/temp/settings/nyc.json'))).rejects.toThrow()
+    })
+    it('does not generate a report', async () => {
+      await generateCoverageReport(job)
+      await expect(() => stat(join(basePath, 'coverage/temp/coverage.json'))).rejects.toThrow()
+      await expect(() => stat(join(basePath, 'coverage/report'))).rejects.toThrow()
+    })
+    it('does not create a mapping', async () => {
+      const coverageMappings = mappings(job)
+      expect(coverageMappings.length).toStrictEqual(0)
+    })
+  })
+  describe('enabled', () => {
+    const basePath = join(path, 'enabled')
+    let job
+    beforeAll(async function () {
+      const reportDir = join(basePath, 'report')
+      await createDir(reportDir)
+      job = fromObject(cwd, {
+        reportDir,
+        coverageTempDir: join(basePath, 'coverage/temp'),
+        coverageReportDir: join(basePath, 'coverage/report'),
+        coverage: true
+      })
+    })
+    it('instruments sources', async () => {
+      await instrument(job)
+      const nycJsonStat = await stat(join(basePath, 'coverage/temp/settings/nyc.json'))
+      expect(nycJsonStat.isFile()).toStrictEqual(true)
+    })
+    it('generates a report', async () => {
+      await generateCoverageReport(job)
+      const reportStat = await stat(join(basePath, 'coverage/report'))
+      expect(reportStat.isDirectory()).toStrictEqual(true)
+    })
+    it('creates a mapping', async () => {
+      const coverageMappings = mappings(job)
+      expect(coverageMappings.length).toStrictEqual(1)
+    })
+  })
+})

package/src/csv-reader.js ADDED Viewed

@@ -0,0 +1,36 @@
+'use strict'
+const { createReadStream } = require('fs')
+const readline = require('readline')
+const unescape = value => {
+  if (value.startsWith('"') && value.endsWith('"')) {
+    return JSON.parse(value)
+  }
+  return value
+}
+async function * buildCsvReader (fileName) {
+  const fileStream = createReadStream(fileName)
+  const rl = readline.createInterface({
+    input: fileStream,
+    crlfDelay: Infinity
+  })
+  let headers
+  for await (const line of rl) {
+    const fields = line.split('\t')
+    if (headers === undefined) {
+      headers = fields
+      continue
+    }
+    const record = {}
+    headers.forEach((field, index) => {
+      record[field] = unescape(fields[index])
+    })
+    yield record
+  }
+}
+module.exports = {
+  buildCsvReader
+}

package/src/csv-reader.spec.js ADDED Viewed

@@ -0,0 +1,42 @@
+const { buildCsvReader } = require('./csv-reader')
+const { createReadStream } = require('fs')
+const { Readable } = require('stream')
+jest.mock('fs')
+describe('src/csv-reader', () => {
+  beforeEach(() => {
+    createReadStream.mockReset()
+    createReadStream.mockImplementation(() => {
+      const s = new Readable()
+      s._read = () => {}
+      s.push(`timestamp\ttext
+1\tabc
+2\thello world
+3\t"abc\\td"
+`)
+      s.push(null)
+      return s
+    })
+  })
+  it('allocates an iterator', () => {
+    const reader = buildCsvReader('test.csv')
+    expect(reader).not.toBeUndefined()
+    expect(typeof reader.next).toBe('function')
+    expect(createReadStream).not.toHaveBeenCalled()
+  })
+  it('reads records', async () => {
+    const reader = buildCsvReader('test.csv')
+    const records = []
+    for await (const record of reader) {
+      records.push(record)
+    }
+    expect(records).toEqual([
+      { timestamp: '1', text: 'abc' },
+      { timestamp: '2', text: 'hello world' },
+      { timestamp: '3', text: 'abc\td' }
+    ])
+  })
+})

package/src/csv-writer.js ADDED Viewed

@@ -0,0 +1,52 @@
+'use strict'
+const { writeFile } = require('fs/promises')
+const append = (fileName, line) => writeFile(fileName, line + '\n', { flag: 'a+' })
+const escape = value => {
+  const stringValue = value.toString()
+  if (stringValue.match(/\r|\n|\t|"/)) {
+    return JSON.stringify(stringValue)
+  }
+  return stringValue
+}
+class CsvWriter {
+  #fileName
+  #ready
+  #fields
+  constructor (fileName) {
+    this.#fileName = fileName
+    this.#ready = Promise.resolve()
+    this.#fields = []
+  }
+  get ready () {
+    return this.#ready
+  }
+  append (records) {
+    if (!Array.isArray(records)) {
+      records = [records]
+    }
+    if (this.#fields.length === 0) {
+      this.#fields = Object.keys(records[0]).filter(name => name !== 'timestamp')
+      this.#ready = this.#ready.then(() => append(this.#fileName, `timestamp\t${this.#fields.join('\t')}`))
+    }
+    const lines = records.map(record => {
+      const { timestamp = Date.now() } = record
+      return [
+        timestamp,
+        ...this.#fields.map(name => escape(record[name]))
+      ].join('\t')
+    }).join('\n')
+    this.#ready = this.#ready.then(() => append(this.#fileName, lines))
+  }
+}
+module.exports = {
+  buildCsvWriter (fileName) {
+    return new CsvWriter(fileName)
+  }
+}