feat: support `moduleInfo.meta` in dev server by aleclarson · Pull Request #5465 · vitejs/vite

aleclarson · 2021-10-28T17:04:45Z

Description

Overall, this PR improves parity of Vite's dev server with Rollup via support for its meta object (see here for Rollup's explanation of meta).

The transform, load, and resolveId hooks can now define a meta object in their returned object, which will be merged into the meta object stored on the related ModuleNode.
Synchronize getModuleInfo with Vite's module graph
- Previously, Vite would create the module info on-demand, even if the module didn't exist.
- Accessing a property of ModuleInfo not supported by Vite will now throw a runtime error, so the offending plugin doesn't fail silently.

What is the purpose of this pull request?

Bug fix
New Feature
Documentation update
Other

…which allows the use of `moduleInfo.meta` for plugin metadata, and `getModuleInfo` will return null if the module graph has no record of the given module ID. Other properties of ModuleInfo will throw when accessed, so incompatible plugins fail in a non-cryptic manner.

Handle a `meta` property being returned from load, transform, and resolveId plugin hooks.

This provides an efficient heuristic for knowing if a module is virtual.

aleclarson · 2021-10-28T17:35:17Z

packages/vite/src/node/server/index.ts

-  const container = await createPluginContainer(config, watcher)
-  const moduleGraph = new ModuleGraph(container)
+  const moduleGraph: ModuleGraph = new ModuleGraph((url) =>
+    container.resolveId(url)


This creates a tight coupling between ModuleGraph and createPluginContainer, but I don't see any way to avoid that. And it's probably not a big deal.

patak-cat · 2021-10-28T18:14:57Z

This looks good to me but we should at least add some basic tests to avoid future regressions. If we get the tests, I think we could merge this one during the beta

This reverts commit 9ee56ab.

The `resolveId` method stops on first truthy result, so merging is never needed.

Shinigami92 · 2021-11-09T19:51:09Z

packages/vite/src/node/server/moduleGraph.ts

+export type ResolvedUrl = [
+  url: string,
+  resolvedId: string,
+  meta: object | null | undefined


non-blocking: Is there a better type then object

joaotavora · 2022-02-04T14:52:08Z

Hello @aleclarson, @patak-dev I'm trying to upgrade to the latest Vite and I'm debugging a problem related to returning {id: ..., meta} in my resolveId hook. I was hopeful it would finally work after your changes, but it doesn't :-(

For reasons that I'd rather not go into, we're import ing things ouside the project root (using server.fs.strict = false) and the call to resolveId, is coming from normalizeUrl in importAnalysis.ts:

...
const resolved = await this.resolve(url, importerFile)
...

reading on, it seems that the meta field in resolved is just discarded as it used to be.

Can it be that you "missed a spot" in your changes, or am I mis-reading this?

joaotavora · 2022-02-04T15:23:21Z

Looks like this happens even if importees are indeed inside the project root. Wonder if this case was considered. I'll try to come up with a repro later, but it would be great to have your thoughts on this, i.e. how this was intented to work.

For now, I'm seeing a regression becasue, even though returning {meta} didn't work like in Rollup and build, getModuleInfo used to synthesize an empty meta object that I could hackily write to and it would have the same behaviour. Now that's gone.

joaotavora · 2022-02-05T13:24:39Z

I've filed an issue, #6766

This commit improves the parity of behaviour between 'vite build' and 'vite dev' when Rollup plugins retuning non-null 'meta' properties from resolveId() hooks are used. If one takes the Rollup behaviour to be any kind of reference in these cases, this is fixing a small bug in Vite, which was in a very large part already fixed by PR vitejs#5465. Here's an explanation of the faulty behaviour: The normalizeUrl() helper calls user plugins's resolveId() twice. - Once with the URL string containing a query suffix. Here it _ignores_ the meta reply. - Again, with the URL no longer containing said suffix. Here it doesn't ignore the meta reply. It is stored in the moduleGraph node. As can be seen, if the user's plugin meta reply depends on the query suffix being passed in the imported URL, that meta reply won't be registered correctly in the module graph and is not retrievable via getModuleInfo() later on. This change makes it so that the first call doesn't ignore the meta reply. This makes Vite's dev server match Rollup's plugin-calling behaviour and fixes vitejs#6766. Fix: vitejs#6766 * packages/vite/src/node/importGlob.ts (ResolvedUrl): Import it. (transformImportGlob): Use it. * packages/vite/src/node/plugins/importAnalysis.ts (ResolvedUrl): Import it. (normalizeUrl): Use it. Always return meta. (transform): Ensure moduleGraph is correctly built.

This commit improves the parity of behaviour between 'vite build' and 'vite dev' when Rollup plugins retuning non-null 'meta' properties from resolveId() hooks are used. If one takes the Rollup behaviour to be any kind of reference in these cases, this is fixing a small bug in Vite, which was in a very large part already fixed by PR vitejs#5465. Here's an explanation of the faulty behaviour: The normalizeUrl() helper calls user plugins's resolveId() twice. - Once with the URL string containing a query suffix. Here it _ignores_ the meta reply. - Again, with the URL no longer containing said suffix. Here it doesn't ignore the meta reply. It is stored in the moduleGraph node. As can be seen, if the user's plugin meta reply depends on the query suffix being passed in the imported URL, that meta reply won't be registered correctly in the module graph and is not retrievable via getModuleInfo() later on. This change makes it so that the first call doesn't ignore the meta reply. This makes Vite's dev server match Rollup's plugin-calling behaviour. Fixes vitejs#6766

aleclarson added 3 commits October 28, 2021 12:52

fix: support moduleInfo.meta in dev server

7e9b058

Handle a `meta` property being returned from load, transform, and resolveId plugin hooks.

feat: set meta.filename for modules loaded from disk

9ee56ab

This provides an efficient heuristic for knowing if a module is virtual.

aleclarson requested review from patak-cat and yyx990803 October 28, 2021 17:33

aleclarson commented Oct 28, 2021

View reviewed changes

patak-cat requested a review from antfu October 28, 2021 18:15

patak-cat added the p3-downstream-blocker Blocking the downstream ecosystem to work properly (priority) label Nov 3, 2021

aleclarson added 4 commits November 9, 2021 10:46

revert "feat: set meta.filename for modules loaded from disk"

8a251d6

This reverts commit 9ee56ab.

fix: remove pointless merging

991e5a6

The `resolveId` method stops on first truthy result, so merging is never needed.

fix: allow returning meta from transform hook w/o overriding code

a8f111c

test: add unit tests for plugin container

248f76c

Niputi mentioned this pull request Nov 9, 2021

Calling getModuleInfo doesn't return custom module meta data in load hook #3240

Closed

Shinigami92 approved these changes Nov 9, 2021

View reviewed changes

patak-cat approved these changes Nov 10, 2021

View reviewed changes

patak-cat merged commit f6d08c7 into vitejs:main Nov 10, 2021

Shinigami92 added this to the 2.7 milestone Nov 25, 2021

joaotavora mentioned this pull request Feb 5, 2022

Support for moduleInfo.meta in resolveId hook still not equivalent in vite dev and vite build #6766

Open

7 tasks

joaotavora mentioned this pull request Feb 8, 2022

fix: fix rollup plugin compatibility when getModuleInfo() is used #6811

Closed

9 tasks

aleclarson deleted the fix/rollup-meta branch February 25, 2022 20:03

patak-cat mentioned this pull request Mar 29, 2023

perf: shorcircuit resolve in ensure entry from url #12655

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: support `moduleInfo.meta` in dev server#5465

feat: support `moduleInfo.meta` in dev server#5465
patak-cat merged 7 commits intovitejs:mainfrom
aleclarson:fix/rollup-meta

aleclarson commented Oct 28, 2021 •

edited

Loading

Uh oh!

aleclarson Oct 28, 2021

Uh oh!

patak-cat commented Oct 28, 2021

Uh oh!

Shinigami92 Nov 9, 2021

Uh oh!

joaotavora commented Feb 4, 2022

Uh oh!

joaotavora commented Feb 4, 2022

Uh oh!

joaotavora commented Feb 5, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

aleclarson commented Oct 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

What is the purpose of this pull request?

Uh oh!

aleclarson Oct 28, 2021

Choose a reason for hiding this comment

Uh oh!

patak-cat commented Oct 28, 2021

Uh oh!

Shinigami92 Nov 9, 2021

Choose a reason for hiding this comment

Uh oh!

joaotavora commented Feb 4, 2022

Uh oh!

joaotavora commented Feb 4, 2022

Uh oh!

joaotavora commented Feb 5, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aleclarson commented Oct 28, 2021 •

edited

Loading