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-manifest): fixes icons not getting asset prefix #20142

Merged
merged 7 commits into from
Jan 27, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`Test plugin manifest options correctly works with default parameters 1`] = `"{\\"name\\":\\"GatsbyJS\\",\\"short_name\\":\\"GatsbyJS\\",\\"start_url\\":\\"/\\",\\"background_color\\":\\"#f7f0eb\\",\\"theme_color\\":\\"#a2466c\\",\\"display\\":\\"standalone\\",\\"icons\\":[{\\"src\\":\\"icons/icon-48x48.png\\",\\"sizes\\":\\"48x48\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"icons/icon-72x72.png\\",\\"sizes\\":\\"72x72\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"icons/icon-96x96.png\\",\\"sizes\\":\\"96x96\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"icons/icon-144x144.png\\",\\"sizes\\":\\"144x144\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"icons/icon-192x192.png\\",\\"sizes\\":\\"192x192\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"icons/icon-256x256.png\\",\\"sizes\\":\\"256x256\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"icons/icon-384x384.png\\",\\"sizes\\":\\"384x384\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"icons/icon-512x512.png\\",\\"sizes\\":\\"512x512\\",\\"type\\":\\"image/png\\"}]}"`;
exports[`Test plugin manifest options correctly works with default parameters 1`] = `"{\\"name\\":\\"GatsbyJS\\",\\"short_name\\":\\"GatsbyJS\\",\\"start_url\\":\\"/\\",\\"background_color\\":\\"#f7f0eb\\",\\"theme_color\\":\\"#a2466c\\",\\"display\\":\\"standalone\\",\\"icons\\":[{\\"src\\":\\"/icons/icon-48x48.png\\",\\"sizes\\":\\"48x48\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"/icons/icon-72x72.png\\",\\"sizes\\":\\"72x72\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"/icons/icon-96x96.png\\",\\"sizes\\":\\"96x96\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"/icons/icon-144x144.png\\",\\"sizes\\":\\"144x144\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"/icons/icon-192x192.png\\",\\"sizes\\":\\"192x192\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"/icons/icon-256x256.png\\",\\"sizes\\":\\"256x256\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"/icons/icon-384x384.png\\",\\"sizes\\":\\"384x384\\",\\"type\\":\\"image/png\\"},{\\"src\\":\\"/icons/icon-512x512.png\\",\\"sizes\\":\\"512x512\\",\\"type\\":\\"image/png\\"}]}"`;

exports[`Test plugin manifest options does file name based cache busting 1`] = `
[MockFunction] {
"calls": Array [
Array [
"public/manifest.webmanifest",
"{\\"name\\":\\"GatsbyJS\\",\\"short_name\\":\\"GatsbyJS\\",\\"start_url\\":\\"/\\",\\"background_color\\":\\"#f7f0eb\\",\\"theme_color\\":\\"#a2466c\\",\\"display\\":\\"standalone\\",\\"icons\\":[{\\"src\\":\\"icons/icon-48x48-contentDigest.png\\",\\"sizes\\":\\"48x48\\",\\"type\\":\\"image/png\\",\\"purpose\\":\\"all\\"},{\\"src\\":\\"icons/icon-128x128-contentDigest.png\\",\\"sizes\\":\\"128x128\\",\\"type\\":\\"image/png\\"}]}",
"{\\"name\\":\\"GatsbyJS\\",\\"short_name\\":\\"GatsbyJS\\",\\"start_url\\":\\"/\\",\\"background_color\\":\\"#f7f0eb\\",\\"theme_color\\":\\"#a2466c\\",\\"display\\":\\"standalone\\",\\"icons\\":[{\\"src\\":\\"/icons/icon-48x48-contentDigest.png\\",\\"sizes\\":\\"48x48\\",\\"type\\":\\"image/png\\",\\"purpose\\":\\"all\\"},{\\"src\\":\\"/icons/icon-128x128-contentDigest.png\\",\\"sizes\\":\\"128x128\\",\\"type\\":\\"image/png\\"}]}",
],
],
"results": Array [
Object {
"type": "return",
"value": undefined,
},
],
}
`;

