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): improve error message when dominant color can't be generated #31879

Merged

Conversation

eligundry
Copy link
Contributor

Description

In my application, I was getting the following error logged hundreds of
times:

[gatsby-source-contentful] Please install gatsby-plugin-sharp

I had gatsby-plugin-sharp installed as a plugin though. I added logging
of the error to the log line and it turns out the error had to do with
cacheImage not being able to load an image and not the fact that
gatsby-plugin-sharp was not installed.

This commit moves the require of gatsby-plugin-sharp to it's own try
block and updates the error messaging of this block to have the error
when an exception is thrown.

Documentation

Related Issues

In my application, I was getting the following error logged hundreds of
times:

```
[gatsby-source-contentful] Please install gatsby-plugin-sharp
```

I had gatsby-plugin-sharp installed as a plugin though. I added logging
of the error to the log line and it turns out the error had to do with
`cacheImage` not being able to load an image and not the fact that
gatsby-plugin-sharp was not installed.

This commit moves the `require` of gatsby-plugin-sharp to it's own `try`
block and updates the error messaging of this block to have the error
when an exception is thrown.
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jun 11, 2021
@LekoArts LekoArts 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 Jun 14, 2021
@wardpeet wardpeet changed the title Refactor how gatsby-plugin-sharp is imported in gatsby-source-contentful fix(gatsby-source-contentful): improve error message when dominant color can't be generated Jun 14, 2021
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.

Thanks! Looks great 🙏

@wardpeet wardpeet merged commit 1f89646 into gatsbyjs:master Jun 14, 2021
@eligundry eligundry deleted the fix-gatsby-source-contentful-warning branch July 20, 2021 02:07
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
None yet
Development

Successfully merging this pull request may close these issues.

3 participants