Merge pull request #1876 from Automattic/fix/normalize-root-source-subpath

Normalize root extra-plugin source subpaths

Author: chubes4

packages/cli/src/recipe-sources.ts

@@ -1573,6 +1573,10 @@ function recipeExtraPluginSourceRootContainsSource(plugin: WorkspaceRecipeExtraP
 }
 
 export function normalizeRecipeExtraPluginSourceSubpath(value: string): string {
+  const rootMarker = value.trim().replace(/\\/g, "/").replace(/\/+$/, "")
+  if (rootMarker === ".") {
+    return ""
+  }
   const normalized = normalizeReviewerSafePath(value)
   if (!normalized || normalized === "." || normalized.startsWith("../") || normalized.includes("/../") || isAbsolute(normalized)) {
     throw new Error(`Recipe extra_plugins sourceSubdir/sourceSubpath must be a safe relative directory: ${value}`)

tests/recipe-extra-plugin-nested-source.test.ts

@@ -70,6 +70,34 @@ await withTempDir("wp-codebox-nested-extra-plugin-source-path-", async (recipeDi
   assert.equal((await stat(join(plugin.source, "example.php"))).isFile(), true)
 })
 
+await withTempDir("wp-codebox-extra-plugin-root-source-path-", async (recipeDirectory) => {
+  const pluginRoot = join(recipeDirectory, "example-plugin")
+  await mkdir(pluginRoot, { recursive: true })
+  await writeFile(join(pluginRoot, "example-plugin.php"), "<?php\n/* Plugin Name: Example Plugin */\n")
+
+  const recipe: WorkspaceRecipe = {
+    schema: "wp-codebox/workspace-recipe/v1",
+    inputs: {
+      extra_plugins: [{
+        sourcePath: "example-plugin",
+        sourceSubpath: ".",
+        mountSlug: "example-plugin",
+        pluginFile: "example-plugin/example-plugin.php",
+      }],
+    },
+    workflow: { steps: [{ command: "inspect-mounted-inputs" }] },
+  }
+
+  assertWorkspaceRecipeJsonSchema(recipe)
+  assert.deepEqual(await validateWorkspaceRecipeSemantics(recipe, join(recipeDirectory, "recipe.json")), [])
+
+  const [plugin] = await prepareRecipeExtraPlugins(recipe, recipeDirectory)
+  assert.ok(plugin)
+  assert.equal(plugin.slug, "example-plugin")
+  assert.equal(plugin.metadata?.sourceSubpath, undefined)
+  assert.equal((await stat(join(plugin.source, "example-plugin.php"))).isFile(), true)
+})
+
 await withTempDir("wp-codebox-nested-extra-plugin-invalid-", async (recipeDirectory) => {
   const repo = join(recipeDirectory, "repo")
   await mkdir(join(repo, "plugins", "nested-plugin"), { recursive: true })
@@ -87,6 +115,11 @@ await withTempDir("wp-codebox-nested-extra-plugin-invalid-", async (recipeDirect
       plugin: { sourcePath: "repo", sourceSubdir: "../outside", mountSlug: "nested-plugin", pluginFile: "nested-plugin/nested-plugin.php" },
       issue: "invalid-source-subdir",
     },
+    {
+      name: "embedded current-directory sourceSubdir",
+      plugin: { sourcePath: "repo", sourceSubdir: "./plugins/nested-plugin", mountSlug: "nested-plugin", pluginFile: "nested-plugin/nested-plugin.php" },
+      issue: "invalid-source-subdir",
+    },
     {
       name: "missing sourceSubdir",
       plugin: { sourcePath: "repo", sourceSubdir: "plugins/missing-plugin", mountSlug: "nested-plugin", pluginFile: "nested-plugin/nested-plugin.php" },