fix: resolve site dependency version from packagePath if defined (#6650)

Author: pieh

packages/build/src/plugins/plugin_conditions.ts

@@ -52,7 +52,7 @@ const siteDependenciesTest = async function (
   return (
     await Promise.all(
       Object.entries(allowedSiteDependencies).map(async ([dependencyName, allowedVersion]) =>
-        siteDependencyTest({ dependencyName, allowedVersion, siteDependencies, buildDir }),
+        siteDependencyTest({ dependencyName, allowedVersion, siteDependencies, buildDir, packagePath }),
       ),
     )
   ).every(Boolean)
@@ -63,10 +63,12 @@ const siteDependencyTest = async function ({
   allowedVersion,
   siteDependencies,
   buildDir,
+  packagePath,
 }: {
   dependencyName: string
   allowedVersion: string
   buildDir: string
+  packagePath?: string
   siteDependencies: Record<string, string | undefined>
 }): Promise<boolean> {
   const siteDependency = siteDependencies[dependencyName]
@@ -81,7 +83,7 @@ const siteDependencyTest = async function ({
 
   try {
     // if this is a range we need to get the exact version
-    const packageJsonPath = await resolvePath(`${dependencyName}/package.json`, buildDir)
+    const packageJsonPath = await resolvePath(`${dependencyName}/package.json`, join(buildDir, packagePath ?? ''))
     const { version } = await importJsonFile(packageJsonPath)
     if (!version) {
       return false

packages/build/tests/plugins_list/fixtures/plugins_compat_site_dependencies_range_monorepo_hoisted/apps/web/netlify.toml

@@ -0,0 +1,2 @@
+[[plugins]]
+package = "netlify-plugin-contextual-env"

packages/build/tests/plugins_list/fixtures/plugins_compat_site_dependencies_range_monorepo_hoisted/apps/web/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "module_plugin",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "test",
+  "license": "MIT",
+  "repository": "test",
+  "dependencies": {
+    "@netlify/dependency-with-range": "^9.5.4"
+  }
+}

packages/build/tests/plugins_list/fixtures/plugins_compat_site_dependencies_range_monorepo_hoisted/node_modules/@netlify/dependency-with-range/package.json

@@ -0,0 +1,5 @@
+{
+  "workspaces": [
+    "apps/*"
+  ]
+}

packages/build/tests/plugins_list/fixtures/plugins_compat_site_dependencies_range_monorepo_hoisted/package.json

@@ -0,0 +1,2 @@
+[[plugins]]
+package = "netlify-plugin-contextual-env"

packages/build/tests/plugins_list/fixtures/plugins_compat_site_dependencies_range_monorepo_not_hoisted/apps/web/netlify.toml

@@ -0,0 +1,11 @@
+{
+  "name": "module_plugin",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "test",
+  "license": "MIT",
+  "repository": "test",
+  "dependencies": {
+    "@netlify/dependency-with-range": "^9.5.4"
+  }
+}

packages/build/tests/plugins_list/fixtures/plugins_compat_site_dependencies_range_monorepo_not_hoisted/apps/web/node_modules/@netlify/dependency-with-range/package.json

@@ -0,0 +1,5 @@
+{
+  "workspaces": [
+    "apps/*"
+  ]
+}

packages/build/tests/plugins_list/fixtures/plugins_compat_site_dependencies_range_monorepo_not_hoisted/apps/web/package.json

@@ -8,8 +8,7 @@ import cpy from 'cpy'
 
 const FIXTURES_DIR = fileURLToPath(new URL('fixtures', import.meta.url))
 
-const runWithApiMock = async function (
-  t,
+const runWithApiMockAndGetNormalizedOutput = async function (
   fixtureName,
   { testPlugin, response = getPluginsList(testPlugin), ...flags } = {},
   status = 200,
@@ -26,12 +25,21 @@ const runWithApiMock = async function (
         ...flags,
       })
       .runWithBuild()
-    await t.snapshot(normalizeOutput(output))
+    return normalizeOutput(output)
   } finally {
     await stopServer()
   }
 }
 
+const runWithApiMock = async function (
+  t,
+  fixtureName,
+  { testPlugin, response = getPluginsList(testPlugin), ...flags } = {},
+  status = 200,
+) {
+  await t.snapshot(await runWithApiMockAndGetNormalizedOutput(fixtureName, { testPlugin, response, ...flags }, status))
+}
+
 // We use a specific plugin in tests. We hardcode its version to keep the tests
 // stable even when new versions of that plugin are published.
 const getPluginsList = function (testPlugin = DEFAULT_TEST_PLUGIN) {
@@ -289,6 +297,66 @@ test.serial('Plugins can specify non-matching compatibility.siteDependencies ran
   })
 })
 
+test.serial(
+  'Plugins can specify matching compatibility.siteDependencies range in monorepo with hoisted node_modules',
+  async (t) => {
+    await removeDir(`${FIXTURES_DIR}/plugins_compat_site_dependencies_range_monorepo_hoisted/apps/web/.netlify`)
+    const normalizedOutput = await runWithApiMockAndGetNormalizedOutput(
+      'plugins_compat_site_dependencies_range_monorepo_hoisted',
+      {
+        testPlugin: {
+          compatibility: [
+            { version: '0.3.0' },
+            {
+              version: '0.2.0',
+              siteDependencies: {
+                // this is satisfied, so this version should be selected
+                '@netlify/dependency-with-range': '<10',
+              },
+            },
+          ],
+        },
+        packagePath: 'apps/web',
+      },
+    )
+    t.true(
+      normalizedOutput.includes(
+        'netlify-plugin-contextual-env 0-2-0 from netlify.toml (latest 0-3-0, expected 0-2-0, compatible 0-2-0)',
+      ),
+    )
+  },
+)
+
+test.serial(
+  'Plugins can specify matching compatibility.siteDependencies range in monorepo without hoisted node_modules',
+  async (t) => {
+    await removeDir(`${FIXTURES_DIR}/plugins_compat_site_dependencies_range_monorepo_not_hoisted/apps/web/.netlify`)
+    const normalizedOutput = await runWithApiMockAndGetNormalizedOutput(
+      'plugins_compat_site_dependencies_range_monorepo_not_hoisted',
+      {
+        testPlugin: {
+          compatibility: [
+            { version: '0.3.0' },
+            {
+              version: '0.2.0',
+              siteDependencies: {
+                // this is satisfied, so this version should be selected
+                '@netlify/dependency-with-range': '<10',
+              },
+            },
+          ],
+        },
+        packagePath: 'apps/web',
+      },
+    )
+    t.true(
+      normalizedOutput.includes(
+        'netlify-plugin-contextual-env 0-2-0 from netlify.toml (latest 0-3-0, expected 0-2-0, compatible 0-2-0)',
+      ),
+    )
+  },
+)
+
 test.serial('Plugin versions can be feature flagged', async (t) => {
   await removeDir(`${FIXTURES_DIR}/plugins_compat_node_version/.netlify`)
   await runWithApiMock(t, 'plugins_compat_node_version', {