History

Wyatt Johnson f0e4298f67 Ensure urlPathname is always a pathname (#63846 ) ### What? This modifies the static generation store to instead store a `url` object with the `pathname` and `search` properties. This corrects the previous behaviour which used the variable `urlPathname` which had ambiguous meanings as it technically contained the search string as well, not just the pathname. In cases during the app render, this still grabs the contents of `url.pathname + url.search` (where `url.search` always has a leading `?` if it has any query parameters, [see the docs](https://developer.mozilla.org/en-US/docs/Web/API/URL/search)) so that it emulates the current behaviour. This allows more specific access though, where now additional parsing can be eliminated which had to strip the query string off of the `urlPathname` in a few places, and more worrisome, still accidentally contained the search string causing errors. ### How? This requires an upstream fix (#64088) which corrected a bug with the store access which had caused some previous test failures (accessing `store.url.pathname` was throwing as `store.url` was undefined on the wrong return, check the upstream PR for more details on that). This also changes out usage of `pagePath` with `route`, and lets it be the fallback (for debugging and error messaging). During static generation, we will provide a value for the page being rendered that's correlated to the particular file on the filesystem that the route is based on: ``` // rendering app/users/[userID]/page.tsx page: /users/[userID] pathname: /users/1, /users/2, etc ``` The `route` is used only for debugging, such as when `generateStaticParams` incorrectly calls `headers()`. This also moves the pathname from the `staticGenerationStore` into the `requestStore`, as it's tied to a given request. Closes NEXT-2965		2024-06-11 12:49:07 -07:00
..
crates	Ensure urlPathname is always a pathname (#63846 )	2024-06-11 12:49:07 -07:00
native
package.json	v15.0.0-canary.25	2024-06-11 00:13:55 +00:00
README.md	chore: fix some typos (#64276 )	2024-04-10 04:04:52 +00:00
turbo.json	next-swc-napi: Enable "plugin" feature by default (#66006 )	2024-05-22 11:09:04 -07:00

README.md

`@next/swc`

This package is responsible for swc compilation customized for next.js

Development

Run tests

cargo test

# Update snapshots and fixtures for tests
UPDATE=1 cargo test

Format code before submitting code

cargo fmt

Build the binary to integrate with next.js

pnpm build-native

Build wasm bindings to integrate with next.js

pnpm build-wasm

napi bindings feature matrix

Due to platform differences napi bindings selectively enables supported features. See below tables for the currently enabled features.

arch\platform	Linux(gnu)	Linux(musl)	Darwin	Win32
ia32				a,b,d,e
x64	a,b,d,e,f	a,b,d,e,f	a,b,d,e,f	a,b,d,e,f
aarch64	a,d,e,f	a,d,e,f	a,b,d,e,f	a,b,c,e

a: turbo_tasks_malloc,
b: turbo_tasks_malloc_custom_allocator,
c: native-tls,
d: rustls-tls,
e: image-extended (webp)
f: plugin

Package hierarchies

@next/swc consist of multiple rust packages to enable features. See below for the high level hierarchies.

flowchart TD
    C(next-custom-transforms) --> A(napi)
    C(next-custom-transforms) --> B(wasm)
    D(next-core) --> A(napi)
    E(next-build) --> A(napi)
    F(next-api) --> A(napi)
    C(next-custom-transforms) --> D
    D(next-core) --> F(next-api)
    D(next-core) --> E(next-build)

next-custom-transforms: provides next-swc specific SWC transform visitors. Turbopack, and the plain next-swc bidnings (transform) use these transforms. Since this is a bottom package can be imported in any place (turbopack / next-swc / wasm), it is important package do not contain specific dependencies. For example, using Turbopack's VC in this package will cause build failures to wasm bindings.
next-core: Implements Turbopack features for the next.js core functionality. This is also the place where Turbopack-specific transform providers (implementing CustomTransformer) lives, which wraps swc's transformer in the next-custom-transforms.
next-api: Binding interface to the next.js provides a proper next.js functionality using next-core.
napi / wasm: The actual binding interfaces, napi for the node.js and wasm for the wasm. Note wasm bindings cannot import packages using turbopack's feature.

To add new swc transforms

Implements a new visitor in next-custom-transforms. It is highly encouraged to use VisitMut instead of Fold for the performance reasons.
Implements a new CustomTransformer under packages/next-swc/crates/next-core/src/next_shared/transforms to make Turbopack's ecma transform plugin, then adjust corresponding rules in packages/next-swc/crates/next-core/src/(next_client|next_server)/context.rs.