[epic] [v13] List of current issues, missing features and possible improvements in the new compiler (and relay)

[alunyov]

Here we will keep track of the progress of the release/adoption of the new compiler in OSS.

If there is something that is blocking you from adopting the new compiler (and it is not mentioned in this list) please create a new issue, we will review and add it to the list/or trying help with the fix.

The goal: help prioritizing critical bug-fixes/features for upcoming v13.0.2 release (and beyond).

Current Reported Issues:

Bugs:

• MockPayloadGenerator: __typename mocking depends on generated request ordering #3744
• [relay-compiler 13] compiler panic for client-only operations: Expected to have a operation_text operation. #3760
• relay-compiler 13.0.1 fails when schema is in __generated__ directory #3737
• Error message source locations are incorrect #3735
• [v13] relay-compiler generates require calls instead of top-level imports when eagerEsModules #3726
• [relay-compiler 13] The root of subscription must be a simple selection #3703 - should be fixed with relay-compiler@main
• V13: relay-compiler not running in CI  #3725 - possible fix is Relay Compiler v13: Providing a statically linked binary? #3739
• [relay-compiler][v13] --config option is not supported (missing, but should be available) #3801
• with CLI options typescript is the default language - should be flow. #3802

Missing Features:

• Support for schema enum extensions? #3748
• [relay v13] Relay compiler throws 'Unsupported (user-defined) scalar type' error for scalars as arguments #3730
• [relay 13] Rust Compiler does not generate enum files #3681
• Add a JSON file query persister strategy to relay-compiler #3666
• relay-compiler --validate option no longer available #3738

Possible Improvements:

• Relay 13: @no_inline directive doesn't work correctly for fragments in a different directory (non-Haste mode) #3742
• Compiler: Flow Enums with Unknown Members instead of "%future added value" #3596
• Rust compiler: purging non-Relay files from __generated__ folders #3438 - note, we now allow some files (.gitkeep/REAMDE to be in the artifactDirectory)
• relay-compiler 13.0.1 writes to stderr #3743
• Relay Compiler v13: Providing a statically linked binary? #3739
• Add support for .gql file extensions for schema files. See [relay-compiler 13] thread panic when using .gql extension schema file #3772

[seanaguinaga]

Documentation has a few TODOs - not sure if that's related or I should make a separate issue

[bigfootjon]

Would OSS support for EntryPoint (which AFAICT just means generating $Parameters.js files, and writing docs) be a good thing to mention under "Possible Improvements:"?

[mikeldking]

Just migrated a large code base to 13.1.1
Main pain-points I had:

• Wasn't clear that the relay-compiler doesn't support --config flag anymore
• We used relay-config which is no longer supported. Also the config file needs to be JSON instead of JS.
• New relay hook type signature changes and changes in type exports from relay-compiler. They are cleaner but it took quite a bit of refactoring.
• relay-compiler defaulted to typescript without a config - this doesn't match the docs?

Thanks for all the improvements! Excited to be on 13.

[alunyov]

Thanks @mikeldking !

I think 1,2 items are probably connected. We do support --config flag, but it is probably cannot read JS files.

relay/compiler/crates/relay-compiler/src/main.rs

Lines 120 to 121 in ec98987

	let config_result = if let Some(config_path) = opt.config {
	Config::load(config_path)

Typescript should not be a default language, maybe you have other config that have typescript in it?

relay/compiler/crates/relay-config/src/typegen_config.rs

Lines 25 to 27 in ec98987

	fn default() -> Self {
	Self::Flow
	}

[mikeldking]

Hey thanks for the response @alunyov

I forked the examples to show what I'm seeing: relayjs/relay-examples#208

Issue 1 (--config not supported)

If you run yarn build:with-config-option (e.g. relay-compiler --config ./relay.config.json) you will get

➜  todo git:(relay-compiler-bug-demo) ✗ (⎈ |mynamespace:mikeldking) yarn build:with-config-option
yarn run v1.22.17
warning ../../../package.json: No license field
$ relay-compiler --config ./relay.config.json
error: Found argument '--config' which wasn't expected, or isn't valid in this context

	If you tried to supply `--config` as a value rather than a flag, use `-- --config`

USAGE:
    relay [OPTIONS] [CONFIG]

For more information try --help
error Command failed with exit code 2.

This diverged (seems to be fixed?) from the docs so it caused some confusion.

Previously you could mix CLI option flags with a config file but now you cannot. E.g. the only valid syntax in this case is relay-compiler ./relay.config.json. We were using a relay.config.js as a base config for two relay compilation steps (two different entry points into our app). We now have a relay.xxx.config.json and a relay.yyy.config.json to accomplish the two compilations.

Issue 2 (typescript default when using options)

You are right, in the case where there is no language specified in the config file, it defaults to flow. However in the case you run the compiler with flags (yarn build:with-options or relay-compiler --schema ./data/schema.graphql --src ./js --artifactDirectory ./__generated__/relay), you will get typescript emitted.

See video:

Screen.Recording.2022-02-17.at.10.29.07.AM.mov

Hope that helps clarify things!

[alunyov]

Thanks @mikeldking for detailed report!

[simkessy]

the old compiler used to output the changed files, is this something that was removed?

[alunyov]

the old compiler used to output the changed files, is this something that was removed?

Hmm, can you create an issue for this? With the possible example/repro to better understand what output should have changed files?