Add logic to find property lookup resolver docblocks

Summary: This diff builds on the previous one to add a new visitor that finds docblocks for property lookup resolvers. The visitor just looks at the location of the `gqlField` comment nodes and compares an object key to see if the object key should generate a property lookup resolver. For any object key that matches, a new `UnresolvedFieldDefinition` is added. Reviewed By: captbaritone Differential Revision: D67370142 fbshipit-source-id: b3abb2fa3b9ea6da77edcd0202c8887597303b68

Author: evanyeung

compiler/crates/relay-schema-generation/src/errors.rs

@@ -98,6 +98,10 @@ pub enum SchemaGenerationError {
  module_name: StringKey,
  import_type: JSImportType,
  },
+ #[error(
+ "The key of a property lookup resolver defined with @gqlField must be an identifier (not a string or computed value)."
+ )]
+ ExpectedPropertyLookupToBeIdentifer,
  #[error(
  "This field is a property lookup but has an import for a GraphQL fragment used in the resolver. This is not allowed."
  )]

compiler/crates/relay-schema-generation/src/find_property_lookup_resolvers.rs

@@ -0,0 +1,93 @@
+/*
+ * 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.
+ */
+
+#![deny(warnings)]
+#![deny(clippy::all)]
+
+use ::intern::string_key::Intern;
+use ::intern::string_key::StringKey;
+use common::Diagnostic;
+use common::Location;
+use common::SourceLocationKey;
+use common::Span;
+use common::WithLocation;
+use docblock_shared::ResolverSourceHash;
+use fnv::FnvHashSet;
+use hermes_estree::ObjectTypePropertyKey;
+use hermes_estree::Range;
+use hermes_estree::SourceRange;
+use hermes_estree::Visitor;
+
+use crate::FieldDefinitionInfo;
+use crate::SchemaGenerationError;
+use crate::UnresolvedFieldDefinition;
+
+fn source_range_to_span(source_range: SourceRange) -> Span {
+ Span {
+ start: source_range.start,
+ end: source_range.end,
+ }
+}
+
+pub struct PropertyVisitor<'a> {
+ pub location: SourceLocationKey,
+ source_hash: ResolverSourceHash,
+ pub errors: Vec<Diagnostic>,
+ entity_name: WithLocation<StringKey>,
+ resolver_node_ranges: &'a FnvHashSet<SourceRange>,
+ pub field_definitions: Vec<UnresolvedFieldDefinition>,
+}
+
+impl<'a> PropertyVisitor<'a> {
+ pub fn new(
+ source_module_path: &str,
+ source_hash: ResolverSourceHash,
+ entity_name: WithLocation<StringKey>,
+ resolver_node_ranges: &'a FnvHashSet<SourceRange>,
+ ) -> Self {
+ Self {
+ location: SourceLocationKey::standalone(source_module_path),
+ source_hash,
+ errors: vec![],
+ entity_name,
+ resolver_node_ranges,
+ field_definitions: vec![],
+ }
+ }
+}
+
+impl Visitor<'_> for PropertyVisitor<'_> {
+ fn visit_object_type_property(&mut self, ast: &'_ hermes_estree::ObjectTypeProperty) {
+ if self.resolver_node_ranges.contains(&ast.range) {
+ let field_name = match &ast.key {
+ ObjectTypePropertyKey::Identifier(id) => WithLocation::from_span(
+ self.location,
+ source_range_to_span(id.range),
+ id.name.clone().intern(),
+ ),
+ ObjectTypePropertyKey::_Literal(lit) => {
+ self.errors.push(Diagnostic::error(
+ SchemaGenerationError::ExpectedPropertyLookupToBeIdentifer,
+ Location::new(self.location, source_range_to_span(lit.range())),
+ ));
+ return;
+ }
+ };
+ let field_definition = UnresolvedFieldDefinition {
+ field_name,
+ entity_name: Some(self.entity_name),
+ return_type: ast.value.clone(),
+ source_hash: self.source_hash,
+ description: None, // TODO
+ deprecated: None, // TODO
+ entity_type: None,
+ field_info: FieldDefinitionInfo::PropertyLookupInfo,
+ };
+ self.field_definitions.push(field_definition);
+ }
+ }
+}

compiler/crates/relay-schema-generation/src/lib.rs

