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.

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

fix: resolve missing peer from versions already present in other parts of the dep graph #7822

Draft
wants to merge 2 commits into
base: v8
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/eight-walls-collect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"pnpm": major
---

When automatically installing peer dependencies, use versions of the peers already present in the dependency graph. Even if they don't satisfy the wanted peer dependency ranges.
5 changes: 5 additions & 0 deletions .changeset/thirty-schools-behave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@pnpm/lockfile.preferred-versions": major
---

Initial release.
2 changes: 1 addition & 1 deletion __utils__/assert-project/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"@pnpm/constants": "workspace:*",
"@pnpm/lockfile-types": "workspace:*",
"@pnpm/modules-yaml": "workspace:*",
"@pnpm/registry-mock": "3.20.0",
"@pnpm/registry-mock": "3.27.0",
"@pnpm/types": "workspace:*",
"is-windows": "^1.0.2",
"isexe": "2.0.0",
Expand Down
2 changes: 1 addition & 1 deletion __utils__/assert-store/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"test": "pnpm pretest && pnpm run compile && jest"
},
"dependencies": {
"@pnpm/registry-mock": "3.20.0",
"@pnpm/registry-mock": "3.27.0",
"@pnpm/store.cafs": "workspace:*",
"path-exists": "^4.0.0"
},
Expand Down
2 changes: 1 addition & 1 deletion exec/plugin-commands-rebuild/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"@pnpm/filter-workspace-packages": "workspace:*",
"@pnpm/plugin-commands-rebuild": "workspace:*",
"@pnpm/prepare": "workspace:*",
"@pnpm/registry-mock": "3.20.0",
"@pnpm/registry-mock": "3.27.0",
"@pnpm/test-fixtures": "workspace:*",
"@pnpm/test-ipc-server": "workspace:*",
"@types/ramda": "0.28.20",
Expand Down
2 changes: 1 addition & 1 deletion exec/plugin-commands-script-runners/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"@pnpm/filter-workspace-packages": "workspace:*",
"@pnpm/plugin-commands-script-runners": "workspace:*",
"@pnpm/prepare": "workspace:*",
"@pnpm/registry-mock": "3.20.0",
"@pnpm/registry-mock": "3.27.0",
"@pnpm/test-ipc-server": "workspace:*",
"@types/is-windows": "^1.0.2",
"@types/ramda": "0.28.20",
Expand Down
13 changes: 13 additions & 0 deletions lockfile/preferred-versions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# @pnpm/lockfile.preferred-versions

> Get preferred version from lockfile

## Install

```
pnpm add @pnpm/lockfile.preferred-versions
```

## License

[MIT](LICENSE)
46 changes: 46 additions & 0 deletions lockfile/preferred-versions/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"name": "@pnpm/lockfile.preferred-versions",
"version": "0.0.0-0",
"description": "Get preferred version from lockfile",
"main": "lib/index.js",
"types": "lib/index.d.ts",
"engines": {
"node": ">=16.14"
},
"files": [
"lib",
"!*.map"
],
"scripts": {
"lint": "eslint \"src/**/*.ts\"",
"test": "pnpm run compile",
"prepublishOnly": "pnpm run compile",
"compile": "tsc --build && pnpm run lint --fix"
},
"repository": "https://github.com/pnpm/pnpm/blob/main/lockfile/preferred-versions",
"keywords": [
"pnpm8",
"pnpm",
"shrinkwrap",
"lockfile"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/pnpm/pnpm/issues"
},
"homepage": "https://github.com/pnpm/pnpm/blob/main/lockfile/preferred-versions#readme",
"devDependencies": {
"@pnpm/lockfile.preferred-versions": "workspace:*"
},
"dependencies": {
"@pnpm/lockfile-utils": "workspace:*",
"@pnpm/manifest-utils": "workspace:*",
"@pnpm/resolver-base": "workspace:*",
"@pnpm/types": "workspace:*",
"version-selector-type": "^3.0.0"
},
"funding": "https://opencollective.com/pnpm",
"exports": {
".": "./lib/index.js"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,6 @@ import { DIRECT_DEP_SELECTOR_WEIGHT, type PreferredVersions } from '@pnpm/resolv
import { type DependencyManifest, type ProjectManifest } from '@pnpm/types'
import getVersionSelectorType from 'version-selector-type'

export function getAllUniqueSpecs (manifests: DependencyManifest[]) {
const allSpecs: Record<string, string> = {}
const ignored = new Set<string>()
for (const manifest of manifests) {
const specs = getAllDependenciesFromManifest(manifest)
for (const [name, spec] of Object.entries(specs)) {
if (ignored.has(name)) continue
if (allSpecs[name] != null && allSpecs[name] !== spec || spec.includes(':')) {
ignored.add(name)
delete allSpecs[name]
continue
}
allSpecs[name] = spec
}
}
return allSpecs
}

export function getPreferredVersionsFromLockfileAndManifests (
snapshots: PackageSnapshots | undefined,
manifests: Array<DependencyManifest | ProjectManifest>
Expand Down
26 changes: 26 additions & 0 deletions lockfile/preferred-versions/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"extends": "@pnpm/tsconfig",
"compilerOptions": {
"outDir": "lib",
"rootDir": "src"
},
"include": [
"src/**/*.ts",
"../../__typings__/**/*.d.ts"
],
"references": [
{
"path": "../../packages/types"
},
{
"path": "../../pkg-manifest/manifest-utils"
},
{
"path": "../../resolving/resolver-base"
},
{
"path": "../lockfile-utils"
}
],
"composite": true
}
8 changes: 8 additions & 0 deletions lockfile/preferred-versions/tsconfig.lint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"include": [
"src/**/*.ts",
"test/**/*.ts",
"../../__typings__/**/*.d.ts"
]
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"@commitlint/prompt-cli": "^17.8.1",
"@pnpm/eslint-config": "workspace:*",
"@pnpm/meta-updater": "1.0.0",
"@pnpm/registry-mock": "3.20.0",
"@pnpm/registry-mock": "3.27.0",
"@pnpm/tsconfig": "workspace:*",
"@pnpm/worker": "workspace:*",
"@types/jest": "^29.5.8",
Expand Down
2 changes: 1 addition & 1 deletion patching/plugin-commands-patching/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"@pnpm/filter-workspace-packages": "workspace:*",
"@pnpm/plugin-commands-patching": "workspace:*",
"@pnpm/prepare": "workspace:*",
"@pnpm/registry-mock": "3.20.0",
"@pnpm/registry-mock": "3.27.0",
"@pnpm/test-fixtures": "workspace:*",
"@types/normalize-path": "^3.0.2",
"@types/ramda": "0.28.20",
Expand Down
5 changes: 3 additions & 2 deletions pkg-manager/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"@pnpm/lockfile-to-pnp": "workspace:*",
"@pnpm/lockfile-utils": "workspace:*",
"@pnpm/lockfile-walker": "workspace:*",
"@pnpm/lockfile.preferred-versions": "workspace:*",
"@pnpm/manifest-utils": "workspace:*",
"@pnpm/matcher": "workspace:*",
"@pnpm/modules-cleaner": "workspace:*",
Expand Down Expand Up @@ -82,11 +83,11 @@
"@pnpm/lockfile-types": "workspace:*",
"@pnpm/package-store": "workspace:*",
"@pnpm/prepare": "workspace:*",
"@pnpm/registry-mock": "3.20.0",
"@pnpm/registry-mock": "3.27.0",
"@pnpm/store-path": "workspace:*",
"@pnpm/store.cafs": "workspace:*",
"@pnpm/test-ipc-server": "workspace:*",
"@pnpm/test-fixtures": "workspace:*",
"@pnpm/test-ipc-server": "workspace:*",
"@types/fs-extra": "^9.0.13",
"@types/is-windows": "^1.0.2",
"@types/normalize-path": "^3.0.2",
Expand Down
2 changes: 1 addition & 1 deletion pkg-manager/core/src/getPeerDependencyIssues.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { getPreferredVersionsFromLockfileAndManifests } from '@pnpm/lockfile.preferred-versions'
import { resolveDependencies, getWantedDependencies } from '@pnpm/resolve-dependencies'
import { type PeerDependencyIssuesByProjects } from '@pnpm/types'
import { getContext, type GetContextOptions, type ProjectOptions } from '@pnpm/get-context'
import { createReadPackageHook } from '@pnpm/hooks.read-package-hook'
import { getPreferredVersionsFromLockfileAndManifests } from './install/getPreferredVersions'
import { type InstallOptions } from './install/extendInstallOptions'
import { DEFAULT_REGISTRIES } from '@pnpm/normalize-registries'

Expand Down
4 changes: 2 additions & 2 deletions pkg-manager/core/src/install/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ import {
} from '@pnpm/lockfile-file'
import { writePnpFile } from '@pnpm/lockfile-to-pnp'
import { extendProjectsWithTargetDirs, satisfiesPackageManifest } from '@pnpm/lockfile-utils'
import { getPreferredVersionsFromLockfileAndManifests } from '@pnpm/lockfile.preferred-versions'
import { logger, globalInfo, streamParser } from '@pnpm/logger'
import { getAllDependenciesFromManifest } from '@pnpm/manifest-utils'
import { getAllDependenciesFromManifest, getAllUniqueSpecs } from '@pnpm/manifest-utils'
import { writeModulesManifest } from '@pnpm/modules-yaml'
import { readModulesDir } from '@pnpm/read-modules-dir'
import { safeReadProjectManifestOnly } from '@pnpm/read-project-manifest'
Expand Down Expand Up @@ -82,7 +83,6 @@ import {
type InstallOptions,
type ProcessedInstallOptions as StrictInstallOptions,
} from './extendInstallOptions'
import { getAllUniqueSpecs, getPreferredVersionsFromLockfileAndManifests } from './getPreferredVersions'
import { linkPackages } from './link'
import { reportPeerDependencyIssues } from './reportPeerDependencyIssues'

Expand Down
10 changes: 10 additions & 0 deletions pkg-manager/core/test/install/autoInstallPeers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -602,3 +602,13 @@ test('do not override the direct dependency with an auto installed peer dependen
const lockfile = await project.readLockfile()
expect(lockfile.dependencies.rxjs.version).toStrictEqual('6.6.7')
})

test('auto install hoisted peer dependency', async () => {
await addDistTag({ package: '@pnpm.e2e/peer-c', version: '1.0.0', distTag: 'latest' })
const project = prepareEmpty()
await addDependenciesToPackage({}, ['@pnpm.e2e/has-peer-c-in-deps@1.0.0', '@pnpm.e2e/abc'], testDefaults({ autoInstallPeers: true }))
const lockfile = project.readLockfile()
expect(Object.keys(lockfile.snapshots).filter((depPath) => depPath.startsWith('@pnpm.e2e/peer-c@'))).toStrictEqual([
'@pnpm.e2e/peer-c@2.0.0',
])
})
3 changes: 3 additions & 0 deletions pkg-manager/core/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@
{
"path": "../../lockfile/lockfile-walker"
},
{
"path": "../../lockfile/preferred-versions"
},
{
"path": "../../lockfile/prune-lockfile"
},
Expand Down
2 changes: 1 addition & 1 deletion pkg-manager/headless/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"@pnpm/package-store": "workspace:*",
"@pnpm/prepare": "workspace:*",
"@pnpm/read-projects-context": "workspace:*",
"@pnpm/registry-mock": "3.20.0",
"@pnpm/registry-mock": "3.27.0",
"@pnpm/store-path": "workspace:*",
"@pnpm/store.cafs": "workspace:*",
"@pnpm/test-fixtures": "workspace:*",
Expand Down
2 changes: 1 addition & 1 deletion pkg-manager/package-requester/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
"@pnpm/client": "workspace:*",
"@pnpm/create-cafs-store": "workspace:*",
"@pnpm/package-requester": "workspace:*",
"@pnpm/registry-mock": "3.20.0",
"@pnpm/registry-mock": "3.27.0",
"@pnpm/test-fixtures": "workspace:*",
"@types/normalize-path": "^3.0.2",
"@types/ramda": "0.28.20",
Expand Down
2 changes: 1 addition & 1 deletion pkg-manager/plugin-commands-installation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"@pnpm/modules-yaml": "workspace:*",
"@pnpm/plugin-commands-installation": "workspace:*",
"@pnpm/prepare": "workspace:*",
"@pnpm/registry-mock": "3.20.0",
"@pnpm/registry-mock": "3.27.0",
"@pnpm/test-fixtures": "workspace:*",
"@pnpm/test-ipc-server": "workspace:*",
"@types/proxyquire": "^1.3.31",
Expand Down
1 change: 1 addition & 0 deletions pkg-manager/resolve-dependencies/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"@pnpm/exec.files-include-install-scripts": "workspace:*",
"@pnpm/lockfile-types": "workspace:*",
"@pnpm/lockfile-utils": "workspace:*",
"@pnpm/lockfile.preferred-versions": "workspace:*",
"@pnpm/manifest-utils": "workspace:*",
"@pnpm/npm-resolver": "workspace:*",
"@pnpm/pick-fetcher": "workspace:*",
Expand Down
21 changes: 20 additions & 1 deletion pkg-manager/resolve-dependencies/src/resolveDependencies.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import {
type Registries,
} from '@pnpm/types'
import * as dp from '@pnpm/dependency-path'
import { getPreferredVersionsFromLockfileAndManifests } from '@pnpm/lockfile.preferred-versions'
import normalizePath from 'normalize-path'
import exists from 'path-exists'
import pDefer from 'p-defer'
Expand Down Expand Up @@ -132,6 +133,7 @@ export interface ResolutionContext {
autoInstallPeersFromHighestMatch: boolean
allowBuild?: (pkgName: string) => boolean
allowedDeprecatedVersions: AllowedDeprecatedVersions
allPreferredVersions?: PreferredVersions
appliedPatches: Set<string>
updatedSet: Set<string>
defaultTag: string
Expand Down Expand Up @@ -288,6 +290,9 @@ export async function resolveRootDependencies (
ctx: ResolutionContext,
importers: ImporterToResolve[]
): Promise<ResolvedRootDependenciesResult> {
if (ctx.autoInstallPeers) {
ctx.allPreferredVersions = getPreferredVersionsFromLockfileAndManifests(ctx.wantedLockfile.packages, [])
}
const { pkgAddressesByImportersWithoutPeers, publishedBy, time } = await resolveDependenciesOfImporters(ctx, importers)
const pkgAddressesByImporters = await Promise.all(zipWith(async (importerResolutionResult, { parentPkgAliases, preferredVersions, options }) => {
const pkgAddresses = importerResolutionResult.pkgAddresses
Expand All @@ -308,7 +313,14 @@ export async function resolveRootDependencies (
}
}
if (!Object.keys(importerResolutionResult.missingPeers).length) break
const wantedDependencies = getNonDevWantedDependencies({ dependencies: importerResolutionResult.missingPeers })
const dependencies = Object.fromEntries(
Object.entries(importerResolutionResult.missingPeers)
.map(([peerName, peerRange]) => {
if (!ctx.allPreferredVersions![peerName]) return [peerName, peerRange]
return [peerName, Object.keys(ctx.allPreferredVersions![peerName]).join(' || ')]
})
)
const wantedDependencies = getNonDevWantedDependencies({ dependencies })

// eslint-disable-next-line no-await-in-loop
const resolveDependenciesResult = await resolveDependencies(ctx, preferredVersions, wantedDependencies, {
Expand Down Expand Up @@ -1152,6 +1164,13 @@ async function resolveDependency (

pkgResponse.body.id = encodePkgId(pkgResponse.body.id)

if (ctx.allPreferredVersions && pkgResponse.body.manifest?.version) {
if (!ctx.allPreferredVersions[pkgResponse.body.manifest.name]) {
ctx.allPreferredVersions[pkgResponse.body.manifest.name] = {}
}
ctx.allPreferredVersions[pkgResponse.body.manifest.name][pkgResponse.body.manifest.version] = 'version'
}

if (
!pkgResponse.body.updated &&
options.currentDepth === Math.max(0, options.updateDepth) &&
Expand Down
3 changes: 3 additions & 0 deletions pkg-manager/resolve-dependencies/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
{
"path": "../../lockfile/lockfile-utils"
},
{
"path": "../../lockfile/preferred-versions"
},
{
"path": "../../lockfile/prune-lockfile"
},
Expand Down
20 changes: 20 additions & 0 deletions pkg-manifest/manifest-utils/src/getAllUniqueSpecs.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { type DependencyManifest } from '@pnpm/types'
import { getAllDependenciesFromManifest } from './getAllDependenciesFromManifest'

export function getAllUniqueSpecs (manifests: DependencyManifest[]) {
const allSpecs: Record<string, string> = {}
const ignored = new Set<string>()
for (const manifest of manifests) {
const specs = getAllDependenciesFromManifest(manifest)
for (const [name, spec] of Object.entries(specs)) {
if (ignored.has(name)) continue
if (allSpecs[name] != null && allSpecs[name] !== spec || spec.includes(':')) {
ignored.add(name)
delete allSpecs[name]
continue
}
allSpecs[name] = spec
}
}
return allSpecs
}