fix(arborist): link deps lifecycle scripts#4875

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.

Sign up for GitHub

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
wraithgar merged 1 commit into from
May 10, 2022
Merged

fix(arborist): link deps lifecycle scripts #4875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
117 changes: 75 additions & 42 deletions workspaces/arborist/lib/arborist/rebuild.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ const sortNodes = (a, b) =>

const _workspaces = Symbol.for('workspaces')
const _build = Symbol('build')
const _loadDefaultNodes = Symbol('loadDefaultNodes')
const _retrieveNodesByType = Symbol('retrieveNodesByType')
const _resetQueues = Symbol('resetQueues')
const _rebuildBundle = Symbol('rebuildBundle')
const _ignoreScripts = Symbol('ignoreScripts')
Expand All@@ -39,6 +41,7 @@ const _includeWorkspaceRoot = Symbol.for('includeWorkspaceRoot')
const _workspacesEnabled = Symbol.for('workspacesEnabled')

const _force = Symbol.for('force')
const _global = Symbol.for('global')

// defined by reify mixin
const _handleOptionalFailure = Symbol.for('handleOptionalFailure')
Expand DownExpand Up@@ -75,51 +78,83 @@ module.exports = cls => class Builder extends cls {
// running JUST a rebuild, we treat optional failures as real fails
this[_doHandleOptionalFailure] = handleOptionalFailure

// if we don't have a set of nodes, then just rebuild
// the actual tree on disk.
if (!nodes) {
const tree = await this.loadActual()
let filterSet
if (!this[_workspacesEnabled]) {
filterSet = this.excludeWorkspacesDependencySet(tree)
nodes = tree.inventory.filter(node =>
filterSet.has(node) || node.isProjectRoot
)
} else if (this[_workspaces] && this[_workspaces].length) {
filterSet = this.workspaceDependencySet(
tree,
this[_workspaces],
this[_includeWorkspaceRoot]
)
nodes = tree.inventory.filter(node => filterSet.has(node))
} else {
nodes = tree.inventory.values()
}
nodes = await this[_loadDefaultNodes]()
}

// separates links nodes so that it can run
// prepare scripts and link bins in the expected order
process.emit('time', 'build')

const {
depNodes,
linkNodes,
} = this[_retrieveNodesByType](nodes)

// build regular deps
await this[_build](depNodes, {})

// build link deps
if (linkNodes.size) {
this[_resetQueues]()
await this[_build](linkNodes, { type: 'links' })
}

process.emit('timeEnd', 'build')
}

// if we don't have a set of nodes, then just rebuild
// the actual tree on disk.
async [_loadDefaultNodes] () {
let nodes
const tree = await this.loadActual()
let filterSet
if (!this[_workspacesEnabled]) {
filterSet = this.excludeWorkspacesDependencySet(tree)
nodes = tree.inventory.filter(node =>
filterSet.has(node) || node.isProjectRoot
)
} else if (this[_workspaces] && this[_workspaces].length) {
filterSet = this.workspaceDependencySet(
tree,
this[_workspaces],
this[_includeWorkspaceRoot]
)
nodes = tree.inventory.filter(node => filterSet.has(node))
} else {
nodes = tree.inventory.values()
}
return nodes
}

