feat(gatsby-plugin-sharp): enable gatsby cloud processing (#15384)

* feat(gatsby-plugin-sharp): enable gatsby cloud processing * fix snapshot * Downgrade got to version 8.3.2 to support node 8.0.0 * remove debug info
gatsbyjs · Jul 12, 2019 · bfc2891 · bfc2891
1 parent bb31a34
commit bfc2891
Show file tree

Hide file tree

Showing 5 changed files with 102 additions and 2 deletions.
diff --git a/packages/gatsby-plugin-sharp/package.json b/packages/gatsby-plugin-sharp/package.json
@@ -11,6 +11,7 @@
     "async": "^2.1.2",
     "bluebird": "^3.5.0",
     "fs-extra": "^7.0.0",
+    "got": "^8.3.2",
     "imagemin": "^6.0.0",
     "imagemin-mozjpeg": "^8.0.0",
     "imagemin-pngquant": "^6.0.0",

diff --git a/packages/gatsby-plugin-sharp/src/__tests__/__snapshots__/process-file.js.snap b/packages/gatsby-plugin-sharp/src/__tests__/__snapshots__/process-file.js.snap
@@ -0,0 +1,41 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`processFile should offload sharp transforms to the cloud 1`] = `
+Array [
+  Promise {},
+]
+`;
+
+exports[`processFile should offload sharp transforms to the cloud 2`] = `
+[MockFunction] {
+  "calls": Array [
+    Array [
+      "https://example.com/image-service",
+      Object {
+        "body": Object {
+          "file": "mypath/file.jpg",
+          "options": Object {
+            "stripMetadata": true,
+          },
+          "transforms": Array [
+            Object {
+              "args": Object {
+                "height": 100,
+                "width": 100,
+              },
+              "outputPath": "myoutputpath/1234/file.jpg",
+            },
+          ],
+        },
+        "json": true,
+      },
+    ],
+  ],
+  "results": Array [
+    Object {
+      "type": "return",
+      "value": Promise {},
+    },
+  ],
+}
+`;
diff --git a/packages/gatsby-plugin-sharp/src/__tests__/process-file.js b/packages/gatsby-plugin-sharp/src/__tests__/process-file.js
@@ -1,4 +1,11 @@
-const { createArgsDigest, sortKeys } = require(`../process-file`)
+jest.mock(`got`)
+jest.mock(`../safe-sharp`, () => {
+  return {
+    simd: jest.fn(),
+  }
+})
+const { createArgsDigest, processFile, sortKeys } = require(`../process-file`)
+const got = require(`got`)
 
 describe(`createArgsDigest`, () => {
   const defaultArgsBaseline = {
@@ -116,3 +123,28 @@ describe(`createArgsDigest`, () => {
     })
   })
 })
+
+describe(`processFile`, () => {
+  it(`should offload sharp transforms to the cloud`, async () => {
+    process.env.GATSBY_CLOUD_IMAGE_SERVICE_URL = `https://example.com/image-service`
+    const transforms = {
+      outputPath: `myoutputpath/1234/file.jpg`,
+      args: {
+        width: 100,
+        height: 100,
+      },
+    }
+
+    got.post.mockImplementation(jest.fn(() => Promise.resolve()))
+
+    expect(
+      await processFile(`mypath/file.jpg`, [transforms], {
+        stripMetadata: true,
+      })
+    ).toMatchSnapshot()
+    expect(got.post).toHaveBeenCalled()
+    expect(got.post).toMatchSnapshot()
+
+    delete process.env.GATSBY_CLOUD_IMAGE_SERVICE_URL
+  })
+})
diff --git a/packages/gatsby-plugin-sharp/src/process-file.js b/packages/gatsby-plugin-sharp/src/process-file.js
@@ -8,6 +8,7 @@ const imageminPngquant = require(`imagemin-pngquant`)
 const imageminWebp = require(`imagemin-webp`)
 const _ = require(`lodash`)
 const crypto = require(`crypto`)
+const got = require(`got`)
 
 // Try to enable the use of SIMD instructions. Seems to provide a smallish
 // speedup on resizing heavy loads (~10%). Sharp disables this feature by
@@ -75,6 +76,31 @@ const argsWhitelist = [
 exports.processFile = (file, transforms, options = {}) => {
   let pipeline
   try {
+    // adds gatsby cloud image service to gatsby-sharp
+    // this is an experimental api so it can be removed without any warnings
+    if (process.env.GATSBY_CLOUD_IMAGE_SERVICE_URL) {
+      let cloudPromise
+
+      return transforms.map(transform => {
+        if (!cloudPromise) {
+          cloudPromise = got
+            .post(process.env.GATSBY_CLOUD_IMAGE_SERVICE_URL, {
+              body: {
+                file,
+                transforms,
+                options,
+              },
+              json: true,
+            })
+            .then(() => transform)
+
+          return cloudPromise
+        }
+
+        return Promise.resolve(transform)
+      })
+    }
+
     pipeline = sharp(file)
 
     // Keep Metadata

diff --git a/yarn.lock b/yarn.lock
@@ -10098,7 +10098,7 @@ got@^7.0.0, got@^7.1.0:
     url-parse-lax "^1.0.0"
     url-to-options "^1.0.1"
 
-got@^8.0.0, got@^8.3.1:
+got@^8.0.0, got@^8.3.1, got@^8.3.2:
   version "8.3.2"
   resolved "https://registry.yarnpkg.com/got/-/got-8.3.2.tgz#1d23f64390e97f776cac52e5b936e5f514d2e937"
   dependencies: