Correctly type empty variables in TypeScript (#4404)

Summary: Previously the compiler produced `{}` for empty objects in TypeScript. This is for example the case for the `...$variables` type, if no variables are present. The problem is that `{}` does not mean "empty object" in TypeScript. It means "any value except null and undefined". Because of this you're able to input **anything** besides those two values as variables for an operation without variables. I opted to produce the more appropriate `Record<PropertyKey, never>`, which effectively represents an object without properties. Pull Request resolved: #4404 Reviewed By: alunyov Differential Revision: D48989147 Pulled By: captbaritone fbshipit-source-id: 67bad8a670496a3caf7b2a3c439a8ff0b283793d
facebook · Oct 6, 2023 · 16910c9 · 16910c9
1 parent cc47bc9
commit 16910c9
Show file tree

Hide file tree

Showing 23 changed files with 28 additions and 28 deletions.
diff --git a/compiler/crates/relay-typegen/src/typescript.rs b/compiler/crates/relay-typegen/src/typescript.rs
@@ -236,15 +236,15 @@ impl TypeScriptPrinter {
 
     fn write_object(&mut self, props: &[Prop]) -> FmtResult {
         if props.is_empty() {
-            write!(&mut self.result, "{{}}")?;
+            write!(&mut self.result, "Record<PropertyKey, never>")?;
             return Ok(());
         }
 
         // Replication of babel printer oddity: objects only containing a spread
         // are missing a newline.
         if props.len() == 1 {
             if let Prop::Spread(_) = props[0] {
-                write!(&mut self.result, "{{}}")?;
+                write!(&mut self.result, "Record<PropertyKey, never>")?;
                 return Ok(());
             }
         }
@@ -413,7 +413,7 @@ mod tests {
     fn exact_object() {
         assert_eq!(
             print_type(&AST::ExactObject(ExactObject::new(Vec::new()))),
-            r"{}".to_string()
+            r"Record<PropertyKey, never>".to_string()
         );
 
         assert_eq!(
@@ -498,7 +498,7 @@ mod tests {
     fn inexact_object() {
         assert_eq!(
             print_type(&AST::InexactObject(InexactObject::new(Vec::new()))),
-            "{}".to_string()
+            "Record<PropertyKey, never>".to_string()
         );
 
         assert_eq!(

diff --git a/...ay-typegen/tests/generate_typescript/fixtures/aliased-fragment-raw-response-type.expected b/...ay-typegen/tests/generate_typescript/fixtures/aliased-fragment-raw-response-type.expected
@@ -13,7 +13,7 @@ fragment MyUserFragment on User {
 }
 ==================================== OUTPUT ===================================
 import { FragmentRefs } from "relay-runtime";
-export type MyQuery$variables = {};
+export type MyQuery$variables = Record<PropertyKey, never>;
 export type MyQuery$data = {
   readonly me: {
     readonly my_inline_fragment: {

diff --git a/...tests/generate_typescript/fixtures/aliased-fragment-spread-in-abstract-selection.expected b/...tests/generate_typescript/fixtures/aliased-fragment-spread-in-abstract-selection.expected
@@ -10,7 +10,7 @@ query RelayReaderNamedFragmentsTest2Query {
 }
 ==================================== OUTPUT ===================================
 import { FragmentRefs } from "relay-runtime";
-export type RelayReaderNamedFragmentsTest2Query$variables = {};
+export type RelayReaderNamedFragmentsTest2Query$variables = Record<PropertyKey, never>;
 export type RelayReaderNamedFragmentsTest2Query$data = {
   readonly node: {
     readonly named_fragment: {

diff --git a/.../crates/relay-typegen/tests/generate_typescript/fixtures/aliased-fragment-spread.expected b/.../crates/relay-typegen/tests/generate_typescript/fixtures/aliased-fragment-spread.expected
@@ -10,7 +10,7 @@ query RelayReaderNamedFragmentsTest2Query {
 }
 ==================================== OUTPUT ===================================
 import { FragmentRefs } from "relay-runtime";
-export type RelayReaderNamedFragmentsTest2Query$variables = {};
+export type RelayReaderNamedFragmentsTest2Query$variables = Record<PropertyKey, never>;
 export type RelayReaderNamedFragmentsTest2Query$data = {
   readonly me: {
     readonly named_fragment: {

diff --git a/...ript/fixtures/aliased-inline-fragment-spread-without-type-condition-linked-field.expected b/...ript/fixtures/aliased-inline-fragment-spread-without-type-condition-linked-field.expected
@@ -8,7 +8,7 @@ query RelayReaderNamedFragmentsTest2Query {
   }
 }
 ==================================== OUTPUT ===================================
-export type RelayReaderNamedFragmentsTest2Query$variables = {};
+export type RelayReaderNamedFragmentsTest2Query$variables = Record<PropertyKey, never>;
 export type RelayReaderNamedFragmentsTest2Query$data = {
   readonly me: {
     readonly id: string;

diff --git a/...script/fixtures/aliased-inline-fragment-spread-without-type-condition-query-root.expected b/...script/fixtures/aliased-inline-fragment-spread-without-type-condition-query-root.expected
@@ -8,7 +8,7 @@ query RelayReaderNamedFragmentsTest2Query {
   }
 }
 ==================================== OUTPUT ===================================
-export type RelayReaderNamedFragmentsTest2Query$variables = {};
+export type RelayReaderNamedFragmentsTest2Query$variables = Record<PropertyKey, never>;
 export type RelayReaderNamedFragmentsTest2Query$data = {
   readonly named_fragment: {
     readonly me: {

diff --git a/.../relay-typegen/tests/generate_typescript/fixtures/aliased-inline-fragment-spread.expected b/.../relay-typegen/tests/generate_typescript/fixtures/aliased-inline-fragment-spread.expected
@@ -8,7 +8,7 @@ query RelayReaderNamedFragmentsTest2Query {
   }
 }
 ==================================== OUTPUT ===================================
-export type RelayReaderNamedFragmentsTest2Query$variables = {};
+export type RelayReaderNamedFragmentsTest2Query$variables = Record<PropertyKey, never>;
 export type RelayReaderNamedFragmentsTest2Query$data = {
   readonly me: {
     readonly id: string;

diff --git a/compiler/crates/relay-typegen/tests/generate_typescript/fixtures/linked-field.expected b/compiler/crates/relay-typegen/tests/generate_typescript/fixtures/linked-field.expected
@@ -27,7 +27,7 @@ query UnionTypeTest {
   }
 }
 ==================================== OUTPUT ===================================
-export type UnionTypeTest$variables = {};
+export type UnionTypeTest$variables = Record<PropertyKey, never>;
 export type UnionTypeTest$data = {
   readonly neverNode: {
     readonly __typename: "FakeNode";

diff --git a/...ler/crates/relay-typegen/tests/generate_typescript/fixtures/match-field-in-query.expected b/...ler/crates/relay-typegen/tests/generate_typescript/fixtures/match-field-in-query.expected
@@ -24,7 +24,7 @@ fragment MarkdownUserNameRenderer_name on MarkdownUserNameRenderer {
 }
 ==================================== OUTPUT ===================================
 import { FragmentRefs } from "relay-runtime";
-export type NameRendererQuery$variables = {};
+export type NameRendererQuery$variables = Record<PropertyKey, never>;
 export type NameRendererQuery$data = {
   readonly me: {
     readonly nameRenderer: {

diff --git a/.../crates/relay-typegen/tests/generate_typescript/fixtures/query-with-match-fields.expected b/.../crates/relay-typegen/tests/generate_typescript/fixtures/query-with-match-fields.expected
@@ -29,7 +29,7 @@ fragment MarkdownUserNameRenderer_name on MarkdownUserNameRenderer {
 }
 ==================================== OUTPUT ===================================
 import { FragmentRefs, Local3DPayload } from "relay-runtime";
-export type Test$variables = {};
+export type Test$variables = Record<PropertyKey, never>;
 export type Test$data = {
   readonly node: {
     readonly " $fragmentSpreads": FragmentRefs<"NameRendererFragment">;

diff --git a/.../crates/relay-typegen/tests/generate_typescript/fixtures/query-with-module-field.expected b/.../crates/relay-typegen/tests/generate_typescript/fixtures/query-with-module-field.expected
@@ -18,7 +18,7 @@ fragment Test_userRenderer on PlainUserRenderer {
 }
 ==================================== OUTPUT ===================================
 import { FragmentRefs, Local3DPayload } from "relay-runtime";
-export type Test$variables = {};
+export type Test$variables = Record<PropertyKey, never>;
 export type Test$data = {
   readonly node: {
     readonly " $fragmentSpreads": FragmentRefs<"Test_user">;
@@ -34,7 +34,7 @@ export type Test$rawResponse = {
   readonly node: {
     readonly __typename: "User";
     readonly id: string;
-    readonly plainUserRenderer: Local3DPayload<"Test_user", {}> | {
+    readonly plainUserRenderer: Local3DPayload<"Test_user", Record<PropertyKey, never>> | {
       readonly __module_component_Test_user: any | null | undefined;
       readonly __module_operation_Test_user: any | null | undefined;
     } | null | undefined;

diff --git a/...elay-typegen/tests/generate_typescript/fixtures/query-with-multiple-match-fields.expected b/...elay-typegen/tests/generate_typescript/fixtures/query-with-multiple-match-fields.expected
@@ -49,7 +49,7 @@ fragment MarkdownUserNameRenderer_name on MarkdownUserNameRenderer {
 }
 ==================================== OUTPUT ===================================
 import { FragmentRefs, Local3DPayload } from "relay-runtime";
-export type Test$variables = {};
+export type Test$variables = Record<PropertyKey, never>;
 export type Test$data = {
   readonly node: {
     readonly username?: string | null | undefined;

diff --git a/...es/relay-typegen/tests/generate_typescript/fixtures/query-with-stream-connection.expected b/...es/relay-typegen/tests/generate_typescript/fixtures/query-with-stream-connection.expected
@@ -17,7 +17,7 @@ query TestDefer @raw_response_type {
   }
 }
 ==================================== OUTPUT ===================================
-export type TestDefer$variables = {};
+export type TestDefer$variables = Record<PropertyKey, never>;
 export type TestDefer$data = {
   readonly node: {
     readonly friends?: {

diff --git a/compiler/crates/relay-typegen/tests/generate_typescript/fixtures/query-with-stream.expected b/compiler/crates/relay-typegen/tests/generate_typescript/fixtures/query-with-stream.expected
@@ -18,7 +18,7 @@ query TestStream @raw_response_type {
   }
 }
 ==================================== OUTPUT ===================================
-export type TestStream$variables = {};
+export type TestStream$variables = Record<PropertyKey, never>;
 export type TestStream$data = {
   readonly node: {
     readonly friends?: {

diff --git a/...ts/generate_typescript/fixtures/relay-resolver-with-output-type-client-interface.expected b/...ts/generate_typescript/fixtures/relay-resolver-with-output-type-client-interface.expected
@@ -36,7 +36,7 @@ extend type User {
   pop_star_game: ClientTypeWithNestedInterface @relay_resolver(fragment_name: "PopStarNameResolverFragment_name", import_path: "PopStarNameResolver", has_output_type: true)
 }
 ==================================== OUTPUT ===================================
-export type User__pop_star_game$normalization$variables = {};
+export type User__pop_star_game$normalization$variables = Record<PropertyKey, never>;
 export type User__pop_star_game$normalization$data = {
   readonly client_interface: {
     readonly __typename: "ClientType";
@@ -52,7 +52,7 @@ export type User__pop_star_game$normalization = {
   variables: User__pop_star_game$normalization$variables;
 };
 -------------------------------------------------------------------------------
-export type User__pop_star_name$normalization$variables = {};
+export type User__pop_star_name$normalization$variables = Record<PropertyKey, never>;
 export type User__pop_star_name$normalization$data = {
   readonly __typename: "ClientType";
   readonly name: string | null | undefined;

diff --git a/...tests/generate_typescript/fixtures/relay-resolver-with-output-type-client-object.expected b/...tests/generate_typescript/fixtures/relay-resolver-with-output-type-client-object.expected
@@ -27,7 +27,7 @@ extend type User {
   pop_star_name: ClientUser @relay_resolver(fragment_name: "PopStarNameResolverFragment_name", import_path: "PopStarNameResolver", has_output_type: true)
 }
 ==================================== OUTPUT ===================================
-export type User__pop_star_name$normalization$variables = {};
+export type User__pop_star_name$normalization$variables = Record<PropertyKey, never>;
 export type User__pop_star_name$normalization$data = {
   readonly name: string | null | undefined;
 };

diff --git a/...rates/relay-typegen/tests/generate_typescript/fixtures/required-bubbles-to-query.expected b/...rates/relay-typegen/tests/generate_typescript/fixtures/required-bubbles-to-query.expected
@@ -6,7 +6,7 @@ query FooQuery {
   }
 }
 ==================================== OUTPUT ===================================
-export type FooQuery$variables = {};
+export type FooQuery$variables = Record<PropertyKey, never>;
 export type FooQuery$data = {
   readonly me: {
     readonly firstName: string | null | undefined;

diff --git a/...ates/relay-typegen/tests/generate_typescript/fixtures/required-raw-response-type.expected b/...ates/relay-typegen/tests/generate_typescript/fixtures/required-raw-response-type.expected
@@ -6,7 +6,7 @@ query MyQuery @raw_response_type {
   }
 }
 ==================================== OUTPUT ===================================
-export type MyQuery$variables = {};
+export type MyQuery$variables = Record<PropertyKey, never>;
 export type MyQuery$data = {
   readonly me: {
     readonly id: string;

diff --git a/...ypegen/tests/generate_typescript/fixtures/required-throw-doesnt-bubbles-to-query.expected b/...ypegen/tests/generate_typescript/fixtures/required-throw-doesnt-bubbles-to-query.expected
@@ -6,7 +6,7 @@ query FooQuery {
   }
 }
 ==================================== OUTPUT ===================================
-export type FooQuery$variables = {};
+export type FooQuery$variables = Record<PropertyKey, never>;
 export type FooQuery$data = {
   readonly me: {
     readonly firstName: string | null | undefined;

diff --git a/...r/crates/relay-typegen/tests/generate_typescript/fixtures/required-throws-nested.expected b/...r/crates/relay-typegen/tests/generate_typescript/fixtures/required-throws-nested.expected
@@ -6,7 +6,7 @@ query FooQuery {
   }
 }
 ==================================== OUTPUT ===================================
-export type FooQuery$variables = {};
+export type FooQuery$variables = Record<PropertyKey, never>;
 export type FooQuery$data = {
   readonly me: {
     readonly firstName: string | null | undefined;

diff --git a/...generate_typescript/fixtures/required-within-aliased-inline-fragment-on-abstract.expected b/...generate_typescript/fixtures/required-within-aliased-inline-fragment-on-abstract.expected
@@ -7,7 +7,7 @@ query RelayReaderNamedFragmentsTest2Query {
   }
 }
 ==================================== OUTPUT ===================================
-export type RelayReaderNamedFragmentsTest2Query$variables = {};
+export type RelayReaderNamedFragmentsTest2Query$variables = Record<PropertyKey, never>;
 export type RelayReaderNamedFragmentsTest2Query$data = {
   readonly node: {
     readonly named_fragment: {

diff --git a/...pegen/tests/generate_typescript/fixtures/required-within-aliased-inline-fragment.expected b/...pegen/tests/generate_typescript/fixtures/required-within-aliased-inline-fragment.expected
@@ -8,7 +8,7 @@ query RelayReaderNamedFragmentsTest2Query {
   }
 }
 ==================================== OUTPUT ===================================
-export type RelayReaderNamedFragmentsTest2Query$variables = {};
+export type RelayReaderNamedFragmentsTest2Query$variables = Record<PropertyKey, never>;
 export type RelayReaderNamedFragmentsTest2Query$data = {
   readonly me: {
     readonly id: string;

diff --git a/compiler/crates/relay-typegen/tests/generate_typescript/fixtures/required.expected b/compiler/crates/relay-typegen/tests/generate_typescript/fixtures/required.expected
@@ -6,7 +6,7 @@ query FooQuery {
   }
 }
 ==================================== OUTPUT ===================================
-export type FooQuery$variables = {};
+export type FooQuery$variables = Record<PropertyKey, never>;
 export type FooQuery$data = {
   readonly me: {
     readonly firstName: string | null | undefined;