feat: check for root publish dir (#292)

* feat: check for root publish dir

* test: add test to catch root publish dir

* fix: error message clarity

Co-authored-by: Marc Littlemore <MarcL@users.noreply.github.com>

* fix: error message consistency

Co-authored-by: Marc Littlemore <MarcL@users.noreply.github.com>

---------

Co-authored-by: Marc Littlemore <MarcL@users.noreply.github.com>

Author: orinokai

src/build/plugin-context.test.ts

@@ -1,7 +1,7 @@
 import { join } from 'node:path'
 
 import { NetlifyPluginOptions } from '@netlify/build'
-import { test, expect, vi } from 'vitest'
+import { expect, test, vi } from 'vitest'
 
 import { mockFileSystem } from '../../tests/index.js'
 
@@ -66,7 +66,7 @@ test('next app with deep custom distDir', () => {
   expect(ctx.standaloneDir).toBe(join(cwd, 'out/dir/standalone/out'))
   expect(ctx.standaloneRootDir).toBe(join(cwd, 'out/dir/standalone'))
   expect(ctx.distDir).toBe('out/dir')
-  expect(ctx.distFolder).toBe('out')
+  expect(ctx.distDirParent).toBe('out')
   expect(ctx.nextDistDir).toBe('dir')
   expect(ctx.relPublishDir).toBe('out/dir')
   expect(ctx.publishDir).toBe(join(cwd, 'out/dir'))
@@ -103,7 +103,7 @@ test('monorepo with package path', () => {
   expect(ctx.standaloneRootDir).toBe(join(cwd, 'apps/my-app/.next/standalone'))
   expect(ctx.staticDir).toBe(join(cwd, 'apps/my-app/.netlify/static'))
   expect(ctx.distDir).toBe('apps/my-app/.next')
-  expect(ctx.distFolder).toBe('apps/my-app')
+  expect(ctx.distDirParent).toBe('apps/my-app')
   expect(ctx.nextDistDir).toBe('.next')
   expect(ctx.relPublishDir).toBe('apps/my-app/.next')
   expect(ctx.publishDir).toBe(join(cwd, 'apps/my-app/.next'))
@@ -142,7 +142,7 @@ test('nx monorepo with package path and different distDir', () => {
   expect(ctx.standaloneRootDir).toBe(join(cwd, 'dist/apps/my-app/.next/standalone'))
   expect(ctx.staticDir).toBe(join(cwd, 'apps/my-app/.netlify/static'))
   expect(ctx.distDir).toBe('dist/apps/my-app/.next')
-  expect(ctx.distFolder).toBe('dist/apps/my-app')
+  expect(ctx.distDirParent).toBe('dist/apps/my-app')
   expect(ctx.nextDistDir).toBe('.next')
   expect(ctx.relPublishDir).toBe('dist/apps/my-app/.next')
   expect(ctx.publishDir).toBe(join(cwd, 'dist/apps/my-app/.next'))

src/build/plugin-context.ts

@@ -1,4 +1,4 @@
-import { readFileSync } from 'node:fs'
+import { existsSync, readFileSync } from 'node:fs'
 import { readFile } from 'node:fs/promises'
 // Here we need to actually import `resolve` from node:path as we want to resolve the paths
 // eslint-disable-next-line no-restricted-imports
@@ -62,7 +62,7 @@ export class PluginContext {
    * The working directory inside the lambda that is used for monorepos to execute the serverless function
    */
   get lambdaWorkingDirectory(): string {
-    return join('/var/task', this.distFolder)
+    return join('/var/task', this.distDirParent)
   }
 
   /**
@@ -83,16 +83,16 @@ export class PluginContext {
     return relative(process.cwd(), resolve(this.packagePath, dir))
   }
 
-  /** The dist folder represents the parent directory of the .next folder or custom distDir */
-  get distFolder(): string {
+  /** Represents the parent directory of the .next folder or custom distDir */
+  get distDirParent(): string {
     // the .. is omitting the last part of the dist dir like `.next` but as it can be any custom folder
     // let's just move one directory up with that
     return join(this.distDir, '..')
   }
 
   /** The `.next` folder or what the custom dist dir is set to */
   get nextDistDir(): string {
-    return relative(this.distFolder, this.distDir)
+    return relative(this.distDirParent, this.distDir)
   }
 
   /** Retrieves the `.next/standalone/` directory monorepo aware */
@@ -102,7 +102,7 @@ export class PluginContext {
     // if the publish directory is .next the standalone directory will be `.next/standalone`
     // for nx workspaces where the publish directory is on the root of the repository
     // like `dist/apps/my-app/.next` the standalone directory will be `.next/standalone/dist/apps/my-app`
-    return join(this.standaloneRootDir, this.distFolder)
+    return join(this.standaloneRootDir, this.distDirParent)
   }
 
   /**
@@ -139,7 +139,7 @@ export class PluginContext {
     if (this.packagePath.length === 0) {
       return this.serverHandlerRootDir
     }
-    return join(this.serverHandlerRootDir, this.distFolder)
+    return join(this.serverHandlerRootDir, this.distDirParent)
   }
 
   get nextServerHandler(): string {
@@ -213,4 +213,17 @@ export class PluginContext {
   failBuild(message: string, error?: unknown): never {
     return this.utils.build.failBuild(message, error instanceof Error ? { error } : undefined)
   }
+
+  verifyPublishDir() {
+    if (!existsSync(this.publishDir)) {
+      this.failBuild(
+        `Your publish directory was not found at: ${this.publishDir}, please check your build settings`,
+      )
+    }
+    if (this.publishDir === this.resolve(this.packagePath)) {
+      this.failBuild(
+        `Your publish directory cannot be the same as the base directory of your site, please check your build settings`,
+      )
+    }
+  }
 }

src/index.ts

@@ -1,5 +1,3 @@
-import { existsSync } from 'node:fs'
-
 import type { NetlifyPluginOptions } from '@netlify/build'
 
 import { restoreBuildCache, saveBuildCache } from './build/cache.js'
@@ -25,12 +23,7 @@ export const onPreBuild = async (options: NetlifyPluginOptions) => {
 
 export const onBuild = async (options: NetlifyPluginOptions) => {
   const ctx = new PluginContext(options)
-  if (!existsSync(ctx.publishDir)) {
-    ctx.failBuild(
-      `Publish directory not found under: ${ctx.publishDir}, please check your netlify.toml`,
-    )
-  }
-  await setImageConfig(ctx)
+  ctx.verifyPublishDir()
 
   // only save the build cache if not run via the CLI
   if (!options.constants.IS_LOCAL) {
@@ -43,6 +36,7 @@ export const onBuild = async (options: NetlifyPluginOptions) => {
     copyPrerenderedContent(ctx),
     createServerHandler(ctx),
     createEdgeHandlers(ctx),
+    setImageConfig(ctx),
   ])
 }
 

tests/integration/simple-app.test.ts

@@ -63,6 +63,13 @@ test<FixtureTestContext>('Test that the simple next app is working', async (ctx)
   expect(load(notFound.body)('h1').text()).toBe('404')
 })
 
+test<FixtureTestContext>('Should warn if publish dir is root', async (ctx) => {
+  await createFixture('simple-next-app', ctx)
+  expect(() => runPlugin(ctx, { PUBLISH_DIR: '.' })).rejects.toThrowError(
+    'check your build settings',
+  )
+})
+
 test<FixtureTestContext>('Should add cache-tags to prerendered app pages', async (ctx) => {
   await createFixture('simple-next-app', ctx)
   await runPlugin(ctx)