Turbopack: Add `BeforeResolve` plugin type #8165

wbinnssmith · 2024-05-16T23:58:05Z

This adds a new plugin type for replacing resolution before it occurs. This allows plugin authors to intercept requests for modules in place of the typical resolution strategy.

This is used to replace ImportMapping replacers for @next/font/local in an upcoming Next.js PR

This adds a new plugin type for replacing resolution _before_ it occurs. This allows plugin authors to intercept requests for modules in place of the typical resolution strategy. This is used to replace `ImportMapping` replacers for `@next/font/local` in an upcoming Next.js PR

vercel · 2024-05-16T23:58:06Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
examples-basic-web	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	May 17, 2024 11:15pm
examples-gatsby-web	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	May 17, 2024 11:15pm
examples-nonmonorepo	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 17, 2024 11:15pm
examples-svelte-web	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	May 17, 2024 11:15pm
examples-tailwind-web	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	May 17, 2024 11:15pm
rust-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 17, 2024 11:15pm

4 Ignored Deployments

Name	Status	Preview	Updated (UTC)
examples-designsystem-docs	⬜️ Ignored (Inspect)	Visit Preview	May 17, 2024 11:15pm
examples-kitchensink-blog	⬜️ Ignored (Inspect)	Visit Preview	May 17, 2024 11:15pm
examples-native-web	⬜️ Ignored (Inspect)	Visit Preview	May 17, 2024 11:15pm
examples-vite-web	⬜️ Ignored (Inspect)	Visit Preview	May 17, 2024 11:15pm

github-actions · 2024-05-17T00:00:03Z

🟢 Turbopack Benchmark CI successful 🟢

Thanks

github-actions · 2024-05-17T00:01:13Z

✅ This change can build next-swc

kwonoj · 2024-05-17T00:02:47Z

crates/turbopack-resolve/src/resolve_options_context.rs

