presidium 4.0.1 → 4.0.7

package/DynamoDBGlobalSecondaryIndex.js

@@ -98,9 +98,9 @@ class DynamoDBGlobalSecondaryIndex {
     this.key = options.key
     this.name = DynamoDBIndexname(this.key)
 
-    this.accessKeyId = options.accessKeyId ?? ''
-    this.secretAccessKey = options.secretAccessKey ?? ''
-    this.region = options.region ?? ''
+    this.accessKeyId = options.accessKeyId
+    this.secretAccessKey = options.secretAccessKey
+    this.region = options.region
     this.apiVersion = '2012-08-10'
 
     this.endpoint = `dynamodb.${this.region}.amazonaws.com`

package/DynamoDBStream.js

@@ -116,9 +116,9 @@ class DynamoDBStream {
     this.ListStreamsLimit = options.ListStreamsLimit ?? 100
     this.JSON = options.JSON ?? false
 
-    this.accessKeyId = options.accessKeyId ?? ''
-    this.secretAccessKey = options.secretAccessKey ?? ''
-    this.region = options.region ?? ''
+    this.accessKeyId = options.accessKeyId
+    this.secretAccessKey = options.secretAccessKey
+    this.region = options.region
     this.apiVersion = '2012-08-10'
 
     this.endpoint = `dynamodb.${this.region}.amazonaws.com`

package/DynamoDBTable.js

@@ -94,9 +94,9 @@ class DynamoDBTable {
     this.name = options.name
     this.key = options.key
 
-    this.accessKeyId = options.accessKeyId ?? ''
-    this.secretAccessKey = options.secretAccessKey ?? ''
-    this.region = options.region ?? ''
+    this.accessKeyId = options.accessKeyId
+    this.secretAccessKey = options.secretAccessKey
+    this.region = options.region
     this.apiVersion = '2012-08-10'
 
     this.endpoint = `dynamodb.${this.region}.amazonaws.com`

package/ECR.js

@@ -46,9 +46,9 @@ const retryHTTPRequest = require('./internal/retryHTTPRequest')
  */
 class ECR {
   constructor(options) {
-    this.accessKeyId = options.accessKeyId ?? ''
-    this.secretAccessKey = options.secretAccessKey ?? ''
-    this.region = options.region ?? ''
+    this.accessKeyId = options.accessKeyId
+    this.secretAccessKey = options.secretAccessKey
+    this.region = options.region
     this.apiVersion = '2015-09-21'
 
     this.endpoint = `ecr.${this.region}.amazonaws.com`

package/GoogleChromeForTesting.js

@@ -6,6 +6,7 @@
  */
 
 const https = require('https')
+const EventEmitter = require('events')
 const os = require('os')
 const fs = require('fs')
 const path = require('path')
@@ -15,15 +16,12 @@ const extract = require('extract-zip')
 const HTTP = require('./HTTP')
 const XML = require('./XML')
 const Readable = require('./Readable')
+const getPlatform = require('./internal/getPlatform')
 const walk = require('./internal/walk')
 const sleep = require('./internal/sleep')
-
-async function getChromeVersions() {
-  const http = new HTTP()
-  const response = await http.GET('https://googlechromelabs.github.io/chrome-for-testing/last-known-good-versions-with-downloads.json')
-  const data = await Readable.JSON(response)
-  return data
-}
+const getChromeUrl = require('./internal/getChromeUrl')
+const getAbsoluteFilePath = require('./internal/getAbsoluteFilePath')
+const getChromeBinaryOrExecutableFilePath = require('./internal/getChromeBinaryOrExecutableFilePath')
 
 function updateConsoleLog(message, platform) {
   readline.cursorTo(process.stdout, 0, undefined);
@@ -31,66 +29,16 @@ function updateConsoleLog(message, platform) {
   process.stdout.write(message);
 }
 
-function getPlatform() {
-  let platform = os.platform()
-  if (platform == 'darwin') {
-    platform = 'mac'
-  }
-  const arch = os.arch()
-
-  if (platform == 'mac') {
-    platform = `${platform}-${arch}`
-  }
-  else if (platform == 'win32') {
-    platform = `win${arch.slice(1)}`
-  }
-  else {
-    platform = `${platform}${arch.slice(1)}`
-  }
-
-  return platform
-}
-
-async function getChromeUrl() {
+async function installChrome() {
   const platform = getPlatform()
+  const url = await getChromeUrl.call(this, platform)
 
-  let url
-  if (['stable', 'beta', 'dev', 'canary'].includes(this.chromeVersion)) {
-    const chromeVersions = await getChromeVersions()
-    const channel = `${this.chromeVersion[0].toUpperCase()}${this.chromeVersion.slice(1)}`
-    const chromeVersionNumber = chromeVersions.channels[channel].version
-    url = `https://storage.googleapis.com/chrome-for-testing-public/${chromeVersionNumber}/${platform}/chrome-${platform}.zip`
-  } else {
-    const chromeVersionNumber = this.chromeVersion
-    url = `https://storage.googleapis.com/chrome-for-testing-public/${chromeVersionNumber}/${platform}/chrome-${platform}.zip`
-  }
-
-  return url
-}
+  let filepath = `${this.chromeDir}/${url.replace('https://storage.googleapis.com/chrome-for-testing-public/', '')}`
+  filepath = getAbsoluteFilePath(filepath, platform)
 
-async function installChrome() {
-  const platform = getPlatform()
   const delimiter = platform.startsWith('win') ? '\\' : '/'
-  const url = await getChromeUrl.call(this)
-
-  let filepath = `${this.chromeDir}${delimiter}${url.replace('https://storage.googleapis.com/chrome-for-testing-public/', '')}`
-  if (platform.startsWith('win')) {
-    filepath = filepath.replace(/\//g, '\\')
-    if (!filepath.startsWith(`${__dirname[0]}:`)) {
-      filepath = path.join(process.cwd(), filepath)
-    }
-  } else if (!filepath.startsWith('/')) {
-    filepath = path.join(process.cwd(), filepath)
-  }
+  const parentDir = `${filepath.split(delimiter).slice(0, -1).join(delimiter)}`
 
-  let parentDir = `${filepath.split(delimiter).slice(0, -1).join(delimiter)}`
-  if (platform.startsWith('win')) {
-    if (!filepath.startsWith(`${__dirname[0]}:`)) {
-      parentDir = path.join(process.cwd(), parentDir)
-    }
-  } else if (!parentDir.startsWith('/')) {
-    parentDir = path.join(process.cwd(), parentDir)
-  }
   await fs.promises.mkdir(parentDir, { recursive: true })
 
   const http = new HTTP()
@@ -113,27 +61,26 @@ async function installChrome() {
     fileStream.write(chunk)
   })
 
+  response.on('end', () => {
+    fileStream.end()
+  })
+
   let resolve
   const promise = new Promise(_resolve => {
     resolve = _resolve
   })
-  response.on('end', () => {
+  fileStream.on('finish', () => {
     resolve()
   })
   await promise
 
   console.log('Extracting', filepath)
-  try {
-    await extract(filepath, { dir: parentDir })
-  } catch (_error) {
-    await sleep(1000)
-    await extract(filepath, { dir: parentDir })
-  }
+  await extract(filepath, { dir: parentDir })
 }
 
 async function getChromeFilepath() {
   const platform = getPlatform()
-  const url = await getChromeUrl.call(this)
+  const url = await getChromeUrl.call(this, platform)
   const filepath = `${this.chromeDir}/${url.replace('https://storage.googleapis.com/chrome-for-testing-public/', '')}`
   const parentDir = `${filepath.split('/').slice(0, -1).join('/')}`
 
@@ -144,16 +91,13 @@ async function getChromeFilepath() {
     }
 
     for await (const filepath of walk(parentDir)) {
-      if (platform.startsWith('mac') && filepath.endsWith('Google Chrome for Testing')) {
-        return filepath
-      }
-      if (platform.startsWith('linux') && filepath.endsWith('chrome')) {
-        return filepath
-      }
-      if (platform.startsWith('win') && filepath.endsWith('chrome.exe')) {
-        return filepath
+      const chromeBinaryOrExecutableFilePath =
+        getChromeBinaryOrExecutableFilePath(filepath, platform)
+      if (chromeBinaryOrExecutableFilePath) {
+        return chromeBinaryOrExecutableFilePath
       }
     }
+    throw new Error('chrome binary or executable not found.')
   } catch (error) {
     if (error.code == 'ENOENT') {
       await installChrome.call(this)
@@ -162,8 +106,6 @@ async function getChromeFilepath() {
     }
     throw error
   }
-
-  throw new Error('unable to find Google Chrome for Testing executable.')
 }
 
 /**
@@ -220,8 +162,9 @@ async function getChromeFilepath() {
  * sudo apt-get update && sudo apt-get install -y libcairo2 libpango-1.0-0 libnss3 libnspr4 libatk1.0-0 libatk-bridge2.0-0 libatspi2.0-0 libcups2 libdrm-dev libxkbcommon0 libxcomposite1 libxdamage1 libxfixes3 libxrandr2 libgbm-dev libasound2-dev
  * ```
  */
-class GoogleChromeForTesting {
+class GoogleChromeForTesting extends EventEmitter {
   constructor(options = {}) {
+    super()
     this.chromeVersion = options.chromeVersion ?? 'stable'
     this.chromeDir = options.chromeDir ?? 'google-chrome-for-testing'
     this.remoteDebuggingPort = options.remoteDebuggingPort ?? 9222
@@ -295,8 +238,7 @@ class GoogleChromeForTesting {
     })
 
     cmd.on('error', error => {
-      console.error(error)
-      process.exit(1)
+      this.emit('error', error)
     })
 
     cmd.on('exit', code => {

package/S3Bucket.js

@@ -90,9 +90,9 @@ class S3Bucket {
   constructor(options) {
     this.name = options.name
 
-    this.accessKeyId = options.accessKeyId ?? ''
-    this.secretAccessKey = options.secretAccessKey ?? ''
-    this.region = options.region ?? ''
+    this.accessKeyId = options.accessKeyId
+    this.secretAccessKey = options.secretAccessKey
+    this.region = options.region
     this.apiVersion = '2012-08-10'
 
     this.host0 = 's3.amazonaws.com'
@@ -2243,15 +2243,9 @@ class S3Bucket {
       }
 
       if (response1.Errors.length > 0) {
-        const errors = response1.Errors.map(({ Key, VersionId, Code, Message }) => {
-          if (VersionId) {
-            return new Error(`${Key} (VersionId ${VersionId}): ${Code}: ${Message}`)
-          }
-          return new Error(`${Key}: ${Code}: ${Message}`)
-        })
+        const errors = response1.Errors.map(createS3DeleteObjectError)
         throw new AggregateError(errors)
       }
-
     }
 
     let versions = await this.listObjectVersions({ MaxKeys: BatchSize }).then(get('Versions'))
@@ -2272,7 +2266,6 @@ class S3Bucket {
         const errors = response1.Errors.map(createS3DeleteObjectError)
         throw new AggregateError(errors)
       }
-
     }
 
     let deleteMarkers = await this.listObjectVersions({ MaxKeys: BatchSize }).then(get('DeleteMarkers'))
@@ -2293,7 +2286,6 @@ class S3Bucket {
         const errors = response1.Errors.map(createS3DeleteObjectError)
         throw new AggregateError(errors)
       }
-
     }
 
     return response

package/SecretsManager.js

@@ -16,6 +16,7 @@ const Readable = require('./Readable')
 const handleAwsResponse = require('./internal/handleAwsResponse')
 const retryableErrorNames = require('./internal/retryableErrorNames')
 const retryHTTPRequest = require('./internal/retryHTTPRequest')
+const sleep = require('./internal/sleep')
 
 /**
  * @name SecretsManager
@@ -49,9 +50,9 @@ const retryHTTPRequest = require('./internal/retryHTTPRequest')
  */
 class SecretsManager {
   constructor(options) {
-    this.accessKeyId = options.accessKeyId ?? ''
-    this.secretAccessKey = options.secretAccessKey ?? ''
-    this.region = options.region ?? ''
+    this.accessKeyId = options.accessKeyId
+    this.secretAccessKey = options.secretAccessKey
+    this.region = options.region
     this.apiVersion = '2017-10-17'
 
     this.endpoint = `secretsmanager.${this.region}.amazonaws.com`
@@ -118,6 +119,53 @@ class SecretsManager {
     return retryHTTPRequest(this.http, method, url, { headers, body: payload })
   }
 
+  // _createSecret(name string, secretString string) -> Promise<{
+  //   ARN: string,
+  //   Name: string,
+  //   VersionId: string,
+  // }>
+  async _createSecret(name, secretString) {
+    const payload = JSON.stringify({
+      ClientRequestToken: crypto.randomUUID(),
+      Name: name,
+      SecretString: secretString,
+    })
+
+    const response = await this._awsRequest('POST', '/', 'CreateSecret', payload)
+
+    if (response.ok) {
+      const data = await Readable.JSON(response)
+      return data
+    }
+
+    throw new AwsError(await Readable.Text(response), response.status)
+  }
+
+  // _createSecret(name string, secretString string) -> Promise<{
+  //   ARN: string,
+  //   Name: string,
+  //   VersionId: string,
+  // }>
+  async _updateSecret(name, secretString) {
+    const secret = await this.getSecret(name)
+
+    const payload = JSON.stringify({
+      ClientRequestToken: crypto.randomUUID(),
+      SecretId: secret.ARN,
+      SecretString: secretString,
+    })
+    const updateSecretResponse =
+      await this._awsRequest('POST', '/', 'UpdateSecret', payload)
+
+    return handleAwsResponse.call(
+      this,
+      updateSecretResponse,
+      this.putSecret,
+      name,
+      secretString
+    )
+  }
+
   /**
    * @name putSecret
    *
@@ -152,50 +200,19 @@ class SecretsManager {
    * ```
    */
   async putSecret(name, secretString) {
-    const createSecretPayload = JSON.stringify({
-      ClientRequestToken: crypto.randomUUID(),
-      Name: name,
-      SecretString: secretString,
-    })
-    const createSecretResponse =
-      await this._awsRequest('POST', '/', 'CreateSecret', createSecretPayload)
-
-    if (createSecretResponse.ok) {
-      const data = await Readable.JSON(createSecretResponse)
+    try {
+      const data = await this._createSecret(name, secretString)
       return data
+    } catch (error) {
+      if (error.name == 'ResourceExistsException') {
+        return this._updateSecret(name, secretString)
+      } else if (retryableErrorNames.includes(error.name)) {
+        await sleep(1000)
+        return this.putSecret.call(this, name, secretString)
+      } else {
+        throw error
+      }
     }
-
-    const createSecretAwsError = new AwsError(
-      await Readable.Text(createSecretResponse),
-      createSecretResponse.status
-    )
-
-    if (createSecretAwsError.name == 'ResourceExistsException') {
-      // continue
-    } else if (retryableErrorNames.includes(createSecretAwsError.name)) {
-      await sleep(1000)
-      return putSecret.call(this, name, secretString)
-    } else {
-      throw createSecretAwsError
-    }
-
-    const secret = await this.getSecret(name)
-
-    const updateSecretPayload = JSON.stringify({
-      ClientRequestToken: crypto.randomUUID(),
-      SecretId: secret.ARN,
-      SecretString: secretString,
-    })
-    const updateSecretResponse =
-      await this._awsRequest('POST', '/', 'UpdateSecret', updateSecretPayload)
-
-    return handleAwsResponse.call(
-      this,
-      updateSecretResponse,
-      this.putSecret,
-      name,
-      secretString
-    )
   }
 
   /**

package/internal/getAbsoluteFilePath.js

@@ -0,0 +1,17 @@
+const path = require('path')
+
+// getAbsoluteFilePath(filepath string, platform string) -> absoluteFilePath string
+function getAbsoluteFilePath(filepath, platform) {
+  if (platform.startsWith('win')) {
+    if (/^[A-Z]:/.test(filepath)) {
+      filepath = filepath.replace(/\//g, '\\')
+    } else {
+      filepath = path.join(process.cwd(), filepath).replace(/\//g, '\\')
+    }
+  } else if (!filepath.startsWith('/')) {
+    filepath = path.join(process.cwd(), filepath)
+  }
+  return filepath
+}
+
+module.exports = getAbsoluteFilePath

package/internal/getAbsoluteFilePath.test.js

@@ -0,0 +1,19 @@
+const Test = require('thunk-test')
+const assert = require('assert')
+const getAbsoluteFilePath = require('./getAbsoluteFilePath')
+
+const test = new Test('getAbsoluteFilePath', getAbsoluteFilePath)
+
+const cwd = process.cwd()
+
+test.case('/test', 'linux64', '/test')
+test.case('test', 'linux64', `${cwd}/test`)
+test.case('/test', 'win64', `${cwd.replace(/\//g, '\\')}\\test`)
+test.case('C:\\test', 'win64', 'C:\\test')
+test.case('D:\\test', 'win64', 'D:\\test')
+
+if (process.argv[1] == __filename) {
+  test()
+}
+
+module.exports = test

package/internal/getChromeBinaryOrExecutableFilePath.js

@@ -0,0 +1,15 @@
+// getChromeBinaryOrExecutableFilePath(filepath string, platform string) -> string
+function getChromeBinaryOrExecutableFilePath(filepath, platform) {
+  if (platform.startsWith('mac') && filepath.endsWith('Google Chrome for Testing')) {
+    return filepath
+  }
+  if (platform.startsWith('linux') && filepath.endsWith('chrome')) {
+    return filepath
+  }
+  if (platform.startsWith('win') && filepath.endsWith('chrome.exe')) {
+    return filepath
+  }
+  return undefined
+}
+
+module.exports = getChromeBinaryOrExecutableFilePath

package/internal/getChromeBinaryOrExecutableFilePath.test.js

@@ -0,0 +1,17 @@
+const Test = require('thunk-test')
+const getChromeBinaryOrExecutableFilePath = require('./getChromeBinaryOrExecutableFilePath.js')
+
+const test = new Test('getChromeBinaryOrExecutableFilePath', getChromeBinaryOrExecutableFilePath)
+
+test.case('/path/to/Google Chrome for Testing', 'mac-x64', '/path/to/Google Chrome for Testing')
+test.case('/path/to/other', 'mac-x64', undefined)
+test.case('/path/to/chrome', 'linux64', '/path/to/chrome')
+test.case('/path/to/other', 'linux64', undefined)
+test.case('C:\\path\\to\\chrome.exe', 'win64', 'C:\\path\\to\\chrome.exe')
+test.case('C:\\path\\to\\other.exe', 'win64', undefined)
+
+if (process.argv[1] == __filename) {
+  test()
+}
+
+module.exports = test

package/internal/getChromeUrl.js

@@ -0,0 +1,20 @@
+const getChromeVersions = require('./getChromeVersions')
+
+// getChromeUrl(platform string) -> chromeUrl string
+async function getChromeUrl(platform) {
+
+  let url
+  if (['stable', 'beta', 'dev', 'canary'].includes(this.chromeVersion)) {
+    const chromeVersions = await getChromeVersions()
+    const channel = `${this.chromeVersion[0].toUpperCase()}${this.chromeVersion.slice(1)}`
+    const chromeVersionNumber = chromeVersions.channels[channel].version
+    url = `https://storage.googleapis.com/chrome-for-testing-public/${chromeVersionNumber}/${platform}/chrome-${platform}.zip`
+  } else {
+    const chromeVersionNumber = this.chromeVersion
+    url = `https://storage.googleapis.com/chrome-for-testing-public/${chromeVersionNumber}/${platform}/chrome-${platform}.zip`
+  }
+
+  return url
+}
+
+module.exports = getChromeUrl

package/internal/getChromeUrl.test.js

@@ -0,0 +1,22 @@
+const Test = require('thunk-test')
+const assert = require('assert')
+const getChromeUrl = require('./getChromeUrl')
+const getChromeVersions = require('./getChromeVersions')
+
+const test = new Test('getChromeUrl', async function integration() {
+  const chromeVersions = await getChromeVersions()
+
+  const chromeVersionNumber = chromeVersions.channels.Stable.version
+  const platform = 'linux64'
+  const url = `https://storage.googleapis.com/chrome-for-testing-public/${chromeVersionNumber}/${platform}/chrome-${platform}.zip`
+
+  assert.equal(await getChromeUrl.call({ chromeVersion: 'stable' }, 'linux64'), url)
+  assert.equal(await getChromeUrl.call({ chromeVersion: chromeVersionNumber }, 'linux64'), url)
+
+}).case()
+
+if (process.argv[1] == __filename) {
+  test()
+}
+
+module.exports = test

package/internal/getChromeVersions.js

@@ -0,0 +1,19 @@
+const HTTP = require('../HTTP')
+const Readable = require('../Readable')
+
+// getChromeVersions() -> Promise<{
+//   channels: {
+//     Stable: { version: string },
+//     Beta: { version: string },
+//     Dev: { version: string },
+//     Canary: { version: string },
+//   },
+// }>
+async function getChromeVersions() {
+  const http = new HTTP()
+  const response = await http.GET('https://googlechromelabs.github.io/chrome-for-testing/last-known-good-versions-with-downloads.json')
+  const data = await Readable.JSON(response)
+  return data
+}
+
+module.exports = getChromeVersions

package/internal/getPlatform.js

@@ -0,0 +1,22 @@
+const os = require('os')
+
+// getPlatform() -> platform string
+function getPlatform() {
+  let platform = os.platform()
+  if (platform == 'darwin') {
+    platform = 'mac'
+  }
+  const arch = os.arch()
+
+  if (platform == 'mac') {
+    platform = `${platform}-${arch}`
+  } else if (platform == 'win32') {
+    platform = `win${arch.slice(1)}`
+  } else {
+    platform = `${platform}${arch.slice(1)}`
+  }
+
+  return platform
+}
+
+module.exports = getPlatform

package/internal/getPlatform.test.js

@@ -0,0 +1,33 @@
+const Test = require('thunk-test')
+const assert = require('assert')
+const getPlatform = require('./getPlatform')
+
+const test = new Test('getPlatform', async function integration() {
+  const os = require('os')
+
+  const osPlatform = os.platform
+  const osArch = os.arch
+
+  os.platform = () => 'darwin'
+  os.arch = () => 'x64'
+
+  assert.equal(getPlatform(), 'mac-x64')
+
+  os.platform = () => 'win32'
+
+  assert.equal(getPlatform(), 'win64')
+
+  os.platform = () => 'linux'
+
+  assert.equal(getPlatform(), 'linux64')
+
+  os.platform = osPlatform
+  os.arch = osArch
+
+}).case()
+
+if (process.argv[1] == __filename) {
+  test()
+}
+
+module.exports = test

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presidium",
-  "version": "4.0.1",
+  "version": "4.0.7",
   "description": "A library for creating web services",
   "author": "Richard Tong",
   "license": "CFOSS",