Relay Support in Rust Compiler #33240

tbezman · 2022-01-13T03:58:48Z

Feature

Implements feature requested in #30805.

A few people including myself have been looking to use Relay with Next.JS and want to use the new Rust Compiler. This is my stab at an implementation.

How it works?

Finds all graphql tagged template experssions and replaces them with requires to the file generated by Relay.

Where I need help

I've only worked with Rust a handful of times so I would appreciate any feedback on my use of language features.
Is there any performance overhead to many duplicate usages of require? I imagine there's a cache in place but I want to be sure.
I've added some unit tests & integration tests but I might be missing some use cases. Feel free to comment some use cases I'm not thinking about.
Related issues linked using fixes #number
Integration tests added
Documentation added
- I haven't added any docs since this is an experimental API.

Documentation / Examples

You're expected to be running the Relay Compiler along side Next.JS when you're developing. This is pretty standard. I wouldn't expect people to have any problem with this.

Usage

In your next.config.js

module.exports = {
  experimental: {
    relay: {
      language: 'typescript', // or 'javascript`
      artifactDirectory: 'path/to/you/artifact/directory' // you can leave this undefined if you did not specify one in the `relay.json`
    }
  }
}

package.json

packages/next-swc/crates/core/src/relay.rs

timneutkens · 2022-01-13T13:07:45Z

Thanks for this PR! Great work 🎉 I've asked @kdy1 to review it.

kdy1

I didn't review tests yet.

packages/next-swc/crates/core/src/relay.rs

packages/next/server/config-shared.ts

tbezman · 2022-01-13T19:36:29Z

Thanks for the feedback @kdy1 . I'll incorporate your feedback tonight.

tbezman · 2022-01-26T07:46:55Z

Last minute push to fix CI checks.

ijjk · 2022-01-26T08:15:40Z

Stats from current PR

