feat: reorders uploads to provide beforeChange hooks with upload data

payloadcms · Mar 13, 2021 · 3c42e6e · 3c42e6e
1 parent 71a15b5
commit 3c42e6e
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 120 deletions.
diff --git a/src/collections/operations/create.ts b/src/collections/operations/create.ts
@@ -70,6 +70,59 @@ async function create(this: Payload, incomingArgs: Arguments): Promise<Document>
     await executeAccess({ req }, collectionConfig.access.create);
   }
 
+  // /////////////////////////////////////
+  // Upload and resize potential files
+  // /////////////////////////////////////
+
+  if (collectionConfig.upload) {
+    const fileData: Partial<FileData> = {};
+
+    const { staticDir, imageSizes } = collectionConfig.upload;
+
+    const file = ((req.files && req.files.file) ? req.files.file : req.file) as UploadedFile;
+
+    if (!file) {
+      throw new MissingFile();
+    }
+
+    let staticPath = staticDir;
+
+    if (staticDir.indexOf('/') !== 0) {
+      staticPath = path.join(config.paths.configDir, staticDir);
+    }
+
+    mkdirp.sync(staticPath);
+
+    const fsSafeName = await getSafeFilename(staticPath, file.name);
+
+    try {
+      await saveBufferToFile(file.data, `${staticPath}/${fsSafeName}`);
+
+      if (isImage(file.mimetype)) {
+        const dimensions = await getImageSize(`${staticPath}/${fsSafeName}`);
+        fileData.width = dimensions.width;
+        fileData.height = dimensions.height;
+
+        if (Array.isArray(imageSizes) && file.mimetype !== 'image/svg+xml') {
+          fileData.sizes = await resizeAndSave(staticPath, collectionConfig, fsSafeName, fileData.mimeType);
+        }
+      }
+    } catch (err) {
+      console.error(err);
+      throw new FileUploadError();
+    }
+
+
+    fileData.filename = fsSafeName;
+    fileData.filesize = file.size;
+    fileData.mimeType = file.mimetype;
+
+    data = {
+      ...data,
+      ...fileData,
+    };
+  }
+
   // /////////////////////////////////////
   // beforeValidate - Fields
   // /////////////////////////////////////
@@ -114,7 +167,7 @@ async function create(this: Payload, incomingArgs: Arguments): Promise<Document>
   // beforeChange - Fields
   // /////////////////////////////////////
 