[_retrieveNodesByType] (nodes) {
const depNodes = new Set()
const linkNodes = new Set()

for (const node of nodes) {
// we skip the target nodes to that workspace in order to make sure
// we only run lifecycle scripts / place bin links once per workspace
if (node.isLink) {
linkNodes.add(node)
} else {
depNodes.add(node)
}
}

await this[_build](depNodes, {})

if (linkNodes.size) {
this[_resetQueues]()
await this[_build](linkNodes, { type: 'links' })
// deduplicates link nodes and their targets, avoids
// calling lifecycle scripts twice when running `npm rebuild`
// ref: https://github.com/npm/cli/issues/2905
//
// we avoid doing so if global=true since `bin-links` relies
// on having the target nodes available in global mode.
if (!this[_global]) {
for (const node of linkNodes) {
depNodes.delete(node.target)
}
}

process.emit('timeEnd', 'build')
return {
depNodes,
linkNodes,
}
}

[_resetQueues] () {
Expand All@@ -136,24 +171,22 @@ module.exports = cls => class Builder extends cls {
process.emit('time', `build:${type}`)

await this[_buildQueues](nodes)

if (!this[_ignoreScripts]) {
await this[_runScripts]('preinstall')
}

// links should run prepare scripts and only link bins after that
if (type !== 'links') {
if (!this[_ignoreScripts]) {
await this[_runScripts]('preinstall')
}
if (this[_binLinks]) {
await this[_linkAllBins]()
}
if (!this[_ignoreScripts]) {
await this[_runScripts]('install')
await this[_runScripts]('postinstall')
}
} else {
if (type === 'links') {
await this[_runScripts]('prepare')
}
if (this[_binLinks]) {
await this[_linkAllBins]()
}

if (this[_binLinks]) {
await this[_linkAllBins]()
}
if (!this[_ignoreScripts]) {
await this[_runScripts]('install')
await this[_runScripts]('postinstall')
}

process.emit('timeEnd', `build:${type}`)
Expand Down
3 changes: 2 additions & 1 deletion workspaces/arborist/lib/arborist/reify.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1105,7 +1105,8 @@ module.exports = cls => class Reifier extends cls {
// skip links that only live within node_modules as they are most
// likely managed by packages we installed, we only want to rebuild
// unchanged links we directly manage
if (node.isLink && node.target.fsTop === tree) {
const linkedFromRoot = node.parent === tree || node.target.fsTop === tree
if (node.isLink && linkedFromRoot) {
nodes.push(node)
}
}
Expand Down
45 changes: 45 additions & 0 deletions workspaces/arborist/test/arborist/rebuild.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -459,6 +459,51 @@ t.test('do not rebuild node-gyp dependencies with gypfile:false', async t => {
await arb.rebuild()
})

// ref: https://github.com/npm/cli/issues/2905
t.test('do not run lifecycle scripts of linked deps twice', async t => {
const testdir = t.testdir({
project: {
'package.json': JSON.stringify({
name: 'my-project',
version: '1.0.0',
dependencies: {
foo: 'file:../foo',
},
}),
node_modules: {
foo: t.fixture('symlink', '../../foo'),
},
},
foo: {
'package.json': JSON.stringify({
name: 'foo',
version: '1.0.0',
scripts: {
postinstall: 'echo "ok"',
},
}),
},
})

const path = resolve(testdir, 'project')
const RUNS = []
const Arborist = t.mock('../../lib/arborist/index.js', {
'@npmcli/run-script': opts => {
RUNS.push(opts)
return require('@npmcli/run-script')(opts)
},
})
const arb = new Arborist({ path, registry })
await arb.rebuild()
t.equal(RUNS.length, 1, 'should run postinstall script only once')
t.match(RUNS, [
{
event: 'postinstall',
pkg: { name: 'foo' },
},
])
})

t.test('workspaces', async t => {
const path = t.testdir({
'package.json': JSON.stringify({
Expand Down
2 changes: 2 additions & 0 deletions workspaces/arborist/test/arborist/reify.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1770,6 +1770,8 @@ t.test('running lifecycle scripts of unchanged link nodes on reify', async t =>

t.ok(fs.lstatSync(resolve(path, 'a/a-prepare')).isFile(),
'should run prepare lifecycle scripts for links directly linked to the tree')
t.ok(fs.lstatSync(resolve(path, 'a/a-post-install')).isFile(),
'should run postinstall lifecycle scripts for links directly linked to the tree')
})

t.test('save-prod, with optional', async t => {
Expand Down
3 changes: 2 additions & 1 deletion workspaces/arborist/test/fixtures/link-dep-lifecycle-scripts/a/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@
"name": "a",
"version": "1.0.0",
"scripts": {
"prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
"prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
"postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
}
}
3 changes: 2 additions & 1 deletion workspaces/arborist/test/fixtures/reify-cases/link-dep-lifecycle-scripts.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,8 @@ module.exports = t => {
"name": "a",
"version": "1.0.0",
"scripts": {
"prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
"prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
"postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
}
})
},
Expand Down
5 changes: 4 additions & 1 deletion workspaces/arborist/test/fixtures/reify-cases/workspaces-link-bin.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,13 +25,16 @@ module.exports = t => {
})
},
"b": {
"file.js": "",
"create-file.js": "require('fs').writeFileSync('file.js', '')\n",
"package.json": JSON.stringify({
"name": "b",
"version": "1.0.0",
"files": [
"file.js"
],
"scripts": {
"preinstall": "node create-file.js"
},
"bin": "file.js"
})
}
Expand Down
1 change: 1 addition & 0 deletions workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/create-file.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
require('fs').writeFileSync('file.js', '')
Empty file removedworkspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/file.js
View file
Open in desktop
Empty file.
3 changes: 3 additions & 0 deletions workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,8 @@
"name": "b",
"version": "1.0.0",
"files": ["file.js"],
"scripts": {
"preinstall": "node create-file.js"
},
"bin": "file.js"
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(arborist): link deps lifecycle scripts#4875

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.

 Sign up for GitHub

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

wraithgar
merged 1 commit into

from

May 10, 2022
 Merged


fix(arborist): link deps lifecycle scripts
#4875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


117 changes: 75 additions & 42 deletions
workspaces/arborist/lib/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ const sortNodes = (a, b) =>

const _workspaces = Symbol.for('workspaces')
const _build = Symbol('build')
const _loadDefaultNodes = Symbol('loadDefaultNodes')
const _retrieveNodesByType = Symbol('retrieveNodesByType')
const _resetQueues = Symbol('resetQueues')
const _rebuildBundle = Symbol('rebuildBundle')
const _ignoreScripts = Symbol('ignoreScripts')
Expand All@@ -39,6 +41,7 @@ const _includeWorkspaceRoot = Symbol.for('includeWorkspaceRoot')
const _workspacesEnabled = Symbol.for('workspacesEnabled')

const _force = Symbol.for('force')
const _global = Symbol.for('global')

// defined by reify mixin
const _handleOptionalFailure = Symbol.for('handleOptionalFailure')
Expand DownExpand Up@@ -75,51 +78,83 @@ module.exports = cls => class Builder extends cls {
 // running JUST a rebuild, we treat optional failures as real fails
 this[_doHandleOptionalFailure] = handleOptionalFailure

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 if (!nodes) {
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 nodes = await this[_loadDefaultNodes]()
 }

 // separates links nodes so that it can run
 // prepare scripts and link bins in the expected order
 process.emit('time', 'build')

 const {
 depNodes,
 linkNodes,
 } = this[_retrieveNodesByType](nodes)

 // build regular deps
 await this[_build](depNodes, {})

 // build link deps
 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 }

 process.emit('timeEnd', 'build')
 }

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 async [_loadDefaultNodes] () {
 let nodes
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 return nodes
 }

 [_retrieveNodesByType] (nodes) {
 const depNodes = new Set()
 const linkNodes = new Set()

 for (const node of nodes) {
 // we skip the target nodes to that workspace in order to make sure
 // we only run lifecycle scripts / place bin links once per workspace
 if (node.isLink) {
 linkNodes.add(node)
 } else {
 depNodes.add(node)
 }
 }

 await this[_build](depNodes, {})

 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 // deduplicates link nodes and their targets, avoids
 // calling lifecycle scripts twice when running `npm rebuild`
 // ref: https://github.com/npm/cli/issues/2905
 //
 // we avoid doing so if global=true since `bin-links` relies
 // on having the target nodes available in global mode.
 if (!this[_global]) {
 for (const node of linkNodes) {
 depNodes.delete(node.target)
 }
 }

 process.emit('timeEnd', 'build')
 return {
 depNodes,
 linkNodes,
 }
 }

 [_resetQueues] () {
Expand All@@ -136,24 +171,22 @@ module.exports = cls => class Builder extends cls {
 process.emit('time', `build:${type}`)

 await this[_buildQueues](nodes)

 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }

 // links should run prepare scripts and only link bins after that
 if (type !== 'links') {
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
 await this[_runScripts]('postinstall')
 }
 } else {
 if (type === 'links') {
 await this[_runScripts]('prepare')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }

if (this[_binLinks]) {
await this[_linkAllBins]()
}
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
await this[_runScripts]('postinstall')
 }

 process.emit('timeEnd', `build:${type}`)
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/lib/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1105,7 +1105,8 @@ module.exports = cls => class Reifier extends cls {
 // skip links that only live within node_modules as they are most
 // likely managed by packages we installed, we only want to rebuild
 // unchanged links we directly manage
 if (node.isLink && node.target.fsTop === tree) {
 const linkedFromRoot = node.parent === tree || node.target.fsTop === tree
 if (node.isLink && linkedFromRoot) {
 nodes.push(node)
 }
 }
Expand Down

45 changes: 45 additions & 0 deletions
workspaces/arborist/test/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -459,6 +459,51 @@ t.test('do not rebuild node-gyp dependencies with gypfile:false', async t => {
 await arb.rebuild()
})

// ref: https://github.com/npm/cli/issues/2905
t.test('do not run lifecycle scripts of linked deps twice', async t => {
 const testdir = t.testdir({
 project: {
 'package.json': JSON.stringify({
 name: 'my-project',
 version: '1.0.0',
 dependencies: {
 foo: 'file:../foo',
 },
 }),
 node_modules: {
 foo: t.fixture('symlink', '../../foo'),
 },
 },
 foo: {
 'package.json': JSON.stringify({
 name: 'foo',
 version: '1.0.0',
 scripts: {
 postinstall: 'echo "ok"',
 },
 }),
 },
 })

 const path = resolve(testdir, 'project')
 const RUNS = []
 const Arborist = t.mock('../../lib/arborist/index.js', {
 '@npmcli/run-script': opts => {
 RUNS.push(opts)
 return require('@npmcli/run-script')(opts)
 },
 })
 const arb = new Arborist({ path, registry })
 await arb.rebuild()
 t.equal(RUNS.length, 1, 'should run postinstall script only once')
 t.match(RUNS, [
 {
 event: 'postinstall',
 pkg: { name: 'foo' },
 },
 ])
})

t.test('workspaces', async t => {
 const path = t.testdir({
 'package.json': JSON.stringify({
Expand Down

2 changes: 2 additions & 0 deletions
workspaces/arborist/test/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1770,6 +1770,8 @@ t.test('running lifecycle scripts of unchanged link nodes on reify', async t =>

 t.ok(fs.lstatSync(resolve(path, 'a/a-prepare')).isFile(),
 'should run prepare lifecycle scripts for links directly linked to the tree')
 t.ok(fs.lstatSync(resolve(path, 'a/a-post-install')).isFile(),
 'should run postinstall lifecycle scripts for links directly linked to the tree')
})

t.test('save-prod, with optional', async t => {
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/link-dep-lifecycle-scripts/a/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
}

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/link-dep-lifecycle-scripts.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,8 @@ module.exports = t => {
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
 })
 },
Expand Down

5 changes: 4 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/workspaces-link-bin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,13 +25,16 @@ module.exports = t => {
 })
 },
 "b": {
 "file.js": "",
 "create-file.js": "require('fs').writeFileSync('file.js', '')\n",
 "package.json": JSON.stringify({
 "name": "b",
 "version": "1.0.0",
 "files": [
 "file.js"
 ],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
 })
 }
Expand Down

1 change: 1 addition & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/create-file.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
require('fs').writeFileSync('file.js', '')
Empty file removedworkspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/file.js

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,8 @@
 "name": "b",
 "version": "1.0.0",
 "files": ["file.js"],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(arborist): link deps lifecycle scripts#4875

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.

 Sign up for GitHub

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

wraithgar
merged 1 commit into

from

May 10, 2022
 Merged


fix(arborist): link deps lifecycle scripts
#4875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


117 changes: 75 additions & 42 deletions
workspaces/arborist/lib/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ const sortNodes = (a, b) =>

const _workspaces = Symbol.for('workspaces')
const _build = Symbol('build')
const _loadDefaultNodes = Symbol('loadDefaultNodes')
const _retrieveNodesByType = Symbol('retrieveNodesByType')
const _resetQueues = Symbol('resetQueues')
const _rebuildBundle = Symbol('rebuildBundle')
const _ignoreScripts = Symbol('ignoreScripts')
Expand All@@ -39,6 +41,7 @@ const _includeWorkspaceRoot = Symbol.for('includeWorkspaceRoot')
const _workspacesEnabled = Symbol.for('workspacesEnabled')

const _force = Symbol.for('force')
const _global = Symbol.for('global')

// defined by reify mixin
const _handleOptionalFailure = Symbol.for('handleOptionalFailure')
Expand DownExpand Up@@ -75,51 +78,83 @@ module.exports = cls => class Builder extends cls {
 // running JUST a rebuild, we treat optional failures as real fails
 this[_doHandleOptionalFailure] = handleOptionalFailure

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 if (!nodes) {
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 nodes = await this[_loadDefaultNodes]()
 }

 // separates links nodes so that it can run
 // prepare scripts and link bins in the expected order
 process.emit('time', 'build')

 const {
 depNodes,
 linkNodes,
 } = this[_retrieveNodesByType](nodes)

 // build regular deps
 await this[_build](depNodes, {})

 // build link deps
 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 }

 process.emit('timeEnd', 'build')
 }

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 async [_loadDefaultNodes] () {
 let nodes
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 return nodes
 }

 [_retrieveNodesByType] (nodes) {
 const depNodes = new Set()
 const linkNodes = new Set()

 for (const node of nodes) {
 // we skip the target nodes to that workspace in order to make sure
 // we only run lifecycle scripts / place bin links once per workspace
 if (node.isLink) {
 linkNodes.add(node)
 } else {
 depNodes.add(node)
 }
 }

 await this[_build](depNodes, {})

 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 // deduplicates link nodes and their targets, avoids
 // calling lifecycle scripts twice when running `npm rebuild`
 // ref: https://github.com/npm/cli/issues/2905
 //
 // we avoid doing so if global=true since `bin-links` relies
 // on having the target nodes available in global mode.
 if (!this[_global]) {
 for (const node of linkNodes) {
 depNodes.delete(node.target)
 }
 }

 process.emit('timeEnd', 'build')
 return {
 depNodes,
 linkNodes,
 }
 }

 [_resetQueues] () {
Expand All@@ -136,24 +171,22 @@ module.exports = cls => class Builder extends cls {
 process.emit('time', `build:${type}`)

 await this[_buildQueues](nodes)

 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }

 // links should run prepare scripts and only link bins after that
 if (type !== 'links') {
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
 await this[_runScripts]('postinstall')
 }
 } else {
 if (type === 'links') {
 await this[_runScripts]('prepare')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }

if (this[_binLinks]) {
await this[_linkAllBins]()
}
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
await this[_runScripts]('postinstall')
 }

 process.emit('timeEnd', `build:${type}`)
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/lib/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1105,7 +1105,8 @@ module.exports = cls => class Reifier extends cls {
 // skip links that only live within node_modules as they are most
 // likely managed by packages we installed, we only want to rebuild
 // unchanged links we directly manage
 if (node.isLink && node.target.fsTop === tree) {
 const linkedFromRoot = node.parent === tree || node.target.fsTop === tree
 if (node.isLink && linkedFromRoot) {
 nodes.push(node)
 }
 }
Expand Down

45 changes: 45 additions & 0 deletions
workspaces/arborist/test/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -459,6 +459,51 @@ t.test('do not rebuild node-gyp dependencies with gypfile:false', async t => {
 await arb.rebuild()
})

// ref: https://github.com/npm/cli/issues/2905
t.test('do not run lifecycle scripts of linked deps twice', async t => {
 const testdir = t.testdir({
 project: {
 'package.json': JSON.stringify({
 name: 'my-project',
 version: '1.0.0',
 dependencies: {
 foo: 'file:../foo',
 },
 }),
 node_modules: {
 foo: t.fixture('symlink', '../../foo'),
 },
 },
 foo: {
 'package.json': JSON.stringify({
 name: 'foo',
 version: '1.0.0',
 scripts: {
 postinstall: 'echo "ok"',
 },
 }),
 },
 })

 const path = resolve(testdir, 'project')
 const RUNS = []
 const Arborist = t.mock('../../lib/arborist/index.js', {
 '@npmcli/run-script': opts => {
 RUNS.push(opts)
 return require('@npmcli/run-script')(opts)
 },
 })
 const arb = new Arborist({ path, registry })
 await arb.rebuild()
 t.equal(RUNS.length, 1, 'should run postinstall script only once')
 t.match(RUNS, [
 {
 event: 'postinstall',
 pkg: { name: 'foo' },
 },
 ])
})

t.test('workspaces', async t => {
 const path = t.testdir({
 'package.json': JSON.stringify({
Expand Down

2 changes: 2 additions & 0 deletions
workspaces/arborist/test/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1770,6 +1770,8 @@ t.test('running lifecycle scripts of unchanged link nodes on reify', async t =>

 t.ok(fs.lstatSync(resolve(path, 'a/a-prepare')).isFile(),
 'should run prepare lifecycle scripts for links directly linked to the tree')
 t.ok(fs.lstatSync(resolve(path, 'a/a-post-install')).isFile(),
 'should run postinstall lifecycle scripts for links directly linked to the tree')
})

t.test('save-prod, with optional', async t => {
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/link-dep-lifecycle-scripts/a/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
}

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/link-dep-lifecycle-scripts.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,8 @@ module.exports = t => {
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
 })
 },
Expand Down

5 changes: 4 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/workspaces-link-bin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,13 +25,16 @@ module.exports = t => {
 })
 },
 "b": {
 "file.js": "",
 "create-file.js": "require('fs').writeFileSync('file.js', '')\n",
 "package.json": JSON.stringify({
 "name": "b",
 "version": "1.0.0",
 "files": [
 "file.js"
 ],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
 })
 }
Expand Down

1 change: 1 addition & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/create-file.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
require('fs').writeFileSync('file.js', '')
Empty file removedworkspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/file.js

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,8 @@
 "name": "b",
 "version": "1.0.0",
 "files": ["file.js"],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(arborist): link deps lifecycle scripts#4875

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.

 Sign up for GitHub

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

wraithgar
merged 1 commit into

from

May 10, 2022
 Merged


fix(arborist): link deps lifecycle scripts
#4875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


117 changes: 75 additions & 42 deletions
workspaces/arborist/lib/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ const sortNodes = (a, b) =>

const _workspaces = Symbol.for('workspaces')
const _build = Symbol('build')
const _loadDefaultNodes = Symbol('loadDefaultNodes')
const _retrieveNodesByType = Symbol('retrieveNodesByType')
const _resetQueues = Symbol('resetQueues')
const _rebuildBundle = Symbol('rebuildBundle')
const _ignoreScripts = Symbol('ignoreScripts')
Expand All@@ -39,6 +41,7 @@ const _includeWorkspaceRoot = Symbol.for('includeWorkspaceRoot')
const _workspacesEnabled = Symbol.for('workspacesEnabled')

const _force = Symbol.for('force')
const _global = Symbol.for('global')

// defined by reify mixin
const _handleOptionalFailure = Symbol.for('handleOptionalFailure')
Expand DownExpand Up@@ -75,51 +78,83 @@ module.exports = cls => class Builder extends cls {
 // running JUST a rebuild, we treat optional failures as real fails
 this[_doHandleOptionalFailure] = handleOptionalFailure

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 if (!nodes) {
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 nodes = await this[_loadDefaultNodes]()
 }

 // separates links nodes so that it can run
 // prepare scripts and link bins in the expected order
 process.emit('time', 'build')

 const {
 depNodes,
 linkNodes,
 } = this[_retrieveNodesByType](nodes)

 // build regular deps
 await this[_build](depNodes, {})

 // build link deps
 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 }

 process.emit('timeEnd', 'build')
 }

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 async [_loadDefaultNodes] () {
 let nodes
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 return nodes
 }

 [_retrieveNodesByType] (nodes) {
 const depNodes = new Set()
 const linkNodes = new Set()

 for (const node of nodes) {
 // we skip the target nodes to that workspace in order to make sure
 // we only run lifecycle scripts / place bin links once per workspace
 if (node.isLink) {
 linkNodes.add(node)
 } else {
 depNodes.add(node)
 }
 }

 await this[_build](depNodes, {})

 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 // deduplicates link nodes and their targets, avoids
 // calling lifecycle scripts twice when running `npm rebuild`
 // ref: https://github.com/npm/cli/issues/2905
 //
 // we avoid doing so if global=true since `bin-links` relies
 // on having the target nodes available in global mode.
 if (!this[_global]) {
 for (const node of linkNodes) {
 depNodes.delete(node.target)
 }
 }

 process.emit('timeEnd', 'build')
 return {
 depNodes,
 linkNodes,
 }
 }

 [_resetQueues] () {
Expand All@@ -136,24 +171,22 @@ module.exports = cls => class Builder extends cls {
 process.emit('time', `build:${type}`)

 await this[_buildQueues](nodes)

 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }

 // links should run prepare scripts and only link bins after that
 if (type !== 'links') {
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
 await this[_runScripts]('postinstall')
 }
 } else {
 if (type === 'links') {
 await this[_runScripts]('prepare')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }

if (this[_binLinks]) {
await this[_linkAllBins]()
}
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
await this[_runScripts]('postinstall')
 }

 process.emit('timeEnd', `build:${type}`)
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/lib/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1105,7 +1105,8 @@ module.exports = cls => class Reifier extends cls {
 // skip links that only live within node_modules as they are most
 // likely managed by packages we installed, we only want to rebuild
 // unchanged links we directly manage
 if (node.isLink && node.target.fsTop === tree) {
 const linkedFromRoot = node.parent === tree || node.target.fsTop === tree
 if (node.isLink && linkedFromRoot) {
 nodes.push(node)
 }
 }
Expand Down

45 changes: 45 additions & 0 deletions
workspaces/arborist/test/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -459,6 +459,51 @@ t.test('do not rebuild node-gyp dependencies with gypfile:false', async t => {
 await arb.rebuild()
})

// ref: https://github.com/npm/cli/issues/2905
t.test('do not run lifecycle scripts of linked deps twice', async t => {
 const testdir = t.testdir({
 project: {
 'package.json': JSON.stringify({
 name: 'my-project',
 version: '1.0.0',
 dependencies: {
 foo: 'file:../foo',
 },
 }),
 node_modules: {
 foo: t.fixture('symlink', '../../foo'),
 },
 },
 foo: {
 'package.json': JSON.stringify({
 name: 'foo',
 version: '1.0.0',
 scripts: {
 postinstall: 'echo "ok"',
 },
 }),
 },
 })

 const path = resolve(testdir, 'project')
 const RUNS = []
 const Arborist = t.mock('../../lib/arborist/index.js', {
 '@npmcli/run-script': opts => {
 RUNS.push(opts)
 return require('@npmcli/run-script')(opts)
 },
 })
 const arb = new Arborist({ path, registry })
 await arb.rebuild()
 t.equal(RUNS.length, 1, 'should run postinstall script only once')
 t.match(RUNS, [
 {
 event: 'postinstall',
 pkg: { name: 'foo' },
 },
 ])
})

t.test('workspaces', async t => {
 const path = t.testdir({
 'package.json': JSON.stringify({
Expand Down

2 changes: 2 additions & 0 deletions
workspaces/arborist/test/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1770,6 +1770,8 @@ t.test('running lifecycle scripts of unchanged link nodes on reify', async t =>

 t.ok(fs.lstatSync(resolve(path, 'a/a-prepare')).isFile(),
 'should run prepare lifecycle scripts for links directly linked to the tree')
 t.ok(fs.lstatSync(resolve(path, 'a/a-post-install')).isFile(),
 'should run postinstall lifecycle scripts for links directly linked to the tree')
})

t.test('save-prod, with optional', async t => {
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/link-dep-lifecycle-scripts/a/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
}

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/link-dep-lifecycle-scripts.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,8 @@ module.exports = t => {
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
 })
 },
Expand Down

5 changes: 4 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/workspaces-link-bin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,13 +25,16 @@ module.exports = t => {
 })
 },
 "b": {
 "file.js": "",
 "create-file.js": "require('fs').writeFileSync('file.js', '')\n",
 "package.json": JSON.stringify({
 "name": "b",
 "version": "1.0.0",
 "files": [
 "file.js"
 ],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
 })
 }
Expand Down

1 change: 1 addition & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/create-file.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
require('fs').writeFileSync('file.js', '')
Empty file removedworkspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/file.js

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,8 @@
 "name": "b",
 "version": "1.0.0",
 "files": ["file.js"],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(arborist): link deps lifecycle scripts#4875

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.

 Sign up for GitHub

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

wraithgar
merged 1 commit into

from

May 10, 2022
 Merged


fix(arborist): link deps lifecycle scripts
#4875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


117 changes: 75 additions & 42 deletions
workspaces/arborist/lib/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ const sortNodes = (a, b) =>

const _workspaces = Symbol.for('workspaces')
const _build = Symbol('build')
const _loadDefaultNodes = Symbol('loadDefaultNodes')
const _retrieveNodesByType = Symbol('retrieveNodesByType')
const _resetQueues = Symbol('resetQueues')
const _rebuildBundle = Symbol('rebuildBundle')
const _ignoreScripts = Symbol('ignoreScripts')
Expand All@@ -39,6 +41,7 @@ const _includeWorkspaceRoot = Symbol.for('includeWorkspaceRoot')
const _workspacesEnabled = Symbol.for('workspacesEnabled')

const _force = Symbol.for('force')
const _global = Symbol.for('global')

// defined by reify mixin
const _handleOptionalFailure = Symbol.for('handleOptionalFailure')
Expand DownExpand Up@@ -75,51 +78,83 @@ module.exports = cls => class Builder extends cls {
 // running JUST a rebuild, we treat optional failures as real fails
 this[_doHandleOptionalFailure] = handleOptionalFailure

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 if (!nodes) {
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 nodes = await this[_loadDefaultNodes]()
 }

 // separates links nodes so that it can run
 // prepare scripts and link bins in the expected order
 process.emit('time', 'build')

 const {
 depNodes,
 linkNodes,
 } = this[_retrieveNodesByType](nodes)

 // build regular deps
 await this[_build](depNodes, {})

 // build link deps
 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 }

 process.emit('timeEnd', 'build')
 }

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 async [_loadDefaultNodes] () {
 let nodes
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 return nodes
 }

 [_retrieveNodesByType] (nodes) {
 const depNodes = new Set()
 const linkNodes = new Set()

 for (const node of nodes) {
 // we skip the target nodes to that workspace in order to make sure
 // we only run lifecycle scripts / place bin links once per workspace
 if (node.isLink) {
 linkNodes.add(node)
 } else {
 depNodes.add(node)
 }
 }

 await this[_build](depNodes, {})

 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 // deduplicates link nodes and their targets, avoids
 // calling lifecycle scripts twice when running `npm rebuild`
 // ref: https://github.com/npm/cli/issues/2905
 //
 // we avoid doing so if global=true since `bin-links` relies
 // on having the target nodes available in global mode.
 if (!this[_global]) {
 for (const node of linkNodes) {
 depNodes.delete(node.target)
 }
 }

 process.emit('timeEnd', 'build')
 return {
 depNodes,
 linkNodes,
 }
 }

 [_resetQueues] () {
Expand All@@ -136,24 +171,22 @@ module.exports = cls => class Builder extends cls {
 process.emit('time', `build:${type}`)

 await this[_buildQueues](nodes)

 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }

 // links should run prepare scripts and only link bins after that
 if (type !== 'links') {
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
 await this[_runScripts]('postinstall')
 }
 } else {
 if (type === 'links') {
 await this[_runScripts]('prepare')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }

if (this[_binLinks]) {
await this[_linkAllBins]()
}
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
await this[_runScripts]('postinstall')
 }

 process.emit('timeEnd', `build:${type}`)
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/lib/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1105,7 +1105,8 @@ module.exports = cls => class Reifier extends cls {
 // skip links that only live within node_modules as they are most
 // likely managed by packages we installed, we only want to rebuild
 // unchanged links we directly manage
 if (node.isLink && node.target.fsTop === tree) {
 const linkedFromRoot = node.parent === tree || node.target.fsTop === tree
 if (node.isLink && linkedFromRoot) {
 nodes.push(node)
 }
 }
Expand Down

45 changes: 45 additions & 0 deletions
workspaces/arborist/test/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -459,6 +459,51 @@ t.test('do not rebuild node-gyp dependencies with gypfile:false', async t => {
 await arb.rebuild()
})

// ref: https://github.com/npm/cli/issues/2905
t.test('do not run lifecycle scripts of linked deps twice', async t => {
 const testdir = t.testdir({
 project: {
 'package.json': JSON.stringify({
 name: 'my-project',
 version: '1.0.0',
 dependencies: {
 foo: 'file:../foo',
 },
 }),
 node_modules: {
 foo: t.fixture('symlink', '../../foo'),
 },
 },
 foo: {
 'package.json': JSON.stringify({
 name: 'foo',
 version: '1.0.0',
 scripts: {
 postinstall: 'echo "ok"',
 },
 }),
 },
 })

 const path = resolve(testdir, 'project')
 const RUNS = []
 const Arborist = t.mock('../../lib/arborist/index.js', {
 '@npmcli/run-script': opts => {
 RUNS.push(opts)
 return require('@npmcli/run-script')(opts)
 },
 })
 const arb = new Arborist({ path, registry })
 await arb.rebuild()
 t.equal(RUNS.length, 1, 'should run postinstall script only once')
 t.match(RUNS, [
 {
 event: 'postinstall',
 pkg: { name: 'foo' },
 },
 ])
})

t.test('workspaces', async t => {
 const path = t.testdir({
 'package.json': JSON.stringify({
Expand Down

2 changes: 2 additions & 0 deletions
workspaces/arborist/test/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1770,6 +1770,8 @@ t.test('running lifecycle scripts of unchanged link nodes on reify', async t =>

 t.ok(fs.lstatSync(resolve(path, 'a/a-prepare')).isFile(),
 'should run prepare lifecycle scripts for links directly linked to the tree')
 t.ok(fs.lstatSync(resolve(path, 'a/a-post-install')).isFile(),
 'should run postinstall lifecycle scripts for links directly linked to the tree')
})

t.test('save-prod, with optional', async t => {
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/link-dep-lifecycle-scripts/a/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
}

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/link-dep-lifecycle-scripts.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,8 @@ module.exports = t => {
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
 })
 },
Expand Down

5 changes: 4 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/workspaces-link-bin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,13 +25,16 @@ module.exports = t => {
 })
 },
 "b": {
 "file.js": "",
 "create-file.js": "require('fs').writeFileSync('file.js', '')\n",
 "package.json": JSON.stringify({
 "name": "b",
 "version": "1.0.0",
 "files": [
 "file.js"
 ],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
 })
 }
Expand Down

1 change: 1 addition & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/create-file.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
require('fs').writeFileSync('file.js', '')
Empty file removedworkspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/file.js

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,8 @@
 "name": "b",
 "version": "1.0.0",
 "files": ["file.js"],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(arborist): link deps lifecycle scripts#4875

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.

 Sign up for GitHub

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

wraithgar
merged 1 commit into

from

May 10, 2022
 Merged


fix(arborist): link deps lifecycle scripts
#4875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


117 changes: 75 additions & 42 deletions
workspaces/arborist/lib/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ const sortNodes = (a, b) =>

const _workspaces = Symbol.for('workspaces')
const _build = Symbol('build')
const _loadDefaultNodes = Symbol('loadDefaultNodes')
const _retrieveNodesByType = Symbol('retrieveNodesByType')
const _resetQueues = Symbol('resetQueues')
const _rebuildBundle = Symbol('rebuildBundle')
const _ignoreScripts = Symbol('ignoreScripts')
Expand All@@ -39,6 +41,7 @@ const _includeWorkspaceRoot = Symbol.for('includeWorkspaceRoot')
const _workspacesEnabled = Symbol.for('workspacesEnabled')

const _force = Symbol.for('force')
const _global = Symbol.for('global')

// defined by reify mixin
const _handleOptionalFailure = Symbol.for('handleOptionalFailure')
Expand DownExpand Up@@ -75,51 +78,83 @@ module.exports = cls => class Builder extends cls {
 // running JUST a rebuild, we treat optional failures as real fails
 this[_doHandleOptionalFailure] = handleOptionalFailure

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 if (!nodes) {
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 nodes = await this[_loadDefaultNodes]()
 }

 // separates links nodes so that it can run
 // prepare scripts and link bins in the expected order
 process.emit('time', 'build')

 const {
 depNodes,
 linkNodes,
 } = this[_retrieveNodesByType](nodes)

 // build regular deps
 await this[_build](depNodes, {})

 // build link deps
 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 }

 process.emit('timeEnd', 'build')
 }

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 async [_loadDefaultNodes] () {
 let nodes
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 return nodes
 }

 [_retrieveNodesByType] (nodes) {
 const depNodes = new Set()
 const linkNodes = new Set()

 for (const node of nodes) {
 // we skip the target nodes to that workspace in order to make sure
 // we only run lifecycle scripts / place bin links once per workspace
 if (node.isLink) {
 linkNodes.add(node)
 } else {
 depNodes.add(node)
 }
 }

 await this[_build](depNodes, {})

 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 // deduplicates link nodes and their targets, avoids
 // calling lifecycle scripts twice when running `npm rebuild`
 // ref: https://github.com/npm/cli/issues/2905
 //
 // we avoid doing so if global=true since `bin-links` relies
 // on having the target nodes available in global mode.
 if (!this[_global]) {
 for (const node of linkNodes) {
 depNodes.delete(node.target)
 }
 }

 process.emit('timeEnd', 'build')
 return {
 depNodes,
 linkNodes,
 }
 }

 [_resetQueues] () {
Expand All@@ -136,24 +171,22 @@ module.exports = cls => class Builder extends cls {
 process.emit('time', `build:${type}`)

 await this[_buildQueues](nodes)

 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }

 // links should run prepare scripts and only link bins after that
 if (type !== 'links') {
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
 await this[_runScripts]('postinstall')
 }
 } else {
 if (type === 'links') {
 await this[_runScripts]('prepare')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }

if (this[_binLinks]) {
await this[_linkAllBins]()
}
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
await this[_runScripts]('postinstall')
 }

 process.emit('timeEnd', `build:${type}`)
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/lib/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1105,7 +1105,8 @@ module.exports = cls => class Reifier extends cls {
 // skip links that only live within node_modules as they are most
 // likely managed by packages we installed, we only want to rebuild
 // unchanged links we directly manage
 if (node.isLink && node.target.fsTop === tree) {
 const linkedFromRoot = node.parent === tree || node.target.fsTop === tree
 if (node.isLink && linkedFromRoot) {
 nodes.push(node)
 }
 }
Expand Down

45 changes: 45 additions & 0 deletions
workspaces/arborist/test/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -459,6 +459,51 @@ t.test('do not rebuild node-gyp dependencies with gypfile:false', async t => {
 await arb.rebuild()
})

// ref: https://github.com/npm/cli/issues/2905
t.test('do not run lifecycle scripts of linked deps twice', async t => {
 const testdir = t.testdir({
 project: {
 'package.json': JSON.stringify({
 name: 'my-project',
 version: '1.0.0',
 dependencies: {
 foo: 'file:../foo',
 },
 }),
 node_modules: {
 foo: t.fixture('symlink', '../../foo'),
 },
 },
 foo: {
 'package.json': JSON.stringify({
 name: 'foo',
 version: '1.0.0',
 scripts: {
 postinstall: 'echo "ok"',
 },
 }),
 },
 })

 const path = resolve(testdir, 'project')
 const RUNS = []
 const Arborist = t.mock('../../lib/arborist/index.js', {
 '@npmcli/run-script': opts => {
 RUNS.push(opts)
 return require('@npmcli/run-script')(opts)
 },
 })
 const arb = new Arborist({ path, registry })
 await arb.rebuild()
 t.equal(RUNS.length, 1, 'should run postinstall script only once')
 t.match(RUNS, [
 {
 event: 'postinstall',
 pkg: { name: 'foo' },
 },
 ])
})

t.test('workspaces', async t => {
 const path = t.testdir({
 'package.json': JSON.stringify({
Expand Down

2 changes: 2 additions & 0 deletions
workspaces/arborist/test/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1770,6 +1770,8 @@ t.test('running lifecycle scripts of unchanged link nodes on reify', async t =>

 t.ok(fs.lstatSync(resolve(path, 'a/a-prepare')).isFile(),
 'should run prepare lifecycle scripts for links directly linked to the tree')
 t.ok(fs.lstatSync(resolve(path, 'a/a-post-install')).isFile(),
 'should run postinstall lifecycle scripts for links directly linked to the tree')
})

t.test('save-prod, with optional', async t => {
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/link-dep-lifecycle-scripts/a/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
}

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/link-dep-lifecycle-scripts.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,8 @@ module.exports = t => {
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
 })
 },
Expand Down

5 changes: 4 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/workspaces-link-bin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,13 +25,16 @@ module.exports = t => {
 })
 },
 "b": {
 "file.js": "",
 "create-file.js": "require('fs').writeFileSync('file.js', '')\n",
 "package.json": JSON.stringify({
 "name": "b",
 "version": "1.0.0",
 "files": [
 "file.js"
 ],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
 })
 }
Expand Down

1 change: 1 addition & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/create-file.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
require('fs').writeFileSync('file.js', '')
Empty file removedworkspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/file.js

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,8 @@
 "name": "b",
 "version": "1.0.0",
 "files": ["file.js"],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(arborist): link deps lifecycle scripts#4875

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.

 Sign up for GitHub

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

wraithgar
merged 1 commit into

from

May 10, 2022
 Merged


fix(arborist): link deps lifecycle scripts
#4875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


117 changes: 75 additions & 42 deletions
workspaces/arborist/lib/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ const sortNodes = (a, b) =>

const _workspaces = Symbol.for('workspaces')
const _build = Symbol('build')
const _loadDefaultNodes = Symbol('loadDefaultNodes')
const _retrieveNodesByType = Symbol('retrieveNodesByType')
const _resetQueues = Symbol('resetQueues')
const _rebuildBundle = Symbol('rebuildBundle')
const _ignoreScripts = Symbol('ignoreScripts')
Expand All@@ -39,6 +41,7 @@ const _includeWorkspaceRoot = Symbol.for('includeWorkspaceRoot')
const _workspacesEnabled = Symbol.for('workspacesEnabled')

const _force = Symbol.for('force')
const _global = Symbol.for('global')

// defined by reify mixin
const _handleOptionalFailure = Symbol.for('handleOptionalFailure')
Expand DownExpand Up@@ -75,51 +78,83 @@ module.exports = cls => class Builder extends cls {
 // running JUST a rebuild, we treat optional failures as real fails
 this[_doHandleOptionalFailure] = handleOptionalFailure

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 if (!nodes) {
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 nodes = await this[_loadDefaultNodes]()
 }

 // separates links nodes so that it can run
 // prepare scripts and link bins in the expected order
 process.emit('time', 'build')

 const {
 depNodes,
 linkNodes,
 } = this[_retrieveNodesByType](nodes)

 // build regular deps
 await this[_build](depNodes, {})

 // build link deps
 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 }

 process.emit('timeEnd', 'build')
 }

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 async [_loadDefaultNodes] () {
 let nodes
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 return nodes
 }

 [_retrieveNodesByType] (nodes) {
 const depNodes = new Set()
 const linkNodes = new Set()

 for (const node of nodes) {
 // we skip the target nodes to that workspace in order to make sure
 // we only run lifecycle scripts / place bin links once per workspace
 if (node.isLink) {
 linkNodes.add(node)
 } else {
 depNodes.add(node)
 }
 }

 await this[_build](depNodes, {})

 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 // deduplicates link nodes and their targets, avoids
 // calling lifecycle scripts twice when running `npm rebuild`
 // ref: https://github.com/npm/cli/issues/2905
 //
 // we avoid doing so if global=true since `bin-links` relies
 // on having the target nodes available in global mode.
 if (!this[_global]) {
 for (const node of linkNodes) {
 depNodes.delete(node.target)
 }
 }

 process.emit('timeEnd', 'build')
 return {
 depNodes,
 linkNodes,
 }
 }

 [_resetQueues] () {
Expand All@@ -136,24 +171,22 @@ module.exports = cls => class Builder extends cls {
 process.emit('time', `build:${type}`)

 await this[_buildQueues](nodes)

 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }

 // links should run prepare scripts and only link bins after that
 if (type !== 'links') {
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
 await this[_runScripts]('postinstall')
 }
 } else {
 if (type === 'links') {
 await this[_runScripts]('prepare')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }

if (this[_binLinks]) {
await this[_linkAllBins]()
}
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
await this[_runScripts]('postinstall')
 }

 process.emit('timeEnd', `build:${type}`)
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/lib/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1105,7 +1105,8 @@ module.exports = cls => class Reifier extends cls {
 // skip links that only live within node_modules as they are most
 // likely managed by packages we installed, we only want to rebuild
 // unchanged links we directly manage
 if (node.isLink && node.target.fsTop === tree) {
 const linkedFromRoot = node.parent === tree || node.target.fsTop === tree
 if (node.isLink && linkedFromRoot) {
 nodes.push(node)
 }
 }
Expand Down

45 changes: 45 additions & 0 deletions
workspaces/arborist/test/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -459,6 +459,51 @@ t.test('do not rebuild node-gyp dependencies with gypfile:false', async t => {
 await arb.rebuild()
})

// ref: https://github.com/npm/cli/issues/2905
t.test('do not run lifecycle scripts of linked deps twice', async t => {
 const testdir = t.testdir({
 project: {
 'package.json': JSON.stringify({
 name: 'my-project',
 version: '1.0.0',
 dependencies: {
 foo: 'file:../foo',
 },
 }),
 node_modules: {
 foo: t.fixture('symlink', '../../foo'),
 },
 },
 foo: {
 'package.json': JSON.stringify({
 name: 'foo',
 version: '1.0.0',
 scripts: {
 postinstall: 'echo "ok"',
 },
 }),
 },
 })

 const path = resolve(testdir, 'project')
 const RUNS = []
 const Arborist = t.mock('../../lib/arborist/index.js', {
 '@npmcli/run-script': opts => {
 RUNS.push(opts)
 return require('@npmcli/run-script')(opts)
 },
 })
 const arb = new Arborist({ path, registry })
 await arb.rebuild()
 t.equal(RUNS.length, 1, 'should run postinstall script only once')
 t.match(RUNS, [
 {
 event: 'postinstall',
 pkg: { name: 'foo' },
 },
 ])
})

t.test('workspaces', async t => {
 const path = t.testdir({
 'package.json': JSON.stringify({
Expand Down

2 changes: 2 additions & 0 deletions
workspaces/arborist/test/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1770,6 +1770,8 @@ t.test('running lifecycle scripts of unchanged link nodes on reify', async t =>

 t.ok(fs.lstatSync(resolve(path, 'a/a-prepare')).isFile(),
 'should run prepare lifecycle scripts for links directly linked to the tree')
 t.ok(fs.lstatSync(resolve(path, 'a/a-post-install')).isFile(),
 'should run postinstall lifecycle scripts for links directly linked to the tree')
})

t.test('save-prod, with optional', async t => {
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/link-dep-lifecycle-scripts/a/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
}

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/link-dep-lifecycle-scripts.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,8 @@ module.exports = t => {
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
 })
 },
Expand Down

5 changes: 4 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/workspaces-link-bin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,13 +25,16 @@ module.exports = t => {
 })
 },
 "b": {
 "file.js": "",
 "create-file.js": "require('fs').writeFileSync('file.js', '')\n",
 "package.json": JSON.stringify({
 "name": "b",
 "version": "1.0.0",
 "files": [
 "file.js"
 ],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
 })
 }
Expand Down

1 change: 1 addition & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/create-file.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
require('fs').writeFileSync('file.js', '')
Empty file removedworkspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/file.js

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,8 @@
 "name": "b",
 "version": "1.0.0",
 "files": ["file.js"],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(arborist): link deps lifecycle scripts#4875

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.

 Sign up for GitHub

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

wraithgar
merged 1 commit into

from

May 10, 2022
 Merged


fix(arborist): link deps lifecycle scripts
#4875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


117 changes: 75 additions & 42 deletions
workspaces/arborist/lib/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ const sortNodes = (a, b) =>

const _workspaces = Symbol.for('workspaces')
const _build = Symbol('build')
const _loadDefaultNodes = Symbol('loadDefaultNodes')
const _retrieveNodesByType = Symbol('retrieveNodesByType')
const _resetQueues = Symbol('resetQueues')
const _rebuildBundle = Symbol('rebuildBundle')
const _ignoreScripts = Symbol('ignoreScripts')
Expand All@@ -39,6 +41,7 @@ const _includeWorkspaceRoot = Symbol.for('includeWorkspaceRoot')
const _workspacesEnabled = Symbol.for('workspacesEnabled')

const _force = Symbol.for('force')
const _global = Symbol.for('global')

// defined by reify mixin
const _handleOptionalFailure = Symbol.for('handleOptionalFailure')
Expand DownExpand Up@@ -75,51 +78,83 @@ module.exports = cls => class Builder extends cls {
 // running JUST a rebuild, we treat optional failures as real fails
 this[_doHandleOptionalFailure] = handleOptionalFailure

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 if (!nodes) {
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 nodes = await this[_loadDefaultNodes]()
 }

 // separates links nodes so that it can run
 // prepare scripts and link bins in the expected order
 process.emit('time', 'build')

 const {
 depNodes,
 linkNodes,
 } = this[_retrieveNodesByType](nodes)

 // build regular deps
 await this[_build](depNodes, {})

 // build link deps
 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 }

 process.emit('timeEnd', 'build')
 }

 // if we don't have a set of nodes, then just rebuild
 // the actual tree on disk.
 async [_loadDefaultNodes] () {
 let nodes
 const tree = await this.loadActual()
 let filterSet
 if (!this[_workspacesEnabled]) {
 filterSet = this.excludeWorkspacesDependencySet(tree)
 nodes = tree.inventory.filter(node =>
 filterSet.has(node) || node.isProjectRoot
 )
 } else if (this[_workspaces] && this[_workspaces].length) {
 filterSet = this.workspaceDependencySet(
 tree,
 this[_workspaces],
 this[_includeWorkspaceRoot]
 )
 nodes = tree.inventory.filter(node => filterSet.has(node))
 } else {
 nodes = tree.inventory.values()
 }
 return nodes
 }

 [_retrieveNodesByType] (nodes) {
 const depNodes = new Set()
 const linkNodes = new Set()

 for (const node of nodes) {
 // we skip the target nodes to that workspace in order to make sure
 // we only run lifecycle scripts / place bin links once per workspace
 if (node.isLink) {
 linkNodes.add(node)
 } else {
 depNodes.add(node)
 }
 }

 await this[_build](depNodes, {})

 if (linkNodes.size) {
 this[_resetQueues]()
 await this[_build](linkNodes, { type: 'links' })
 // deduplicates link nodes and their targets, avoids
 // calling lifecycle scripts twice when running `npm rebuild`
 // ref: https://github.com/npm/cli/issues/2905
 //
 // we avoid doing so if global=true since `bin-links` relies
 // on having the target nodes available in global mode.
 if (!this[_global]) {
 for (const node of linkNodes) {
 depNodes.delete(node.target)
 }
 }

 process.emit('timeEnd', 'build')
 return {
 depNodes,
 linkNodes,
 }
 }

 [_resetQueues] () {
Expand All@@ -136,24 +171,22 @@ module.exports = cls => class Builder extends cls {
 process.emit('time', `build:${type}`)

 await this[_buildQueues](nodes)

 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }

 // links should run prepare scripts and only link bins after that
 if (type !== 'links') {
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('preinstall')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
 await this[_runScripts]('postinstall')
 }
 } else {
 if (type === 'links') {
 await this[_runScripts]('prepare')
 }
 if (this[_binLinks]) {
 await this[_linkAllBins]()
 }

if (this[_binLinks]) {
await this[_linkAllBins]()
}
 if (!this[_ignoreScripts]) {
 await this[_runScripts]('install')
await this[_runScripts]('postinstall')
 }

 process.emit('timeEnd', `build:${type}`)
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/lib/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1105,7 +1105,8 @@ module.exports = cls => class Reifier extends cls {
 // skip links that only live within node_modules as they are most
 // likely managed by packages we installed, we only want to rebuild
 // unchanged links we directly manage
 if (node.isLink && node.target.fsTop === tree) {
 const linkedFromRoot = node.parent === tree || node.target.fsTop === tree
 if (node.isLink && linkedFromRoot) {
 nodes.push(node)
 }
 }
Expand Down

45 changes: 45 additions & 0 deletions
workspaces/arborist/test/arborist/rebuild.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -459,6 +459,51 @@ t.test('do not rebuild node-gyp dependencies with gypfile:false', async t => {
 await arb.rebuild()
})

// ref: https://github.com/npm/cli/issues/2905
t.test('do not run lifecycle scripts of linked deps twice', async t => {
 const testdir = t.testdir({
 project: {
 'package.json': JSON.stringify({
 name: 'my-project',
 version: '1.0.0',
 dependencies: {
 foo: 'file:../foo',
 },
 }),
 node_modules: {
 foo: t.fixture('symlink', '../../foo'),
 },
 },
 foo: {
 'package.json': JSON.stringify({
 name: 'foo',
 version: '1.0.0',
 scripts: {
 postinstall: 'echo "ok"',
 },
 }),
 },
 })

 const path = resolve(testdir, 'project')
 const RUNS = []
 const Arborist = t.mock('../../lib/arborist/index.js', {
 '@npmcli/run-script': opts => {
 RUNS.push(opts)
 return require('@npmcli/run-script')(opts)
 },
 })
 const arb = new Arborist({ path, registry })
 await arb.rebuild()
 t.equal(RUNS.length, 1, 'should run postinstall script only once')
 t.match(RUNS, [
 {
 event: 'postinstall',
 pkg: { name: 'foo' },
 },
 ])
})

t.test('workspaces', async t => {
 const path = t.testdir({
 'package.json': JSON.stringify({
Expand Down

2 changes: 2 additions & 0 deletions
workspaces/arborist/test/arborist/reify.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1770,6 +1770,8 @@ t.test('running lifecycle scripts of unchanged link nodes on reify', async t =>

 t.ok(fs.lstatSync(resolve(path, 'a/a-prepare')).isFile(),
 'should run prepare lifecycle scripts for links directly linked to the tree')
 t.ok(fs.lstatSync(resolve(path, 'a/a-post-install')).isFile(),
 'should run postinstall lifecycle scripts for links directly linked to the tree')
})

t.test('save-prod, with optional', async t => {
Expand Down

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/link-dep-lifecycle-scripts/a/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
}

3 changes: 2 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/link-dep-lifecycle-scripts.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,8 @@ module.exports = t => {
 "name": "a",
 "version": "1.0.0",
 "scripts": {
 "prepare": "node -e \"require('fs').writeFileSync(require('path').resolve('a-prepare'), '')\""
 "prepare": "node -e \"require('fs').writeFileSync('a-prepare', '')\"",
 "postinstall": "node -e \"require('fs').writeFileSync('a-post-install', '')\""
 }
 })
 },
Expand Down

5 changes: 4 additions & 1 deletion
workspaces/arborist/test/fixtures/reify-cases/workspaces-link-bin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,13 +25,16 @@ module.exports = t => {
 })
 },
 "b": {
 "file.js": "",
 "create-file.js": "require('fs').writeFileSync('file.js', '')\n",
 "package.json": JSON.stringify({
 "name": "b",
 "version": "1.0.0",
 "files": [
 "file.js"
 ],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
 })
 }
Expand Down

1 change: 1 addition & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/create-file.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
require('fs').writeFileSync('file.js', '')
Empty file removedworkspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/file.js

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
workspaces/arborist/test/fixtures/workspaces-link-bin/packages/b/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,8 @@
 "name": "b",
 "version": "1.0.0",
 "files": ["file.js"],
 "scripts": {
 "preinstall": "node create-file.js"
 },
 "bin": "file.js"
}