Skip to content

refactor(metro-file-map): Drop "native find binary" crawler (and forceNodeFilesystemAPI flag) #1693

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

Closed
kitten wants to merge 2 commits into from
Closed

refactor(metro-file-map): Drop "native find binary" crawler (and forceNodeFilesystemAPI flag) #1693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26ea529
Drop native find binary crawler
kitten Apr 22, 2026
586030f
Regenerate ts-defs
kitten Apr 22, 2026
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
2 changes: 0 additions & 2 deletions packages/metro-file-map/src/Watcher.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ type WatcherOptions = {
console: Console,
enableSymlinks: boolean,
extensions: ReadonlyArray<string>,
forceNodeFilesystemAPI: boolean,
healthCheckFilePrefix: string,
ignoreForCrawl: (filePath: string) => boolean,
ignorePatternForWatch: RegExp,
Expand Down Expand Up @@ -131,7 +130,6 @@ export class Watcher extends EventEmitter {
console: options.console,
includeSymlinks: options.enableSymlinks,
extensions: options.extensions,
forceNodeFilesystemAPI: options.forceNodeFilesystemAPI,
ignore: ignoreForCrawl,
onStatus: status => {
this.emit('status', status);
Expand Down
1 change: 0 additions & 1 deletion packages/metro-file-map/src/cache/__tests__/DiskCacheManager-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ const buildParameters: BuildParameters = {
cacheBreaker: '',
computeSha1: true,
enableSymlinks: false,
forceNodeFilesystemAPI: true,
ignorePattern: /ignored/,
retainAllFiles: false,
extensions: ['js', 'json'],
Expand Down
9 changes: 0 additions & 9 deletions packages/metro-file-map/src/crawlers/__tests__/integration-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,10 @@ const isWatchmanOnPath = () => {
}
};

const mockUseNativeFind = jest.fn();
jest.mock('../node/hasNativeFindSupport', () => () => mockUseNativeFind());

type Crawler = typeof nodeCrawl | typeof watchmanCrawl;

const CRAWLERS: {[key: string]: ?Crawler} = {
'node-find': opts => {
mockUseNativeFind.mockResolvedValue(true);
return nodeCrawl(opts);
},
'node-recursive': opts => {
mockUseNativeFind.mockResolvedValue(false);
return nodeCrawl(opts);
},
watchman: isWatchmanOnPath() ? watchmanCrawl : null,
Expand Down Expand Up @@ -140,7 +132,6 @@ describe.each(Object.keys(CRAWLERS))(
rootDir: FIXTURES_DIR,
abortSignal: null,
computeSha1: false,
forceNodeFilesystemAPI: false,
onStatus: () => {},
});

Expand Down
198 changes: 14 additions & 184 deletions packages/metro-file-map/src/crawlers/__tests__/node-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,32 +12,6 @@ import TreeFS from '../../lib/TreeFS';

jest.useRealTimers();

jest.mock('child_process', () => ({
spawn: jest.fn((cmd, args) => {
let closeCallback;
return {
on: jest.fn().mockImplementation((event, callback) => {
if (event === 'exit') {
callback(mockSpawnExit, null);
}
}),
stdout: {
on: jest.fn().mockImplementation((event, callback) => {
if (event === 'data') {
setTimeout(() => {
callback(mockResponse);
setTimeout(closeCallback, 0);
}, 0);
} else if (event === 'close') {
closeCallback = callback;
}
}),
setEncoding: jest.fn(),
},
};
}),
}));

jest.mock('graceful-fs', () => {
const slash = require('slash');
let mtime = 32;
Expand Down Expand Up @@ -126,96 +100,37 @@ const createMap = obj =>
const rootDir = '/project';
const emptyFS = new TreeFS({rootDir, files: new Map()});
const getFS = (files: FileData) => new TreeFS({rootDir, files});
let mockResponse;
let mockSpawnExit;
let nodeCrawl;
let childProcess;

describe('node crawler', () => {
beforeEach(() => {
jest.resetModules();

mockResponse = [
'/project/fruits/pear.js',
'/project/fruits/strawberry.js',
'/project/fruits/tomato.js',
].join('\n');

mockSpawnExit = 0;
});

test('crawls for files based on patterns', async () => {
childProcess = require('child_process');
nodeCrawl = require('../node').default;

mockResponse = [
'/project/fruits/pear.js',
'/project/fruits/strawberry.js',
'/project/fruits/tomato.js',
'/project/vegetables/melon.json',
].join('\n');

const {changedFiles, removedFiles} = await nodeCrawl({
previousState: {fileSystem: emptyFS},
extensions: ['js', 'json'],
ignore: pearMatcher,
rootDir,
roots: ['/project/fruits', '/project/vegtables'],
});

expect(childProcess.spawn).lastCalledWith('find', [
'/project/fruits',
'/project/vegtables',
'(',
'(',
'-type',
'f',
'(',
'-iname',
'*.js',
'-o',
'-iname',
'*.json',
')',
')',
')',
]);

expect(changedFiles).not.toBe(null);

expect(changedFiles).toEqual(
createMap({
'fruits/strawberry.js': [32, 42, 0, null, 0, null],
'fruits/tomato.js': [33, 42, 0, null, 0, null],
'vegetables/melon.json': [34, 42, 0, null, 0, null],
}),
);

expect(removedFiles).toEqual(new Set());
});

test('updates only changed files', async () => {
nodeCrawl = require('../node').default;

// In this test sample, strawberry is changed and tomato is unchanged
const tomato = [33, 42, 1, null, 0, null];
// The readdir mock returns tomato.js (mtime=32) and
// directory/strawberry.js (mtime=33). In this test, tomato is unchanged
// and strawberry is changed.
const files = createMap({
'fruits/strawberry.js': [30, 40, 1, null, 0, null],
'fruits/tomato.js': tomato,
'fruits/directory/strawberry.js': [30, 40, 1, null, 0, null],
'fruits/tomato.js': [32, 42, 1, null, 0, null],
});

const {changedFiles, removedFiles} = await nodeCrawl({
console: global.console,
previousState: {fileSystem: getFS(files)},
extensions: ['js'],
ignore: pearMatcher,
rootDir,
roots: ['/project/fruits'],
});

// Tomato is not included because it is unchanged
// Tomato is not included because its mtime is unchanged
expect(changedFiles).toEqual(
createMap({
'fruits/strawberry.js': [32, 42, 0, null, 0, null],
'fruits/directory/strawberry.js': [33, 42, 0, null, 0, null],
}),
);

Expand All @@ -225,117 +140,34 @@ describe('node crawler', () => {
test('returns removed files', async () => {
nodeCrawl = require('../node').default;

// In this test sample, previouslyExisted was present before and will not be
// when crawling this directory.
// In this test sample, previouslyExisted was present before and will not
// be found when crawling this directory.
const files = createMap({
'fruits/previouslyExisted.js': [30, 40, 1, null, 0, null],
'fruits/strawberry.js': [33, 42, 0, null, 0, null],
'fruits/directory/strawberry.js': [33, 42, 0, null, 0, null],
'fruits/tomato.js': [32, 42, 0, null, 0, null],
});

const {changedFiles, removedFiles} = await nodeCrawl({
console: global.console,
previousState: {fileSystem: getFS(files)},
extensions: ['js'],
ignore: pearMatcher,
rootDir,
roots: ['/project/fruits'],
});

expect(changedFiles).toEqual(
createMap({
'fruits/strawberry.js': [32, 42, 0, null, 0, null],
'fruits/tomato.js': [33, 42, 0, null, 0, null],
}),
);
expect(changedFiles).toEqual(new Map());
expect(removedFiles).toEqual(new Set(['fruits/previouslyExisted.js']));
});

test('uses node fs APIs with incompatible find binary', async () => {
mockResponse = '';
mockSpawnExit = 1;
childProcess = require('child_process');

nodeCrawl = require('../node').default;

const {changedFiles, removedFiles} = await nodeCrawl({
previousState: {fileSystem: emptyFS},
extensions: ['js'],
ignore: pearMatcher,
rootDir,
roots: ['/project/fruits'],
});

expect(childProcess.spawn).lastCalledWith(
'find',
['.', '-type', 'f', '(', '-iname', '*.ts', '-o', '-iname', '*.js', ')'],
{cwd: expect.any(String)},
);
expect(changedFiles).toEqual(
createMap({
'fruits/directory/strawberry.js': [33, 42, 0, null, 0, null],
'fruits/tomato.js': [32, 42, 0, null, 0, null],
}),
);
expect(removedFiles).toEqual(new Set());
});

test('uses node fs APIs without find binary', async () => {
childProcess = require('child_process');
childProcess.spawn.mockImplementationOnce(() => {
throw new Error();
});
nodeCrawl = require('../node').default;

const {changedFiles, removedFiles} = await nodeCrawl({
console: global.console,
previousState: {fileSystem: emptyFS},
extensions: ['js'],
ignore: pearMatcher,
rootDir,
roots: ['/project/fruits'],
});

expect(changedFiles).toEqual(
createMap({
'fruits/directory/strawberry.js': [33, 42, 0, null, 0, null],
'fruits/tomato.js': [32, 42, 0, null, 0, null],
}),
);
expect(removedFiles).toEqual(new Set());
});

test('uses node fs APIs if "forceNodeFilesystemAPI" is set to true, regardless of platform', async () => {
childProcess = require('child_process');
nodeCrawl = require('../node').default;

const {changedFiles, removedFiles} = await nodeCrawl({
console: global.console,
previousState: {fileSystem: emptyFS},
extensions: ['js'],
forceNodeFilesystemAPI: true,
ignore: pearMatcher,
rootDir,
roots: ['/project/fruits'],
});

expect(childProcess.spawn).toHaveBeenCalledTimes(0);
expect(changedFiles).toEqual(
createMap({
'fruits/directory/strawberry.js': [33, 42, 0, null, 0, null],
'fruits/tomato.js': [32, 42, 0, null, 0, null],
}),
);
expect(removedFiles).toEqual(new Set());
});

test('completes with empty roots', async () => {
nodeCrawl = require('../node').default;

const {changedFiles, removedFiles} = await nodeCrawl({
console: global.console,
previousState: {fileSystem: emptyFS},
extensions: ['js'],
forceNodeFilesystemAPI: true,
ignore: pearMatcher,
rootDir,
roots: [],
Expand All @@ -357,7 +189,6 @@ describe('node crawler', () => {
console: mockConsole,
previousState: {fileSystem: emptyFS},
extensions: ['js'],
forceNodeFilesystemAPI: true,
ignore: pearMatcher,
rootDir,
roots: ['/error'],
Expand All @@ -378,7 +209,6 @@ describe('node crawler', () => {
console: global.console,
previousState: {fileSystem: emptyFS},
extensions: ['js'],
forceNodeFilesystemAPI: true,
ignore: pearMatcher,
rootDir,
roots: ['/project/fruits'],
Expand Down Expand Up @@ -440,7 +270,7 @@ describe('node crawler', () => {
extensions: ['js', 'json'],
ignore: pearMatcher,
rootDir,
roots: ['/project/fruits', '/project/vegtables'],
roots: ['/project/fruits'],
}),
).rejects.toThrow(err);
});
Expand Down
41 changes: 0 additions & 41 deletions packages/metro-file-map/src/crawlers/node/hasNativeFindSupport.js
View file
Open in desktop

This file was deleted.

Loading
Loading