-  let resultWithLocales = await this.performFieldOperations(collectionConfig, {
+  const resultWithLocales = await this.performFieldOperations(collectionConfig, {
     data,
     hook: 'beforeChange',
     operation: 'create',
@@ -123,59 +176,6 @@ async function create(this: Payload, incomingArgs: Arguments): Promise<Document>
     unflattenLocales: true,
   });
 
-  // /////////////////////////////////////
-  // Upload and resize potential files
-  // /////////////////////////////////////
-
-  if (collectionConfig.upload) {
-    const fileData: Partial<FileData> = {};
-
-    const { staticDir, imageSizes } = collectionConfig.upload;
-
-    const file = ((req.files && req.files.file) ? req.files.file : req.file) as UploadedFile;
-
-    if (!file) {
-      throw new MissingFile();
-    }
-
-    let staticPath = staticDir;
-
-    if (staticDir.indexOf('/') !== 0) {
-      staticPath = path.join(config.paths.configDir, staticDir);
-    }
-
-    mkdirp.sync(staticPath);
-
-    const fsSafeName = await getSafeFilename(staticPath, file.name);
-
-    try {
-      await saveBufferToFile(file.data, `${staticPath}/${fsSafeName}`);
-
-      if (isImage(file.mimetype)) {
-        const dimensions = await getImageSize(`${staticPath}/${fsSafeName}`);
-        fileData.width = dimensions.width;
-        fileData.height = dimensions.height;
-
-        if (Array.isArray(imageSizes) && file.mimetype !== 'image/svg+xml') {
-          fileData.sizes = await resizeAndSave(staticPath, collectionConfig, fsSafeName, fileData.mimeType);
-        }
-      }
-    } catch (err) {
-      console.error(err);
-      throw new FileUploadError();
-    }
-
-
-    fileData.filename = fsSafeName;
-    fileData.filesize = file.size;
-    fileData.mimeType = file.mimetype;
-
-    resultWithLocales = {
-      ...resultWithLocales,
-      ...fileData,
-    };
-  }
-
   // /////////////////////////////////////
   // Create
   // /////////////////////////////////////

diff --git a/src/collections/operations/update.ts b/src/collections/operations/update.ts
@@ -117,6 +117,59 @@ async function update(incomingArgs: Arguments): Promise<Document> {
 
   let { data } = args;
 
+  // /////////////////////////////////////
+  // Upload and resize potential files
+  // /////////////////////////////////////
+
+  if (collectionConfig.upload) {
+    const fileData: Partial<FileData> = {};
+
+    const { staticDir, imageSizes } = collectionConfig.upload;
+
+    let staticPath = staticDir;
+
+    if (staticDir.indexOf('/') !== 0) {
+      staticPath = path.join(config.paths.configDir, staticDir);
+    }
+
+    const file = ((req.files && req.files.file) ? req.files.file : req.file) as UploadedFile;
+
+    if (file) {
+      const fsSafeName = await getSafeFilename(staticPath, file.name);
+
+      try {
+        await saveBufferToFile(file.data, `${staticPath}/${fsSafeName}`);
+
+        fileData.filename = fsSafeName;
+        fileData.filesize = file.size;
+        fileData.mimeType = file.mimetype;
+
+        if (isImage(file.mimetype)) {
+          const dimensions = await getImageSize(`${staticPath}/${fsSafeName}`);
+          fileData.width = dimensions.width;
+          fileData.height = dimensions.height;
+
+          if (Array.isArray(imageSizes) && file.mimetype !== 'image/svg+xml') {
+            fileData.sizes = await resizeAndSave(staticPath, collectionConfig, fsSafeName, fileData.mimeType);
+          }
+        }
+      } catch (err) {
+        throw new FileUploadError();
+      }
+
+      data = {
+        ...data,
+        ...fileData,
+      };
+    } else if (data.file === null) {
+      data = {
+        ...data,
+        filename: null,
+        sizes: null,
+      };
+    }
+  }
+
   // /////////////////////////////////////
   // beforeValidate - Fields
   // /////////////////////////////////////
@@ -177,59 +230,6 @@ async function update(incomingArgs: Arguments): Promise<Document> {
     docWithLocales,
   });
 
-  // /////////////////////////////////////
-  // Upload and resize potential files
-  // /////////////////////////////////////
-
-  if (collectionConfig.upload) {
-    const fileData: Partial<FileData> = {};
-
-    const { staticDir, imageSizes } = collectionConfig.upload;
-
-    let staticPath = staticDir;
-
-    if (staticDir.indexOf('/') !== 0) {
-      staticPath = path.join(config.paths.configDir, staticDir);
-    }
-
-    const file = ((req.files && req.files.file) ? req.files.file : req.file) as UploadedFile;
-
-    if (file) {
-      const fsSafeName = await getSafeFilename(staticPath, file.name);
-
-      try {
-        await saveBufferToFile(file.data, `${staticPath}/${fsSafeName}`);
-
-        fileData.filename = fsSafeName;
-        fileData.filesize = file.size;
-        fileData.mimeType = file.mimetype;
-
-        if (isImage(file.mimetype)) {
-          const dimensions = await getImageSize(`${staticPath}/${fsSafeName}`);
-          fileData.width = dimensions.width;
-          fileData.height = dimensions.height;
-
-          if (Array.isArray(imageSizes) && file.mimetype !== 'image/svg+xml') {
-            fileData.sizes = await resizeAndSave(staticPath, collectionConfig, fsSafeName, fileData.mimeType);
-          }
-        }
-      } catch (err) {
-        throw new FileUploadError();
-      }
-
-      result = {
-        ...result,
-        ...fileData,
-      };
-    } else if (result.file === null) {
-      result = {
-        ...result,
-        filename: null,
-        sizes: null,
-      };
-    }
-  }
-
   // /////////////////////////////////////
   // Handle potential password update
   // /////////////////////////////////////

diff --git a/src/fields/baseFields/baseUploadFields.ts b/src/fields/baseFields/baseUploadFields.ts
@@ -4,18 +4,6 @@ export default [
   {
     name: 'filename',
     label: 'Filename',
-    hooks: {
-      beforeChange: [
-        ({ req, operation, value }) => {
-          if (operation === 'create') {
-            const file = (req.files && req.files.file) ? req.files.file as { name: string } : req.file;
-            return file.name;
-          }
-
-          return value;
-        },
-      ],
-    },
     type: 'text',
     required: true,
     unique: true,

diff --git a/src/fields/baseFields/baseVerificationFields.ts b/src/fields/baseFields/baseVerificationFields.ts
@@ -2,7 +2,7 @@ import { Field, FieldHook } from '../config/types';
 
 const autoRemoveVerificationToken: FieldHook = ({ originalDoc, data, value }) => {
   // If a user manually sets `_verified` to true,
-  // and it was `false`, set _verificationToken to `undefined`.
+  // and it was `false`, set _verificationToken to `null`.
   // This is useful because the admin panel
   // allows users to set `_verified` to true manually
   if (data?._verified === true && originalDoc?._verified === false) {