@@ -10,6 +10,7 @@
 #![deny(clippy::all)]
 
 mod errors;
+mod find_property_lookup_resolvers;
 mod find_resolver_imports;
 
 use std::collections::hash_map::Entry;
@@ -41,6 +42,7 @@ use find_resolver_imports::JSImportType;
 use find_resolver_imports::ModuleResolution;
 use find_resolver_imports::ModuleResolutionKey;
 use fnv::FnvBuildHasher;
+use fnv::FnvHashSet;
 use graphql_ir::FragmentDefinitionName;
 use graphql_syntax::ConstantArgument;
 use graphql_syntax::ConstantDirective;
@@ -72,6 +74,7 @@ use hermes_estree::Range;
 use hermes_estree::SourceRange;
 use hermes_estree::TypeAlias;
 use hermes_estree::TypeAnnotationEnum;
+use hermes_estree::Visitor;
 use hermes_parser::parse;
 use hermes_parser::ParseResult;
 use hermes_parser::ParserDialect;
@@ -92,6 +95,8 @@ use relay_docblock::WeakObjectIr;
 use rustc_hash::FxHashMap;
 use schema_extractor::SchemaExtractor;
 
+use crate::find_property_lookup_resolvers::PropertyVisitor;
+
 pub static LIVE_FLOW_TYPE_NAME: &str = "LiveState";
 
 type FnvIndexMap<K, V> = IndexMap<K, V, FnvBuildHasher>;
@@ -241,12 +246,17 @@ impl RelayResolverExtractor {
  let module_resolution = import_export_visitor.get_module_resolution(&ast)?;
 
  let attached_comments = find_nodes_after_comments(&ast, &comments);
- // TODO: use the gqlField comments
- let (_gql_field_comments, attached_comments): (AttachedComments<'_>, AttachedComments<'_>) =
+ let (gql_field_comments, attached_comments): (AttachedComments<'_>, AttachedComments<'_>) =
  attached_comments
  .into_iter()
  .partition(|(comment, _, _, _)| comment.contains("@gqlField"));
 
+ let gql_comments = FnvHashSet::from_iter(
+ gql_field_comments
+ .into_iter()
+ .map(|(_, _, _, node_range)| node_range),
+ );
+
  let result = try_all(
  attached_comments
  .into_iter()
@@ -320,14 +330,34 @@ impl RelayResolverExtractor {
  type_alias,
  }) => {
  let name = resolver_value.field_value.unwrap_or(field_name);
+ let mut prop_visitor = PropertyVisitor::new(
+ source_module_path,
+ source_hash,
+ name,
+ &gql_comments,
+ );
+ prop_visitor.visit_flow_type_annotation(&type_alias);
+ if !prop_visitor.errors.is_empty() {
+ return Err(prop_visitor.errors);
+ }
+ let field_definitions: Vec<(
+ UnresolvedFieldDefinition,
+ SourceLocationKey,
+ )> = prop_visitor
+ .field_definitions
+ .into_iter()
+ .map(|def| (def, prop_visitor.location))
+ .collect();
+
  self.add_weak_type_definition(
  name,
  type_alias,
  source_hash,
  source_module_path,
  description,
  false,
- )?
+ )?;
+ self.unresolved_field_definitions.extend(field_definitions);
  }
  }
  Ok(())

compiler/crates/relay-schema-generation/tests/docblock/fixtures/property-lookup.expected

