Skip to content

metro-file-map: Let plugins report what changed in a batch, on the change event - #1953

Open
robhogan wants to merge 4 commits into
robhogan/observe-haste-namesfrom
robhogan/plugin-change-summaries
Open

robhogan wants to merge 4 commits into
robhogan/observe-haste-namesfrom
robhogan/plugin-change-summaries

Conversation

@robhogan

@robhogan robhogan commented Sep 18, 2026 •

Copy link
Copy Markdown
Collaborator

Context

A file map plugin often knows things about a batch of changes that nothing else can work out. For Haste, #1952 records the names a resolution looked up, and invalidating from those means knowing which names a change rebound. The ChangeEvent carries paths, and by the time a consumer sees it a removed file's name is already gone from the map, but HastePlugin.onChanged has it to hand:

onChanged(delta: ReadonlyFileSystemChanges<?string>): void {
// Process removals first so that moves aren't treated as duplicates.
for (const [canonicalPath, maybeHasteId] of delta.removedFiles) {
this.#onRemovedFile(canonicalPath, maybeHasteId);
}

This change

This lets a plugin's onChanged return a summary, published on ChangeEvent.pluginChanges by plugin name. The summary type defaults to void, so existing plugins are unaffected. HastePlugin reports changedNames.

Plugin names now have to be unique across all plugins, not just those with a worker. Persisted state was already keyed by name, so two sharing a name were already overwriting each other.

Not addressed here: on a cold start HastePlugin builds a summary nobody reads (transient, and nothing where Haste is inert), and an edit that changes a file's Haste name is neither applied to the map nor reported, which predates this.

Invalidating from the summary is the next PR.

Changelog: Internal

Test plan

New unit tests cover the watch and recrawl paths and duplicate plugin names.

@robhogan
robhogan added this pull request to stack #1947 September 18, 2026 21:05
@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Sep 18, 2026
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from 128f7ac to 6a3fc0e Compare September 25, 2026 18:04
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from 6a3fc0e to 5de1b40 Compare September 29, 2026 14:30
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from 5de1b40 to aa75dc8 Compare September 29, 2026 14:36
@robhogan
robhogan removed this pull request from stack #1947 October 9, 2026 15:33
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from aa75dc8 to 45d155a Compare October 9, 2026 15:34
@robhogan
robhogan added this pull request to stack #2045 October 9, 2026 15:34
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from 45d155a to d42120c Compare October 9, 2026 15:42
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from d42120c to 10a5047 Compare October 19, 2026 07:10
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch 2 times, most recently from 51e1703 to 6fe4e75 Compare October 19, 2026 07:34
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from 6fe4e75 to 818a641 Compare October 19, 2026 07:48
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from 818a641 to d0a76ec Compare October 21, 2026 17:01
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from d0a76ec to 6d7fdd5 Compare October 30, 2026 14:19
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from 6d7fdd5 to fc0cb38 Compare October 30, 2026 14:24
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from fc0cb38 to e3fd11a Compare October 30, 2026 16:05
…ange event

## Context

A file map plugin often knows things about a batch of changes that nothing else can work out. For Haste, #1952 records the names a resolution looked up, and invalidating from those means knowing which names a change rebound. The `ChangeEvent` carries paths, and by the time a consumer sees it a removed file's name is already gone from the map, but `HastePlugin.onChanged` has it to hand:

https://github.com/react/metro/blob/6dbe97956af0f66f7a1d88014ba0b784a4a4d893/packages/metro-file-map/src/plugins/HastePlugin.js#L241-L245

## This change

This lets a plugin's `onChanged` return a summary, published on `ChangeEvent.pluginChanges` by plugin name. The summary type defaults to `void`, so existing plugins are unaffected. `HastePlugin` reports `changedNames`.

Plugin names now have to be unique across all plugins, not just those with a worker. Persisted state was already keyed by name, so two sharing a name were already overwriting each other.

Not addressed here: on a cold start `HastePlugin` builds a summary nobody reads (transient, and nothing where Haste is inert), and an edit that changes a file's Haste name is neither applied to the map nor reported, which predates this.

Invalidating from the summary is the next PR.

Changelog: Internal

## Test plan

New unit tests cover the watch and recrawl paths and duplicate plugin names.
@robhogan
robhogan force-pushed the robhogan/plugin-change-summaries branch from 7866a3a to 08303d7 Compare November 18, 2026 13:05
@robhogan
robhogan requested review from huntie and vzaidman November 20, 2026 16:04
@robhogan
robhogan marked this pull request as ready for review November 20, 2026 16:04

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant