@strapi/data-transfer 5.4.2 → 5.5.1

package/dist/index.mjs

@@ -298,8 +298,57 @@ const middleware = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.definePr
   __proto__: null,
   runMiddleware
 }, Symbol.toStringTag, { value: "Module" }));
+const createDiagnosticReporter = (options = {}) => {
+  const { stackSize = -1 } = options;
+  const emitter = new EventEmitter();
+  const stack = [];
+  const addListener = (event, listener) => {
+    emitter.on(event, listener);
+  };
+  const isDiagnosticValid = (diagnostic2) => {
+    if (!diagnostic2.kind || !diagnostic2.details || !diagnostic2.details.message) {
+      return false;
+    }
+    return true;
+  };
+  return {
+    stack: {
+      get size() {
+        return stack.length;
+      },
+      get items() {
+        return stack;
+      }
+    },
+    report(diagnostic2) {
+      if (!isDiagnosticValid(diagnostic2)) {
+        return this;
+      }
+      emitter.emit("diagnostic", diagnostic2);
+      emitter.emit(`diagnostic.${diagnostic2.kind}`, diagnostic2);
+      if (stackSize !== -1 && stack.length >= stackSize) {
+        stack.shift();
+      }
+      stack.push(diagnostic2);
+      return this;
+    },
+    onDiagnostic(listener) {
+      addListener("diagnostic", listener);
+      return this;
+    },
+    on(kind, listener) {
+      addListener(`diagnostic.${kind}`, listener);
+      return this;
+    }
+  };
+};
+const diagnostic = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  createDiagnosticReporter
+}, Symbol.toStringTag, { value: "Module" }));
 const index$8 = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
+  diagnostics: diagnostic,
   encryption: index$9,
   json,
   middleware,
@@ -400,50 +449,6 @@ const validateProvider = (type, provider) => {
     );
   }
 };
-const createDiagnosticReporter = (options = {}) => {
-  const { stackSize = -1 } = options;
-  const emitter = new EventEmitter();
-  const stack = [];
-  const addListener = (event, listener) => {
-    emitter.on(event, listener);
-  };
-  const isDiagnosticValid = (diagnostic) => {
-    if (!diagnostic.kind || !diagnostic.details || !diagnostic.details.message) {
-      return false;
-    }
-    return true;
-  };
-  return {
-    stack: {
-      get size() {
-        return stack.length;
-      },
-      get items() {
-        return stack;
-      }
-    },
-    report(diagnostic) {
-      if (!isDiagnosticValid(diagnostic)) {
-        return this;
-      }
-      emitter.emit("diagnostic", diagnostic);
-      emitter.emit(`diagnostic.${diagnostic.kind}`, diagnostic);
-      if (stackSize !== -1 && stack.length >= stackSize) {
-        stack.shift();
-      }
-      stack.push(diagnostic);
-      return this;
-    },
-    onDiagnostic(listener) {
-      addListener("diagnostic", listener);
-      return this;
-    },
-    on(kind, listener) {
-      addListener(`diagnostic.${kind}`, listener);
-      return this;
-    }
-  };
-};
 class ProviderError extends DataTransferError {
   constructor(severity, message, details) {
     super("provider", severity, message, details);
@@ -576,7 +581,7 @@ class TransferEngine {
   reportInfo(message, params) {
     this.diagnostics.report({
       kind: "info",
-      details: { createdAt: /* @__PURE__ */ new Date(), message, params, source: "engine" }
+      details: { createdAt: /* @__PURE__ */ new Date(), message, params, origin: "engine" }
     });
   }
   /**
@@ -1907,7 +1912,7 @@ class LocalStrapiDestinationProvider {
       details: {
         createdAt: /* @__PURE__ */ new Date(),
         message,
-        source: "local-destination-provider"
+        origin: "local-destination-provider"
       },
       kind: "info"
     });
