Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Feb 18, 2021
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-image/src/resolver-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`],
},
Expand Down
20 changes: 20 additions & 0 deletions packages/gatsby-source-contentful/src/extend-node-type.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const {
GraphQLFloat,
GraphQLNonNull,
GraphQLJSON,
GraphQLList,
} = require(`gatsby/graphql`)
const qs = require(`qs`)
const { generateImageData } = require(`gatsby-plugin-image`)
Expand All @@ -33,6 +34,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`])
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why a set is needed here.

Suggested change
const validImageFormats = new Set([`jpg`, `png`, `webp`])
const validImageFormats = [`jpg`, `png`, `webp`]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was under the impression that set.has was significantly faster than array.includes

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It probably is but it doesn't matter on a 3 items list. For me when I read Sets I expect things to get added to it and making sure things are unique and that makes it more complex in my head.

Sets are fine, that's why I approved it but wanted to get the reason on the why :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just a pattern I always use for this sort of check, particularly when dealing with potentially large numbers of nodes, with a constant Set.


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\``
Expand Down Expand Up @@ -200,6 +203,13 @@ const generateImageSource = (
height = CONTENTFUL_IMAGE_MAX_SIZE
}

if (!validImageFormats.has(toFormat)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (!validImageFormats.has(toFormat)) {
if (!validImageFormats.includes(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,
Expand Down Expand Up @@ -781,6 +791,16 @@ exports.extendNodeType = ({ type, store, reporter }) => {
type: GraphQLInt,
defaultValue: 50,
},
formats: {
type: GraphQLList(ImageFormatType),
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: [``, `webp`],
},
})

fieldConfig.type = GraphQLJSON
Expand Down
1 change: 1 addition & 0 deletions packages/gatsby-source-contentful/src/schemes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const ImageFormatType = new GraphQLEnumType({
name: `ContentfulImageFormat`,
values: {
NO_CHANGE: { value: `` },
AUTO: { value: `` },
JPG: { value: `jpg` },
PNG: { value: `png` },
WEBP: { value: `webp` },
Expand Down