mirror of https://github.com/status-im/metro.git
Fix haste resolution (and better warnings)
Summary: @public Fix the haste resolution algorithm. Changed the map data structure from a list of modules, to a list of modules grouped by platform. This considerably simplifies the "getModule" method and makes it easy to properly warn about colliding module names. This also fixes a bug where we used to include `.web` files when we shouldn't (see task). Reviewed By: @vjeux Differential Revision: D2482969
This commit is contained in:
parent
179b9c07a9
commit
2a1d958251
|
@ -12,6 +12,8 @@ const chalk = require('chalk');
|
||||||
const path = require('path');
|
const path = require('path');
|
||||||
const getPlatformExtension = require('../../lib/getPlatformExtension');
|
const getPlatformExtension = require('../../lib/getPlatformExtension');
|
||||||
|
|
||||||
|
const GENERIC_PLATFORM = 'generic';
|
||||||
|
|
||||||
class HasteMap {
|
class HasteMap {
|
||||||
constructor({ fastfs, moduleCache, helpers }) {
|
constructor({ fastfs, moduleCache, helpers }) {
|
||||||
this._fastfs = fastfs;
|
this._fastfs = fastfs;
|
||||||
|
@ -43,7 +45,9 @@ class HasteMap {
|
||||||
/*eslint no-labels: 0 */
|
/*eslint no-labels: 0 */
|
||||||
if (type === 'delete' || type === 'change') {
|
if (type === 'delete' || type === 'change') {
|
||||||
loop: for (let name in this._map) {
|
loop: for (let name in this._map) {
|
||||||
let modules = this._map[name];
|
const modulesMap = this._map[name];
|
||||||
|
for (let platform in modulesMap) {
|
||||||
|
const modules = modulesMap[platform];
|
||||||
for (var i = 0; i < modules.length; i++) {
|
for (var i = 0; i < modules.length; i++) {
|
||||||
if (modules[i].path === absPath) {
|
if (modules[i].path === absPath) {
|
||||||
modules.splice(i, 1);
|
modules.splice(i, 1);
|
||||||
|
@ -51,6 +55,7 @@ class HasteMap {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if (type === 'delete') {
|
if (type === 'delete') {
|
||||||
return;
|
return;
|
||||||
|
@ -69,18 +74,28 @@ class HasteMap {
|
||||||
}
|
}
|
||||||
|
|
||||||
getModule(name, platform = null) {
|
getModule(name, platform = null) {
|
||||||
if (!this._map[name]) {
|
const modulesMap = this._map[name];
|
||||||
|
if (modulesMap == null) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
const modules = this._map[name];
|
// If no platform is given we choose the generic platform module list.
|
||||||
if (platform != null) {
|
// If a platform is given and no modules exist we fallback
|
||||||
for (let i = 0; i < modules.length; i++) {
|
// to the generic platform module list.
|
||||||
if (getPlatformExtension(modules[i].path) === platform) {
|
let modules;
|
||||||
return modules[i];
|
if (platform == null) {
|
||||||
|
modules = modulesMap[GENERIC_PLATFORM];
|
||||||
|
} else {
|
||||||
|
modules = modulesMap[platform];
|
||||||
|
if (modules == null) {
|
||||||
|
modules = modulesMap[GENERIC_PLATFORM];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (modules == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
if (modules.length > 1) {
|
if (modules.length > 1) {
|
||||||
if (!this._warnedAbout[name]) {
|
if (!this._warnedAbout[name]) {
|
||||||
this._warnedAbout[name] = true;
|
this._warnedAbout[name] = true;
|
||||||
|
@ -99,7 +114,6 @@ class HasteMap {
|
||||||
const randomIndex = Math.floor(Math.random() * modules.length);
|
const randomIndex = Math.floor(Math.random() * modules.length);
|
||||||
return modules[randomIndex];
|
return modules[randomIndex];
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
return modules[0];
|
return modules[0];
|
||||||
}
|
}
|
||||||
|
@ -129,15 +143,17 @@ class HasteMap {
|
||||||
|
|
||||||
_updateHasteMap(name, mod) {
|
_updateHasteMap(name, mod) {
|
||||||
if (this._map[name] == null) {
|
if (this._map[name] == null) {
|
||||||
this._map[name] = [];
|
this._map[name] = Object.create(null);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (mod.type === 'Module') {
|
const moduleMap = this._map[name];
|
||||||
// Modules takes precendence over packages.
|
const modulePlatform = getPlatformExtension(mod.path) || GENERIC_PLATFORM;
|
||||||
this._map[name].unshift(mod);
|
|
||||||
} else {
|
if (!moduleMap[modulePlatform]) {
|
||||||
this._map[name].push(mod);
|
moduleMap[modulePlatform] = [];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
moduleMap[modulePlatform].push(mod);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1134,66 +1134,6 @@ describe('DependencyGraph', function() {
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
pit('providesModule wins when conflict with package', function() {
|
|
||||||
var root = '/root';
|
|
||||||
fs.__setMockFilesystem({
|
|
||||||
'root': {
|
|
||||||
'index.js': [
|
|
||||||
'/**',
|
|
||||||
' * @providesModule index',
|
|
||||||
' */',
|
|
||||||
'require("aPackage")',
|
|
||||||
].join('\n'),
|
|
||||||
'b.js': [
|
|
||||||
'/**',
|
|
||||||
' * @providesModule aPackage',
|
|
||||||
' */',
|
|
||||||
].join('\n'),
|
|
||||||
'aPackage': {
|
|
||||||
'package.json': JSON.stringify({
|
|
||||||
name: 'aPackage',
|
|
||||||
main: 'main.js'
|
|
||||||
}),
|
|
||||||
'main.js': 'lol'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
var dgraph = new DependencyGraph({
|
|
||||||
roots: [root],
|
|
||||||
fileWatcher: fileWatcher,
|
|
||||||
assetExts: ['png', 'jpg'],
|
|
||||||
cache: cache,
|
|
||||||
});
|
|
||||||
return getOrderedDependenciesAsJSON(dgraph, '/root/index.js').then(function(deps) {
|
|
||||||
expect(deps)
|
|
||||||
.toEqual([
|
|
||||||
{
|
|
||||||
id: 'index',
|
|
||||||
path: '/root/index.js',
|
|
||||||
dependencies: ['aPackage'],
|
|
||||||
isAsset: false,
|
|
||||||
isAsset_DEPRECATED: false,
|
|
||||||
isJSON: false,
|
|
||||||
isPolyfill: false,
|
|
||||||
resolution: undefined,
|
|
||||||
resolveDependency: undefined,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: 'aPackage',
|
|
||||||
path: '/root/b.js',
|
|
||||||
dependencies: [],
|
|
||||||
isAsset: false,
|
|
||||||
isAsset_DEPRECATED: false,
|
|
||||||
isJSON: false,
|
|
||||||
isPolyfill: false,
|
|
||||||
resolution: undefined,
|
|
||||||
resolveDependency: undefined,
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
pit('should be forgiving with missing requires', function() {
|
pit('should be forgiving with missing requires', function() {
|
||||||
var root = '/root';
|
var root = '/root';
|
||||||
fs.__setMockFilesystem({
|
fs.__setMockFilesystem({
|
||||||
|
@ -2616,6 +2556,11 @@ describe('DependencyGraph', function() {
|
||||||
* @providesModule a
|
* @providesModule a
|
||||||
*/
|
*/
|
||||||
`,
|
`,
|
||||||
|
'a.web.js': `
|
||||||
|
/**
|
||||||
|
* @providesModule a
|
||||||
|
*/
|
||||||
|
`,
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -3684,6 +3629,88 @@ describe('DependencyGraph', function() {
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('warnings', () => {
|
||||||
|
let warn = console.warn;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
console.warn = jest.genMockFn();
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
console.warn = warn;
|
||||||
|
});
|
||||||
|
|
||||||
|
pit('should warn about colliding module names', function() {
|
||||||
|
fs.__setMockFilesystem({
|
||||||
|
'root': {
|
||||||
|
'index.js': `
|
||||||
|
/**
|
||||||
|
* @providesModule index
|
||||||
|
*/
|
||||||
|
require('a');
|
||||||
|
`,
|
||||||
|
'a.js': `
|
||||||
|
/**
|
||||||
|
* @providesModule a
|
||||||
|
*/
|
||||||
|
`,
|
||||||
|
'b.js': `
|
||||||
|
/**
|
||||||
|
* @providesModule a
|
||||||
|
*/
|
||||||
|
`,
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
var dgraph = new DependencyGraph({
|
||||||
|
roots: ['/root'],
|
||||||
|
fileWatcher: fileWatcher,
|
||||||
|
assetExts: ['png', 'jpg'],
|
||||||
|
cache: cache,
|
||||||
|
});
|
||||||
|
|
||||||
|
return getOrderedDependenciesAsJSON(dgraph, '/root/index.js').then(function(deps) {
|
||||||
|
expect(console.warn.mock.calls.length).toBe(1);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
pit('should warn about colliding module names within a platform', function() {
|
||||||
|
var root = '/root';
|
||||||
|
fs.__setMockFilesystem({
|
||||||
|
'root': {
|
||||||
|
'index.ios.js': `
|
||||||
|
/**
|
||||||
|
* @providesModule index
|
||||||
|
*/
|
||||||
|
require('a');
|
||||||
|
`,
|
||||||
|
'a.ios.js': `
|
||||||
|
/**
|
||||||
|
* @providesModule a
|
||||||
|
*/
|
||||||
|
`,
|
||||||
|
'b.ios.js': `
|
||||||
|
/**
|
||||||
|
* @providesModule a
|
||||||
|
*/
|
||||||
|
`,
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
var dgraph = new DependencyGraph({
|
||||||
|
roots: [root],
|
||||||
|
fileWatcher: fileWatcher,
|
||||||
|
assetExts: ['png', 'jpg'],
|
||||||
|
cache: cache,
|
||||||
|
});
|
||||||
|
|
||||||
|
return getOrderedDependenciesAsJSON(dgraph, '/root/index.ios.js', 'ios').then(function(deps) {
|
||||||
|
expect(console.warn.mock.calls.length).toBe(1);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe('getAsyncDependencies', () => {
|
describe('getAsyncDependencies', () => {
|
||||||
pit('should get dependencies', function() {
|
pit('should get dependencies', function() {
|
||||||
var root = '/root';
|
var root = '/root';
|
||||||
|
|
Loading…
Reference in New Issue