feat(gatsby-sharp): add gatsby-sharp as sharp abstraction

Author: wardpeet

packages/gatsby-sharp/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": [["babel-preset-gatsby-package"]]
+}

packages/gatsby-sharp/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "gatsby-sharp",
+  "version": "0.0.1-next.0",
+  "sideEffects": false,
+  "keywords": [
+    "gatsby",
+    "sharp"
+  ],
+  "main": "dist/index.js",
+  "source": "src/index.ts",
+  "files": [
+    "dist/*"
+  ],
+  "types": "dist/index.d.ts",
+  "homepage": "https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-sharp#readme",
+  "dependencies": {
+    "@types/sharp": "^0.29.4",
+    "sharp": "^0.29.3"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.10.4",
+    "@babel/core": "^7.10.4",
+    "cross-env": "^7.0.2"
+  },
+  "engines": {
+    "node": ">=14.15.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gatsbyjs/gatsby.git",
+    "directory": "packages/gatsby-sharp"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "babel src --out-file dist/index.js --ignore \"**/__tests__\" --extensions \".ts,.js\"",
+    "typegen": "tsc --emitDeclarationOnly --declaration --declarationDir dist/",
+    "prepare": "cross-env NODE_ENV=production npm-run-all -s build typegen",
+    "watch": "babel src --out-file dist/index.js --ignore \"**/__tests__\" --extensions \".ts,.js\""
+  }
+}

packages/gatsby-sharp/src/__tests__/index.ts

@@ -0,0 +1,76 @@
+/**  @jest-environment node */
+import { exec } from "child_process"
+
+jest.mock(`child_process`, () => {
+  return {
+    exec: jest.fn(async (command, options, cb) => {
+      setImmediate(() => {
+        try {
+          return cb(
+            null,
+            `> sharp@0.29.3 install C:\\Users\\Ward\\projects\\gatsby\\gatsby\\node_modules\\sharp\n`,
+            ``
+          )
+        } catch (err) {
+          return cb(true, ``, err.message)
+        }
+      })
+    }),
+  }
+})
+
+function getSharpInstance(): typeof import("../index") {
+  let getSharpInstance
+  jest.isolateModules(() => {
+    getSharpInstance = require(`../index`)
+  })
+
+  return getSharpInstance()
+}
+
+describe(`getSharpInstance`, () => {
+  beforeEach(() => {
+    exec.mockClear()
+  })
+
+  // jest mocking is making this impossible to test
+  it(`should give you the bare sharp module`, async () => {
+    const sharpInstance = await getSharpInstance()
+
+    expect(exec).not.toHaveBeenCalled()
+    expect(sharpInstance).toBeDefined()
+    expect(sharpInstance.versions).toBeDefined()
+  })
+
+  it(
+    `should rebuild sharp when binaries not found for current arch`,
+    async () => {
+      expect.assertions(3)
+
+      let called = false
+      jest.doMock(`sharp`, () => {
+        if (!called) {
+          called = true
+          throw new Error(`sharp failed to load`)
+        }
+
+        return jest.requireActual(`sharp`)
+      })
+
+      try {
+        const sharpInstance = await getSharpInstance()
+        expect(sharpInstance).toBeDefined()
+        expect(sharpInstance.versions).toBeDefined()
+      } catch (err) {
+        // ignore
+      }
+
+      expect(exec).toHaveBeenCalledWith(
+        `npm rebuild sharp`,
+        expect.anything(),
+        expect.anything()
+      )
+    },
+    60 * 1000
+  )
+})

packages/gatsby-sharp/src/index.ts

@@ -0,0 +1,48 @@
+const { exec } = require(`child_process`)
+const { createRequire } = require(`module`)
+
+module.exports = async function getSharpInstance(): Promise<
+  typeof import("sharp")
+> {
+  try {
+    return importSharp()
+  } catch (err) {
+    await rebuildSharp()
+
+    // Try importing again now we have rebuilt sharp
+    return importSharp()
+  }
+}
+
+function importSharp(): typeof import("sharp") {
+  const cleanRequire = createRequire(__filename)
+  const sharp = cleanRequire(`sharp`)
+
+  sharp.simd(true)
+  // Concurrency is handled by gatsby
+  sharp.concurrency(1)
+
+  return sharp
+}
+
+function rebuildSharp(): Promise<string> {
+  return new Promise((resolve, reject) => {
+    exec(
+      `npm rebuild sharp`,
+      {
+        timeout: 60 * 1000,
+      },
+      (error, stdout, stderr) => {
+        if (error) {
+          if (error.killed) {
+            console.log(`timeout reached`)
+          }
+
+          return reject(stderr)
+        }
+
+        return setImmediate(() => resolve(stdout))
+      }
+    )
+  })
+}

packages/gatsby-sharp/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "exclude": [
+    "src/__tests__",
+    "src/__mocks__",
+    "dist",
+  ]
+}

packages/gatsby/sharp.d.ts

@@ -0,0 +1,3 @@
+import getSharpInstance from "gatsby-sharp"
+
+export = getSharpInstance

packages/gatsby/sharp.js

@@ -0,0 +1,3 @@
+"use strict"
+
+module.exports = require('gatsby-sharp');