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

next/script fix duplicate scripts #28428

Merged
merged 14 commits into from Aug 24, 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/next/client/index.tsx
Expand Up @@ -156,13 +156,17 @@ window.__NEXT_P = []
const headManager: {
mountedInstances: Set<unknown>
updateHead: (head: JSX.Element[]) => void
getIsSsr?: () => boolean
} = initHeadManager()
const appElement: HTMLElement | null = document.getElementById('__next')

let lastRenderReject: (() => void) | null
let webpackHMR: any
export let router: Router
let CachedApp: AppComponent, onPerfEntry: (metric: any) => void
headManager.getIsSsr = () => {
return router.isSsr
}

class Container extends React.Component<{
fn: (err: Error, info?: any) => void
Expand Down
7 changes: 5 additions & 2 deletions packages/next/client/script.tsx
Expand Up @@ -140,7 +140,7 @@ function Script(props: ScriptProps): JSX.Element | null {
} = props

// Context is available only during SSR
const { updateScripts, scripts } = useContext(HeadManagerContext)
const { updateScripts, scripts, getIsSsr } = useContext(HeadManagerContext)

useEffect(() => {
if (strategy === 'afterInteractive') {
Expand All @@ -161,7 +161,10 @@ function Script(props: ScriptProps): JSX.Element | null {
},
])
updateScripts(scripts)
} else {
} else if (getIsSsr && getIsSsr()) {
// Script has already loaded during SSR
LoadCache.add(restProps.id || src)
} else if (getIsSsr && !getIsSsr()) {
loadScript(props)
}
}
Expand Down
1 change: 1 addition & 0 deletions packages/next/shared/lib/head-manager-context.ts
Expand Up @@ -5,6 +5,7 @@ export const HeadManagerContext: React.Context<{
mountedInstances?: any
updateScripts?: (state: any) => void
scripts?: any
getIsSsr?: () => boolean
}> = React.createContext({})

if (process.env.NODE_ENV !== 'production') {
Expand Down
9 changes: 4 additions & 5 deletions test/integration/script-loader/pages/page3.js
Expand Up @@ -4,11 +4,10 @@ const Page = () => {
return (
<div class="container">
<Script id="inline-script">
{`(window.onload = function () {
const newDiv = document.createElement('div')
newDiv.id = 'onload-div'
document.querySelector('body').appendChild(newDiv)
})`}
{`const newDiv = document.createElement('div')
newDiv.id = 'onload-div'
document.querySelector('body').appendChild(newDiv)
`}
</Script>
<Script
id="scriptLazyOnload"
Expand Down
13 changes: 12 additions & 1 deletion test/integration/script-loader/test/index.test.js
Expand Up @@ -128,14 +128,25 @@ describe('Script Loader', () => {
try {
browser = await webdriver(appPort, '/')

// beforeInteractive scripts should load once
let documentBIScripts = await browser.elementsByCss(
'[src$="documentBeforeInteractive"]'
)
expect(documentBIScripts.length).toBe(1)

await browser.waitForElementByCss('[href="/page1"]')
await browser.click('[href="/page1"]')

await browser.waitForElementByCss('.container')
await waitFor(1000)

const script = await browser.elementById('scriptBeforeInteractive')

// Ensure beforeInteractive script isn't duplicated on navigation
documentBIScripts = await browser.elementsByCss(
'[src$="documentBeforeInteractive"]'
)
expect(documentBIScripts.length).toBe(1)

// Renders script tag
expect(script).toBeDefined()
} finally {
Expand Down