Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.

refactor(nuxt): add import protection to nitro config #5847

Merged
merged 3 commits into from
Jul 12, 2022
Merged

refactor(nuxt): add import protection to nitro config #5847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b62f1fe
refactor(nuxt): add import protection to nitro config
danielroe Jul 12, 2022
484714a
style: remove separate variable for plugin
danielroe Jul 12, 2022
a0bda70
fix: exclude nitro renderer from import protection
danielroe Jul 12, 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
22 changes: 10 additions & 12 deletions packages/nuxt/src/core/nitro.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,16 @@ export async function initNitro (nuxt: Nuxt) {
nitroConfig.virtual['#build/dist/server/server.mjs'] = 'export default () => {}'
}

// Register nuxt protection patterns
nitroConfig.rollupConfig.plugins.push(ImportProtectionPlugin.rollup({
rootDir: nuxt.options.rootDir,
patterns: [
...['#app', /^#build(\/|$)/]
.map(p => [p, 'Vue app aliases are not allowed in server routes.']) as [RegExp | string, string][]
],
exclude: [/core[\\/]runtime[\\/]nitro[\\/]renderer/]
}))

// Extend nitro config with hook
await nuxt.callHook('nitro:config', nitroConfig)

Expand All @@ -121,18 +131,6 @@ export async function initNitro (nuxt: Nuxt) {
// Connect hooks
nuxt.hook('close', () => nitro.hooks.callHook('close'))

// Register nuxt protection patterns
nitro.hooks.hook('rollup:before', (nitro) => {
const plugin = ImportProtectionPlugin.rollup({
rootDir: nuxt.options.rootDir,
patterns: [
...['#app', /^#build(\/|$)/]
.map(p => [p, 'Vue app aliases are not allowed in server routes.']) as [RegExp | string, string][]
]
})
nitro.options.rollupConfig.plugins.push(plugin)
})

// Setup handlers
const devMidlewareHandler = dynamicEventHandler()
nitro.options.devHandlers.unshift({ handler: devMidlewareHandler })
Expand Down
4 changes: 4 additions & 0 deletions packages/nuxt/src/core/plugins/import-protection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const _require = createRequire(import.meta.url)
interface ImportProtectionOptions {
rootDir: string
patterns: [importPattern: string | RegExp, warning?: string][]
exclude?: Array<RegExp | string>
}

export const vueAppPatterns = (nuxt: Nuxt) => [
Expand All @@ -25,10 +26,13 @@ export const vueAppPatterns = (nuxt: Nuxt) => [

export const ImportProtectionPlugin = createUnplugin(function (options: ImportProtectionOptions) {
const cache: Record<string, Map<string | RegExp, boolean>> = {}
const importersToExclude = options?.exclude || []
return {
name: 'nuxt:import-protection',
enforce: 'pre',
resolveId (id, importer) {
if (importersToExclude.some(p => typeof p === 'string' ? importer === p : p.test(importer))) { return }

const invalidImports = options.patterns.filter(([pattern]) => pattern instanceof RegExp ? pattern.test(id) : pattern === id)
let matched: boolean
for (const match of invalidImports) {
Expand Down