Skip to content
New issue

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

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(core): use require.resolve instead of Module internals #5796

Merged
merged 7 commits into from May 25, 2019
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/core/src/resolver.js
@@ -1,4 +1,3 @@
import Module from 'module'
import { resolve, join } from 'path'
import fs from 'fs-extra'
import consola from 'consola'
Expand All @@ -7,7 +6,7 @@ import esm from 'esm'
import { startsWithRootAlias, startsWithSrcAlias } from '@nuxt/utils'

export default class Resolver {
constructor(nuxt) {
constructor(nuxt, moduleResolver) {
this.nuxt = nuxt
this.options = this.nuxt.options

Expand All @@ -19,15 +18,18 @@ export default class Resolver {

// ESM Loader
this.esm = esm(module)

// module resolver
this.moduleResolver = moduleResolver || require.resolve
clarkdo marked this conversation as resolved.
Show resolved Hide resolved
}

resolveModule(path) {
try {
return Module._resolveFilename(path, {
return this.moduleResolver(path, {
paths: this.options.modulesDir
})
} catch (error) {
if (error.code === 'MODULE_NOT_FOUND') {
if (error.code === 'MODULE_NOT_FOUND' || error.message.includes('Cannot resolve module')) {
clarkdo marked this conversation as resolved.
Show resolved Hide resolved
return undefined
} else {
throw error
Expand Down
39 changes: 20 additions & 19 deletions packages/core/test/resolver.test.js
@@ -1,4 +1,3 @@
import Module from 'module'
import path from 'path'
import esm from 'esm'
import fs from 'fs-extra'
Expand All @@ -7,7 +6,6 @@ import { startsWithRootAlias, startsWithSrcAlias } from '@nuxt/utils'

import Resolver from '../src/resolver'

jest.mock('module')
jest.mock('path')
jest.mock('esm', () => jest.fn(() => jest.fn()))
jest.mock('fs-extra')
Expand All @@ -33,42 +31,45 @@ describe('core: resolver', () => {
expect(esm).toBeCalledTimes(1)
})

test('should call _resolveFilename in resolveModule', () => {
const resolver = new Resolver({
options: { modulesDir: '/var/nuxt/node_modules' }
})
Module._resolveFilename = jest.fn(() => '/var/nuxt/resolver/module')
test('should call require.resolve in resolveModule', () => {
require.resolve = jest.fn(() => '/var/nuxt/resolver/module')
const resolver = new Resolver(
{
options: { modulesDir: '/var/nuxt/node_modules' }
},
require.resolve
)

const modulePath = resolver.resolveModule('/var/nuxt/resolver')

expect(modulePath).toEqual('/var/nuxt/resolver/module')
expect(Module._resolveFilename).toBeCalledTimes(1)
expect(Module._resolveFilename).toBeCalledWith('/var/nuxt/resolver', { paths: '/var/nuxt/node_modules' })
expect(require.resolve).toBeCalledTimes(1)
expect(require.resolve).toBeCalledWith('/var/nuxt/resolver', { paths: '/var/nuxt/node_modules' })
})

test('should return undefined when module is not found', () => {
const resolver = new Resolver({
options: { modulesDir: '/var/nuxt/node_modules' }
})
Module._resolveFilename = jest.fn(() => {
require.resolve = jest.fn(() => {
const err = new Error()
err.code = 'MODULE_NOT_FOUND'
throw err
})
const resolver = new Resolver({
options: { modulesDir: '/var/nuxt/node_modules' }
}, require.resolve)

const modulePath = resolver.resolveModule('/var/nuxt/resolver')

expect(modulePath).toBeUndefined()
expect(Module._resolveFilename).toBeCalledTimes(1)
expect(require.resolve).toBeCalledTimes(1)
})

test('should throw error when _resolveFilename failed', () => {
const resolver = new Resolver({
options: { modulesDir: '/var/nuxt/node_modules' }
})
Module._resolveFilename = jest.fn(() => {
test('should throw error when require.resolve failed', () => {
require.resolve = jest.fn(() => {
throw new Error('resolve failed')
})
const resolver = new Resolver({
options: { modulesDir: '/var/nuxt/node_modules' }
}, require.resolve)

expect(() => resolver.resolveModule('/var/nuxt/resolver')).toThrow('resolve failed')
})
Expand Down