Start on unit tests for image handling

Author: hatton

jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.ts?$": "ts-jest",
+  },
+  transformIgnorePatterns: ["<rootDir>/node_modules/"],
+};

package.json

@@ -56,7 +56,7 @@
   },
   "devDependencies": {
     "@types/fs-extra": "^9.0.13",
-    "@types/jest": "^26.0.24",
+    "@types/jest": "^28.1.6",
     "@types/node": "^12.20.11",
     "@typescript-eslint/eslint-plugin": "^4.22.0",
     "@typescript-eslint/parser": "^4.22.0",
@@ -66,11 +66,11 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.4.0",
-    "jest": "^27.2.0",
+    "jest": "^28.1.3",
     "lint-staged": "^10.5.4",
     "prettier": "^2.2.1",
     "semantic-release": "^19.0.2",
-    "ts-jest": "^27.0.5",
+    "ts-jest": "^28.0.7",
     "ts-node": "^10.2.1",
     "typescript": "^4.6.4"
   },

src/NotionImage.spec.ts

@@ -0,0 +1,102 @@
+import { parseImageBlock } from "./NotionImage";
+
+/* eslint-disable @typescript-eslint/require-await */
+describe("image caption", () => {
+  it("should find a caption", async () => {
+    const img = parseImageBlock(kImageBlock);
+    expect(img.url).toBe("https://someimage.png");
+  });
+});
+
+const kImageBlock = {
+  object: "block",
+  id: "20b821b4-7c5b-41dc-8e30-92c23c125580",
+  parent: {
+    type: "page_id",
+    page_id: "9dd05134-0401-47f6-b159-1e6b76b9aad3",
+  },
+  created_time: "2022-07-25T23:05:00.000Z",
+  last_edited_time: "2022-07-25T23:07:00.000Z",
+  created_by: {
+    object: "user",
+    id: "11fb7f16-0560-4aee-ab88-ed75a850cfc4",
+  },
+  last_edited_by: {
+    object: "user",
+    id: "11fb7f16-0560-4aee-ab88-ed75a850cfc4",
+  },
+  has_children: false,
+  archived: false,
+  type: "image",
+  image: {
+    caption: [
+      {
+        type: "text",
+        text: { content: "fr-", link: null },
+        annotations: {
+          bold: false,
+          italic: false,
+          strikethrough: false,
+          underline: false,
+          code: false,
+          color: "default",
+        },
+        plain_text: "fr-",
+        href: null,
+      },
+      {
+        type: "text",
+        text: {
+          content: "https://i.imgur.com/pYmE7OJ.png",
+          link: { url: "https://i.imgur.com/pYmE7OJ.png" },
+        },
+        annotations: {
+          bold: false,
+          italic: false,
+          strikethrough: false,
+          underline: false,
+          code: false,
+          color: "default",
+        },
+        plain_text: "https://i.imgur.com/pYmE7OJ.png",
+        href: "https://i.imgur.com/pYmE7OJ.png",
+      },
+      {
+        type: "text",
+        text: { content: " es-", link: null },
+        annotations: {
+          bold: false,
+          italic: false,
+          strikethrough: false,
+          underline: false,
+          code: false,
+          color: "default",
+        },
+        plain_text: " es-",
+        href: null,
+      },
+      {
+        type: "text",
+        text: {
+          content: "https://i.imgur.com/8paSZ0i.png",
+          link: { url: "https://i.imgur.com/8paSZ0i.png" },
+        },
+        annotations: {
+          bold: false,
+          italic: false,
+          strikethrough: false,
+          underline: false,
+          code: false,
+          color: "default",
+        },
+        plain_text: "https://i.imgur.com/8paSZ0i.png",
+        href: "https://i.imgur.com/8paSZ0i.png",
+      },
+    ],
+    type: "file",
+    file: {
+      url: "https://someimage.png",
+      expiry_time: "2022-07-26T00:19:09.096Z",
+    },
+  },
+};

src/NotionImage.ts

@@ -66,17 +66,33 @@ function hashOfString(s: string) {
   return Math.abs(hash);
 }
 
-// Download the image if we don't have it, give it a good name, and
-// change the src to point to our copy of the image.
-export async function processImageBlock(b: any): Promise<void> {
-  let url = "";
+type LocalizableImageWithCaption = {
+  url: string;
+  caption?: string;
+  localizedUrls: Array<{ iso632Code: string; url: string }>;
+};
+export function parseImageBlock(b: any): LocalizableImageWithCaption {
+  const img: LocalizableImageWithCaption = {
+    url: "",
+    localizedUrls: [],
+  };
+
   if ("file" in b.image) {
-    url = b.image.file.url; // image saved on notion (actually AWS)
+    img.url = b.image.file.url; // image saved on notion (actually AWS)
   } else {
-    url = b.image.external.url; // image still pointing somewhere else. I've see this happen when copying a Google Doc into Notion. Notion kep pointing at the google doc.
+    img.url = b.image.external.url; // image still pointing somewhere else. I've see this happen when copying a Google Doc into Notion. Notion kep pointing at the google doc.
   }
 
-  const newPath = imagePrefix + "/" + (await saveImage(url, imageOutputPath));
+  return img;
+}
+
+// Download the image if we don't have it, give it a good name, and
+// change the src to point to our copy of the image.
+export async function processImageBlock(b: any): Promise<void> {
+  const img = parseImageBlock(b);
+
+  const newPath =
+    imagePrefix + "/" + (await saveImage(img.url, imageOutputPath));
 
   // change the src to point to our copy of the image
   if ("file" in b.image) {