chore: remove fs-extra as a dependency. (#40)

* chore: remove fs-extra as a dependency.

Fixes https://linear.app/netlify/issue/FRA-91/remove-fs-extra-dependency

* chore: update

* chore: updates

* chore: update

* chore: update

* chore: update

* chore: update

* chore: update

* chore: update

* chore: update

Author: lukasholzer

package-lock.json

@@ -18,7 +18,7 @@
     "build:debug": "tsc --sourceMap",
     "build:watch": "tsc --watch",
     "test": "vitest",
-    "test:ci": "vitest run --reporter=default"
+    "test:ci": "vitest run --reporter=default --retry=3"
   },
   "repository": {
     "type": "git",
@@ -41,7 +41,6 @@
     "@netlify/build": "^29.20.6",
     "@netlify/functions": "^2.0.1",
     "@vercel/nft": "^0.24.3",
-    "fs-extra": "^11.1.1",
     "globby": "^13.2.2",
     "os": "^0.1.2",
     "outdent": "^0.8.0",
@@ -51,7 +50,6 @@
     "@netlify/eslint-config-node": "^7.0.1",
     "@netlify/serverless-functions-api": "^1.10.1",
     "@netlify/zip-it-and-ship-it": "^9.25.5",
-    "@types/fs-extra": "^11.0.1",
     "@types/mock-fs": "^4.13.1",
     "@types/uuid": "^9.0.6",
     "cheerio": "^1.0.0-rc.12",

package.json

@@ -1,5 +1,7 @@
 import { NetlifyPluginConstants, NetlifyPluginUtils } from '@netlify/build'
-import { ensureDir, move, pathExists } from 'fs-extra/esm'
+import { existsSync } from 'node:fs'
+import { mkdir, rename, rm } from 'node:fs/promises'
+import { join } from 'node:path'
 import { BUILD_DIR } from './constants.js'
 
 /**
@@ -9,15 +11,32 @@ export const moveBuildOutput = async (
   { PUBLISH_DIR }: NetlifyPluginConstants,
   utils: NetlifyPluginUtils,
 ): Promise<void> => {
-  if (!(await pathExists(PUBLISH_DIR))) {
+  if (!existsSync(PUBLISH_DIR)) {
     utils.build.failBuild(
       'Your publish directory does not exist. Please check your netlify.toml file.',
     )
   }
 
-  // move the build output to a temp dir
-  await move(PUBLISH_DIR, `${BUILD_DIR}/.next`, { overwrite: true })
+  const tempDir = join(BUILD_DIR, '.next')
 
-  // recreate the publish dir so we can move the static content back
-  await ensureDir(PUBLISH_DIR)
+  try {
+    // cleanup any existing directory
+    await rm(tempDir, { force: true, recursive: true })
+    await mkdir(tempDir, { recursive: true })
+    // move the build output to a temp dir
+    await rename(PUBLISH_DIR, tempDir)
+  } catch (error) {
+    if (error instanceof Error) {
+      utils.build.failBuild(`Error moving the build output to the temp directory`, { error })
+    }
+  }
+
+  try {
+    // recreate the publish dir so we can move the static content back
+    await mkdir(PUBLISH_DIR, { recursive: true })
+  } catch (error) {
+    if (error instanceof Error) {
+      utils.build.failBuild(`Error recreating publish directory`, { error })
+    }
+  }
 }

src/build/cache.ts

@@ -1,14 +1,28 @@
-import { copy } from 'fs-extra/esm'
 import { globby } from 'globby'
+import { existsSync } from 'node:fs'
+import { copyFile, mkdir } from 'node:fs/promises'
+import { dirname, join } from 'node:path'
 
 /**
  * Copy App/Pages Router Javascript needed by the server handler
  */
-export const copyServerContent = async (src: string, dest: string): Promise<Promise<void>[]> => {
+export const copyServerContent = async (src: string, dest: string): Promise<void> => {
   const paths = await globby([`*`, `server/*`, `server/chunks/*`, `server/+(app|pages)/**/*.js`], {
     cwd: src,
     extglob: true,
   })
 
-  return paths.map((path: string) => copy(`${src}/${path}`, `${dest}/${path}`))
+  await Promise.all(
+    paths.map(async (path: string) => {
+      const srcPath = join(src, path)
+      const destPath = join(dest, path)
+
+      if (!existsSync(srcPath)) {
+        throw new Error(`Source file does not exist: ${srcPath}`)
+      }
+
+      await mkdir(dirname(destPath), { recursive: true })
+      await copyFile(srcPath, destPath)
+    }),
+  )
 }

src/build/content/server.ts

@@ -1,39 +1,73 @@
 import { NetlifyPluginConstants } from '@netlify/build'
-import { copy, pathExists } from 'fs-extra/esm'
 import { globby } from 'globby'
-import { ParsedPath, parse } from 'node:path'
+import { existsSync } from 'node:fs'
+import { copyFile, cp, mkdir } from 'node:fs/promises'
+import { ParsedPath, dirname, join, parse } from 'node:path'
 import { BUILD_DIR, WORKING_DIR } from '../constants.js'
 
 /**
  * Copy static pages (HTML without associated JSON data)
  */
-const copyStaticPages = async (src: string, dest: string): Promise<Promise<void>[]> => {
+const copyStaticPages = async (src: string, dest: string): Promise<void> => {
   const paths = await globby([`server/pages/**/*.+(html|json)`], {
     cwd: src,
     extglob: true,
   })
 
-  return (
+  await Promise.all(
     paths
       .map(parse)
       // keep only static files that do not have JSON data
       .filter(({ dir, name }: ParsedPath) => !paths.includes(`${dir}/${name}.json`))
-      .map(({ dir, base }: ParsedPath) =>
-        copy(`${src}/${dir}/${base}`, `${dest}/${dir.replace(/^server\/(app|pages)/, '')}/${base}`),
-      )
+      .map(async ({ dir, base }: ParsedPath) => {
+        const srcPath = join(src, dir, base)
+        const destPath = join(dest, dir.replace(/^server\/(app|pages)/, ''), base)
+
+        await mkdir(dirname(destPath), { recursive: true })
+        await copyFile(srcPath, destPath)
+      }),
   )
 }
 
+/**
+ * Copies static assets
+ */
+const copyStaticAssets = async ({
+  PUBLISH_DIR,
+}: Pick<NetlifyPluginConstants, 'PUBLISH_DIR'>): Promise<void> => {
+  try {
+    const src = join(BUILD_DIR, '.next/static')
+    const dist = join(PUBLISH_DIR, '_next/static')
+    await mkdir(dist, { recursive: true })
+    cp(src, dist, { recursive: true, force: true })
+  } catch (error) {
+    throw new Error(`Failed to copy static assets: ${error}`)
+  }
+}
+
+/**
+ * Copies the public folder over
+ */
+const copyPublicAssets = async ({
+  PUBLISH_DIR,
+}: Pick<NetlifyPluginConstants, 'PUBLISH_DIR'>): Promise<void> => {
+  const src = join(WORKING_DIR, 'public')
+  const dist = join(PUBLISH_DIR, 'public')
+  if (!existsSync(src)) {
+    return
+  }
+
+  await mkdir(dist, { recursive: true })
+  await cp(src, dist)
+}
+
 /**
  * Move static content to the publish dir so it is uploaded to the CDN
  */
 export const copyStaticContent = async ({ PUBLISH_DIR }: NetlifyPluginConstants): Promise<void> => {
   await Promise.all([
-    // static pages
-    Promise.all(await copyStaticPages(`${BUILD_DIR}/.next`, PUBLISH_DIR)),
-    // static assets
-    copy(`${BUILD_DIR}/.next/static/`, `${PUBLISH_DIR}/_next/static`),
-    // public assets
-    (await pathExists(`${WORKING_DIR}/public/`)) && copy(`${WORKING_DIR}/public/`, PUBLISH_DIR),
+    copyStaticPages(`${BUILD_DIR}/.next`, PUBLISH_DIR),
+    copyStaticAssets({ PUBLISH_DIR }),
+    copyPublicAssets({ PUBLISH_DIR }),
   ])
 }

src/build/content/static.ts

@@ -1,10 +1,11 @@
-import { emptyDir } from 'fs-extra/esm'
+import { mkdir, rm } from 'node:fs/promises'
 import { EDGE_HANDLER_DIR } from '../constants.js'
 
 /**
  * Create a Netlify edge function to run the Next.js server
  */
 export const createEdgeHandler = async () => {
   // reset the handler directory
-  await emptyDir(EDGE_HANDLER_DIR)
+  await rm(EDGE_HANDLER_DIR, { recursive: true, force: true })
+  await mkdir(EDGE_HANDLER_DIR, { recursive: true })
 }