exports[`Test plugin manifest options properly prefixes icons in manifest with asset or path prefix 1`] = `
[MockFunction] {
"calls": Array [
Array [
"public/manifest.webmanifest",
"{\\"name\\":\\"GatsbyJS\\",\\"short_name\\":\\"GatsbyJS\\",\\"start_url\\":\\"/\\",\\"background_color\\":\\"#f7f0eb\\",\\"theme_color\\":\\"#a2466c\\",\\"display\\":\\"standalone\\",\\"icons\\":[{\\"src\\":\\"/test-prefix/icons/icon-48x48.png\\",\\"sizes\\":\\"48x48\\",\\"type\\":\\"image/png\\",\\"purpose\\":\\"all\\"},{\\"src\\":\\"/test-prefix/icons/icon-128x128.png\\",\\"sizes\\":\\"128x128\\",\\"type\\":\\"image/png\\"}]}",
],
],
"results": Array [
Expand Down
25 changes: 18 additions & 7 deletions packages/gatsby-plugin-manifest/src/__tests__/gatsby-node.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ const manifestOptions = {
display: `standalone`,
icons: [
{
src: `icons/icon-48x48.png`,
src: `/icons/icon-48x48.png`,
sizes: `48x48`,
type: `image/png`,
purpose: `all`,
},
{
src: `icons/icon-128x128.png`,
src: `/icons/icon-128x128.png`,
sizes: `128x128`,
type: `image/png`,
},
Expand All @@ -90,6 +90,7 @@ describe(`Test plugin manifest options`, () => {
fs.mkdirSync.mockReset()
fs.existsSync.mockReset()
sharp.mockClear()
global.__PATH_PREFIX__ = ``
})

// the require of gatsby-node performs the invoking
Expand Down Expand Up @@ -123,12 +124,12 @@ describe(`Test plugin manifest options`, () => {
const pluginSpecificOptions = {
icons: [
{
src: `icons/icon-48x48.png`,
src: `/icons/icon-48x48.png`,
sizes: `${size}x${size}`,
type: `image/png`,
},
{
src: `other-icons/icon-48x48.png`,
src: `/other-icons/icon-48x48.png`,
sizes: `${size}x${size}`,
type: `image/png`,
},
Expand All @@ -142,11 +143,11 @@ describe(`Test plugin manifest options`, () => {

const firstIconPath = path.join(
`public`,
path.dirname(`icons/icon-48x48.png`)
path.dirname(`/icons/icon-48x48.png`)
)
const secondIconPath = path.join(
`public`,
path.dirname(`other-icons/icon-48x48.png`)
path.dirname(`/other-icons/icon-48x48.png`)
)

expect(fs.mkdirSync).toHaveBeenNthCalledWith(1, firstIconPath)
Expand All @@ -163,7 +164,7 @@ describe(`Test plugin manifest options`, () => {
icon: icon,
icons: [
{
src: `icons/icon-48x48.png`,
src: `/icons/icon-48x48.png`,
sizes: `${size}x${size}`,
type: `image/png`,
},
Expand Down Expand Up @@ -257,6 +258,16 @@ describe(`Test plugin manifest options`, () => {
)
})

it(`properly prefixes icons in manifest with asset or path prefix`, async () => {
global.__PATH_PREFIX__ = `/test-prefix`

await onPostBootstrap(apiArgs, {
...manifestOptions,
})

expect(fs.writeFileSync).toMatchSnapshot()
})

it(`icon options iterator adds options and the icon array take precedence`, async () => {
fs.statSync.mockReturnValueOnce({ isFile: () => true })

Expand Down
9 changes: 9 additions & 0 deletions packages/gatsby-plugin-manifest/src/gatsby-node.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ import path from "path"
import sharp from "./safe-sharp"
import { createContentDigest, cpuCoreCount } from "gatsby-core-utils"
import { defaultIcons, doesIconExist, addDigestToPath } from "./common"
import { withPrefix as fallbackWithPrefix, withAssetPrefix } from "gatsby"

// TODO: remove for v3
const withPrefix = withAssetPrefix || fallbackWithPrefix

sharp.simd(true)

Expand Down Expand Up @@ -119,6 +123,11 @@ const makeManifest = async (cache, reporter, pluginOptions, shouldLocalize) => {
manifest.icons = [...defaultIcons]
}

//Fix #18497 by prefixing paths
manifest.icons = manifest.icons.map(icon => {
return { ...icon, src: withPrefix(icon.src) }
})

// Specify extra options for each icon (if requested).
if (pluginOptions.icon_options) {
manifest.icons = manifest.icons.map(icon => {
Expand Down