fix(gatsby-source-contentful): Correct supported image formats

gatsbyjs · Feb 18, 2021 · 94cfe3e · 94cfe3e
1 parent f25ea67
commit 94cfe3e
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 1 deletion.
diff --git a/packages/gatsby-plugin-image/src/resolver-utils.ts b/packages/gatsby-plugin-image/src/resolver-utils.ts
@@ -176,7 +176,7 @@ export function getGatsbyImageFieldConfig<TSource, TContext>(
             The image formats to generate. Valid values are AUTO (meaning the same format as the source image), JPG, PNG, WEBP and AVIF.
             The default value is [AUTO, WEBP], and you should rarely need to change this. Take care if you specify JPG or PNG when you do
             not know the formats of the source images, as this could lead to unwanted results such as converting JPEGs to PNGs. Specifying
-            both PNG and JPG is not supported and will be ignored. AVIF support is currently experimental.
+            both PNG and JPG is not supported and will be ignored. 
         `,
         defaultValue: [`auto`, `webp`],
       },

diff --git a/packages/gatsby-source-contentful/src/extend-node-type.js b/packages/gatsby-source-contentful/src/extend-node-type.js
@@ -12,6 +12,8 @@ const {
   GraphQLFloat,
   GraphQLNonNull,
   GraphQLJSON,
+  GraphQLList,
+  GraphQLEnumType,
 } = require(`gatsby/graphql`)
 const qs = require(`qs`)
 const { generateImageData } = require(`gatsby-plugin-image`)
@@ -33,6 +35,8 @@ const {
 // cache is more likely to go stale than the images (which never go stale)
 // Note that the same image might be requested multiple times in the same run
 
+const validImageFormats = new Set([`jpg`, `png`, `webp`])
+
 if (process.env.GATSBY_REMOTE_CACHE) {
   console.warn(
     `Note: \`GATSBY_REMOTE_CACHE\` will be removed soon because it has been renamed to \`GATSBY_CONTENTFUL_EXPERIMENTAL_REMOTE_CACHE\``
@@ -200,6 +204,13 @@ const generateImageSource = (
     height = CONTENTFUL_IMAGE_MAX_SIZE
   }
 
+  if (!validImageFormats.has(toFormat)) {
+    console.warn(
+      `[gatsby-source-contentful] Invalid image format "${toFormat}". Supported types are jpg, png and webp"`
+    )
+    return undefined
+  }
+
   const src = createUrl(filename, {
     width,
     height,
@@ -781,6 +792,26 @@ exports.extendNodeType = ({ type, store, reporter }) => {
         type: GraphQLInt,
         defaultValue: 50,
       },
+      formats: {
+        type: GraphQLList(
+          new GraphQLEnumType({
+            name: `ContentfulImageFormat`,
+            values: {
+              AUTO: { value: `auto` },
+              JPG: { value: `jpg` },
+              PNG: { value: `png` },
+              WEBP: { value: `webp` },
+            },
+          })
+        ),
+        description: stripIndent`
+            The image formats to generate. Valid values are AUTO (meaning the same format as the source image), JPG, PNG, and WEBP.
+            The default value is [AUTO, WEBP], and you should rarely need to change this. Take care if you specify JPG or PNG when you do
+            not know the formats of the source images, as this could lead to unwanted results such as converting JPEGs to PNGs. Specifying
+            both PNG and JPG is not supported and will be ignored. 
+        `,
+        defaultValue: [`auto`, `webp`],
+      },
     })
 
     fieldConfig.type = GraphQLJSON