Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

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

Jump to bottom

fix: run migrator in a separator process, fix require cache issues during upgrade #5360

Merged
merged 4 commits into from Apr 7, 2020
Merged

fix: run migrator in a separator process, fix require cache issues during upgrade #5360

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
305cf49
fix: run migrator in a separator process, fix require cache issues du…
sodatea Apr 6, 2020
922bcc4
fix: fix cwd
sodatea Apr 6, 2020
c8a2b89
test: fix test mocks
sodatea Apr 6, 2020
bff2d3d
fix: early return
sodatea Apr 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
52 changes: 31 additions & 21 deletions packages/@vue/cli/lib/Upgrader.js
View file
Open in desktop
Expand Up @@ -2,6 +2,7 @@ const fs = require('fs')
const path = require('path')
const {
chalk,
execa,
semver,

log,
Expand All @@ -12,19 +13,17 @@ const {
isPlugin,
resolvePluginId,

loadModule
loadModule,
resolveModule
} = require('@vue/cli-shared-utils')

const tryGetNewerRange = require('./util/tryGetNewerRange')
const getPkg = require('./util/getPkg')
const PackageManager = require('./util/ProjectPackageManager')

const { runMigrator } = require('./migrate')

function clearRequireCache () {
Object.keys(require.cache).forEach(key => delete require.cache[key])
}

module.exports = class Upgrader {
constructor (context = process.cwd()) {
this.context = context
Expand Down Expand Up @@ -108,28 +107,39 @@ module.exports = class Upgrader {

log(`Upgrading ${packageName} from ${installed} to ${targetVersion}`)
await this.pm.upgrade(`${packageName}@~${targetVersion}`)
// as the dependencies have now changed, the require cache must be invalidated
// otherwise it may affect the behavior of the migrator
clearRequireCache()

// The cached `pkg` field won't automatically update after running `this.pm.upgrade`.
// Also, `npm install pkg@~version` won't replace the original `"pkg": "^version"` field.
// So we have to manually update `this.pkg` and write to the file system in `runMigrator`
this.pkg[depEntry][packageName] = `~${targetVersion}`
const noop = () => {}

const pluginMigrator =
loadModule(`${packageName}/migrator`, this.context) || noop

await runMigrator(
this.context,
{
id: packageName,
apply: pluginMigrator,
baseVersion: installed
},
this.pkg
)

const resolvedPluginMigrator =
resolveModule(`${packageName}/migrator`, this.context)

if (resolvedPluginMigrator) {
// for unit tests, need to run migrator in the same process for mocks to work
// TODO: fix the tests and remove this special case
if (process.env.VUE_CLI_TEST) {
clearRequireCache()
await require('./migrate').runMigrator(
this.context,
{
id: packageName,
apply: loadModule(`${packageName}/migrator`, this.context),
baseVersion: installed
},
this.pkg
)
return
}

const cliBin = path.resolve(__dirname, '../bin/vue.js')
// Run migrator in a separate process to avoid all kinds of require cache issues
await execa('node', [cliBin, 'migrate', packageName, '--from', installed], {
cwd: this.context,
stdio: 'inherit'
})
}
}

async getUpgradable (includeNext) {
Expand Down