@@ -2084,7 +2089,6 @@ class LocalStrapiDestinationProvider {
     const removeAssetsBackup = this.#removeAssetsBackup.bind(this);
     const strapi2 = this.strapi;
     const transaction2 = this.transaction;
-    const backupDirectory = this.uploadsBackupDirectoryName;
     const fileEntitiesMapper = this.#entitiesMapper["plugin::upload.file"];
     const restoreMediaEntitiesContent = this.#isContentTypeIncluded("plugin::upload.file");
     return new Writable({
@@ -2095,47 +2099,28 @@ class LocalStrapiDestinationProvider {
       },
       async write(chunk, _encoding, callback) {
         await transaction2?.attach(async () => {
-          if (!chunk.metadata) {
-            const assetsDirectory = path.join(strapi2.dirs.static.public, "uploads");
-            const entryPath = path.join(assetsDirectory, chunk.filename);
-            const writableStream = fse.createWriteStream(entryPath);
-            chunk.stream.pipe(writableStream).on("close", () => {
-              callback(null);
-            }).on("error", async (error) => {
-              const errorMessage = error.code === "ENOSPC" ? " Your server doesn't have space to proceed with the import. " : " ";
-              try {
-                await fse.rm(assetsDirectory, { recursive: true, force: true });
-                this.destroy(
-                  new ProviderTransferError(
-                    `There was an error during the transfer process.${errorMessage}The original files have been restored to ${assetsDirectory}`
-                  )
-                );
-              } catch (err) {
-                throw new ProviderTransferError(
-                  `There was an error doing the rollback process. The original files are in ${backupDirectory}, but we failed to restore them to ${assetsDirectory}`
-                );
-              } finally {
-                callback(error);
-              }
-            });
-            return;
-          }
           const uploadData = {
             ...chunk.metadata,
             stream: Readable.from(chunk.stream),
             buffer: chunk?.buffer
           };
           const provider = strapi2.config.get("plugin::upload").provider;
+          const fileId = fileEntitiesMapper?.[uploadData.id];
+          if (!fileId) {
+            callback(new Error(`File ID not found for ID: ${uploadData.id}`));
+          }
           try {
             await strapi2.plugin("upload").provider.uploadStream(uploadData);
             if (!restoreMediaEntitiesContent) {
               return callback();
             }
             if (uploadData?.type) {
-              const condition = uploadData?.id ? { id: fileEntitiesMapper[uploadData.id] } : { hash: uploadData.mainHash };
               const entry2 = await strapi2.db.query("plugin::upload.file").findOne({
-                where: condition
+                where: { id: fileId }
               });
+              if (!entry2) {
+                throw new Error("file not found");
+              }
               const specificFormat = entry2?.formats?.[uploadData.type];
               if (specificFormat) {
                 specificFormat.url = uploadData.url;
@@ -2150,8 +2135,11 @@ class LocalStrapiDestinationProvider {
               return callback();
             }
             const entry = await strapi2.db.query("plugin::upload.file").findOne({
-              where: { id: fileEntitiesMapper[uploadData.id] }
+              where: { id: fileId }
             });
+            if (!entry) {
+              throw new Error("file not found");
+            }
             entry.url = uploadData.url;
             await strapi2.db.query("plugin::upload.file").update({
               where: { id: entry.id },
@@ -2394,7 +2382,7 @@ class LocalStrapiSourceProvider {
       details: {
         createdAt: /* @__PURE__ */ new Date(),
         message,
-        source: "local-source-provider"
+        origin: "local-source-provider"
       },
       kind: "info"
     });
@@ -2504,12 +2492,12 @@ const createDispatcher = (ws, retryMessageOptions = {
         const response = JSON.parse(raw.toString());
         if (message.type === "command") {
           reportInfo?.(
-            `recieved response to message command: ${message.command} uuid: ${uuid} sent: ${numberOfTimesMessageWasSent}`
+            `received 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}`
+            `received response to message action:${messageToSend.action} ${messageToSend.kind === "step" ? `step:${messageToSend.step}` : ""} uuid:${uuid} sent:${numberOfTimesMessageWasSent}`
           );
         }
         if (response.uuid === uuid) {
@@ -2568,7 +2556,7 @@ const createDispatcher = (ws, retryMessageOptions = {
     dispatchTransferStep
   };
 };
-const connectToWebsocket = (address, options) => {
+const connectToWebsocket = (address, options, diagnostics) => {
   return new Promise((resolve, reject2) => {
     const server = new WebSocket(address, options);
     server.once("open", () => {
@@ -2602,6 +2590,14 @@ const connectToWebsocket = (address, options) => {
         )
       );
     });
+    server.on("message", (raw) => {
+      const response = JSON.parse(raw.toString());
+      if (response.diagnostic) {
+        diagnostics?.report({
+          ...response.diagnostic
+        });
+      }
+    });
     server.once("error", (err) => {
       reject2(
         new ProviderTransferError(err.message, {
@@ -2775,7 +2771,7 @@ class RemoteStrapiDestinationProvider {
       details: {
         createdAt: /* @__PURE__ */ new Date(),
         message,
-        source: "remote-destination-provider"
+        origin: "remote-destination-provider"
       },
       kind: "info"
     });
@@ -2800,10 +2796,10 @@ class RemoteStrapiDestinationProvider {
     )}${TRANSFER_PATH}/push`;
     this.#reportInfo("establishing websocket connection");
     if (!auth) {
-      ws = await connectToWebsocket(wsUrl);
+      ws = await connectToWebsocket(wsUrl, void 0, this.#diagnostics);
     } else if (auth.type === "token") {
       const headers = { Authorization: `Bearer ${auth.token}` };
-      ws = await connectToWebsocket(wsUrl, { headers });
+      ws = await connectToWebsocket(wsUrl, { headers }, this.#diagnostics);
     } else {
       throw new ProviderValidationError("Auth method not available", {
         check: "auth.type",
@@ -3139,7 +3135,7 @@ class RemoteStrapiSourceProvider {
       details: {
         createdAt: /* @__PURE__ */ new Date(),
         message,
-        source: "remote-source-provider"
+        origin: "remote-source-provider"
       },
       kind: "info"
     });
@@ -3155,10 +3151,10 @@ class RemoteStrapiSourceProvider {
     )}${TRANSFER_PATH}/pull`;
     this.#reportInfo("establishing websocket connection");
     if (!auth) {
-      ws = await connectToWebsocket(wsUrl);
+      ws = await connectToWebsocket(wsUrl, void 0, this.#diagnostics);
     } else if (auth.type === "token") {
       const headers = { Authorization: `Bearer ${auth.token}` };
-      ws = await connectToWebsocket(wsUrl, { headers });
+      ws = await connectToWebsocket(wsUrl, { headers }, this.#diagnostics);
     } else {
       throw new ProviderValidationError("Auth method not available", {
         check: "auth.type",
@@ -3409,6 +3405,7 @@ const handlerControllerFactory = (implementation) => (options) => {
     const cb = (ws) => {
       const state = { id: void 0 };
       const messageUUIDs = /* @__PURE__ */ new Set();
+      const diagnostics = createDiagnosticReporter();
       const cannotRespondHandler = (err) => {
         strapi?.log?.error(
           "[Data transfer] Cannot send error response to client, closing connection"
@@ -3442,6 +3439,9 @@ const handlerControllerFactory = (implementation) => (options) => {
         set response(response) {
           state.response = response;
         },
+        get diagnostics() {
+          return diagnostics;
+        },
         addUUID(uuid) {
           messageUUIDs.add(uuid);
         },
@@ -3557,6 +3557,10 @@ const handlerControllerFactory = (implementation) => (options) => {
         onError() {
         },
         onClose() {
+        },
+        onInfo() {
+        },
+        onWarning() {
         }
       };
       const handler = Object.assign(Object.create(prototype), implementation(prototype));
@@ -3589,6 +3593,14 @@ const handlerControllerFactory = (implementation) => (options) => {
           cannotRespondHandler(err);
         }
       });
+      diagnostics.onDiagnostic((diagnostic2) => {
+        const uuid = randomUUID();
+        const payload = JSON.stringify({
+          diagnostic: diagnostic2,
+          uuid
+        });
+        handler.send(payload);
+      });
     };
     try {
       handleWSUpgrade(wss, ctx, cb);
@@ -3624,6 +3636,26 @@ const createPushController = handlerControllerFactory((proto) => ({
   verifyAuth() {
     return proto.verifyAuth.call(this, TRANSFER_KIND$1);
   },
+  onInfo(message) {
+    this.diagnostics?.report({
+      details: {
+        message,
+        origin: "push-handler",
+        createdAt: /* @__PURE__ */ new Date()
+      },
+      kind: "info"
+    });
+  },
+  onWarning(message) {
+    this.diagnostics?.report({
+      details: {
+        message,
+        createdAt: /* @__PURE__ */ new Date(),
+        origin: "push-handler"
+      },
+      kind: "warning"
+    });
+  },
   cleanup() {
     proto.cleanup.call(this);
     this.streams = {};
@@ -3700,6 +3732,7 @@ const createPushController = handlerControllerFactory((proto) => ({
     proto.addUUID(uuid);
     if (type === "command") {
       const { command } = msg;
+      this.onInfo(`received command:${command} uuid:${uuid}`);
       await this.executeAndRespond(uuid, () => {
         this.assertValidTransferCommand(command);
         if (command === "status") {
@@ -3708,6 +3741,7 @@ const createPushController = handlerControllerFactory((proto) => ({
         return this[command](msg.params);
       });
     } else if (type === "transfer") {
+      this.onInfo(`received transfer action:${msg.action} step:${msg.kind} uuid:${uuid}`);
       await this.executeAndRespond(uuid, async () => {
         await this.verifyAuth();
         this.assertValidTransfer();
@@ -3809,6 +3843,9 @@ const createPushController = handlerControllerFactory((proto) => ({
       }
       this.flow?.set(step);
     }
+    if (action === "bootstrap") {
+      return this.provider?.[action](this.diagnostics);
+    }
     return this.provider?.[action]();
   },
   async streamAsset(payload) {
@@ -3874,6 +3911,7 @@ const createPushController = handlerControllerFactory((proto) => ({
       getStrapi: () => strapi
     });
     this.provider.onWarning = (message) => {
+      this.onWarning(message);
       strapi.log.warn(message);
     };
     return { transferID: this.transferID };
@@ -3914,6 +3952,26 @@ const createPullController = handlerControllerFactory((proto) => ({
     this.streams = {};
     delete this.provider;
   },
+  onInfo(message) {
+    this.diagnostics?.report({
+      details: {
+        message,
+        origin: "pull-handler",
+        createdAt: /* @__PURE__ */ new Date()
+      },
+      kind: "info"
+    });
+  },
+  onWarning(message) {
+    this.diagnostics?.report({
+      details: {
+        message,
+        createdAt: /* @__PURE__ */ new Date(),
+        origin: "pull-handler"
+      },
+      kind: "warning"
+    });
+  },
   assertValidTransferAction(action) {
     const validActions = VALID_TRANSFER_ACTIONS;
     if (validActions.includes(action)) {
@@ -3943,6 +4001,7 @@ const createPullController = handlerControllerFactory((proto) => ({
     proto.addUUID(uuid);
     if (type === "command") {
       const { command } = msg;
+      this.onInfo(`received command:${command} uuid:${uuid}`);
       await this.executeAndRespond(uuid, () => {
         this.assertValidTransferCommand(command);
         if (command === "status") {
@@ -3951,6 +4010,7 @@ const createPullController = handlerControllerFactory((proto) => ({
         return this[command](msg.params);
       });
     } else if (type === "transfer") {
+      this.onInfo(`received transfer action:${msg.action} step:${msg.kind} uuid:${uuid}`);
       await this.executeAndRespond(uuid, async () => {
         await this.verifyAuth();
         this.assertValidTransfer();
@@ -3972,6 +4032,9 @@ const createPullController = handlerControllerFactory((proto) => ({
   async onTransferAction(msg) {
     const { action } = msg;
     this.assertValidTransferAction(action);
+    if (action === "bootstrap") {
+      return this.provider?.[action](this.diagnostics);
+    }
     return this.provider?.[action]();
   },
   async flush(stage, id) {
@@ -4183,7 +4246,7 @@ class LocalFileSourceProvider {
       details: {
         createdAt: /* @__PURE__ */ new Date(),
         message,
-        source: "file-source-provider"
+        origin: "file-source-provider"
       },
       kind: "info"
     });
@@ -4274,9 +4337,7 @@ class LocalFileSourceProvider {
             try {
               metadata = await loadAssetMetadata(`assets/metadata/${file}.json`);
             } catch (error) {
-              console.warn(
-                ` Failed to read metadata for ${file}, Strapi will try to fix this issue automatically`
-              );
+              throw new Error(`Failed to read metadata for ${file}`);
             }
             const asset = {
               metadata,
@@ -4464,7 +4525,7 @@ class LocalFileDestinationProvider {
       details: {
         createdAt: /* @__PURE__ */ new Date(),
         message,
-        source: "file-destination-provider"
+        origin: "file-destination-provider"
       },
       kind: "info"
     });