✨ Feature(transformer): add fallback to support more image formats such as HEIC

change probe-image-size -> image-size to support more formats

ISSUES CLOSED: #13

Author: Molunerfinn

package.json

@@ -81,6 +81,7 @@
     "ejs": "^2.6.1",
     "fs-extra": "^6.0.1",
     "globby": "^8.0.2",
+    "image-size": "^0.8.3",
     "inquirer": "^6.0.0",
     "lodash-id": "^0.14.0",
     "lowdb": "^1.0.0",

src/plugins/transformer/path.ts

@@ -1,29 +1,30 @@
-import probe from 'probe-image-size'
-import path from 'path'
-import fs from 'fs-extra'
 import PicGo from '../../core/PicGo'
-import { getURLFile } from '../../utils/getURLFile'
-import { isUrl } from '../../utils/common'
-import { IPathTransformedImgInfo, ImgInfo } from '../../utils/interfaces'
+import {
+  isUrl,
+  getImageSize,
+  getFSFile,
+  getURLFile
+} from '../../utils/common'
+import { IPathTransformedImgInfo, ImgInfo, ImgSize } from '../../utils/interfaces'
 
 const handle = async (ctx: PicGo): Promise<PicGo> => {
   let results: ImgInfo[] = ctx.output
   await Promise.all(ctx.input.map(async (item: string) => {
     let info: IPathTransformedImgInfo
     if (isUrl(item)) {
-      info = await getURLFile(ctx, item)
+      info = await getURLFile(item)
     } else {
       info = await getFSFile(item)
     }
     if (info.success) {
       try {
-        const imgSize = probe.sync(info.buffer)
+        const imgSize = getImgSize(ctx, info.buffer, item)
         results.push({
           buffer: info.buffer,
           fileName: info.fileName,
           width: imgSize.width,
           height: imgSize.height,
-          extname: path.extname(item)
+          extname: info.extname
         })
       } catch (e) {
         ctx.log.error(e)
@@ -35,20 +36,13 @@ const handle = async (ctx: PicGo): Promise<PicGo> => {
   return ctx
 }
 
-const getFSFile = async (item: string): Promise<IPathTransformedImgInfo> => {
-  try {
-    return {
-      extname: path.extname(item),
-      fileName: path.basename(item),
-      buffer: await fs.readFile(item),
-      success: true
-    }
-  } catch {
-    return {
-      reason: `read file ${item} error`,
-      success: false
-    }
+const getImgSize = (ctx: PicGo, file: Buffer, path: string): ImgSize => {
+  const imageSize = getImageSize(file)
+  if (!imageSize.real) {
+    ctx.log.warn(`can't get ${path}'s image size`)
+    ctx.log.warn(`fallback to 200 * 200`)
   }
+  return imageSize
 }
 
 export default {

src/utils/common.ts

@@ -1,3 +1,13 @@
+import request from 'request'
+import requestPromise from 'request-promise-native'
+import fs from 'fs-extra'
+import path from 'path'
+import { imageSize } from 'image-size'
+import {
+  ImgSize,
+  IPathTransformedImgInfo
+} from './interfaces'
+
 export const isUrl = (url: string): boolean => (url.startsWith('http://') || url.startsWith('https://'))
 export const isUrlEncode = (url: string): boolean => {
   url = url || ''
@@ -14,3 +24,91 @@ export const handleUrlEncode = (url: string): string => {
   }
   return url
 }
+
+export const getImageSize = (file: Buffer): ImgSize => {
+  try {
+    const { width, height } = imageSize(file)
+    return {
+      real: true,
+      width,
+      height
+    }
+  } catch (e) {
+    // fallback to 200 * 200
+    return {
+      real: false,
+      width: 200,
+      height: 200
+    }
+  }
+}
+
+export const getFSFile = async (filePath: string): Promise<IPathTransformedImgInfo> => {
+  try {
+    return {
+      extname: path.extname(filePath),
+      fileName: path.basename(filePath),
+      buffer: await fs.readFile(filePath),
+      success: true
+    }
+  } catch {
+    return {
+      reason: `read file ${filePath} error`,
+      success: false
+    }
+  }
+}
+
+export const getURLFile = async (url: string): Promise<IPathTransformedImgInfo> => {
+  const requestOptions = {
+    method: 'GET',
+    url,
+    encoding: null
+  }
+  let isImage = false
+  let extname = ''
+  let timeoutId
+  // tslint:disable-next-line: typedef
+  const requestFn = new Promise<IPathTransformedImgInfo>(async (resolve): Promise<void> => {
+    try {
+      const res = await requestPromise(requestOptions)
+        .on('response', (response: request.Response): void => {
+          const contentType = response.headers['content-type']
+          if (contentType.includes('image')) {
+            isImage = true
+            extname = `.${contentType.split('image/')[1]}`
+          }
+        })
+      clearTimeout(timeoutId)
+      if (isImage) {
+        resolve({
+          buffer: res,
+          fileName: path.basename(requestOptions.url.split('?')[0]),
+          extname,
+          success: true
+        })
+      } else {
+        resolve({
+          success: false,
+          reason: `${url} is not image`
+        })
+      }
+    } catch {
+      clearTimeout(timeoutId)
+      resolve({
+        success: false,
+        reason: `request ${url} error`
+      })
+    }
+  })
+  // tslint:disable-next-line: typedef
+  const timeoutPromise = new Promise<IPathTransformedImgInfo>((resolve): void => {
+    timeoutId = setTimeout(() => {
+      resolve({
+        success: false,
+        reason: `request ${url} timeout`
+      })
+    }, 10000)
+  })
+  return Promise.race([requestFn, timeoutPromise])
+}

src/utils/getURLFile.ts

@@ -69,6 +69,7 @@ export interface Result {
 export interface ImgSize {
   width: number
   height: number
+  real?: boolean
 }
 
 /**

src/utils/interfaces.ts

@@ -2336,6 +2336,13 @@ ignore@^3.3.5:
   resolved "https://registry.yarnpkg.com/ignore/-/ignore-3.3.10.tgz#0a97fb876986e8081c631160f8f9f389157f0043"
   integrity sha512-Pgs951kaMm5GXP7MOvxERINe3gsaVjUWFm+UZPSq9xYriQAksyhg0csnS0KXSNRD5NmNdapXEpjxG49+AKh/ug==
 
+image-size@^0.8.3:
+  version "0.8.3"
+  resolved "https://registry.npmjs.org/image-size/-/image-size-0.8.3.tgz#f0b568857e034f29baffd37013587f2c0cad8b46"
+  integrity sha512-SMtq1AJ+aqHB45c3FsB4ERK0UCiA2d3H1uq8s+8T0Pf8A3W4teyBQyaFaktH6xvZqh+npwlKU7i4fJo0r7TYTg==
+  dependencies:
+    queue "6.0.1"
+
 import-fresh@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/import-fresh/-/import-fresh-2.0.0.tgz#d81355c15612d386c61f9ddd3922d4304822a546"
@@ -2819,21 +2826,11 @@ lodash.templatesettings@^4.0.0:
   dependencies:
     lodash._reinterpolate "^3.0.0"
 
-lodash@4, lodash@^4.17.10, lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.15, lodash@^4.2.1:
+lodash@4, lodash@4.17.11, lodash@4.17.14, lodash@^4.17.10, lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.15, lodash@^4.2.1:
   version "4.17.15"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.15.tgz#b447f6670a0455bbfeedd11392eff330ea097548"
   integrity sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==
 
-lodash@4.17.11:
-  version "4.17.11"
-  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.11.tgz#b39ea6229ef607ecd89e2c8df12536891cac9b8d"
-  integrity sha512-cQKh8igo5QUhZ7lg38DYWAxMvjSAKG0A8wGSVimP07SIUEK2UO+arSRKbRZWtelMtN5V0Hkwh5ryOto/SshYIg==
-
-lodash@4.17.14:
-  version "4.17.14"
-  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.14.tgz#9ce487ae66c96254fe20b599f21b6816028078ba"
-  integrity sha512-mmKYbW3GLuJeX+iGP+Y7Gp1AiGHGbXHCOh/jZmrawMmsE7MS4znI3RL2FsjbqOyMayHInjOeykW7PEajUk1/xw==
-
 log-symbols@^2.2.0:
   version "2.2.0"
   resolved "https://registry.yarnpkg.com/log-symbols/-/log-symbols-2.2.0.tgz#5740e1c5d6f0dfda4ad9323b5332107ef6b4c40a"
@@ -3607,6 +3604,13 @@ qs@~6.5.2:
   resolved "https://registry.yarnpkg.com/qs/-/qs-6.5.2.tgz#cb3ae806e8740444584ef154ce8ee98d403f3e36"
   integrity sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==
 
+queue@6.0.1:
+  version "6.0.1"
+  resolved "https://registry.npmjs.org/queue/-/queue-6.0.1.tgz#abd5a5b0376912f070a25729e0b6a7d565683791"
+  integrity sha512-AJBQabRCCNr9ANq8v77RJEv73DPbn55cdTb+Giq4X0AVnNVZvMHlYp7XlQiN+1npCZj1DuSmaA2hYVUUDgxFDg==
+  dependencies:
+    inherits "~2.0.3"
+
 quick-lru@^1.0.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/quick-lru/-/quick-lru-1.1.0.tgz#4360b17c61136ad38078397ff11416e186dcfbb8"