@@ -0,0 +1,194 @@
+==================================== INPUT ====================================
+/**
+ * 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.
+ */
+
+//- module.js
+
+/**
+ * @RelayResolver
+ */
+export type Cat = {
+ /**
+ * @gqlField
+ */
+ name: string,
+ /**
+ * @gqlField
+ */
+ color: string,
+};
+==================================== OUTPUT ===================================
+Field(
+ TerseRelayResolver(
+ TerseRelayResolverIr {
+ field: FieldDefinition {
+ name: Identifier {
+ span: 268:272,
+ token: Token {
+ span: 268:272,
+ kind: Identifier,
+ },
+ value: "name",
+ },
+ type_: Named(
+ NamedTypeAnnotation {
+ name: Identifier {
+ span: 274:280,
+ token: Token {
+ span: 274:280,
+ kind: Identifier,
+ },
+ value: "String",
+ },
+ },
+ ),
+ arguments: None,
+ directives: [],
+ description: None,
+ hack_source: None,
+ span: 268:272,
+ },
+ type_: WithLocation {
+ location: module.js:231:234,
+ item: "Cat",
+ },
+ root_fragment: None,
+ deprecated: None,
+ semantic_non_null: Some(
+ ConstantDirective {
+ span: 268:272,
+ at: Token {
+ span: 0:0,
+ kind: Empty,
+ },
+ name: Identifier {
+ span: 268:272,
+ token: Token {
+ span: 0:0,
+ kind: Empty,
+ },
+ value: "semanticNonNull",
+ },
+ arguments: None,
+ },
+ ),
+ live: None,
+ location: module.js:268:272,
+ fragment_arguments: None,
+ source_hash: ResolverSourceHash(
+ "028500824c2efa57e633f83759af8a99",
+ ),
+ type_confirmed: true,
+ is_property_lookup: true,
+ },
+ ),
+)
+extend type Cat {
+ name: String @relay_resolver(fragment_name: "Cat____relay_model_instance", generated_fragment: true, inject_fragment_data: "__relay_model_instance", is_property_lookup: true, type_confirmed: true, has_output_type: true, import_name: "name", import_path: "module.js") @resolver_source_hash(value: "028500824c2efa57e633f83759af8a99") @semanticNonNull
+}
+
+
+Field(
+ TerseRelayResolver(
+ TerseRelayResolverIr {
+ field: FieldDefinition {
+ name: Identifier {
+ span: 312:317,
+ token: Token {
+ span: 312:317,
+ kind: Identifier,
+ },
+ value: "color",
+ },
+ type_: Named(
+ NamedTypeAnnotation {
+ name: Identifier {
+ span: 319:325,
+ token: Token {
+ span: 319:325,
+ kind: Identifier,
+ },
+ value: "String",
+ },
+ },
+ ),
+ arguments: None,
+ directives: [],
+ description: None,
+ hack_source: None,
+ span: 312:317,
+ },
+ type_: WithLocation {
+ location: module.js:231:234,
+ item: "Cat",
+ },
+ root_fragment: None,
+ deprecated: None,
+ semantic_non_null: Some(
+ ConstantDirective {
+ span: 312:317,
+ at: Token {
+ span: 0:0,
+ kind: Empty,
+ },
+ name: Identifier {
+ span: 312:317,
+ token: Token {
+ span: 0:0,
+ kind: Empty,
+ },
+ value: "semanticNonNull",
+ },
+ arguments: None,
+ },
+ ),
+ live: None,
+ location: module.js:312:317,
+ fragment_arguments: None,
+ source_hash: ResolverSourceHash(
+ "028500824c2efa57e633f83759af8a99",
+ ),
+ type_confirmed: true,
+ is_property_lookup: true,
+ },
+ ),
+)
+extend type Cat {
+ color: String @relay_resolver(fragment_name: "Cat____relay_model_instance", generated_fragment: true, inject_fragment_data: "__relay_model_instance", is_property_lookup: true, type_confirmed: true, has_output_type: true, import_name: "color", import_path: "module.js") @resolver_source_hash(value: "028500824c2efa57e633f83759af8a99") @semanticNonNull
+}
+
+
+Type(
+ WeakObjectType(
+ WeakObjectIr {
+ type_name: Identifier {
+ span: 231:234,
+ token: Token {
+ span: 231:234,
+ kind: Identifier,
+ },
+ value: "Cat",
+ },
+ rhs_location: module.js:231:234,
+ description: None,
+ hack_source: None,
+ deprecated: None,
+ location: module.js:231:234,
+ implements_interfaces: [],
+ source_hash: ResolverSourceHash(
+ "028500824c2efa57e633f83759af8a99",
+ ),
+ type_confirmed: true,
+ },
+ ),
+)
+scalar CatModel @__RelayCustomScalar(path: "module.js", export_name: "Cat")
+
+
+type Cat @__RelayResolverModel @RelayOutputType @__RelayWeakObject {
+ __relay_model_instance: CatModel! @resolver_source_hash(value: "028500824c2efa57e633f83759af8a99") @unselectable(reason: "This field is intended only for Relay's internal use")
+}