contentful-export 8.2.0 → 8.2.2

package/README.md

@@ -216,6 +216,14 @@ Skip exporting webhooks
 
 Untag assets and entries
 
+#### `includeExperienceOrchestration` [boolean] [default: true]
+
+Export Experience Orchestration (ExO) entities: Design Tokens, Components, Experience Templates, Data Assemblies, Experience Fragments, and Experiences.
+
+Requires the Organization to have the `exo_m1` entitlement. If the Organization is not entitled, the export will not throw — each ExO array will be empty and a warning will be logged.
+
+See [docs/exo-export.md](./docs/exo-export.md) for full details.
+
 #### `contentOnly` [boolean] [default: false]
 
 Only export entries and assets
@@ -340,6 +348,19 @@ This is an overview of the exported data:
 }
 ```
 
+When `includeExperienceOrchestration: true` is set, six additional arrays are included:
+
+```json
+{
+  "designTokens": [],
+  "components": [],
+  "experienceTemplates": [],
+  "dataAssemblies": [],
+  "experienceFragments": [],
+  "experiences": []
+}
+```
+
 _Note:_ Tags feature is not available for all users. If you do not have access to this feature, the tags array will always be empty.
 
 _Note:_ `designTokens`, `components`, `experienceTemplates`, `dataAssemblies`, `experienceFragments`, and `experiences` are Experience Orchestration (ExO) entities — present by default; absent only if you explicitly set `includeExperienceOrchestration: false` — see the "Experience Orchestration (ExO) entities" section below.

package/dist/index.js

@@ -118,8 +118,11 @@ function runContentfulExport(params) {
           return _bfj.default.write(options.logFilePath, ctx.data, {
             circular: 'ignore',
             space: 2,
-            bufferLength: 1024,
-            yieldRate: 16384
+            // Do not set `yieldRate` -- values above `bufferLength`
+            // make bfj 9's serialization quadratic and it never
+            // finishes. See DX-1343.
+            bufferLength: 65536,
+            highWaterMark: 1024 * 1024
           });
         }
       }]);

package/dist/tasks/download-assets.js

@@ -13,19 +13,26 @@ var _stream = require("stream");
 var _util = require("util");
 var _embargoedAssets = require("../utils/embargoedAssets");
 var _axios = _interopRequireDefault(require("axios"));
+var _axiosRetry = _interopRequireDefault(require("axios-retry"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const streamPipeline = (0, _util.promisify)(_stream.pipeline);
 
+// For streaming responses, axios timeout applies to time-to-first-byte, not total transfer duration
+const DEFAULT_DOWNLOAD_TIMEOUT_MS = 30000;
+const DEFAULT_RETRY_LIMIT = 3;
+
 /**
  * @param {Object} options - The options for downloading the asset.
  * @param {string} options.url - The URL of the asset to download.
  * @param {string} options.directory - The directory where the asset should be saved.
  * @param {import('axios').AxiosInstance} options.httpClient - The HTTP client to use for downloading the asset.
+ * @param {string} options.assetId - The ID of the asset being downloaded, used in error messages.
  */
 async function downloadAsset({
   url,
   directory,
-  httpClient
+  httpClient,
+  assetId
 }) {
   // handle urls without protocol
   if (url.startsWith('//')) {
@@ -57,7 +64,14 @@ async function downloadAsset({
      * @type {import('axios').AxiosError}
      */
     const axiosError = e;
-    throw new Error(`error response status: ${axiosError.response.status}`);
+    if (axiosError.response) {
+      throw new Error(`error downloading asset ${assetId} (${url}): HTTP ${axiosError.response.status} ${axiosError.response.statusText}`, {
+        cause: axiosError
+      });
+    }
+    throw new Error(`error downloading asset ${assetId} (${url}): ${e.message}`, {
+      cause: e
+    });
   }
 }
 function downloadAssets(options) {
@@ -67,11 +81,24 @@ function downloadAssets(options) {
     let errorCount = 0;
     const httpClient = _axios.default.create({
       headers: options.headers,
-      timeout: options.timeout,
+      timeout: DEFAULT_DOWNLOAD_TIMEOUT_MS,
       httpAgent: options.httpAgent,
       httpsAgent: options.httpsAgent,
       proxy: options.proxy
     });
+    (0, _axiosRetry.default)(httpClient, {
+      retries: DEFAULT_RETRY_LIMIT,
+      retryDelay: _axiosRetry.default.exponentialDelay,
+      shouldResetTimeout: true,
+      retryCondition: error => {
+        var _error$response;
+        return _axiosRetry.default.isNetworkOrIdempotentRequestError(error) || ((_error$response = error.response) === null || _error$response === void 0 ? void 0 : _error$response.status) === 429;
+      },
+      onRetry: (retryCount, error) => {
+        const status = error.response ? `HTTP ${error.response.status}` : error.code || error.message;
+        _contentfulBatchLibs.logEmitter.emit('warning', `Asset download failed (${status}), retrying (attempt ${retryCount})...`);
+      }
+    });
     return _bluebird.default.map(ctx.data.assets, asset => {
       const entityName = (0, _contentfulBatchLibs.getEntityName)(asset);
       if (!asset.fields.file) {
@@ -87,10 +114,12 @@ function downloadAssets(options) {
           errorCount++;
           return _bluebird.default.resolve();
         }
+        const assetId = asset.sys.id;
         let startingPromise = _bluebird.default.resolve({
           url,
           directory: options.exportDir,
-          httpClient
+          httpClient,
+          assetId
         });
         if ((0, _embargoedAssets.isEmbargoedAsset)(url)) {
           const {
@@ -103,13 +132,15 @@ function downloadAssets(options) {
           startingPromise = (0, _embargoedAssets.signUrl)(host, accessToken, spaceId, environmentId, url, expiresAtMs, httpClient).then(signedUrl => ({
             url: signedUrl,
             directory: options.exportDir,
-            httpClient
+            httpClient,
+            assetId
           }));
         }
         return startingPromise.then(downloadAsset).then(() => {
           task.output = `${_figures.default.tick} downloaded ${entityName} (${url})`;
           successCount++;
         }).catch(error => {
+          _contentfulBatchLibs.logEmitter.emit('warning', error.message);
           task.output = `${_figures.default.cross} error downloading ${url}: ${error.message}`;
           errorCount++;
         });

package/dist/tasks/get-space-data.js

@@ -71,8 +71,11 @@ function getFullSourceSpace({
         method: 'getTags'
       }).then(extractItems).then(items => {
         ctx.data.tags = items;
-      }).catch(() => {
-        ctx.data.tags = [];
+      }).catch(err => {
+        _contentfulBatchLibs.logEmitter.emit('error', new Error(`Fetching tags failed: ${err.message}`, {
+          cause: err
+        }));
+        throw err;
       });
     }),
     skip: () => skipTags
@@ -257,7 +260,7 @@ function getEditorInterfaces(contentTypes) {
     }).catch(() => {
       // old contentTypes may not have an editor interface but we'll handle in a later stage
       // but it should not stop getting the data process
-      _contentfulBatchLibs.logEmitter.emit('warning', `No editor interface found for ${contentType}`);
+      _contentfulBatchLibs.logEmitter.emit('warning', `No editor interface found for ${contentType.name || contentType.sys.id}`);
       return _bluebird.default.resolve(null);
     });
   }, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-export",
-  "version": "8.2.0",
+  "version": "8.2.2",
   "description": "this tool allows you to export a space to a JSON dump",
   "main": "dist/index.js",
   "types": "types.d.ts",
@@ -46,6 +46,7 @@
   },
   "dependencies": {
     "axios": "^1.13.5",
+    "axios-retry": "^4.5.0",
     "bfj": "^9.1.3",
     "bluebird": "^3.3.3",
     "cli-table3": "^0.6.0",