Skip to content

feat(gatsby-plugin-sharp): Add tracedSVG option in fluid and fixed processors #11981

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

Merged
merged 2 commits into from
Feb 22, 2019
Merged

feat(gatsby-plugin-sharp): Add tracedSVG option in fluid and fixed processors #11981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d5530f
Add tracedSVG option in fluid and fixed processors
oorestisime Feb 21, 2019
db16b40
Add unit tests
oorestisime Feb 22, 2019
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
33 changes: 33 additions & 0 deletions packages/gatsby-plugin-sharp/src/__tests__/__snapshots__/index.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Object {
"srcSet": "/static/1234/56b42/test.png 200w,
/static/1234/a3030/test.png 281w",
"srcSetType": "image/png",
"tracedSVG": undefined,
}
`;

Expand All @@ -41,6 +42,7 @@ Object {
"srcSet": "/static/1234/4df82/test.png 200w,
/static/1234/67b29/test.png 281w",
"srcSetType": "image/png",
"tracedSVG": undefined,
}
`;

Expand All @@ -57,6 +59,7 @@ Object {
"src": "/static/1234/4ce1a/test.png",
"srcSet": "/static/1234/4ce1a/test.png 1w",
"srcSetType": "image/png",
"tracedSVG": undefined,
}
`;

Expand All @@ -70,3 +73,33 @@ Object {
"width": 746,
}
`;

exports[`gatsby-plugin-sharp tracedSVG runs on demand 1`] = `
Object {
"aspectRatio": 1,
"base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAIAAAAC64paAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAGElEQVQ4y2P4TwFgGNU8qnlU86jmgdUMAOBEq42KgAyMAAAAAElFTkSuQmCC",
"height": 1,
"originalName": undefined,
"src": "/static/1234/05eb0/test.png",
"srcSet": "/static/1234/05eb0/test.png 1x",
"tracedSVG": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='100' height='100' viewBox='0 0 100 100' version='1'/%3e",
"width": 1,
}
`;

exports[`gatsby-plugin-sharp tracedSVG runs on demand 2`] = `
Object {
"aspectRatio": 1,
"base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAIAAAAC64paAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAGElEQVQ4y2P4TwFgGNU8qnlU86jmgdUMAOBEq42KgAyMAAAAAElFTkSuQmCC",
"density": 72,
"originalImg": "/static/1234/c1fac/test.png",
"originalName": undefined,
"presentationHeight": 1,
"presentationWidth": 1,
"sizes": "(max-width: 1px) 100vw, 1px",
"src": "/static/1234/c1fac/test.png",
"srcSet": "/static/1234/c1fac/test.png 1w",
"srcSetType": "image/png",
"tracedSVG": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='100' height='100' viewBox='0 0 100 100' version='1'/%3e",
}
`;
47 changes: 47 additions & 0 deletions packages/gatsby-plugin-sharp/src/__tests__/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,53 @@ describe(`gatsby-plugin-sharp`, () => {
expect(result).toMatchSnapshot()
})
})

describe(`tracedSVG`, () => {
it(`doesn't always run`, async () => {
const args = {
maxWidth: 100,
width: 100,
tracedSVG: { color: `#FF0000` },
}

let result = await fixed({
file,
args,
})

expect(result.tracedSVG).toBeUndefined()
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd add a jest mock for the traceSVG function (it's already exported) and add an assertion that it's not called. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Any way i could mock this properly?

thought about

const spy = jest.spyOn(rest, `traceSVG`)

    beforeEach(() => {
      spy.mockClear()
    })

    afterAll(() => {
      spy.mockClear()
    })

with rest

const {
  base64,
  fluid,
  fixed,
  queueImageResizing,
  getImageSize,
  ...rest
} = require(`../`)

Copy link
Contributor

Choose a reason for hiding this comment

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

This seems trickier than I initially thought

Guess we should merge and iterate on the tests and the code (to make it easier to test) later


result = await fluid({
file,
args,
})

expect(result.tracedSVG).toBeUndefined()
})

it(`runs on demand`, async () => {
const args = {
maxWidth: 100,
width: 100,
generateTracedSVG: true,
tracedSVG: { color: `#FF0000` },
}

let result = await fixed({
file,
args,
})

expect(result).toMatchSnapshot()

result = await fluid({
file,
args,
})

expect(result).toMatchSnapshot()
})
})
})

function getFileObject(absolutePath, name = `test`) {
Expand Down
18 changes: 18 additions & 0 deletions packages/gatsby-plugin-sharp/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,18 @@ async function base64(arg) {
return await memoizedBase64(arg)
}

async function getTracedSVG(options, file) {
if (options.generateTracedSVG && options.tracedSVG) {
const tracedSVG = await traceSVG({
file,
args: options.tracedSVG,
fileArgs: options,
})
return tracedSVG
}
return undefined
}

async function fluid({ file, args = {}, reporter, cache }) {
const options = healOptions(pluginOptions, args, {})
// Account for images with a high pixel density. We assume that these types of
Expand Down Expand Up @@ -686,6 +698,8 @@ async function fluid({ file, args = {}, reporter, cache }) {
// Get base64 version
const base64Image = await base64({ file, args: base64Args, reporter, cache })

const tracedSVG = await getTracedSVG(options, file)

// Construct src and srcSet strings.
const originalImg = _.maxBy(images, image => image.width).src
const fallbackSrc = _.minBy(images, image =>
Expand Down Expand Up @@ -729,6 +743,7 @@ async function fluid({ file, args = {}, reporter, cache }) {
density,
presentationWidth,
presentationHeight,
tracedSVG,
}
}

Expand Down Expand Up @@ -796,6 +811,8 @@ async function fixed({ file, args = {}, reporter, cache }) {
// Get base64 version
const base64Image = await base64({ file, args: base64Args, reporter, cache })

const tracedSVG = await getTracedSVG(options, file)

const fallbackSrc = images[0].src
const srcSet = images
.map((image, i) => {
Expand Down Expand Up @@ -829,6 +846,7 @@ async function fixed({ file, args = {}, reporter, cache }) {
src: fallbackSrc,
srcSet,
originalName: originalName,
tracedSVG,
}
}

Expand Down