Unverified Commit 7e95e300 authored by Balázs Orbán's avatar Balázs Orbán Committed by GitHub

fix: allow certain variable names in development (#33638)

Fixes #24570

A few variable names (listed https://github.com/vercel/next.js/issues/24570#issuecomment-828721019) were causing problems when using `next dev`.

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `yarn lint`
parent 0d642f12
...@@ -17,67 +17,70 @@ declare const module: { ...@@ -17,67 +17,70 @@ declare const module: {
// This function gets unwrapped into global scope, which is why we don't invert // This function gets unwrapped into global scope, which is why we don't invert
// if-blocks. Also, you cannot use `return`. // if-blocks. Also, you cannot use `return`.
export default function () { export default function () {
// Legacy CSS implementations will `eval` browser code in a Node.js context // Wrapped in an IIFE to avoid polluting the global scope
// to extract CSS. For backwards compatibility, we need to check we're in a ;(function () {
// browser context before continuing. // Legacy CSS implementations will `eval` browser code in a Node.js context
if ( // to extract CSS. For backwards compatibility, we need to check we're in a
typeof self !== 'undefined' && // browser context before continuing.
// AMP / No-JS mode does not inject these helpers: if (
'$RefreshHelpers$' in self typeof self !== 'undefined' &&
) { // AMP / No-JS mode does not inject these helpers:
var currentExports = module.__proto__.exports '$RefreshHelpers$' in self
var prevExports = module.hot.data?.prevExports ?? null ) {
var currentExports = module.__proto__.exports
var prevExports = module.hot.data?.prevExports ?? null
// This cannot happen in MainTemplate because the exports mismatch between // This cannot happen in MainTemplate because the exports mismatch between
// templating and execution. // templating and execution.
self.$RefreshHelpers$.registerExportsForReactRefresh( self.$RefreshHelpers$.registerExportsForReactRefresh(
currentExports, currentExports,
module.id module.id
) )
// A module can be accepted automatically based on its exports, e.g. when // A module can be accepted automatically based on its exports, e.g. when
// it is a Refresh Boundary. // it is a Refresh Boundary.
if (self.$RefreshHelpers$.isReactRefreshBoundary(currentExports)) { if (self.$RefreshHelpers$.isReactRefreshBoundary(currentExports)) {
// Save the previous exports on update so we can compare the boundary // Save the previous exports on update so we can compare the boundary
// signatures. // signatures.
module.hot.dispose(function (data) { module.hot.dispose(function (data) {
data.prevExports = currentExports data.prevExports = currentExports
}) })
// Unconditionally accept an update to this module, we'll check if it's // Unconditionally accept an update to this module, we'll check if it's
// still a Refresh Boundary later. // still a Refresh Boundary later.
module.hot.accept() module.hot.accept()
// This field is set when the previous version of this module was a // This field is set when the previous version of this module was a
// Refresh Boundary, letting us know we need to check for invalidation or // Refresh Boundary, letting us know we need to check for invalidation or
// enqueue an update. // enqueue an update.
if (prevExports !== null) { if (prevExports !== null) {
// A boundary can become ineligible if its exports are incompatible // A boundary can become ineligible if its exports are incompatible
// with the previous exports. // with the previous exports.
// //
// For example, if you add/remove/change exports, we'll want to // For example, if you add/remove/change exports, we'll want to
// re-execute the importing modules, and force those components to // re-execute the importing modules, and force those components to
// re-render. Similarly, if you convert a class component to a // re-render. Similarly, if you convert a class component to a
// function, we want to invalidate the boundary. // function, we want to invalidate the boundary.
if ( if (
self.$RefreshHelpers$.shouldInvalidateReactRefreshBoundary( self.$RefreshHelpers$.shouldInvalidateReactRefreshBoundary(
prevExports, prevExports,
currentExports currentExports
) )
) { ) {
module.hot.invalidate()
} else {
self.$RefreshHelpers$.scheduleUpdate()
}
}
} else {
// Since we just executed the code for the module, it's possible that the
// new exports made it ineligible for being a boundary.
// We only care about the case when we were _previously_ a boundary,
// because we already accepted this update (accidental side effect).
var isNoLongerABoundary = prevExports !== null
if (isNoLongerABoundary) {
module.hot.invalidate() module.hot.invalidate()
} else {
self.$RefreshHelpers$.scheduleUpdate()
} }
} }
} else {
// Since we just executed the code for the module, it's possible that the
// new exports made it ineligible for being a boundary.
// We only care about the case when we were _previously_ a boundary,
// because we already accepted this update (accidental side effect).
var isNoLongerABoundary = prevExports !== null
if (isNoLongerABoundary) {
module.hot.invalidate()
}
} }
} })()
} }
import { createNext } from 'e2e-utils'
import { NextInstance } from 'test/lib/next-modes/base'
import { sandbox } from './helpers'
describe('ReactRefreshModule', () => {
let next: NextInstance
beforeAll(async () => {
next = await createNext({
files: {},
skipStart: true,
})
})
afterAll(() => next.destroy())
it('should allow any variable names', async () => {
const { session, cleanup } = await sandbox(next, new Map([]))
expect(await session.hasRedbox()).toBe(false)
const variables = [
'_a',
'_b',
'currentExports',
'prevExports',
'isNoLongerABoundary',
]
for await (const variable of variables) {
await session.patch(
'pages/index.js',
`import { default as ${variable} } from 'next/link'
export default function Page() {
return null
}`
)
expect(await session.hasRedbox()).toBe(false)
expect(next.cliOutput).not.toContain(
`'${variable}' has already been declared`
)
}
await cleanup()
})
})
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment