Skip to content

fix(arborist): safely fallback on unresolved $ dependency references #8180

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

Merged
merged 1 commit into from
Mar 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 26 additions & 12 deletions workspaces/arborist/lib/edge.js
Original file line number Diff line number Diff line change
Expand Up @@ -206,29 +206,43 @@ class Edge {
if (this.overrides?.value && this.overrides.value !== '*' && this.overrides.name === this.#name) {
if (this.overrides.value.startsWith('$')) {
const ref = this.overrides.value.slice(1)
const pkg = this.#from?.sourceReference
let pkg = this.#from?.sourceReference
? this.#from?.sourceReference.root.package
: this.#from?.root?.package
if (pkg.devDependencies?.[ref]) {
return pkg.devDependencies[ref]
}
if (pkg.optionalDependencies?.[ref]) {
return pkg.optionalDependencies[ref]
}
if (pkg.dependencies?.[ref]) {
return pkg.dependencies[ref]
}
if (pkg.peerDependencies?.[ref]) {
return pkg.peerDependencies[ref]

let specValue = this.#calculateReferentialOverrideSpec(ref, pkg)

// If the package isn't found in the root package, fall back to the local package.
if (!specValue) {
pkg = this.#from?.package
specValue = this.#calculateReferentialOverrideSpec(ref, pkg)
}

if (specValue) {
return specValue
}
throw new Error(`Unable to resolve reference ${this.overrides.value}`)
}
return this.overrides.value
}
return this.#spec
}

#calculateReferentialOverrideSpec (ref, pkg) {
if (pkg.devDependencies?.[ref]) {
return pkg.devDependencies[ref]
}
if (pkg.optionalDependencies?.[ref]) {
return pkg.optionalDependencies[ref]
}
if (pkg.dependencies?.[ref]) {
return pkg.dependencies[ref]
}
if (pkg.peerDependencies?.[ref]) {
return pkg.peerDependencies[ref]
}
}

get accept () {
return this.#accept
}
Expand Down
49 changes: 49 additions & 0 deletions workspaces/arborist/test/edge.js
Original file line number Diff line number Diff line change
Expand Up @@ -1195,3 +1195,52 @@ t.test('overrideset comparison logic', (t) => {
t.ok(!overrides7.isEqual(overrides1), 'overridesets are different')
t.end()
})

t.test('override fallback to local when root missing dependency with from.overrides set', t => {
const localFrom = {
package: {
devDependencies: {
foo: '^1.2.3',
},
},
root: {
package: {
// no 'foo' defined here
},
},
edgesOut: new Map(),
edgesIn: new Set(),
// dummy overrides object that returns an override with isEqual defined
overrides: {
getEdgeRule (edge) {
return {
value: edge.overrides.value,
name: edge.overrides.name,
isEqual (other) {
return other && this.value === other.value && this.name === other.name
},
}
},
},
addEdgeOut (edge) {
this.edgesOut.set(edge.name, edge)
},
resolve () {
return null
},
}

const edge = new Edge({
from: localFrom,
type: 'prod',
name: 'foo',
spec: '1.x',
overrides: {
value: '$foo',
name: 'foo',
},
})

t.equal(edge.spec, '^1.2.3', 'should fallback to local package version from devDependencies')
t.end()
})