presidium 4.0.10 → 4.1.0

package/Docker.js

@@ -11,11 +11,13 @@ const identity = require('rubico/x/identity')
 const size = require('rubico/x/size')
 const defaultsDeep = require('rubico/x/defaultsDeep')
 const Transducer = require('rubico/Transducer')
-const zlib = require('zlib')
 const http = require('http')
+const fs = require('fs')
+const zlib = require('zlib')
+const uniqid = require('uniqid')
+const { spawn } = require('child_process')
 const Readable = require('./Readable')
 const HTTP = require('./HTTP')
-const Archive = require('./internal/Archive')
 const querystring = require('querystring')
 const split = require('./internal/split')
 const join = require('./internal/join')
@@ -43,6 +45,12 @@ const handleDockerHTTPResponse = require('./internal/handleDockerHTTPResponse')
  * Arguments:
  *   * `options`
  *     * `apiVersion` - the version of the Docker API. Defaults to `'1.48'`.
+ *
+ * Supported platforms:
+ *   * `linux64`
+ *
+ * System dependencies:
+ *   * `tar`
  */
 class Docker {
   constructor(options = {}) {
@@ -341,7 +349,7 @@ class Docker {
    *   * `path` - parent directory of the build context.
    *   * `options`
    *     * `image` - the name and optional tag of the image. If no tag is present, `'LATEST'` is assumed as the value for the tag.
-   *     * `ignore` - filepaths or filenames to ignore when bundling files and directories for the build context.
+   *     * `ignore` - patterns to ignore when bundling files and directories for the build context.
    *     * `archive` - an object of filenames and file contents that will be present in the build context.
    *     * `archiveDockerfile` - the filepath including filename of the Dockerfile, e.g. `'Dockerfiles/Dockerfile2'`. Defaults to `'Dockerfile'`.
    *     * `platform` - target platform for the build, e.g. `'linux/arm64'`.
@@ -401,12 +409,58 @@ class Docker {
    *   * [Dockerfile](https://docs.docker.com/engine/reference/builder/)
    */
   async buildImage(path, options = {}) {
-    const pack = Archive.tar(path, {
-      base: options.archive,
-      ignore: options.ignore ?? ['node_modules', '.git', '.nyc_output'],
+    path = path.endsWith('/') ? path : `${path}/`
+
+    const archiveDir = `/tmp/presidium/Docker-buildImage/${uniqid()}`
+
+    await fs.promises.mkdir(archiveDir, { recursive: true })
+
+    const archiveFilename = `${archiveDir}/archive.tar`
+
+    const cmdArgs = [
+      '-cf',
+      archiveFilename,
+      '-C',
+      path,
+    ]
+
+    if (options.ignore) {
+      for (const pattern of options.ignore) {
+        cmdArgs.push(`--exclude=${pattern}`)
+      }
+    }
+
+    cmdArgs.push('.')
+
+    const cmd = spawn('tar', cmdArgs, { stdio: 'inherit' })
+
+    await new Promise(resolve => {
+      cmd.on('close', resolve)
     })
 
-    const compressed = pack.pipe(zlib.createGzip())
+    if (options.archive) {
+      for (const filename in options.archive) {
+        await fs.promises.writeFile(
+          `${archiveDir}/${filename}`, options.archive[filename]
+        )
+
+        const cmdArgs = [
+          '-rf',
+          archiveFilename,
+          `--directory=${archiveDir}`,
+        ]
+
+        cmdArgs.push(filename)
+
+        const cmd = spawn('tar', cmdArgs, { stdio: 'inherit' })
+
+        await new Promise(resolve => {
+          cmd.on('close', resolve)
+        })
+      }
+    }
+
+    const archive = fs.createReadStream(archiveFilename).pipe(zlib.createGzip())
 
     const response = await this.http.post(`/build?${querystring.stringify({
       dockerfile: options.archiveDockerfile ?? 'Dockerfile',
@@ -414,12 +468,14 @@ class Docker {
       forcerm: true,
       platform: options.platform ?? '',
     })}`, {
-      body: compressed,
+      body: archive,
       headers: {
         'Content-Type': 'application/x-tar',
       },
     })
 
+    await fs.promises.rm(archiveDir, { recursive: true })
+
     const dataStream = await handleDockerHTTPResponse(response, { stream: true })
     return dataStream
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presidium",
-  "version": "4.0.10",
+  "version": "4.1.0",
   "description": "The Presidium library.",
   "author": "Richard Tong",
   "license": "CFOSS",
@@ -67,19 +67,18 @@
     "presidium-db": ">=3.10.0",
     "presidium-websocket": ">=3.2.1",
     "rubico": "^2.7.7",
-    "tar-stream": "^3.1.7"
+    "uniqid": "^5.4.0"
   },
   "scripts": {
     "test": "node test.js && mocha **/*.test.js *.test.js",
     "lint": "eslint ."
   },
   "devDependencies": {
-    "@aws-sdk/crc64-nvme-crt": "^3.848.0",
-    "eslint": "^7.13.0",
-    "fast-crc32c": "^2.0.0",
-    "mocha": "^10.8.2",
-    "nyc": "^17.1.0",
-    "thunk-test": "^1.3.9",
-    "wavefile": "^11.0.0"
+    "@aws-sdk/crc64-nvme-crt": "latest",
+    "fast-crc32c": "latest",
+    "mocha": "12.0.0-beta-3",
+    "nyc": "latest",
+    "thunk-test": "latest",
+    "wavefile": "latest"
   }
 }

package/internal/Archive.js

@@ -1,115 +0,0 @@
-require('rubico/global')
-const tarStream = require('tar-stream')
-const fs = require('fs')
-const walk = require('./walk')
-
-/**
- * @name Archive
- */
-const Archive = {}
-
-/**
- * @name Archive.tar
- *
- * @docs
- * ```coffeescript [specscript]
- * module tar 'https://github.com/mafintosh/tar-stream'
- *
- * Archive.tar(path string, options {
- *   ignore: Array<string>,
- *   base: Object<string>,
- * }) -> pack tar.Pack
- * ```
- *
- * Bundle multiple files and directories from a parent directory into a tarball.
- *
- * Arguments:
- *   * `path` - the path to the parent directory which contains the files and directories to bundle.
- *   * `options`
- *     * `ignore` - filepaths, filenames, or patterns to ignore.
- */
-Archive.tar = function tar(path, options) {
-  path = path.endsWith('/') ? path : `${path}/`
-  const ignore = get(options, 'ignore')
-  const pack = tarStream.pack()
-
-  pipe(path, [
-    walk,
-    filter(path => {
-      for (const part of ignore) {
-        if (path.includes(part)) {
-          return false
-        }
-      }
-      return true
-    }),
-
-    reduce(async (pack, filepath) => {
-      const stats = await pipe(filepath, [
-        fs.promises.stat,
-        pick(['size', 'mode', 'mtime', 'uid', 'gid']),
-      ])
-
-      const entry = pack.entry({ ...stats, name: filepath.replace(path, '') })
-
-      const fileStream = fs.createReadStream(filepath)
-
-      fileStream.pipe(entry)
-
-      await new Promise(resolve => {
-        fileStream.on('end', resolve)
-      })
-
-      return pack
-    }, pack),
-
-    tap(pack => {
-      const base = options.base ?? {}
-      for (const filename in base) {
-        pack.entry({ name: filename }, base[filename])
-      }
-      pack.finalize()
-    }),
-  ])
-
-  return pack
-}
-
-/**
- * @name untar
- *
- * @docs
- * ```coffeescript [specscript]
- * module tar 'https://github.com/mafintosh/tar-stream'
- * module presidium 'https://presidium.services/docs'
- *
- * Archive.untar(pack tar.Pack) ->
- *   contentMap Promise<Map<(filepath string)=>(content presidium.Readable)> >
- * ```
- *
- * Extract a tarball into a map of file paths to content streams.
- *
- * Arguments:
- *   * `pack` - a tarball represented by the `tar.Pack` type. Returned by the [tar](#tar) method.
- */
-Archive.untar = function untar(pack) {
-  const extractStream = tarStream.extract()
-  const extracted = new Map()
-  return new Promise((resolve, reject) => {
-    extractStream.on('entry', (header, stream, next) => {
-      stream.header = header
-      extracted.set(header.name, stream)
-      next()
-    })
-
-    extractStream.on('finish', () => {
-      resolve(extracted)
-    })
-
-    extractStream.on('error', reject)
-
-    pack.pipe(extractStream)
-  })
-}
-
-module.exports = Archive

package/internal/Archive.test.js

@@ -1,78 +0,0 @@
-const assert = require('assert')
-const stream = require('stream')
-const fs = require('fs/promises')
-const Test = require('thunk-test')
-const Archive = require('./Archive')
-const resolvePath = require('./resolvePath')
-const map = require('rubico/map')
-const reduce = require('rubico/reduce')
-const Readable = require('../Readable')
-
-const test = new Test('Archive', async function integration() {
-
-  {
-    const pack = await Archive.tar(__dirname, {
-      ignore: ['Dockerfile', 'node_modules', '.git', '.nyc_output'],
-    })
-    const extracted = await Archive.untar(pack)
-    assert(extracted.size > 0)
-    for (const [path, entry] of extracted) {
-      assert('header' in entry)
-      assert(!path.startsWith('/'))
-      assert.equal(typeof path, 'string')
-      assert.equal(typeof entry[Symbol.asyncIterator], 'function')
-      assert(entry.readable)
-    }
-  }
-
-  {
-    const base = {
-      Dockerfile: 'FROM node:15-alpine'
-    }
-    const ignore = ['fixtures', 'tmp', 'google-chrome-for-testing']
-    const pack = await Archive.tar(__dirname, { ignore, base })
-    const extracted = await Archive.untar(pack)
-    const dir = await fs.readdir(__dirname)
-      .then(filter(filepath => {
-        for (const part of ignore) {
-          if (filepath.includes(part)) {
-            return false
-          }
-        }
-        return true
-      }))
-    const extractedKeys = [...extracted.keys()]
-    assert.equal(extracted.size, dir.length + 1) // extra Dockerfile
-    assert(extracted.has('Dockerfile'))
-    assert.equal(
-      await reduce(extracted.get('Dockerfile'), (a, b) => a + b, ''),
-      'FROM node:15-alpine'
-    )
-  }
-
-  {
-    const base = {
-      Dockerfile: 'FROM busybox:1.32',
-      '.aws/credentials': '[presidium]\naccessKeyId\nsecretAccessKey',
-    }
-    const pack = await Archive.tar(`${__dirname}/`, {
-      ignore: ['hashJSON.js'],
-      base,
-    })
-    const extracted = await Archive.untar(pack)
-    assert(extracted.size > 0)
-    assert(extracted.has('Dockerfile'))
-    assert(extracted.has('.aws/credentials'))
-    assert.equal(
-      await reduce(extracted.get('Dockerfile'), (a, b) => a + b, ''),
-      'FROM busybox:1.32'
-    )
-  }
-
-}).case()
-
-if (process.argv[1] == __filename) {
-  test()
-}
-
-module.exports = test