Merge pull request #3933 from owid/data-insight-image-validation

🎉 add admin image validation for data insights
owid · Sep 9, 2024 · 07db948 · 07db948
2 parents 9c1a2a2 + 5f53911
commit 07db948
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/adminSiteClient/gdocsValidation.ts b/adminSiteClient/gdocsValidation.ts
@@ -13,6 +13,7 @@ import {
     OwidGdocDataInsightInterface,
     checkIsAuthor,
     OwidGdocAuthorInterface,
+    getFilenameExtension,
 } from "@ourworldindata/utils"
 
 function validateTitle(gdoc: OwidGdoc, errors: OwidGdocErrorMessage[]) {
@@ -198,6 +199,40 @@ function validateGrapherUrl(
     }
 }
 
+function validateDataInsightImage(
+    gdoc: OwidGdocDataInsightInterface,
+    errors: OwidGdocErrorMessage[]
+) {
+    const image = gdoc.content.body.find((block) => block.type === "image")
+    if (!image) {
+        errors.push({
+            property: "body",
+            type: OwidGdocErrorMessageType.Warning,
+            message: `Data insight is missing an image.`,
+        })
+    } else {
+        for (const property of ["filename", "smallFilename"] as const) {
+            if (!image[property]) {
+                errors.push({
+                    property: "body",
+                    type: OwidGdocErrorMessageType.Error,
+                    message: `Data insight image is missing ${property}`,
+                })
+            }
+            if (
+                image[property] &&
+                getFilenameExtension(image[property]) !== "png"
+            ) {
+                errors.push({
+                    property: "body",
+                    type: OwidGdocErrorMessageType.Warning,
+                    message: `Data insight ${property} should be a PNG`,
+                })
+            }
+        }
+    }
+}
+
 function validateAtomFields(
     gdoc: OwidGdocPostInterface,
     errors: OwidGdocErrorMessage[]
@@ -262,6 +297,7 @@ export const getErrors = (gdoc: OwidGdoc): OwidGdocErrorMessage[] => {
     } else if (checkIsDataInsight(gdoc)) {
         validateApprovedBy(gdoc, errors)
         validateGrapherUrl(gdoc, errors)
+        validateDataInsightImage(gdoc, errors)
     } else if (checkIsAuthor(gdoc)) {
         validateSocials(gdoc, errors)
     }