Normalized extension root path before usage in ext:dev:upload. (#6054)

apascal07 · web-flow · commit 654e88483bb6 · 2023-06-28T18:50:54.000Z
* Normalized extension root path before usage.

* Update CHANGELOG.md

* Update publisherApi.ts

* Update extensionsHelper.ts

* Update CHANGELOG.md

* Replaced join() with normalize() and fixed regex.

* Update extensionsHelper.ts

* Update extensionsHelper.ts
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,2 +1,3 @@
 - Increased extension instance create poll timeout to 1h to match backend (#5969).
 - Refactored `ext:install` to use the latest extension metadata. (#5997)
+- Normalized extension root path before usage in `ext:dev:upload`. (#6054)
diff --git a/src/extensions/extensionsHelper.ts b/src/extensions/extensionsHelper.ts
@@ -408,24 +408,17 @@ export async function promptForValidRepoURI(): Promise<string> {
 }
 
 /**
- * Prompts for a valid extension root.
+ * Prompts for an extension root.
  *
  * @param defaultRoot the default extension root
  */
-export async function promptForValidExtensionRoot(defaultRoot: string): Promise<string> {
-  let rootIsValid = false;
-  let extensionRoot = "";
-  while (!rootIsValid) {
-    extensionRoot = await promptOnce({
-      type: "input",
-      message:
-        "Enter this extension's root directory in the repo (defaults to previous root if set):",
-      default: defaultRoot,
-    });
-    // TODO: Add real directory path validation.
-    rootIsValid = true;
-  }
-  return extensionRoot;
+export async function promptForExtensionRoot(defaultRoot: string): Promise<string> {
+  return await promptOnce({
+    type: "input",
+    message:
+      "Enter this extension's root directory in the repo (defaults to previous root if set):",
+    default: defaultRoot,
+  });
 }
 
 /**
@@ -817,11 +810,17 @@ export async function uploadExtensionVersionFromGitHubSource(args: {
   if (!extensionRoot) {
     const defaultRoot = "/";
     if (!args.nonInteractive) {
-      extensionRoot = await promptForValidExtensionRoot(defaultRoot);
+      extensionRoot = await promptForExtensionRoot(defaultRoot);
     } else {
       extensionRoot = defaultRoot;
     }
   }
+  // Normalize root path and strip leading and trailing slashes and all `../`.
+  const normalizedRoot = path
+    .normalize(extensionRoot)
+    .replaceAll(/^\/|\/$/g, "")
+    .replaceAll(/^(\.\.\/)*/g, "");
+  extensionRoot = normalizedRoot || "/";
 
   // Prompt for source ref and default to HEAD.
   let sourceRef = args.sourceRef;
diff --git a/src/extensions/publisherApi.ts b/src/extensions/publisherApi.ts
@@ -205,7 +205,7 @@ export async function createExtensionVersionFromGitHubSource(args: {
     ExtensionVersion
   >(`/${refs.toExtensionName(ref)}/versions:createFromSource`, {
     versionId: ref.version,
-    extensionRoot: args.extensionRoot ?? "/",
+    extensionRoot: args.extensionRoot || "/",
     githubRepositorySource: {
       uri: args.repoUri,
       sourceRef: args.sourceRef,

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`- Increased extension instance create poll timeout to 1h to match backend (#5969).`
`2`	`2`	- Refactored `ext:install` to use the latest extension metadata. (#5997)
	`3`	+- Normalized extension root path before usage in `ext:dev:upload`. (#6054)