@sanity/export 3.39.0 → 3.40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/export",
-  "version": "3.39.0",
+  "version": "3.40.0",
   "description": "Export Sanity documents and assets",
   "keywords": [
     "sanity",

package/src/constants.js

@@ -33,3 +33,11 @@ exports.DOCUMENT_STREAM_DEBUG_INTERVAL = 10000
  * @internal
  */
 exports.REQUEST_READ_TIMEOUT = 3 * 60 * 1000 // 3 minutes
+
+/**
+  What mode to use when exporting documents.
+  stream: Export all documents in the dataset in one request, this will be consistent but might be slow on large datasets.
+  cursor: Export documents using a cursor, this might lead to inconsistent results if a mutation is performed while exporting.
+*/
+exports.MODE_STREAM = 'stream'
+exports.MODE_CURSOR = 'cursor'

package/src/export.js

@@ -11,13 +11,14 @@ const filterDocumentTypes = require('./filterDocumentTypes')
 const filterDrafts = require('./filterDrafts')
 const filterSystemDocuments = require('./filterSystemDocuments')
 const getDocumentsStream = require('./getDocumentsStream')
+const getDocumentCursorStream = require('./getDocumentCursorStream')
 const logFirstChunk = require('./logFirstChunk')
 const rejectOnApiError = require('./rejectOnApiError')
 const stringifyStream = require('./stringifyStream')
 const tryParseJson = require('./tryParseJson')
 const rimraf = require('./util/rimraf')
 const validateOptions = require('./validateOptions')
-const {DOCUMENT_STREAM_DEBUG_INTERVAL} = require('./constants')
+const {DOCUMENT_STREAM_DEBUG_INTERVAL, MODE_CURSOR, MODE_STREAM} = require('./constants')
 
 const noop = () => null
 
@@ -118,7 +119,7 @@ async function exportDataset(opts) {
     cb(null, doc)
   }
 
-  const inputStream = await getDocumentsStream(options)
+  const inputStream = await getDocumentInputStream(options)
   debug('Got HTTP %d', inputStream.statusCode)
   debug('Response headers: %o', inputStream.headers)
 
@@ -250,6 +251,17 @@ async function exportDataset(opts) {
   return result
 }
 
+function getDocumentInputStream(options) {
+  if (options.mode === MODE_STREAM) {
+    return getDocumentsStream(options)
+  }
+  if (options.mode === MODE_CURSOR) {
+    return getDocumentCursorStream(options)
+  }
+
+  throw new Error(`Invalid mode: ${options.mode}`)
+}
+
 function isWritableStream(val) {
   return (
     val !== null &&

package/src/getDocumentCursorStream.js

@@ -0,0 +1,73 @@
+const {Transform} = require('node:stream')
+
+const pkg = require('../package.json')
+const requestStream = require('./requestStream')
+
+module.exports = async (options) => {
+  let streamsInflight = 0
+  const stream = new Transform({
+    async transform(chunk, encoding, callback) {
+      if (encoding !== 'buffer' && encoding !== 'string') {
+        callback(null, chunk)
+        return
+      }
+
+      let parsedChunk = null
+      try {
+        parsedChunk = JSON.parse(chunk.toString())
+      } catch (err) {
+        // Ignore JSON parse errors
+        // this can happen if the chunk is not a JSON object. We just pass it through and let the caller handle it.
+      }
+
+      if (
+        parsedChunk !== null &&
+        typeof parsedChunk === 'object' &&
+        'nextCursor' in parsedChunk &&
+        typeof parsedChunk.nextCursor === 'string' &&
+        !('_id' in parsedChunk)
+      ) {
+        streamsInflight++
+
+        const reqStream = await startStream(options, parsedChunk.nextCursor)
+        reqStream.on('end', () => {
+          streamsInflight--
+          if (streamsInflight === 0) {
+            stream.end()
+          }
+        })
+        reqStream.pipe(this, {end: false})
+
+        callback()
+        return
+      }
+
+      callback(null, chunk)
+    },
+  })
+
+  streamsInflight++
+  const reqStream = await startStream(options, '')
+  reqStream.on('end', () => {
+    streamsInflight--
+    if (streamsInflight === 0) {
+      stream.end()
+    }
+  })
+
+  reqStream.pipe(stream, {end: false})
+  return stream
+}
+
+function startStream(options, nextCursor) {
+  const url = options.client.getUrl(
+    `/data/export/${options.dataset}?nextCursor=${encodeURIComponent(nextCursor)}`,
+  )
+  const token = options.client.config().token
+  const headers = {
+    'User-Agent': `${pkg.name}@${pkg.version}`,
+    ...(token ? {Authorization: `Bearer ${token}`} : {}),
+  }
+
+  return requestStream({url, headers, maxRetries: options.maxRetries})
+}

package/src/validateOptions.js

@@ -3,6 +3,8 @@ const {
   DOCUMENT_STREAM_MAX_RETRIES,
   ASSET_DOWNLOAD_MAX_RETRIES,
   REQUEST_READ_TIMEOUT,
+  MODE_STREAM,
+  MODE_CURSOR,
 } = require('./constants')
 
 const clientMethods = ['getUrl', 'config']
@@ -13,6 +15,7 @@ const exportDefaults = {
   drafts: true,
   assets: true,
   raw: false,
+  mode: MODE_STREAM,
   maxRetries: DOCUMENT_STREAM_MAX_RETRIES,
   maxAssetRetries: ASSET_DOWNLOAD_MAX_RETRIES,
   readTimeout: REQUEST_READ_TIMEOUT,
@@ -25,6 +28,15 @@ function validateOptions(opts) {
     throw new Error(`options.dataset must be a valid dataset name`)
   }
 
+  if (
+    typeof options.mode !== 'string' ||
+    (options.mode !== MODE_STREAM && options.mode !== MODE_CURSOR)
+  ) {
+    throw new Error(
+      `options.mode must be either "${MODE_STREAM}" or "${MODE_CURSOR}", got "${options.mode}"`,
+    )
+  }
+
   if (options.onProgress && typeof options.onProgress !== 'function') {
     throw new Error(`options.onProgress must be a function`)
   }