Default Build (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
buildDuration	15.2s	15.3s	⚠️ +74ms
buildDurationCached	3.8s	3.9s	⚠️ +6ms
nodeModulesSize	463 MB	463 MB	⚠️ +483 B

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.79	3.85	⚠️ +0.06
/ avg req/sec	659.63	649.35	⚠️ -10.28
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.992	2.059	⚠️ +0.07
/error-in-render avg req/sec	1254.77	1214.36	⚠️ -40.41

Client Bundles (main, webpack, commons)

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
450.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	27.2 kB	27.2 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	71 kB	71 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
_app-HASH.js gzip	1.37 kB	1.37 kB	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	312 B	312 B	✓
css-HASH.js gzip	326 B	326 B	✓
dynamic-HASH.js gzip	2.37 kB	2.37 kB	✓
head-HASH.js gzip	350 B	350 B	✓
hooks-HASH.js gzip	919 B	919 B	✓
image-HASH.js gzip	4.94 kB	4.94 kB	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	2.19 kB	2.19 kB	✓
routerDirect..HASH.js gzip	321 B	321 B	✓
script-HASH.js gzip	383 B	383 B	✓
withRouter-HASH.js gzip	318 B	318 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	14.4 kB	14.4 kB	✓

Client Build Manifests

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
_buildManifest.js gzip	460 B	460 B	✓
Overall change	460 B	460 B	✓

Rendered Page Sizes

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
index.html gzip	531 B	531 B	✓
link.html gzip	545 B	545 B	✓
withRouter.html gzip	526 B	526 B	✓
Overall change	1.6 kB	1.6 kB	✓

Default Build with SWC (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
buildDuration	19.4s	19.5s	⚠️ +22ms
buildDurationCached	3.8s	3.8s	⚠️ +47ms
nodeModulesSize	463 MB	463 MB	⚠️ +483 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.784	3.829	⚠️ +0.05
/ avg req/sec	660.6	652.97	⚠️ -7.63
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.051	2.016	-0.04
/error-in-render avg req/sec	1218.98	1239.87	+20.89

Client Bundles (main, webpack, commons)

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
450.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.3 kB	42.3 kB	✓
main-HASH.js gzip	27.3 kB	27.3 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	71.3 kB	71.3 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
_app-HASH.js gzip	1.35 kB	1.35 kB	✓
_error-HASH.js gzip	180 B	180 B	✓
amp-HASH.js gzip	305 B	305 B	✓
css-HASH.js gzip	321 B	321 B	✓
dynamic-HASH.js gzip	2.36 kB	2.36 kB	✓
head-HASH.js gzip	342 B	342 B	✓
hooks-HASH.js gzip	911 B	911 B	✓
image-HASH.js gzip	4.97 kB	4.97 kB	✓
index-HASH.js gzip	256 B	256 B	✓
link-HASH.js gzip	2.21 kB	2.21 kB	✓
routerDirect..HASH.js gzip	314 B	314 B	✓
script-HASH.js gzip	375 B	375 B	✓
withRouter-HASH.js gzip	309 B	309 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	14.3 kB	14.3 kB	✓

Client Build Manifests

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
_buildManifest.js gzip	459 B	459 B	✓
Overall change	459 B	459 B	✓

Rendered Page Sizes

	vercel/next.js canary	tbezman/next.js relay-plugin	Change
index.html gzip	529 B	529 B	✓
link.html gzip	543 B	543 B	✓
withRouter.html gzip	525 B	525 B	✓
Overall change	1.6 kB	1.6 kB	✓

Commit: 464dd97

hanford · 2022-01-26T15:37:45Z

Woo! thanks again for all the work on this friends

This reverts commit b20eb99.

tbezman · 2022-01-26T22:07:33Z

@timneutkens When will we see a new version published. Does this happen automatically?

ijjk · 2022-01-26T22:13:24Z

@tbezman there were some issues with the release with these changes, see #33702 for more info.

alex-statsig · 2022-02-07T02:54:27Z

Does something need to be done to make this work with jest as well? This works for me builds, but tests using the setup from docs (https://nextjs.org/docs/advanced-features/compiler) fail to transform graphql calls

timneutkens · 2022-02-10T10:55:25Z

@alex-statsig are you using next/jest?

hanford · 2022-02-10T17:12:45Z

@alex-statsig I still use babel-relay-plugin for tests, I was able to only use babel during tests (we removed our babel config to enable SWC) with the following jest config:

module.exports = {
  ..

  transform: {
    '^.+\\.(js|jsx|ts|tsx)$': [
      'babel-jest',
      {
        presets: [
          [
            'next/babel',
            {
              'preset-react': {
                runtime: 'automatic',
                importSource: '@emotion/react',
              },
            },
          ],
        ],
        plugins: [
          [
            'relay',
            {
              src: './',
              artifactDirectory: '../../dazzle-types',
              schema: '../apps/weaver/schemas/__generated__/main.graphql',
              language: 'typescript',
            },
          ],
        ],
      },
    ],
  },
}

alex-statsig · 2022-02-10T22:50:09Z

@hanford Thanks, I'll try that - had fully removed our config hoping that "next/jest" would handle it.

@timneutkens Yes I was, same setup as linked in that doc. I'll try it out again shortly

## Feature Implements feature requested in vercel#30805. A few people including myself have been looking to use Relay with Next.JS and want to use the new Rust Compiler. This is my stab at an implementation. ### How it works? Finds all `graphql` tagged template experssions and replaces them with `require`s to the file generated by Relay. ### Where I need help - I've only worked with Rust a handful of times so I would appreciate any feedback on my use of language features. - Is there any performance overhead to many duplicate usages of `require`? I imagine there's a cache in place but I want to be sure. - I've added some unit tests & integration tests but I might be missing some use cases. Feel free to comment some use cases I'm not thinking about. - [x] Related issues linked using `fixes #number` - [x] Integration tests added - [ ] Documentation added - I haven't added any docs since this is an experimental API. ## Documentation / Examples You're expected to be running the Relay Compiler along side Next.JS when you're developing. This is pretty standard. I wouldn't expect people to have any problem with this. ### Usage In your `next.config.js` ```js module.exports = { experimental: { relay: { language: 'typescript', // or 'javascript` artifactDirectory: 'path/to/you/artifact/directory' // you can leave this undefined if you did not specify one in the `relay.json` } } } ``` Co-authored-by: Tim Neutkens <6324199+timneutkens@users.noreply.github.com>

tbezman added 7 commits January 11, 2022 18:37

Add support for relay compiler imports

2aaa426

Add relay deps for integration tests

f794fcf

Add integration test for Relay SWC Compiler

6c966d2

More exhaustive tests

8ee3e6c

Remove dead code

46e2534

Pass through relay config from next config

66e6859

Run relay compiler when running integration test

eb88c71

ijjk added the type: next label Jan 13, 2022

tbezman commented Jan 13, 2022

View reviewed changes

package.json Show resolved Hide resolved

Remove more dead code

4ef5e23

tbezman commented Jan 13, 2022

View reviewed changes

packages/next-swc/crates/core/src/relay.rs Outdated Show resolved Hide resolved

tbezman commented Jan 13, 2022

View reviewed changes

packages/next-swc/crates/core/src/relay.rs Show resolved Hide resolved

tbezman marked this pull request as ready for review January 13, 2022 04:02

tbezman requested review from huozhi, ijjk, padmaia, shuding and timneutkens as code owners January 13, 2022 04:02

Merge branch 'canary' into relay-plugin

90d3bce

tbezman mentioned this pull request Jan 13, 2022

Port Relay Babel plugin to SWC #30805

Closed

kdy1 requested changes Jan 13, 2022

View reviewed changes

This comment has been minimized.

Sign in to view

hanford mentioned this pull request Jan 13, 2022

Relay without babel in 2021: Where do we stand with next-gen JS bundlers? facebook/relay#3319

Open

alunyov reviewed Jan 13, 2022

View reviewed changes

packages/next-swc/crates/core/src/relay.rs Outdated Show resolved Hide resolved

alunyov reviewed Jan 13, 2022

View reviewed changes

packages/next-swc/crates/core/src/relay.rs Outdated Show resolved Hide resolved

alunyov reviewed Jan 13, 2022

View reviewed changes

packages/next/server/config-shared.ts Outdated Show resolved Hide resolved

tbezman added 2 commits January 13, 2022 17:50

Remove useless to_string and String::from

718929c

Remove clone in favor of borrowing

6d03ee9

Add better docs for CouldNotCategorize error

b5f89bc

timneutkens previously approved these changes Jan 26, 2022

View reviewed changes

This comment has been minimized.

Sign in to view

tbezman added 2 commits January 25, 2022 23:45

Add relay: false to full test suite

1682ac3

Prettier fix

464dd97

tbezman dismissed timneutkens’s stale review via 464dd97 January 26, 2022 07:46

timneutkens approved these changes Jan 26, 2022

View reviewed changes

kodiakhq bot merged commit b20eb99 into vercel:canary Jan 26, 2022

ijjk added a commit that referenced this pull request Jan 26, 2022

Revert "Relay Support in Rust Compiler (#33240)"

8f47df2

This reverts commit b20eb99.

ijjk mentioned this pull request Jan 26, 2022

Revert "Relay Support in Rust Compiler" #33699

Merged

wongmjane mentioned this pull request Jan 31, 2022

Relay Support in Rust Compiler #33702

Merged

github-actions bot locked as resolved and limited conversation to collaborators Mar 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Relay Support in Rust Compiler #33240

Relay Support in Rust Compiler #33240

tbezman commented Jan 13, 2022 •

edited

timneutkens commented Jan 13, 2022

kdy1 left a comment

This comment has been minimized.

tbezman commented Jan 13, 2022

This comment has been minimized.

tbezman commented Jan 26, 2022

ijjk commented Jan 26, 2022

hanford commented Jan 26, 2022

tbezman commented Jan 26, 2022

ijjk commented Jan 26, 2022

alex-statsig commented Feb 7, 2022

timneutkens commented Feb 10, 2022

hanford commented Feb 10, 2022 •

edited

alex-statsig commented Feb 10, 2022

Navigation Menu

Relay Support in Rust Compiler #33240

Relay Support in Rust Compiler #33240

Conversation

tbezman commented Jan 13, 2022 • edited

Feature

How it works?

Where I need help

Documentation / Examples

Usage

timneutkens commented Jan 13, 2022

kdy1 left a comment

Choose a reason for hiding this comment

This comment has been minimized.

tbezman commented Jan 13, 2022

This comment has been minimized.

tbezman commented Jan 26, 2022

ijjk commented Jan 26, 2022

Stats from current PR

hanford commented Jan 26, 2022

tbezman commented Jan 26, 2022

ijjk commented Jan 26, 2022

alex-statsig commented Feb 7, 2022

timneutkens commented Feb 10, 2022

hanford commented Feb 10, 2022 • edited

alex-statsig commented Feb 10, 2022

tbezman commented Jan 13, 2022 •

edited

hanford commented Feb 10, 2022 •

edited