@sanity/import/src/importFromStream.js

Import documents to a Sanity dataset

const fs = require('fs')
const os = require('os')
const path = require('path')
const debug = require('debug')('sanity:import:stream')
const {glob} = require('tinyglobby')
const gunzipMaybe = require('gunzip-maybe')
const isTar = require('is-tar')
const {noop} = require('lodash')
const miss = require('mississippi')
const peek = require('peek-stream')
const tar = require('tar-fs')
const getJsonStreamer = require('./util/getJsonStreamer')

module.exports = (stream, options, importers) =>
  new Promise((resolve, reject) => {
    const slugDate = new Date()
      .toISOString()
      .replace(/[^a-z0-9]/gi, '-')
      .toLowerCase()

    const outputPath = path.join(os.tmpdir(), `sanity-import-${slugDate}`)
    debug('Importing from stream')

    let isTarStream = false
    let jsonDocuments

    const uncompressStream = miss.pipeline(gunzipMaybe(), untarMaybe())
    miss.pipe(stream, uncompressStream, (err) => {
      if (err) {
        reject(err)
        return
      }

      if (isTarStream) {
        findAndImport()
      } else {
        resolve(importers.fromArray(jsonDocuments, options))
      }
    })

    function untarMaybe() {
      return peek({newline: false, maxBuffer: 300}, (data, swap) => {
        if (isTar(data)) {
          debug('Stream is a tarball, extracting to %s', outputPath)
          isTarStream = true
          return swap(null, tar.extract(outputPath))
        }

        debug('Stream is an ndjson file, streaming JSON')
        const jsonStreamer = getJsonStreamer()
        const concatter = miss.concat(resolveNdjsonStream)
        const ndjsonStream = miss.pipeline(jsonStreamer, concatter)
        ndjsonStream.on('error', (err) => {
          uncompressStream.emit('error', err)
          destroy([uncompressStream, jsonStreamer, concatter, ndjsonStream])
          reject(err)
        })
        return swap(null, ndjsonStream)
      })
    }

    function resolveNdjsonStream(documents) {
      debug('Finished reading ndjson stream')
      jsonDocuments = documents
    }

    async function findAndImport() {
      debug('Tarball extracted, looking for ndjson')

      const files = await glob(['**/*.ndjson'], {cwd: outputPath, deep: 2, absolute: true})
      if (!files.length) {
        reject(new Error('ndjson-file not found in tarball'))
        return
      }

      const importBaseDir = path.dirname(files[0])
      resolve(importers.fromFolder(importBaseDir, {...options, deleteOnComplete: true}, importers))
    }
  })

function destroy(streams) {
  streams.forEach((stream) => {
    if (isFS(stream)) {
      // use close for fs streams to avoid fd leaks
      stream.close(noop)
    } else if (isRequest(stream)) {
      // request.destroy just do .end - .abort is what we want
      stream.abort()
    } else if (isFn(stream.destroy)) {
      stream.destroy()
    }
  })
}

function isFn(fn) {
  return typeof fn === 'function'
}

function isFS(stream) {
  return (
    (stream instanceof (fs.ReadStream || noop) || stream instanceof (fs.WriteStream || noop)) &&
    isFn(stream.close)
  )
}

function isRequest(stream) {
  return stream.setHeader && isFn(stream.abort)
}