@strapi/data-transfer 5.4.0 → 5.4.2

package/dist/index.mjs

@@ -576,7 +576,7 @@ class TransferEngine {
   reportInfo(message, params) {
     this.diagnostics.report({
       kind: "info",
-      details: { createdAt: /* @__PURE__ */ new Date(), message, params }
+      details: { createdAt: /* @__PURE__ */ new Date(), message, params, source: "engine" }
     });
   }
   /**
@@ -868,8 +868,8 @@ ${formattedDiffs}`,
    */
   async bootstrap() {
     const results = await Promise.allSettled([
-      this.sourceProvider.bootstrap?.(),
-      this.destinationProvider.bootstrap?.()
+      this.sourceProvider.bootstrap?.(this.diagnostics),
+      this.destinationProvider.bootstrap?.(this.diagnostics)
     ]);
     results.forEach((result) => {
       if (result.status === "rejected") {
@@ -1874,6 +1874,7 @@ class LocalStrapiDestinationProvider {
   transaction;
   uploadsBackupDirectoryName;
   onWarning;
+  #diagnostics;
   /**
    * The entities mapper is used to map old entities to their new IDs
    */
@@ -1883,7 +1884,8 @@ class LocalStrapiDestinationProvider {
     this.#entitiesMapper = {};
     this.uploadsBackupDirectoryName = `uploads_backup_${Date.now()}`;
   }
-  async bootstrap() {
+  async bootstrap(diagnostics) {
+    this.#diagnostics = diagnostics;
     this.#validateOptions();
     this.strapi = await this.options.getStrapi();
     if (!this.strapi) {
@@ -1900,6 +1902,16 @@ class LocalStrapiDestinationProvider {
     const excluded = this.options.restore?.entities?.exclude && this.options.restore?.entities.exclude.includes(type);
     return !excluded && !notIncluded;
   };
+  #reportInfo(message) {
+    this.#diagnostics?.report({
+      details: {
+        createdAt: /* @__PURE__ */ new Date(),
+        message,
+        source: "local-destination-provider"
+      },
+      kind: "info"
+    });
+  }
   async close() {
     const { autoDestroy } = this.options;
     this.transaction?.end();
@@ -1908,6 +1920,7 @@ class LocalStrapiDestinationProvider {
     }
   }
   #validateOptions() {
+    this.#reportInfo("validating options");
     if (!VALID_CONFLICT_STRATEGIES.includes(this.options.strategy)) {
       throw new ProviderValidationError(`Invalid strategy ${this.options.strategy}`, {
         check: "strategy",
@@ -1924,10 +1937,12 @@ class LocalStrapiDestinationProvider {
     if (!this.options.restore) {
       throw new ProviderValidationError("Missing restore options");
     }
+    this.#reportInfo("deleting record ");
     return deleteRecords(this.strapi, this.options.restore);
   }
   async #deleteAllAssets(trx) {
     assertValidStrapi(this.strapi);
+    this.#reportInfo("deleting all assets");
     if (!this.#areAssetsIncluded()) {
       return;
     }
@@ -1940,9 +1955,12 @@ class LocalStrapiDestinationProvider {
         }
       }
     }
+    this.#reportInfo("deleted all assets");
   }
   async rollback() {
+    this.#reportInfo("Rolling back transaction");
     await this.transaction?.rollback();
+    this.#reportInfo("Rolled back transaction");
   }
   async beforeTransfer() {
     if (!this.strapi) {
@@ -1961,6 +1979,7 @@ class LocalStrapiDestinationProvider {
     });
   }
   getMetadata() {
+    this.#reportInfo("getting metadata");
     assertValidStrapi(this.strapi, "Not able to get Schemas");
     const strapiVersion = this.strapi.config.get("info.strapi");
     const createdAt = (/* @__PURE__ */ new Date()).toISOString();
@@ -1972,6 +1991,7 @@ class LocalStrapiDestinationProvider {
     };
   }
   getSchemas() {
+    this.#reportInfo("getting schema");
     assertValidStrapi(this.strapi, "Not able to get Schemas");
     const schemas = schemasToValidJSON({
       ...this.strapi.contentTypes,
@@ -1981,6 +2001,7 @@ class LocalStrapiDestinationProvider {
   }
   createEntitiesWriteStream() {
     assertValidStrapi(this.strapi, "Not able to import entities");
+    this.#reportInfo("creating entities stream");
     const { strategy } = this.options;
     const updateMappingTable = (type, oldID, newID) => {
       if (!this.#entitiesMapper[type]) {
@@ -2007,6 +2028,7 @@ class LocalStrapiDestinationProvider {
       return;
     }
     if (this.strapi.config.get("plugin::upload").provider === "local") {
+      this.#reportInfo("creating assets backup directory");
       const assetsDirectory = path.join(this.strapi.dirs.static.public, "uploads");
       const backupDirectory = path.join(
         this.strapi.dirs.static.public,
@@ -2022,6 +2044,7 @@ class LocalStrapiDestinationProvider {
         await fse.move(assetsDirectory, backupDirectory);
         await fse.mkdir(assetsDirectory);
         await fse.outputFile(path.join(assetsDirectory, ".gitkeep"), "");
+        this.#reportInfo(`created assets backup directory ${backupDirectory}`);
       } catch (err) {
         throw new ProviderTransferError(
           "The backup folder for the assets could not be created inside the public folder. Please ensure Strapi has write permissions on the public directory",
@@ -2039,17 +2062,20 @@ class LocalStrapiDestinationProvider {
       return;
     }
     if (this.strapi.config.get("plugin::upload").provider === "local") {
+      this.#reportInfo("removing assets backup");
       assertValidStrapi(this.strapi);
       const backupDirectory = path.join(
         this.strapi.dirs.static.public,
         this.uploadsBackupDirectoryName
       );
       await fse.rm(backupDirectory, { recursive: true, force: true });
+      this.#reportInfo("successfully removed assets backup");
     }
   }
   // TODO: Move this logic to the restore strategy
   async createAssetsWriteStream() {
     assertValidStrapi(this.strapi, "Not able to stream Assets");
+    this.#reportInfo("creating assets write stream");
     if (!this.#areAssetsIncluded()) {
       throw new ProviderTransferError(
         "Attempting to transfer assets when `assets` is not set in restore options"
@@ -2144,6 +2170,7 @@ class LocalStrapiDestinationProvider {
   }
   async createConfigurationWriteStream() {
     assertValidStrapi(this.strapi, "Not able to stream Configurations");
+    this.#reportInfo("creating configuration write stream");
     const { strategy } = this.options;
     if (strategy === "restore") {
       return createConfigurationWriteStream(this.strapi, this.transaction);
@@ -2155,6 +2182,7 @@ class LocalStrapiDestinationProvider {
     });
   }
   async createLinksWriteStream() {
+    this.#reportInfo("creating links write stream");
     if (!this.strapi) {
       throw new Error("Not able to stream links. Strapi instance not found");
     }
@@ -2353,12 +2381,24 @@ class LocalStrapiSourceProvider {
   type = "source";
   options;
   strapi;
+  #diagnostics;
   constructor(options) {
     this.options = options;
   }
-  async bootstrap() {
+  async bootstrap(diagnostics) {
+    this.#diagnostics = diagnostics;
     this.strapi = await this.options.getStrapi();
   }
+  #reportInfo(message) {
+    this.#diagnostics?.report({
+      details: {
+        createdAt: /* @__PURE__ */ new Date(),
+        message,
+        source: "local-source-provider"
+      },
+      kind: "info"
+    });
+  }
   async close() {
     const { autoDestroy } = this.options;
     if (autoDestroy === void 0 || autoDestroy === true) {
@@ -2366,6 +2406,7 @@ class LocalStrapiSourceProvider {
     }
   }
   getMetadata() {
+    this.#reportInfo("getting metadata");
     const strapiVersion = strapi.config.get("info.strapi");
     const createdAt = (/* @__PURE__ */ new Date()).toISOString();
     return {
@@ -2377,6 +2418,7 @@ class LocalStrapiSourceProvider {
   }
   async createEntitiesReadStream() {
     assertValidStrapi(this.strapi, "Not able to stream entities");
+    this.#reportInfo("creating entities read stream");
     return chain([
       // Entities stream
       createEntitiesStream(this.strapi),
@@ -2386,14 +2428,17 @@ class LocalStrapiSourceProvider {
   }
   createLinksReadStream() {
     assertValidStrapi(this.strapi, "Not able to stream links");
+    this.#reportInfo("creating links read stream");
     return createLinksStream(this.strapi);
   }
   createConfigurationReadStream() {
     assertValidStrapi(this.strapi, "Not able to stream configuration");
+    this.#reportInfo("creating configuration read stream");
     return createConfigurationStream(this.strapi);
   }
   getSchemas() {
     assertValidStrapi(this.strapi, "Not able to get Schemas");
+    this.#reportInfo("getting schemas");
     const schemas = schemasToValidJSON({
       ...this.strapi.contentTypes,
       ...this.strapi.components
@@ -2405,13 +2450,14 @@ class LocalStrapiSourceProvider {
   }
   createAssetsReadStream() {
     assertValidStrapi(this.strapi, "Not able to stream assets");
+    this.#reportInfo("creating assets read stream");
     return createAssetsStream(this.strapi);
   }
 }
 const createDispatcher = (ws, retryMessageOptions = {
   retryMessageMaxRetries: 5,
   retryMessageTimeout: 3e4
-}) => {
+}, reportInfo) => {
   const state = {};
   const dispatch = async (message, options = {}) => {
     if (!ws) {
@@ -2424,6 +2470,16 @@ const createDispatcher = (ws, retryMessageOptions = {
       if (options.attachTransfer) {
         Object.assign(payload, { transferID: state.transfer?.id });
       }
+      if (message.type === "command") {
+        reportInfo?.(
+          `dispatching message command:${message.command} uuid:${uuid} sent:${numberOfTimesMessageWasSent}`
+        );
+      } else if (message.type === "transfer") {
+        const messageToSend = message;
+        reportInfo?.(
+          `dispatching message action:${messageToSend.action} ${messageToSend.kind === "step" ? `step:${messageToSend.step}` : ""} uuid:${uuid} sent:${numberOfTimesMessageWasSent}`
+        );
+      }
       const stringifiedPayload = JSON.stringify(payload);
       ws.send(stringifiedPayload, (error) => {
         if (error) {
@@ -2446,6 +2502,16 @@ const createDispatcher = (ws, retryMessageOptions = {
       const interval = setInterval(sendPeriodically, retryMessageTimeout);
       const onResponse = (raw) => {
         const response = JSON.parse(raw.toString());
+        if (message.type === "command") {
+          reportInfo?.(
+            `recieved response to message command: ${message.command} uuid: ${uuid} sent: ${numberOfTimesMessageWasSent}`
+          );
+        } else if (message.type === "transfer") {
+          const messageToSend = message;
+          reportInfo?.(
+            `recieved response to message action:${messageToSend.action} ${messageToSend.kind === "step" ? `step:${messageToSend.step}` : ""} uuid:${uuid} sent:${numberOfTimesMessageWasSent}`
+          );
+        }
         if (response.uuid === uuid) {
           clearInterval(interval);
           if (response.error) {
@@ -2577,6 +2643,7 @@ class RemoteStrapiDestinationProvider {
   dispatcher;
   transferID;
   stats;
+  #diagnostics;
   constructor(options) {
     this.options = options;
     this.ws = null;
@@ -2703,7 +2770,18 @@ class RemoteStrapiDestinationProvider {
       }
     });
   }
-  async bootstrap() {
+  #reportInfo(message) {
+    this.#diagnostics?.report({
+      details: {
+        createdAt: /* @__PURE__ */ new Date(),
+        message,
+        source: "remote-destination-provider"
+      },
+      kind: "info"
+    });
+  }
+  async bootstrap(diagnostics) {
+    this.#diagnostics = diagnostics;
     const { url, auth } = this.options;
     const validProtocols = ["https:", "http:"];
     let ws;
@@ -2720,6 +2798,7 @@ class RemoteStrapiDestinationProvider {
     const wsUrl = `${wsProtocol}//${url.host}${trimTrailingSlash(
       url.pathname
     )}${TRANSFER_PATH}/push`;
+    this.#reportInfo("establishing websocket connection");
     if (!auth) {
       ws = await connectToWebsocket(wsUrl);
     } else if (auth.type === "token") {
@@ -2733,10 +2812,19 @@ class RemoteStrapiDestinationProvider {
         }
       });
     }
+    this.#reportInfo("established websocket connection");
     this.ws = ws;
     const { retryMessageOptions } = this.options;
-    this.dispatcher = createDispatcher(this.ws, retryMessageOptions);
+    this.#reportInfo("creating dispatcher");
+    this.dispatcher = createDispatcher(
+      this.ws,
+      retryMessageOptions,
+      (message) => this.#reportInfo(message)
+    );
+    this.#reportInfo("created dispatcher");
+    this.#reportInfo("initialize transfer");
     this.transferID = await this.initTransfer();
+    this.#reportInfo(`initialized transfer ${this.transferID}`);
     this.dispatcher.setTransferProperties({ id: this.transferID, kind: "push" });
     await this.dispatcher.dispatchTransferAction("bootstrap");
   }
@@ -2863,6 +2951,7 @@ class RemoteStrapiSourceProvider {
     this.dispatcher = null;
   }
   results;
+  #diagnostics;
   async #createStageReadStream(stage) {
     const startResult = await this.#startStep(stage);
     if (startResult instanceof Error) {
@@ -3045,7 +3134,18 @@ class RemoteStrapiSourceProvider {
     }
     return res.transferID;
   }
-  async bootstrap() {
+  #reportInfo(message) {
+    this.#diagnostics?.report({
+      details: {
+        createdAt: /* @__PURE__ */ new Date(),
+        message,
+        source: "remote-source-provider"
+      },
+      kind: "info"
+    });
+  }
+  async bootstrap(diagnostics) {
+    this.#diagnostics = diagnostics;
     const { url, auth } = this.options;
     let ws;
     this.assertValidProtocol(url);
@@ -3053,6 +3153,7 @@ class RemoteStrapiSourceProvider {
     const wsUrl = `${wsProtocol}//${url.host}${trimTrailingSlash(
       url.pathname
     )}${TRANSFER_PATH}/pull`;
+    this.#reportInfo("establishing websocket connection");
     if (!auth) {
       ws = await connectToWebsocket(wsUrl);
     } else if (auth.type === "token") {
@@ -3066,10 +3167,19 @@ class RemoteStrapiSourceProvider {
         }
       });
     }
+    this.#reportInfo("established websocket connection");
     this.ws = ws;
     const { retryMessageOptions } = this.options;
-    this.dispatcher = createDispatcher(this.ws, retryMessageOptions);
+    this.#reportInfo("creating dispatcher");
+    this.dispatcher = createDispatcher(
+      this.ws,
+      retryMessageOptions,
+      (message) => this.#reportInfo(message)
+    );
+    this.#reportInfo("creating dispatcher");
+    this.#reportInfo("initialize transfer");
     const transferID = await this.initTransfer();
+    this.#reportInfo(`initialized transfer ${transferID}`);
     this.dispatcher.setTransferProperties({ id: transferID, kind: "pull" });
     await this.dispatcher.dispatchTransferAction("bootstrap");
   }
@@ -4060,6 +4170,7 @@ class LocalFileSourceProvider {
   name = "source::local-file";
   options;
   #metadata;
+  #diagnostics;
   constructor(options) {
     this.options = options;
     const { encryption } = this.options;
@@ -4067,10 +4178,21 @@ class LocalFileSourceProvider {
       throw new Error("Missing encryption key");
     }
   }
+  #reportInfo(message) {
+    this.#diagnostics?.report({
+      details: {
+        createdAt: /* @__PURE__ */ new Date(),
+        message,
+        source: "file-source-provider"
+      },
+      kind: "info"
+    });
+  }
   /**
    * Pre flight checks regarding the provided options, making sure that the file can be opened (decrypted, decompressed), etc.
    */
-  async bootstrap() {
+  async bootstrap(diagnostics) {
+    this.#diagnostics = diagnostics;
     const { path: filePath } = this.options.file;
     try {
       await this.#loadMetadata();
@@ -4095,12 +4217,14 @@ class LocalFileSourceProvider {
     return this.#parseJSONFile(backupStream, path2);
   }
   async getMetadata() {
+    this.#reportInfo("getting metadata");
     if (!this.#metadata) {
       await this.#loadMetadata();
     }
     return this.#metadata ?? null;
   }
   async getSchemas() {
+    this.#reportInfo("getting schemas");
     const schemaCollection = await collect(
       this.createSchemasReadStream()
     );
@@ -4111,21 +4235,26 @@ class LocalFileSourceProvider {
     return schemasToValidJSON(schemas);
   }
   createEntitiesReadStream() {
+    this.#reportInfo("creating entities read stream");
     return this.#streamJsonlDirectory("entities");
   }
   createSchemasReadStream() {
+    this.#reportInfo("creating schemas read stream");
     return this.#streamJsonlDirectory("schemas");
   }
   createLinksReadStream() {
+    this.#reportInfo("creating links read stream");
     return this.#streamJsonlDirectory("links");
   }
   createConfigurationReadStream() {
+    this.#reportInfo("creating configuration read stream");
     return this.#streamJsonlDirectory("configuration");
   }
   createAssetsReadStream() {
     const inStream = this.#getBackupStream();
     const outStream = new PassThrough({ objectMode: true });
     const loadAssetMetadata = this.#loadAssetMetadata.bind(this);
+    this.#reportInfo("creating assets read stream");
     pipeline(
       [
         inStream,
@@ -4326,9 +4455,20 @@ class LocalFileDestinationProvider {
   results = {};
   #providersMetadata = {};
   #archive = {};
+  #diagnostics;
   constructor(options) {
     this.options = options;
   }
+  #reportInfo(message) {
+    this.#diagnostics?.report({
+      details: {
+        createdAt: /* @__PURE__ */ new Date(),
+        message,
+        source: "file-destination-provider"
+      },
+      kind: "info"
+    });
+  }
   get #archivePath() {
     const { encryption, compression, file } = this.options;
     let filePath = `${file.path}.tar`;
@@ -4345,9 +4485,11 @@ class LocalFileDestinationProvider {
     return this;
   }
   createGzip() {
+    this.#reportInfo("creating gzip");
     return zip$1.createGzip();
   }
-  bootstrap() {
+  bootstrap(diagnostics) {
+    this.#diagnostics = diagnostics;
     const { compression, encryption } = this.options;
     if (encryption.enabled && !encryption.key) {
       throw new Error("Can't encrypt without a key");
@@ -4386,6 +4528,7 @@ class LocalFileDestinationProvider {
     }
   }
   async rollback() {
+    this.#reportInfo("rolling back");
     await this.close();
     await rm(this.#archivePath, { force: true });
   }
@@ -4393,6 +4536,7 @@ class LocalFileDestinationProvider {
     return null;
   }
   async #writeMetadata() {
+    this.#reportInfo("writing metadata");
     const metadata = this.#providersMetadata.source;
     if (metadata) {
       await new Promise((resolve) => {
@@ -4413,6 +4557,7 @@ class LocalFileDestinationProvider {
     if (!this.#archive.stream) {
       throw new Error("Archive stream is unavailable");
     }
+    this.#reportInfo("creating schemas write stream");
     const filePathFactory = createFilePathFactory("schemas");
     const entryStream = createTarEntryStream(
       this.#archive.stream,
@@ -4425,6 +4570,7 @@ class LocalFileDestinationProvider {
     if (!this.#archive.stream) {
       throw new Error("Archive stream is unavailable");
     }
+    this.#reportInfo("creating entities write stream");
     const filePathFactory = createFilePathFactory("entities");
     const entryStream = createTarEntryStream(
       this.#archive.stream,
@@ -4437,6 +4583,7 @@ class LocalFileDestinationProvider {
     if (!this.#archive.stream) {
       throw new Error("Archive stream is unavailable");
     }
+    this.#reportInfo("creating links write stream");
     const filePathFactory = createFilePathFactory("links");
     const entryStream = createTarEntryStream(
       this.#archive.stream,
@@ -4449,6 +4596,7 @@ class LocalFileDestinationProvider {
     if (!this.#archive.stream) {
       throw new Error("Archive stream is unavailable");
     }
+    this.#reportInfo("creating configuration write stream");
     const filePathFactory = createFilePathFactory("configuration");
     const entryStream = createTarEntryStream(
       this.#archive.stream,
@@ -4462,6 +4610,7 @@ class LocalFileDestinationProvider {
     if (!archiveStream) {
       throw new Error("Archive stream is unavailable");
     }
+    this.#reportInfo("creating assets write stream");
     return new Writable({
       objectMode: true,
       write(data, _encoding, callback) {