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.

Sign up for GitHub

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

Jump to bottom

fix(core): throw error if build folder already exists on initial clean #9112

Merged
merged 13 commits into from
Jun 30, 2023
Merged

fix(core): throw error if build folder already exists on initial clean #9112

Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
89903b3
fix(plugins): throw error if build folder already exists on initial c…
thedevwonder Jun 29, 2023
be98393
fix: throw an error if the output path name matches the cwd name case…
thedevwonder Jun 29, 2023
2293e12
fix: add toLowerCase() to match case
thedevwonder Jun 29, 2023
6638477
fix: add toLowerCase() to match case
thedevwonder Jun 29, 2023
358a8ae
fix(plugins): add file check using fs
thedevwonder Jun 30, 2023
7a23fbf
fix(plugins): use pathExistsSync from fs-extra module to validate path
thedevwonder Jun 30, 2023
2a7bb19
Apply suggestions from code review
Josh-Cena Jun 30, 2023
546f8a6
fix(plugins): add await fs.pathExists
thedevwonder Jun 30, 2023
4c427f1
fix(plugins): revert back to using pathExistsSync
thedevwonder Jun 30, 2023
c0aa55c
fix(plugins): add private validator func to check duplicate name in c…
thedevwonder Jun 30, 2023
daa1932
fix(core): change build error message on initial clean up
thedevwonder Jun 30, 2023
b08a976
fix(core): add file exists check and isFile check synchronously
thedevwonder Jun 30, 2023
d86ac5c
fix(core): fix build error message
thedevwonder Jun 30, 2023
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
20 changes: 20 additions & 0 deletions packages/docusaurus/src/webpack/plugins/CleanWebpackPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
// More context: https://github.com/facebook/docusaurus/pull/1839

import path from 'path';
import fs from 'fs-extra';
import {sync as delSync} from 'del';
import type {Compiler, Stats} from 'webpack';

Expand Down Expand Up @@ -115,6 +116,19 @@ export default class CleanWebpackPlugin {
this.removeFiles = this.removeFiles.bind(this);
}

private checkIfFileNameIsDuplicate(): boolean {
thedevwonder marked this conversation as resolved.
Show resolved Hide resolved
const dir = path.dirname(this.outputPath);
const baseName = path.basename(this.outputPath).toLowerCase();
// eslint-disable-next-line no-restricted-properties
const duplicateFiles = fs
.readdirSync(dir)
.filter((fileName) => fileName.toLowerCase() === baseName);
if (duplicateFiles.length > 0) {
return true;
}
return false;
}
Copy link
Collaborator

@slorber slorber Jun 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be enough

if (
      (await fs.pathExists(outputPath)) &&
      (await fs.stat(outputPath)).isFile()
    ) {
   throw new Error("...");
}

On:

  • case insensitive FS: this should throw for files like BUILD or build
  • case-sensitive FS: if a file named BUILD exists, I think it's allowed to create a folder named build? 🤔

I only have access to a case insensitive file-system. Can someone test my assumption on case sensitive file-system?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@slorber, I think yours is better because it doesn't break the abstraction of whether the FS is case-sensitive or not :)

Copy link
Contributor Author

@thedevwonder thedevwonder Jun 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be enough

if (
      (await fs.pathExists(outputPath)) &&
      (await fs.stat(outputPath)).isFile()
    ) {
   throw new Error("...");
}

On:

  • case insensitive FS: this should throw for files like BUILD or build
  • case-sensitive FS: if a file named BUILD exists, I think it's allowed to create a folder named build? 🤔

I only have access to a case insensitive file-system. Can someone test my assumption on case sensitive file-system?

I used gitpod.io to test this usecase. It is a case-sensitive system. I changed the code because I thought someone using case-sensitive FS may create a BUILD file and someone not using this FS may find this file throwing an error during the build

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about this, any suggestions? @slorber @Josh-Cena

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fine. Running the same project on different systems can often run into inconsistencies, like some imports that work on case-insensitive systems suddenly fail in case-sensitive ones.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Josh-Cena I see, keeping it simple then!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Josh-Cena @slorber I have used the sync version of pathExists and stat functions and fixed the error message. Let me know if this looks good.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have also tested the code in my local env. Works fine:)


apply(compiler: Compiler): void {
if (!compiler.options.output.path) {
console.warn(
Expand Down Expand Up @@ -152,6 +166,12 @@ export default class CleanWebpackPlugin {
return;
}

if (this.checkIfFileNameIsDuplicate()) {
throw new Error(
`Output directory ${this.outputPath} already exists. Docusaurus needs this directory to save the build output. Either remove the directory or choose a different build directory via '--out-dir'.`,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's a directory the role of this plugin is to delete. As @Josh-Cena said the problem is only if a file already exists, so this error message is not good.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@slorber this makes sense, I'll do the change

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes done

);
}

this.initialClean = true;

this.removeFiles(this.cleanOnceBeforeBuildPatterns);
Expand Down