add/change -> touch

Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:
facebook · Dec 21, 2024 · f981dbc · f981dbc
1 parent 1375020
commit f981dbc
Show file tree

Hide file tree

Showing 10 changed files with 77 additions and 90 deletions.
diff --git a/packages/metro-file-map/src/Watcher.js b/packages/metro-file-map/src/Watcher.js
@@ -22,7 +22,7 @@ import type {AbortSignal} from 'node-abort-controller';
 
 import nodeCrawl from './crawlers/node';
 import watchmanCrawl from './crawlers/watchman';
-import {ADD_EVENT, CHANGE_EVENT} from './watchers/common';
+import {TOUCH_EVENT} from './watchers/common';
 import FSEventsWatcher from './watchers/FSEventsWatcher';
 import NodeWatcher from './watchers/NodeWatcher';
 import WatchmanWatcher from './watchers/WatchmanWatcher';
@@ -210,7 +210,7 @@ export class Watcher extends EventEmitter {
           watcher.on('all', (change: WatcherBackendChangeEvent) => {
             const basename = path.basename(change.relativePath);
             if (basename.startsWith(this._options.healthCheckFilePrefix)) {
-              if (change.event === ADD_EVENT || change.event === CHANGE_EVENT) {
+              if (change.event === TOUCH_EVENT) {
                 debug(
                   'Observed possible health check cookie: %s in %s',
                   change.relativePath,

diff --git a/packages/metro-file-map/src/__tests__/index-test.js b/packages/metro-file-map/src/__tests__/index-test.js
@@ -1621,13 +1621,13 @@ describe('FileMap', () => {
       `;
       const e = mockEmitters[path.join('/', 'project', 'fruits')];
       e.emit('all', {
-        event: 'add',
+        event: 'touch',
         relativePath: 'Tomato.js',
         root: path.join('/', 'project', 'fruits'),
         metadata: MOCK_CHANGE_FILE,
       });
       e.emit('all', {
-        event: 'change',
+        event: 'touch',
         relativePath: 'Pear.js',
         root: path.join('/', 'project', 'fruits'),
         metadata: MOCK_CHANGE_FILE,
@@ -1662,13 +1662,13 @@ describe('FileMap', () => {
         // Tomato!
       `;
       e.emit('all', {
-        event: 'change',
+        event: 'touch',
         relativePath: 'Tomato.js',
         root: path.join('/', 'project', 'fruits'),
         metadata: MOCK_CHANGE_FILE,
       });
       e.emit('all', {
-        event: 'change',
+        event: 'touch',
         relativePath: 'Tomato.js',
         root: path.join('/', 'project', 'fruits'),
         metadata: MOCK_CHANGE_FILE,
@@ -1683,25 +1683,22 @@ describe('FileMap', () => {
         const {fileSystem} = await hm.build();
         const fruitsRoot = path.join('/', 'project', 'fruits');
         const e = mockEmitters[fruitsRoot];
-        mockFs[path.join(fruitsRoot, 'Tomato.js')] = `
-        // Tomato!
-      `;
         e.emit('all', {
-          event: 'change',
-          relativePath: 'Tomato.js',
+          event: 'touch',
+          relativePath: 'Strawberry.js',
           root: fruitsRoot,
           metadata: MOCK_CHANGE_FILE,
         });
         e.emit('all', {
-          event: 'change',
+          event: 'touch',
           relativePath: 'LinkToStrawberry.js',
           root: fruitsRoot,
           metadata: MOCK_CHANGE_LINK,
         });
         const {eventsQueue} = await waitForItToChange(hm);
         expect(eventsQueue).toEqual([
           {
-            filePath: path.join(fruitsRoot, 'Tomato.js'),
+            filePath: path.join(fruitsRoot, 'Strawberry.js'),
             metadata: MOCK_CHANGE_FILE,
             type: 'change',
           },
@@ -1718,25 +1715,22 @@ describe('FileMap', () => {
         const {fileSystem} = await hm.build();
         const fruitsRoot = path.join('/', 'project', 'fruits');
         const e = mockEmitters[fruitsRoot];
-        mockFs[path.join(fruitsRoot, 'Tomato.js')] = `
-        // Tomato!
-      `;
         e.emit('all', {
-          event: 'change',
-          relativePath: 'Tomato.js',
+          event: 'touch',
+          relativePath: 'Strawberry.js',
           root: fruitsRoot,
           metadata: MOCK_CHANGE_FILE,
         });
         e.emit('all', {
-          event: 'change',
+          event: 'touch',
           relativePath: 'LinkToStrawberry.js',
           root: fruitsRoot,
           metadata: MOCK_CHANGE_LINK,
         });
         const {eventsQueue} = await waitForItToChange(hm);
         expect(eventsQueue).toEqual([
           {
-            filePath: path.join(fruitsRoot, 'Tomato.js'),
+            filePath: path.join(fruitsRoot, 'Strawberry.js'),
             metadata: MOCK_CHANGE_FILE,
             type: 'change',
           },
@@ -1759,7 +1753,7 @@ describe('FileMap', () => {
         const {fileSystem} = await hm.build();
         const e = mockEmitters[path.join('/', 'project', 'fruits')];
         e.emit('all', {
-          event: 'add',
+          event: 'touch',
           relativePath: 'apple.js',
           root: path.join('/', 'project', 'fruits', 'node_modules', ''),
           metadata: MOCK_CHANGE_FILE,
@@ -1788,13 +1782,13 @@ describe('FileMap', () => {
 
         const e = mockEmitters[path.join('/', 'project', 'fruits')];
         e.emit('all', {
-          event: 'add',
+          event: 'touch',
           relativePath: 'Banana.js',
           root: path.join('/', 'project', 'fruits', ''),
           metadata: MOCK_CHANGE_FILE,
         });
         e.emit('all', {
-          event: 'add',
+          event: 'touch',
           relativePath: 'Banana.unwatched',
           root: path.join('/', 'project', 'fruits', ''),
           metadata: MOCK_CHANGE_FILE,
@@ -1803,7 +1797,7 @@ describe('FileMap', () => {
         const filePath = path.join('/', 'project', 'fruits', 'Banana.js');
         expect(eventsQueue).toHaveLength(1);
         expect(eventsQueue).toEqual([
-          {filePath, metadata: MOCK_CHANGE_FILE, type: 'add'},
+          {filePath, metadata: MOCK_CHANGE_FILE, type: 'change'},
         ]);
         expect(fileSystem.getModuleName(filePath)).toBeDefined();
       },
@@ -1844,7 +1838,7 @@ describe('FileMap', () => {
           link: 'Strawberry.js',
         };
         e.emit('all', {
-          event: 'add',
+          event: 'touch',
           relativePath: 'LinkToStrawberry.ext',
           root: path.join('/', 'project', 'fruits', ''),
           metadata: MOCK_CHANGE_LINK,
@@ -1921,13 +1915,13 @@ describe('FileMap', () => {
         expect(hasteMap.getModule('Orange', 'android')).toBeTruthy();
         const e = mockEmitters[path.join('/', 'project', 'fruits')];
         e.emit('all', {
-          event: 'change',
+          event: 'touch',
           relativePath: 'Orange.ios.js',
           root: path.join('/', 'project', 'fruits'),
           metadata: MOCK_CHANGE_FILE,
         });
         e.emit('all', {
-          event: 'change',
+          event: 'touch',
           relativePath: 'Orange.android.js',
           root: path.join('/', 'project', 'fruits'),
           metadata: MOCK_CHANGE_FILE,
@@ -1994,7 +1988,7 @@ describe('FileMap', () => {
         root: path.join('/', 'project', 'vegetables'),
       });
       mockEmitters[path.join('/', 'project', 'fruits')].emit('all', {
-        event: 'add',
+        event: 'touch',
         relativePath: 'Melon.js',
         root: path.join('/', 'project', 'fruits'),
         metadata: MOCK_CHANGE_FILE,
@@ -2033,13 +2027,13 @@ describe('FileMap', () => {
         `;
         const e = mockEmitters[path.join('/', 'project', 'fruits')];
         e.emit('all', {
-          event: 'change',
+          event: 'touch',
           relativePath: 'Pear.js',
           root: path.join('/', 'project', 'fruits'),
           metadata: MOCK_CHANGE_FILE,
         });
         e.emit('all', {
-          event: 'add',
+          event: 'touch',
           relativePath: 'Pear.js',
           root: path.join('/', 'project', 'fruits', 'another'),
           metadata: MOCK_CHANGE_FILE,
@@ -2081,13 +2075,13 @@ describe('FileMap', () => {
           const {fileSystem} = await hm.build();
           const e = mockEmitters[path.join('/', 'project', 'fruits')];
           e.emit('all', {
-            event: 'change',
+            event: 'touch',
             relativePath: 'Pear.js',
             root: path.join('/', 'project', 'fruits'),
             metadata: MOCK_CHANGE_FILE,
           });
           e.emit('all', {
-            event: 'add',
+            event: 'touch',
             relativePath: 'Pear.js',
             root: path.join('/', 'project', 'fruits', 'another'),
             metadata: MOCK_CHANGE_FILE,
@@ -2139,7 +2133,7 @@ describe('FileMap', () => {
             metadata: MOCK_CHANGE_FILE,
           });
           e.emit('all', {
-            event: 'add',
+            event: 'touch',
             relativePath: 'Pear2.js',
             root: path.join('/', 'project', 'fruits'),
             metadata: MOCK_CHANGE_FILE,
@@ -2164,7 +2158,7 @@ describe('FileMap', () => {
         `;
         const e = mockEmitters[path.join('/', 'project', 'fruits')];
         e.emit('all', {
-          event: 'add',
+          event: 'touch',
           relativePath: 'Pear2.js',
           root: path.join('/', 'project', 'fruits', 'another'),
           metadata: MOCK_CHANGE_FILE,
@@ -2189,13 +2183,13 @@ describe('FileMap', () => {
         // Tomato!
       `;
         e.emit('all', {
-          event: 'change',
+          event: 'touch',
           relativePath: 'tomato.js',
           root: path.join('/', 'project', 'fruits'),
           metadata: MOCK_CHANGE_FOLDER,
         });
         e.emit('all', {
-          event: 'change',
+          event: 'touch',
           relativePath: path.join('tomato.js', 'index.js'),
           root: path.join('/', 'project', 'fruits'),
           metadata: MOCK_CHANGE_FILE,

diff --git a/packages/metro-file-map/src/flow-types.js b/packages/metro-file-map/src/flow-types.js
@@ -324,7 +324,7 @@ export type ReadOnlyRawMockMap = $ReadOnly<{
 
 export type WatcherBackendChangeEvent =
   | $ReadOnly<{
-      event: 'change' | 'add',
+      event: 'touch',
       relativePath: string,
       root: string,
       metadata: ChangeEventMetadata,

diff --git a/packages/metro-file-map/src/index.js b/packages/metro-file-map/src/index.js
@@ -898,14 +898,23 @@ export default class FileMap extends EventEmitter {
       // null, then it is assumed that the watcher does not have capabilities
       // to detect modified time, and change processing proceeds.
       if (
-        change.event === 'change' &&
+        change.event === 'touch' &&
         linkStats != null &&
         change.metadata.modifiedTime != null &&
         linkStats.modifiedTime === change.metadata.modifiedTime
       ) {
         return;
       }
 
+      // Emitted events, unlike memoryless backend events, specify 'add' or
+      // 'change' instead of 'touch'.
+      const eventTypeToEmit =
+        change.event === 'touch'
+          ? linkStats == null
+            ? 'add'
+            : 'change'
+          : 'delete';
+
       const onChangeStartTime = performance.timeOrigin + performance.now();
 
       changeQueue = changeQueue
@@ -915,7 +924,7 @@ export default class FileMap extends EventEmitter {
             nextEmit != null &&
             nextEmit.eventsQueue.find(
               event =>
-                event.type === change.event &&
+                event.type === eventTypeToEmit &&
                 event.filePath === absoluteFilePath &&
                 ((!event.metadata && !change.metadata) ||
                   (event.metadata &&
@@ -935,7 +944,7 @@ export default class FileMap extends EventEmitter {
             const event = {
               filePath: absoluteFilePath,
               metadata,
-              type: change.event,
+              type: eventTypeToEmit,
             };
             if (nextEmit == null) {
               nextEmit = {
@@ -960,9 +969,9 @@ export default class FileMap extends EventEmitter {
             );
           }
 
-          // If the file was added or changed,
+          // If the file was added or modified,
           // parse it and update the haste map.
-          if (change.event === 'add' || change.event === 'change') {
+          if (change.event === 'touch') {
             invariant(
               change.metadata.size != null,
               'since the file exists or changed, it should have known size',

diff --git a/packages/metro-file-map/src/watchers/FSEventsWatcher.js b/packages/metro-file-map/src/watchers/FSEventsWatcher.js
@@ -33,9 +33,8 @@ try {
   // Optional dependency, only supported on Darwin.
 }
 
-const CHANGE_EVENT = 'change';
+const TOUCH_EVENT = 'touch';
 const DELETE_EVENT = 'delete';
-const ADD_EVENT = 'add';
 const ALL_EVENT = 'all';
 
 /**
@@ -161,12 +160,7 @@ export default class FSEventsWatcher extends EventEmitter {
         size: stat.size,
       };
 
-      if (this._tracked.has(filepath)) {
-        this._emit({event: CHANGE_EVENT, relativePath, metadata});
-      } else {
-        this._tracked.add(filepath);
-        this._emit({event: ADD_EVENT, relativePath, metadata});
-      }
+      this._emit({event: TOUCH_EVENT, relativePath, metadata});
     } catch (error) {
       if (error?.code !== 'ENOENT') {
         this.emit('error', error);