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-plugin-sharp): PathPrefix isn't being passed/set for GatsbyImage #28845

Merged
merged 7 commits into from
Jan 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions e2e-tests/path-prefix/cypress/integration/path-prefix.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,26 @@ describe(`Production pathPrefix`, () => {
cy.location(`pathname`).should(`eq`, withTrailingSlash(pathPrefix))
})

it(`renders static image`, () => {
cy.getTestElement(`static-image`)
.should(`have.attr`, `srcset`)
.and(srcset => {
srcset.split(/\s*,\s*/).forEach(part => {
laurieontech marked this conversation as resolved.
Show resolved Hide resolved
expect(part).to.contain(`/blog`)
})
})
})

it(`renders dynamic image`, () => {
cy.getTestElement(`gatsby-image`)
.should(`have.attr`, `srcset`)
.and(srcset => {
srcset.split(/\s*,\s*/).forEach(part => {
expect(part).to.contain(`/blog`)
})
})
})

describe(`navigation`, () => {
it(`prefixes link with /blog`, () => {
cy.getTestElement(`page-2-link`)
Expand Down
7 changes: 7 additions & 0 deletions e2e-tests/path-prefix/gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,15 @@ module.exports = {
icon: `src/images/gatsby-icon.png`, // This path is relative to the root of the site.
},
},
{
resolve: `gatsby-source-filesystem`,
options: {
path: `${__dirname}/src/images/`,
},
},
`gatsby-plugin-sitemap`,
`gatsby-plugin-sharp`,
`gatsby-transformer-sharp`,
`gatsby-plugin-image`,
{
resolve: `gatsby-plugin-feed`,
Expand Down
4 changes: 3 additions & 1 deletion e2e-tests/path-prefix/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@
"cypress": "^3.1.0",
"gatsby": "^2.3.34",
"gatsby-plugin-feed": "^2.1.2",
"gatsby-plugin-image": "~1.0.0",
"gatsby-plugin-image": "^0.4.0",
"gatsby-plugin-manifest": "^2.0.17",
"gatsby-plugin-offline": "^2.0.23",
"gatsby-plugin-react-helmet": "^3.0.6",
"gatsby-plugin-sharp": "^2.0.37",
"gatsby-plugin-sitemap": "^2.0.12",
"gatsby-source-filesystem": "^2.8.1",
"gatsby-transformer-sharp": "^2.9.0",
"react": "^16.8.0",
"react-dom": "^16.8.0",
"react-helmet": "^5.2.0"
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
83 changes: 51 additions & 32 deletions e2e-tests/path-prefix/src/pages/index.js
Original file line number Diff line number Diff line change
@@ -1,38 +1,57 @@
import * as React from "react"
import { Link, navigate } from "gatsby"
import { StaticImage } from "gatsby-plugin-image"
import { Link, navigate, graphql } from "gatsby"
import { StaticImage, GatsbyImage, getImage } from "gatsby-plugin-image"

import Layout from "../components/layout"

const IndexPage = () => (
<Layout>
<h1>Hi people</h1>
<StaticImage
src="../images/gatsby-icon.png"
alt="Gatsby icon"
layout="fixed"
/>
<p>Welcome to your new Gatsby site.</p>
<p>Now go build something great.</p>
<Link data-testid="page-2-link" to="/page-2/">
Go to page 2
</Link>
<Link data-testid="page-blogtest-link" to="/blogtest/">
Go to blogtest
</Link>
<button
data-testid="page-2-button-link"
onClick={() => navigate(`/page-2/`)}
>
Go to page 2 with navigate()
</button>
<Link data-testid="404-link" to="/not-existing-page">
Go to not existing page
</Link>
<Link data-testid="subdir-link" to="subdirectory/page-1">
Go to subdirectory
</Link>
</Layout>
)
const IndexPage = ({ data }) => {
const image = getImage(data.file)
return (
<Layout>
<h1>Hi people</h1>
<StaticImage
src="../images/gatsby-icon.png"
alt="Gatsby icon"
layout="fixed"
data-testid="static-image"
/>
<GatsbyImage
image={image}
alt="Citrus Fruits"
data-testid="gatsby-image"
/>
<p>Welcome to your new Gatsby site.</p>
<p>Now go build something great.</p>
<Link data-testid="page-2-link" to="/page-2/">
Go to page 2
</Link>
<Link data-testid="page-blogtest-link" to="/blogtest/">
Go to blogtest
</Link>
<button
data-testid="page-2-button-link"
onClick={() => navigate(`/page-2/`)}
>
Go to page 2 with navigate()
</button>
<Link data-testid="404-link" to="/not-existing-page">
Go to not existing page
</Link>
<Link data-testid="subdir-link" to="subdirectory/page-1">
Go to subdirectory
</Link>
</Layout>
)
}

export const query = graphql`
query {
file(relativePath: { eq: "citrus-fruits.jpg" }) {
childImageSharp {
gatsbyImageData
}
}
}
`

export default IndexPage
10 changes: 9 additions & 1 deletion packages/gatsby-plugin-sharp/src/image-data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,9 @@ export async function generateImageData({
toFormat: primaryFormat,
})

if (pathPrefix) transform.pathPrefix = pathPrefix
if (pathPrefix) {
transform.pathPrefix = pathPrefix
}
return transform
})

Expand Down Expand Up @@ -256,6 +258,9 @@ export async function generateImageData({
height: Math.round(width / imageSizes.aspectRatio),
toFormat: `avif`,
})
if (pathPrefix) {
transform.pathPrefix = pathPrefix
}
return transform
})

Expand Down Expand Up @@ -285,6 +290,9 @@ export async function generateImageData({
height: Math.round(width / imageSizes.aspectRatio),
toFormat: `webp`,
})
if (pathPrefix) {
transform.pathPrefix = pathPrefix
}
return transform
})

Expand Down
4 changes: 2 additions & 2 deletions packages/gatsby-transformer-sharp/src/customize-schema.js
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,6 @@ const imageNodeType = ({
},
resolve: async (image, fieldArgs, context) => {
const file = getNodeAndSavePathDependency(image.parent, context.path)
const args = { ...fieldArgs, pathPrefix }

if (!generateImageData) {
reporter.warn(`Please upgrade gatsby-plugin-sharp`)
Expand All @@ -525,7 +524,8 @@ const imageNodeType = ({
}
const imageData = await generateImageData({
file,
args,
args: fieldArgs,
laurieontech marked this conversation as resolved.
Show resolved Hide resolved
pathPrefix,
reporter,
cache,
})
Expand Down