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

feat(gatsby-plugin-image): add check for node.gatsbyImage in the getImage helper #35507

Merged
merged 4 commits into from
May 3, 2022
Merged

feat(gatsby-plugin-image): add check for node.gatsbyImage in the getImage helper #35507

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f8956bd
add check for node.gatsbyImage in the getImage helper
TylerBarnes Apr 27, 2022
f5d9aa2
add unit tests
TylerBarnes Apr 29, 2022
76142ed
Merge branch 'master' into fix/get-image-for-image-cdn
TylerBarnes Apr 30, 2022
951823d
Merge branch 'master' into fix/get-image-for-image-cdn
TylerBarnes May 3, 2022
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
31 changes: 23 additions & 8 deletions packages/gatsby-plugin-image/src/components/__tests__/hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,19 @@ const node: Node = {
},
}

const dataParent = {
const imageDataParent = {
...node,
gatsbyImageData: imageData,
}

const imageParent = {
...node,
gatsbyImage: imageData,
}

const fileNode = {
...node,
childImageSharp: dataParent,
childImageSharp: imageDataParent,
}

const getImageDataArgs: IGetImageDataArgs = {
Expand Down Expand Up @@ -147,13 +152,21 @@ describe(`The image helper functions`, () => {
it(`returns the same data if passed gatsbyImageData`, () => {
expect(getImage(imageData)).toEqual(imageData)
})
it(`returns the same data if passed gatsbyImage`, () => {
expect(getImage(imageData)).toEqual(imageData)
})

it(`gets an image from a FileNode`, () => {
expect(getImage(fileNode)?.images.fallback?.src).toEqual(`imagesrc.jpg`)
})

it(`gets an image from an IGatsbyImageDataParent`, () => {
expect(getImage(dataParent)?.images.fallback?.src).toEqual(`imagesrc.jpg`)
it(`gets an image from an IGatsbyImageDataParent/IGatsbyImageParent`, () => {
expect(getImage(imageDataParent)?.images.fallback?.src).toEqual(
`imagesrc.jpg`
)
expect(getImage(imageParent)?.images.fallback?.src).toEqual(
`imagesrc.jpg`
)
})
it(`returns undefined from an invalid object`, () => {
expect(getImage(node)).toBeUndefined()
Expand All @@ -177,8 +190,9 @@ describe(`The image helper functions`, () => {
expect(getSrc(fileNode)).toEqual(`imagesrc.jpg`)
})

it(`gets src from an IGatsbyImageDataParent`, () => {
expect(getSrc(dataParent)).toEqual(`imagesrc.jpg`)
it(`gets src from an IGatsbyImageDataParent/IGatsbyImageParent`, () => {
expect(getSrc(imageDataParent)).toEqual(`imagesrc.jpg`)
expect(getSrc(imageParent)).toEqual(`imagesrc.jpg`)
})

it(`returns undefined from an invalid object`, () => {
Expand All @@ -202,8 +216,9 @@ describe(`The image helper functions`, () => {
expect(getSrcSet(fileNode)).toEqual(`imagesrcset.jpg 1x`)
})

it(`gets srcSet from an IGatsbyImageDataParent`, () => {
expect(getSrcSet(dataParent)).toEqual(`imagesrcset.jpg 1x`)
it(`gets srcSet from an IGatsbyImageDataParent/IGatsbyImageParent`, () => {
expect(getSrcSet(imageDataParent)).toEqual(`imagesrcset.jpg 1x`)
expect(getSrcSet(imageParent)).toEqual(`imagesrcset.jpg 1x`)
})

it(`returns undefined from an invalid object`, () => {
Expand Down
20 changes: 19 additions & 1 deletion packages/gatsby-plugin-image/src/components/hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ export function hasImageLoaded(cacheKey: string): boolean {
export type IGatsbyImageDataParent<T = never> = T & {
gatsbyImageData: IGatsbyImageData
}
export type IGatsbyImageParent<T = never> = T & {
gatsbyImage: IGatsbyImageData
}
export type FileNode = Node & {
childImageSharp?: IGatsbyImageDataParent<Node>
}
Expand All @@ -61,14 +64,29 @@ const isGatsbyImageDataParent = <T>(
node: IGatsbyImageDataParent<T> | any
): node is IGatsbyImageDataParent<T> => Boolean(node?.gatsbyImageData)

export type ImageDataLike = FileNode | IGatsbyImageDataParent | IGatsbyImageData
const isGatsbyImageParent = <T>(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
node: IGatsbyImageParent<T> | any
): node is IGatsbyImageParent<T> => Boolean(node?.gatsbyImage)

export type ImageDataLike =
| FileNode
| IGatsbyImageDataParent
| IGatsbyImageParent
| IGatsbyImageData

export const getImage = (node: ImageDataLike): IGatsbyImageData | undefined => {
if (isGatsbyImageData(node)) {
return node
}
// gatsbyImageData GraphQL field
if (isGatsbyImageDataParent(node)) {
return node.gatsbyImageData
}
// gatsbyImage GraphQL field for Gatsby's Image CDN service
if (isGatsbyImageParent(node)) {
return node.gatsbyImage
}
return node?.childImageSharp?.gatsbyImageData
}

Expand Down