@@ -72,6 +72,7 @@ pub struct ResolveOptionsContext {
    /// A list of plugins which get applied before (in the future) and after


probably need to adjust comment bit, also we may want to rename plugins in this case?

… show custom error message Depends on vercel/turborepo#8165 This: - Creates and uses a `BeforeResolvePlugin` to handle requests to `next/font/local/target.css` instead of `ImportMapping` replacers - Returns a `ResolveResultItem::Error` which includes a custom `StyledString` describing the missing font file Test Plan: `TURBOPACK=1 pnpm test-dev test/e2e/app-dir/next-font/next-font.test.ts`

github-actions · 2024-05-17T00:04:34Z

⚠️ CI failed ⚠️

The following steps have failed in CI:

Turbopack Rust tests (mac/win, non-blocking)

See workflow summary for details

sokra · 2024-05-17T10:51:30Z

crates/turbopack-core/src/resolve/mod.rs

+) -> Result<Option<Vc<ResolveResult>>> {
+    for plugin in &options.await?.before_resolve_plugins {
+        if let Some(result) = *plugin
+            .before_resolve(lookup_path, reference_type.clone(), request)


That might have a negative performance effect, since it calls the plugin for every resolving in the application. So something like with the resolve plugins would be beneficial: before_resolve_condition

sokra · 2024-05-17T10:54:11Z

crates/turbopack-core/src/resolve/mod.rs

@@ -66,6 +67,7 @@ pub enum ModuleResolveResultItem {
    OutputAsset(Vc<Box<dyn OutputAsset>>),
    External(String, ExternalType),
    Ignore,
+    Error(Vc<StyledString>),


Suggested change

Error(Vc<StyledString>),

RuntimeError(Vc<String>),

I was thinking for this to lead to a runtime error during code generation.

Shouldn't this be a build error -- we wouldn't want to produce something that is runnable if this is the case. I think that's what happens with Webpack.

sokra · 2024-05-17T10:55:34Z

crates/turbopack-core/src/resolve/mod.rs

@@ -2553,7 +2619,18 @@ pub async fn handle_resolve_error(
                .cell()
                .emit();
            }
-            result
+
+            if let Some(error_string) = result.await?.get_first_error() {


I think it should not do that. It should just return the result even if that's a resolve result with runtime error.

The issue should be emitted earlier. E.g. in the before resolve plugin itself

… show custom error message (#65870) Depends on vercel/turborepo#8165 This: - Creates and uses a `BeforeResolvePlugin` to handle requests to `next/font/local/target.css` instead of `ImportMapping` replacers - Returns a `ResolveResultItem::Error` which includes a custom `StyledString` describing the missing font file Test Plan: `TURBOPACK=1 pnpm test-dev test/e2e/app-dir/next-font/next-font.test.ts`

This adds a new plugin type for replacing resolution _before_ it occurs. This allows plugin authors to intercept requests for modules in place of the typical resolution strategy. This is used to replace `ImportMapping` replacers for `@next/font/local` in an upcoming Next.js PR

vercel/turborepo#8165 introduced plugins that operate before resolving occurs, meaning that plugins like `InvalidImportResolvePlugin` which never use the initial resolve result and report issues can avoid that work. Test Plan: `TURBOPACK_DEV=1 TURBOPACK=1 pnpm test-dev test/development/acceptance-app/invalid-imports.test.ts`

This adds a new plugin type for replacing resolution _before_ it occurs. This allows plugin authors to intercept requests for modules in place of the typical resolution strategy. This is used to replace `ImportMapping` replacers for `@next/font/local` in an upcoming Next.js PR

… show custom error message (#65870) Depends on vercel/turborepo#8165 This: - Creates and uses a `BeforeResolvePlugin` to handle requests to `next/font/local/target.css` instead of `ImportMapping` replacers - Returns a `ResolveResultItem::Error` which includes a custom `StyledString` describing the missing font file Test Plan: `TURBOPACK=1 pnpm test-dev test/e2e/app-dir/next-font/next-font.test.ts`

vercel/turborepo#8165 introduced plugins that operate before resolving occurs, meaning that plugins like `InvalidImportResolvePlugin` which never use the initial resolve result and report issues can avoid that work. Test Plan: `TURBOPACK_DEV=1 TURBOPACK=1 pnpm test-dev test/development/acceptance-app/invalid-imports.test.ts`

… show custom error message (#65870) Depends on vercel/turborepo#8165 This: - Creates and uses a `BeforeResolvePlugin` to handle requests to `next/font/local/target.css` instead of `ImportMapping` replacers - Returns a `ResolveResultItem::Error` which includes a custom `StyledString` describing the missing font file Test Plan: `TURBOPACK=1 pnpm test-dev test/e2e/app-dir/next-font/next-font.test.ts`

vercel/turborepo#8165 introduced plugins that operate before resolving occurs, meaning that plugins like `InvalidImportResolvePlugin` which never use the initial resolve result and report issues can avoid that work. Test Plan: `TURBOPACK_DEV=1 TURBOPACK=1 pnpm test-dev test/development/acceptance-app/invalid-imports.test.ts`

… show custom error message (#65870) Depends on vercel/turborepo#8165 This: - Creates and uses a `BeforeResolvePlugin` to handle requests to `next/font/local/target.css` instead of `ImportMapping` replacers - Returns a `ResolveResultItem::Error` which includes a custom `StyledString` describing the missing font file Test Plan: `TURBOPACK=1 pnpm test-dev test/e2e/app-dir/next-font/next-font.test.ts`

vercel/turborepo#8165 introduced plugins that operate before resolving occurs, meaning that plugins like `InvalidImportResolvePlugin` which never use the initial resolve result and report issues can avoid that work. Test Plan: `TURBOPACK_DEV=1 TURBOPACK=1 pnpm test-dev test/development/acceptance-app/invalid-imports.test.ts`

turbo-orchestrator bot added created-by: turbopack labels May 16, 2024

wbinnssmith requested review from kwonoj, sokra and bgw May 16, 2024 23:58

vercel bot deployed to Preview – examples-nonmonorepo May 16, 2024 23:58 View deployment

kwonoj reviewed May 17, 2024

View reviewed changes

wbinnssmith mentioned this pull request May 17, 2024

Turbopack: Implement next/font/local with BeforeResolvePlugin and show custom error message vercel/next.js#65870

Merged

vercel bot deployed to Preview – rust-docs May 17, 2024 00:08 View deployment

fixup! Turbopack: Add BeforeResolve plugin type

d8eb030

vercel bot deployed to Preview – examples-nonmonorepo May 17, 2024 00:18 View deployment

vercel bot deployed to Preview – rust-docs May 17, 2024 00:27 View deployment

kdy1 mentioned this pull request May 17, 2024

fix(turbopack): Use correct method for the proxy of fetch #7739

Closed

sokra reviewed May 17, 2024

View reviewed changes

wbinnssmith added 2 commits May 17, 2024 14:00

fixup! Turbopack: Add BeforeResolve plugin type

bd4cc3f

Merge remote-tracking branch 'origin/main' into wbinnssmith/font-plugin

1b95122

vercel bot deployed to Preview – examples-nonmonorepo May 17, 2024 21:00 View deployment

vercel bot deployed to Preview – examples-nonmonorepo May 17, 2024 21:01 View deployment

vercel bot deployed to Preview – rust-docs May 17, 2024 21:12 View deployment

fixup! Turbopack: Add BeforeResolve plugin type

5715b87

vercel bot deployed to Preview – examples-nonmonorepo May 17, 2024 22:28 View deployment

vercel bot deployed to Preview – rust-docs May 17, 2024 22:30 View deployment

fixup! Turbopack: Add BeforeResolve plugin type

6b184a3

vercel bot deployed to Preview – examples-nonmonorepo May 17, 2024 23:14 View deployment

vercel bot deployed to Preview – rust-docs May 17, 2024 23:15 View deployment

wbinnssmith marked this pull request as ready for review May 17, 2024 23:46

wbinnssmith requested a review from a team as a code owner May 17, 2024 23:46

kwonoj approved these changes May 20, 2024

View reviewed changes

wbinnssmith merged commit 41075ab into main May 20, 2024
48 of 50 checks passed

wbinnssmith deleted the wbinnssmith/font-plugin branch May 20, 2024 21:51

wbinnssmith mentioned this pull request Jun 7, 2024

Make InvalidImportResolvePlugin a BeforeResolvePlugin vercel/next.js#66622

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Turbopack: Add `BeforeResolve` plugin type #8165

Turbopack: Add `BeforeResolve` plugin type #8165

wbinnssmith commented May 16, 2024

vercel bot commented May 16, 2024 •

edited

Loading

github-actions bot commented May 17, 2024 •

edited

Loading

github-actions bot commented May 17, 2024

kwonoj May 17, 2024

github-actions bot commented May 17, 2024 •

edited

Loading

sokra May 17, 2024

sokra May 17, 2024

wbinnssmith May 17, 2024

sokra May 17, 2024 •

edited

Loading

		@@ -72,6 +72,7 @@ pub struct ResolveOptionsContext {
		/// A list of plugins which get applied before (in the future) and after

Turbopack: Add BeforeResolve plugin type #8165

Turbopack: Add BeforeResolve plugin type #8165

Conversation

wbinnssmith commented May 16, 2024

vercel bot commented May 16, 2024 • edited Loading

github-actions bot commented May 17, 2024 • edited Loading

🟢 Turbopack Benchmark CI successful 🟢

github-actions bot commented May 17, 2024

kwonoj May 17, 2024

Choose a reason for hiding this comment

github-actions bot commented May 17, 2024 • edited Loading

⚠️ CI failed ⚠️

sokra May 17, 2024

Choose a reason for hiding this comment

sokra May 17, 2024

Choose a reason for hiding this comment

wbinnssmith May 17, 2024

Choose a reason for hiding this comment

sokra May 17, 2024 • edited Loading

Choose a reason for hiding this comment

Turbopack: Add `BeforeResolve` plugin type #8165

Turbopack: Add `BeforeResolve` plugin type #8165

vercel bot commented May 16, 2024 •

edited

Loading

github-actions bot commented May 17, 2024 •

edited

Loading

github-actions bot commented May 17, 2024 •

edited

Loading

sokra May 17, 2024 •

edited

Loading