Merge pull request #243 from robin-thomas/robin_writable_path

fix: check if provided path is writable
WalletConnect · Sep 12, 2023 · f6aeded · f6aeded
2 parents b2e345b + 601dfaf
commit f6aeded
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 2 deletions.
diff --git a/src/createEthApp.ts b/src/createEthApp.ts
@@ -4,7 +4,7 @@ import Handlebars from "handlebars";
 import path from "path";
 
 import { FrameworkKey, TemplateKey } from "./helpers/constants";
-import { isDirectoryEmpty } from "./helpers/directories";
+import { isDirectoryEmpty, isDirectoryWriteable } from "./helpers/directories";
 import { throwFrameworkNotFoundError, throwTemplateNotFoundError } from "./helpers/errors";
 import { downloadAndExtractFrameworkHandlebars, hasFramework, hasFrameworkHandlebars } from "./helpers/frameworks";
 import { tryGitInit } from "./helpers/git";
@@ -56,6 +56,11 @@ export async function createEthApp({
     process.exit(1);
   }
 
+  if (!(await isDirectoryWriteable(root))) {
+    console.error("Your application path is not writable. Please check your directory permissions and try again.");
+    process.exit(1);
+  }
+
   shouldUseYarn();
   shouldUseYarnWorkspaces();
 

diff --git a/src/helpers/directories.ts b/src/helpers/directories.ts
@@ -59,3 +59,12 @@ export function isDirectoryEmpty(directoryPath: string, appName: string): boolea
 
   return true;
 }
+
+export async function isDirectoryWriteable(directory: string): Promise<boolean> {
+  try {
+    await fs.promises.access(directory, (fs.constants || fs).W_OK);
+    return true;
+  } catch (err) {
+    return false;
+  }
+}
diff --git a/test/unit/directories.test.ts b/test/unit/directories.test.ts
@@ -3,7 +3,7 @@ import fsExtra from "fs-extra";
 import path from "path";
 import tempy from "tempy";
 
-import { isDirectoryEmpty } from "../../src/helpers/directories";
+import { isDirectoryEmpty, isDirectoryWriteable } from "../../src/helpers/directories";
 
 // This has to be in sync with the valid files defined "helpers/directories".
 const filesDirsTable: string[][] = [
@@ -105,6 +105,26 @@ describe("directories", function () {
     });
   });
 
+  describe("when the directory is not writable", function () {
+    beforeEach(async function () {
+      await fsExtra.chmod(testDirPath, 0o444);
+    });
+
+    test("returns false", async function () {
+      await expect(isDirectoryWriteable(testDirPath)).resolves.toBe(false);
+    });
+  });
+
+  describe("when the directory is writable", function () {
+    beforeEach(async function () {
+      await fsExtra.chmod(testDirPath, 0o777);
+    });
+
+    test("returns true", async function () {
+      await expect(isDirectoryWriteable(testDirPath)).resolves.toBe(true);
+    });
+  });
+
   afterEach(function () {
     fsExtra.removeSync(testDirPath);
   });