Document __typename and __id in LSP hover

Reviewed By: alunyov Differential Revision: D39375625 fbshipit-source-id: e6266ac1b0305eae885ac488bd452e135f82a800
facebook · Sep 9, 2022 · 298af34 · 298af34
1 parent d24c295
commit 298af34
Show file tree

Hide file tree

Showing 14 changed files with 117 additions and 24 deletions.
diff --git a/compiler/crates/relay-lsp/tests/hover/fixtures/double_underscore_id_field.expected b/compiler/crates/relay-lsp/tests/hover/fixtures/double_underscore_id_field.expected
@@ -0,0 +1,14 @@
+==================================== INPUT ====================================
+query MyQuery {
+  me {
+    _|_id
+  }
+}
+==================================== OUTPUT ===================================
+Field: **__id**
+--
+Relay's cache key for this object.
+--
+Type: **[ID!](command:nuclide.relay-lsp.openSchemaExplorer?{%22path%22:[%22Query%22,%22User%22,%22ID%22],%22schemaName%22:%22Some%20Schema%20Name%22})**
+--
+**Client Schema Extension**: This field was declared as a Relay Client Schema Extension, and is therefore only avalaible in Relay code. [Learn More](https://relay.dev/docs/guided-tour/updating-data/client-only-data/#client-only-data-client-schema-extensions).
diff --git a/compiler/crates/relay-lsp/tests/hover/fixtures/double_underscore_id_field.graphql b/compiler/crates/relay-lsp/tests/hover/fixtures/double_underscore_id_field.graphql
@@ -0,0 +1,5 @@
+query MyQuery {
+  me {
+    _|_id
+  }
+}
diff --git a/compiler/crates/relay-lsp/tests/hover/fixtures/double_underscore_typename_field.expected b/compiler/crates/relay-lsp/tests/hover/fixtures/double_underscore_typename_field.expected
@@ -0,0 +1,12 @@
+==================================== INPUT ====================================
+query MyQuery {
+  me {
+    _|_typename
+  }
+}
+==================================== OUTPUT ===================================
+Field: **__typename**
+--
+This object's GraphQL type. Provided by GraphQL type name introspection.
+--
+Type: **[String!](command:nuclide.relay-lsp.openSchemaExplorer?{%22path%22:[%22Query%22,%22User%22,%22String%22],%22schemaName%22:%22Some%20Schema%20Name%22})**
diff --git a/compiler/crates/relay-lsp/tests/hover/fixtures/double_underscore_typename_field.graphql b/compiler/crates/relay-lsp/tests/hover/fixtures/double_underscore_typename_field.graphql
@@ -0,0 +1,5 @@
+query MyQuery {
+  me {
+    _|_typename
+  }
+}
diff --git a/compiler/crates/relay-lsp/tests/hover_test.rs b/compiler/crates/relay-lsp/tests/hover_test.rs
@@ -4,14 +4,28 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @generated SignedSource<<6daa50c6d4e1f509314b7c28a29bf686>>
+ * @generated SignedSource<<7e6c48eb62c1d815fb6644cb2e6e3bb3>>
  */
 
 mod hover;
 
 use hover::transform_fixture;
 use fixture_tests::test_fixture;
 
+#[test]
+fn double_underscore_id_field() {
+    let input = include_str!("hover/fixtures/double_underscore_id_field.graphql");
+    let expected = include_str!("hover/fixtures/double_underscore_id_field.expected");
+    test_fixture(transform_fixture, "double_underscore_id_field.graphql", "hover/fixtures/double_underscore_id_field.expected", input, expected);
+}
+
+#[test]
+fn double_underscore_typename_field() {
+    let input = include_str!("hover/fixtures/double_underscore_typename_field.graphql");
+    let expected = include_str!("hover/fixtures/double_underscore_typename_field.expected");
+    test_fixture(transform_fixture, "double_underscore_typename_field.graphql", "hover/fixtures/double_underscore_typename_field.expected", input, expected);
+}
+
 #[test]
 fn fragment_definition_name() {
     let input = include_str!("hover/fixtures/fragment_definition_name.graphql");

diff --git a/compiler/crates/schema/src/field_descriptions.rs b/compiler/crates/schema/src/field_descriptions.rs
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+use intern::string_key::Intern;
+use intern::string_key::StringKey;
+use lazy_static::lazy_static;
+
+lazy_static! {
+    pub static ref CLIENT_ID_DESCRIPTION: StringKey = "Relay's cache key for this object.".intern();
+    pub static ref TYPENAME_DESCRIPTION: StringKey =
+        "This object's GraphQL type. Provided by GraphQL type name introspection.".intern();
+}
diff --git a/compiler/crates/schema/src/flatbuffer/wrapper.rs b/compiler/crates/schema/src/flatbuffer/wrapper.rs
@@ -18,6 +18,8 @@ use intern::string_key::StringKey;
 use ouroboros::self_referencing;
 
 use super::FlatBufferSchema;
+use crate::field_descriptions::CLIENT_ID_DESCRIPTION;
+use crate::field_descriptions::TYPENAME_DESCRIPTION;
 use crate::Argument;
 use crate::ArgumentDefinitions;
 use crate::Directive;
@@ -122,16 +124,18 @@ impl SchemaWrapper {
             parent_type: None,
             description: None,
         });
-        result.fields.get(CLIENTID_FIELD_ID, || Field {
-            name: WithLocation::generated(result.clientid_field_name),
-            is_extension: true,
-            arguments: ArgumentDefinitions::new(Default::default()),
-            type_: TypeReference::NonNull(Box::new(TypeReference::Named(
-                result.get_type("ID".intern()).unwrap(),
-            ))),
-            directives: Vec::new(),
-            parent_type: None,
-            description: None,
+        result.fields.get(CLIENTID_FIELD_ID, || -> Field {
+            Field {
+                name: WithLocation::generated(result.clientid_field_name),
+                is_extension: true,
+                arguments: ArgumentDefinitions::new(Default::default()),
+                type_: TypeReference::NonNull(Box::new(TypeReference::Named(
+                    result.get_type("ID".intern()).unwrap(),
+                ))),
+                directives: Vec::new(),
+                parent_type: None,
+                description: Some(*CLIENT_ID_DESCRIPTION),
+            }
         });
         result.fields.get(STRONGID_FIELD_ID, || Field {
             name: WithLocation::generated(result.strongid_field_name),
@@ -140,7 +144,7 @@ impl SchemaWrapper {
             type_: TypeReference::Named(result.get_type("ID".intern()).unwrap()),
             directives: Vec::new(),
             parent_type: None,
-            description: None,
+            description: Some(*TYPENAME_DESCRIPTION),
         });
         result.fields.get(FETCH_TOKEN_FIELD_ID, || Field {
             name: WithLocation::generated(result.fetch_token_field_name),

diff --git a/compiler/crates/schema/src/in_memory/mod.rs b/compiler/crates/schema/src/in_memory/mod.rs
@@ -23,6 +23,8 @@ use crate::definitions::Argument;
 use crate::definitions::Directive;
 use crate::definitions::*;
 use crate::errors::SchemaError;
+use crate::field_descriptions::CLIENT_ID_DESCRIPTION;
+use crate::field_descriptions::TYPENAME_DESCRIPTION;
 use crate::graphql_schema::Schema;
 
 fn todo_add_location<T>(error: SchemaError) -> DiagnosticsResult<T> {
@@ -906,7 +908,7 @@ impl InMemorySchema {
             type_: TypeReference::NonNull(Box::new(TypeReference::Named(string_type))),
             directives: Vec::new(),
             parent_type: None,
-            description: None,
+            description: Some(*TYPENAME_DESCRIPTION),
         });
     }
 
@@ -936,7 +938,7 @@ impl InMemorySchema {
             type_: TypeReference::NonNull(Box::new(TypeReference::Named(id_type))),
             directives: Vec::new(),
             parent_type: None,
-            description: None,
+            description: Some(*CLIENT_ID_DESCRIPTION),
         });
     }
 

diff --git a/compiler/crates/schema/src/lib.rs b/compiler/crates/schema/src/lib.rs
@@ -13,6 +13,7 @@
 
 pub mod definitions;
 mod errors;
+mod field_descriptions;
 mod flatbuffer;
 mod graphql_schema;
 mod in_memory;

diff --git a/compiler/crates/schema/tests/build_schema/fixtures/directive-on-arg-def.expected b/compiler/crates/schema/tests/build_schema/fixtures/directive-on-arg-def.expected
@@ -187,7 +187,9 @@ Text Schema:Schema {
         ),
         directives: [],
         parent_type: None,
-        description: None,
+        description: Some(
+            "This object's GraphQL type. Provided by GraphQL type name introspection.",
+        ),
     },
     Field {
         name: WithLocation {
@@ -219,7 +221,9 @@ Text Schema:Schema {
         ),
         directives: [],
         parent_type: None,
-        description: None,
+        description: Some(
+            "Relay's cache key for this object.",
+        ),
     },
     Field {
         name: WithLocation {

diff --git a/compiler/crates/schema/tests/build_schema/fixtures/directives-for-external-types.expected b/compiler/crates/schema/tests/build_schema/fixtures/directives-for-external-types.expected
@@ -512,7 +512,9 @@ Text Schema:Schema {
         ),
         directives: [],
         parent_type: None,
-        description: None,
+        description: Some(
+            "This object's GraphQL type. Provided by GraphQL type name introspection.",
+        ),
     },
     Field {
         name: WithLocation {
@@ -544,7 +546,9 @@ Text Schema:Schema {
         ),
         directives: [],
         parent_type: None,
-        description: None,
+        description: Some(
+            "Relay's cache key for this object.",
+        ),
     },
     Field {
         name: WithLocation {

diff --git a/compiler/crates/schema/tests/build_schema/fixtures/field-descriptions.expected b/compiler/crates/schema/tests/build_schema/fixtures/field-descriptions.expected
@@ -248,7 +248,9 @@ Text Schema:Schema {
         ),
         directives: [],
         parent_type: None,
-        description: None,
+        description: Some(
+            "This object's GraphQL type. Provided by GraphQL type name introspection.",
+        ),
     },
     Field {
         name: WithLocation {
@@ -280,7 +282,9 @@ Text Schema:Schema {
         ),
         directives: [],
         parent_type: None,
-        description: None,
+        description: Some(
+            "Relay's cache key for this object.",
+        ),
     },
     Field {
         name: WithLocation {

diff --git a/compiler/crates/schema/tests/build_schema/fixtures/interface-implements-interface.expected b/compiler/crates/schema/tests/build_schema/fixtures/interface-implements-interface.expected
@@ -273,7 +273,9 @@ Text Schema:Schema {
         ),
         directives: [],
         parent_type: None,
-        description: None,
+        description: Some(
+            "This object's GraphQL type. Provided by GraphQL type name introspection.",
+        ),
     },
     Field {
         name: WithLocation {
@@ -305,7 +307,9 @@ Text Schema:Schema {
         ),
         directives: [],
         parent_type: None,
-        description: None,
+        description: Some(
+            "Relay's cache key for this object.",
+        ),
     },
     Field {
         name: WithLocation {

diff --git a/compiler/crates/schema/tests/build_schema/fixtures/kitchen-sink.expected b/compiler/crates/schema/tests/build_schema/fixtures/kitchen-sink.expected
@@ -446,7 +446,9 @@ Text Schema:Schema {
         ),
         directives: [],
         parent_type: None,
-        description: None,
+        description: Some(
+            "This object's GraphQL type. Provided by GraphQL type name introspection.",
+        ),
     },
     Field {
         name: WithLocation {
@@ -478,7 +480,9 @@ Text Schema:Schema {
         ),
         directives: [],
         parent_type: None,
-        description: None,
+        description: Some(
+            "Relay's cache key for this object.",
+        ),
     },
     Field {
         name: WithLocation {