Skip to content

fix!: do not magically find and run a server.js file on start #262

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

Draft
owlstronaut wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix!: do not magically find and run a server.js file on start #262

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
11 changes: 0 additions & 11 deletions lib/is-server-package.js
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions lib/run-script-pkg.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ const promiseSpawn = require('@npmcli/promise-spawn')
const packageEnvs = require('./package-envs.js')
const { isNodeGypPackage, defaultGypInstallScript } = require('@npmcli/node-gyp')
const signalManager = require('./signal-manager.js')
const isServerPackage = require('./is-server-package.js')

const runScriptPkg = async options => {
const {
Expand Down Expand Up @@ -37,8 +36,6 @@ const runScriptPkg = async options => {
await isNodeGypPackage(path)
) {
cmd = defaultGypInstallScript
} else if (event === 'start' && await isServerPackage(path)) {
cmd = 'node server.js'
}

if (!cmd) {
Expand Down
3 changes: 1 addition & 2 deletions lib/run-script.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
const PackageJson = require('@npmcli/package-json')
const runScriptPkg = require('./run-script-pkg.js')
const validateOptions = require('./validate-options.js')
const isServerPackage = require('./is-server-package.js')

const runScript = async options => {
validateOptions(options)
Expand All @@ -12,4 +11,4 @@ const runScript = async options => {
return runScriptPkg({ ...options, pkg })
}

module.exports = Object.assign(runScript, { isServerPackage })
module.exports = runScript
28 changes: 2 additions & 26 deletions test/run-script.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,8 @@ t.test('run-script', async t => {
t.strictSame(res, { code: 0, signal: null })
})

await t.test('start event, pkg has server.js but no start script', async t => {
await t.test('start event, pkg has no start script, early exit', async t => {
const path = t.testdir({ 'server.js': '' })
spawk.spawn(/.*/, a => a.includes('node server.js'))
const res = await runScript({
event: 'start',
path,
Expand All @@ -85,11 +84,7 @@ t.test('run-script', async t => {
scripts: {},
},
})
t.match(res, {
event: 'start',
script: 'node server.js',
pkgid: '@npmcli/run-script-test@1.2.3',
})
t.strictSame(res, { code: 0, signal: null })
})

await t.test('pkg does not have requested script, with custom cmd', async t => {
Expand All @@ -111,22 +106,3 @@ t.test('run-script', async t => {
t.ok(spawk.done())
})
})

t.test('isServerPackage', async t => {
await t.test('is server package', async t => {
const testdir = t.testdir({
'server.js': '',
})
await t.resolves(runScript.isServerPackage(testdir), true)
})
await t.test('is not server package - no server.js', async t => {
const testdir = t.testdir({})
await t.resolves(runScript.isServerPackage(testdir), false)
})
await t.test('is not server package - invalid server.js', async t => {
const testdir = t.testdir({
'server.js': {},
})
await t.resolves(runScript.isServerPackage(testdir), false)
})
})