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.

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

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

Merged
merged 1 commit into from Feb 18, 2021

Conversation

ascorbic
Copy link
Contributor

Contentful doesn't support AVIF. This fixes the resolver, and adds a check in the url builder

@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Feb 18, 2021
@ascorbic ascorbic force-pushed the fix/contentful-image-catch-invalid branch from 94cfe3e to 628edce Compare February 18, 2021 10:05
@ascorbic ascorbic force-pushed the fix/contentful-image-catch-invalid branch from 628edce to 2ce9ce4 Compare February 18, 2021 10:06
Copy link
Contributor

@wardpeet wardpeet left a comment

Choose a reason for hiding this comment

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

I've added a small nit.

@@ -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.

@@ -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)) {

@ascorbic ascorbic added topic: source-contentful Related to Gatsby's integration with Contentful and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Feb 18, 2021
@ascorbic ascorbic merged commit 3b4d32f into master Feb 18, 2021
@ascorbic ascorbic deleted the fix/contentful-image-catch-invalid branch February 18, 2021 10:43
@ascorbic ascorbic added this to To cherry-pick in V2 Release hotfixes via automation Feb 18, 2021
ascorbic added a commit that referenced this pull request Feb 18, 2021
@ascorbic ascorbic moved this from To cherry-pick to Backport PR opened in V2 Release hotfixes Feb 18, 2021
@ascorbic ascorbic moved this from Backport PR opened to Backported in V2 Release hotfixes Feb 19, 2021
@ascorbic
Copy link
Contributor Author

Published in gatsby-source-contentful@4.6.2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: source-contentful Related to Gatsby's integration with Contentful
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants