Pipe information through compiler for simplified resolver generation for property lookup resolvers

Summary: This diff creates the foundation of a new quality of life feature that allows for quickly defining resolvers that just do a property lookup on the base model. The changes in this diff are just piping the information of whether or not the resolver is a regular function or a new property lookup resolver through the compiler. It starts in the schema generation module and must carry the information all the way through to the printer. A stacked diff will actually implement the logic to find and add the resolver information. Reviewed By: captbaritone Differential Revision: D66714731 fbshipit-source-id: 4eba405cc590f461339f3f165d9832b52854c75e

Author: evanyeung

compiler/crates/docblock-shared/src/lib.rs

@@ -46,6 +46,10 @@ lazy_static! {
  /// has validated that its Flow/TypeScript type matches the GraphQL type.
  pub static ref TYPE_CONFIRMED_ARGUMENT_NAME: ArgumentName =
  ArgumentName("type_confirmed".intern());
+ /// Indicates that the resolver is just a property lookup on the underlying model (and we need to generate
+ /// code to do this lookup)
+ pub static ref RESOLVER_IS_PROPERTY_LOOKUP: ArgumentName =
+ ArgumentName("is_property_lookup".intern());
  /// "Weak" resolver types are types which are backed by a JS model value, but which don't have a stable
  /// identity. Types in the generated schema are annotated with a directive using this name to signal
  /// to the rest of Relay that they are backed by a "weak" Relay Resolver model.

compiler/crates/relay-codegen/src/ast.rs

@@ -97,6 +97,12 @@ pub enum GraphQLModuleDependency {
  },
 }
 
+#[derive(Eq, PartialEq, Hash, Debug)]
+pub enum ResolverJSFunction {
+ Module(JSModuleDependency),
+ PropertyLookup(String),
+}
+
 #[derive(Eq, PartialEq, Hash, Debug)]
 pub enum Primitive {
  Key(AstKey),
@@ -122,7 +128,7 @@ pub enum Primitive {
  RelayResolverModel {
  graphql_module_name: StringKey,
  graphql_module_path: StringKey,
- js_module: JSModuleDependency,
+ resolver_fn: ResolverJSFunction,
  injected_field_name_details: Option<(StringKey, bool)>,
  },
 }

compiler/crates/relay-codegen/src/build_ast.rs

@@ -52,6 +52,7 @@ use relay_transforms::get_resolver_fragment_dependency_name;
 use relay_transforms::relay_resolvers::get_resolver_info;
 use relay_transforms::relay_resolvers::resolver_import_alias;
 use relay_transforms::relay_resolvers::ResolverInfo;
+use relay_transforms::relay_resolvers::ResolverSchemaGenType;
 use relay_transforms::remove_directive;
 use relay_transforms::CatchMetadataDirective;
 use relay_transforms::ClientEdgeMetadata;
@@ -94,6 +95,7 @@ use crate::ast::ObjectEntry;
 use crate::ast::Primitive;
 use crate::ast::QueryID;
 use crate::ast::RequestParameters;
+use crate::ast::ResolverJSFunction;
 use crate::ast::ResolverModuleReference;
 use crate::constants::CODEGEN_CONSTANTS;
 use crate::object;
@@ -1449,6 +1451,7 @@ impl<'schema, 'builder, 'config> CodegenBuilder<'schema, 'builder, 'config> {
  },
  )),
  type_confirmed: relay_resolver_metadata.type_confirmed,
+ resolver_type: ResolverSchemaGenType::ResolverModule,
  };
  let fragment_primitive = Primitive::Key(self.object(object! {
  args: Primitive::SkippableNull,
@@ -1534,10 +1537,19 @@ impl<'schema, 'builder, 'config> CodegenBuilder<'schema, 'builder, 'config> {
  ),
  );
 
+ let resolver_fn = match relay_resolver_metadata.resolver_type {
+ ResolverSchemaGenType::ResolverModule => {
+ ResolverJSFunction::Module(resolver_js_module)
+ }
+ ResolverSchemaGenType::PropertyLookup => {
+ ResolverJSFunction::PropertyLookup(field.name.item.to_string())
+ }
+ };
+
  Primitive::RelayResolverModel {
  graphql_module_name: fragment_name.item.0,
  graphql_module_path: fragment_import_path,
- js_module: resolver_js_module,
+ resolver_fn,
  injected_field_name_details: match injection_mode {
  FragmentDataInjectionMode::Field { name, is_required } => {
  Some((name, is_required))

compiler/crates/relay-codegen/src/printer.rs

@@ -34,6 +34,7 @@ use crate::ast::ObjectEntry;
 use crate::ast::Primitive;
 use crate::ast::QueryID;
 use crate::ast::RequestParameters;
+use crate::ast::ResolverJSFunction;
 use crate::ast::ResolverModuleReference;
 use crate::build_ast::build_fragment;
 use crate::build_ast::build_operation;
@@ -588,13 +589,13 @@ impl<'b> JSONPrinter<'b> {
  Primitive::RelayResolverModel {
  graphql_module_path,
  graphql_module_name,
- js_module,
+ resolver_fn,
  injected_field_name_details,
  } => self.write_relay_resolver_model(
  f,
  *graphql_module_name,
  *graphql_module_path,
- js_module,
+ resolver_fn,
  injected_field_name_details.as_ref().copied(),
  ),
  }
@@ -661,7 +662,7 @@ impl<'b> JSONPrinter<'b> {
  f: &mut String,
  graphql_module_name: StringKey,
  graphql_module_path: StringKey,
- js_module: &JSModuleDependency,
+ resolver_fn: &ResolverJSFunction,
  injected_field_name_details: Option<(StringKey, bool)>,
  ) -> FmtResult {
  let relay_runtime_experimental = "relay-runtime/experimental";
@@ -685,11 +686,14 @@ impl<'b> JSONPrinter<'b> {
  )),
  )?;
  write!(f, ", ")?;
- self.write_js_dependency(
- f,
- js_module.import_name.clone(),
- get_module_path(self.js_module_format, js_module.path),
- )?;
+ match resolver_fn {
+ ResolverJSFunction::Module(js_module) => self.write_js_dependency(
+ f,
+ js_module.import_name.clone(),
+ get_module_path(self.js_module_format, js_module.path),
+ )?,
+ ResolverJSFunction::PropertyLookup(property) => write!(f, "(o) => o.{}", property)?,
+ }
  if let Some((field_name, is_required_field)) = injected_field_name_details {
  write!(f, ", '{}'", field_name)?;
  write!(f, ", {}", is_required_field)?;

compiler/crates/relay-docblock/src/docblock_ir.rs

@@ -404,6 +404,7 @@ fn parse_terse_relay_resolver_ir(
  fragment_arguments,
  source_hash,
  type_confirmed: false,
+ is_property_lookup: false,
  })
 }
 

compiler/crates/relay-docblock/src/ir.rs

@@ -32,6 +32,7 @@ use docblock_shared::RELAY_RESOLVER_MODEL_INSTANCE_FIELD;
 use docblock_shared::RELAY_RESOLVER_SOURCE_HASH;
 use docblock_shared::RELAY_RESOLVER_SOURCE_HASH_VALUE;
 use docblock_shared::RELAY_RESOLVER_WEAK_OBJECT_DIRECTIVE;
+use docblock_shared::RESOLVER_IS_PROPERTY_LOOKUP;
 use docblock_shared::RESOLVER_VALUE_SCALAR_NAME;
 use docblock_shared::TYPE_CONFIRMED_ARGUMENT_NAME;
 use graphql_ir::FragmentDefinitionName;
@@ -373,6 +374,7 @@ trait ResolverIr: Sized {
  fn source_hash(&self) -> ResolverSourceHash;
  fn semantic_non_null(&self) -> Option<ConstantDirective>;
  fn type_confirmed(&self) -> bool;
+ fn is_property_lookup(&self) -> bool;
 
  fn to_graphql_schema_ast(
  self,
@@ -514,7 +516,12 @@ trait ResolverIr: Sized {
  }
  }
  }
-
+ if self.is_property_lookup() {
+ arguments.push(true_argument(
+ RESOLVER_IS_PROPERTY_LOOKUP.0,
+ Location::generated(),
+ ));
+ }
  let schema = project_config.schema;
 
  if let Some(output_type) = self.output_type() {
@@ -821,6 +828,7 @@ pub struct TerseRelayResolverIr {
  /// Indicates that the extraction method used has already validated that the
  /// implementaiton matches the GraphQL types.
  pub type_confirmed: bool,
+ pub is_property_lookup: bool,
 }
 
 impl ResolverIr for TerseRelayResolverIr {
@@ -926,6 +934,10 @@ impl ResolverIr for TerseRelayResolverIr {
  fn type_confirmed(&self) -> bool {
  self.type_confirmed
  }
+
+ fn is_property_lookup(&self) -> bool {
+ self.is_property_lookup
+ }
 }
 
 impl ResolverTypeDefinitionIr for TerseRelayResolverIr {
@@ -1118,6 +1130,10 @@ impl ResolverIr for LegacyVerboseResolverIr {
  fn type_confirmed(&self) -> bool {
  false
  }
+
+ fn is_property_lookup(&self) -> bool {
+ false
+ }
 }
 
 impl ResolverTypeDefinitionIr for LegacyVerboseResolverIr {
@@ -1267,6 +1283,10 @@ impl ResolverIr for StrongObjectIr {
  fn type_confirmed(&self) -> bool {
  self.type_confirmed
  }
+
+ fn is_property_lookup(&self) -> bool {
+ false
+ }
 }
 
 /// Relay Resolver docblock representing a "model" type for a weak object
@@ -1456,6 +1476,10 @@ impl ResolverIr for WeakObjectIr {
  fn type_confirmed(&self) -> bool {
  self.type_confirmed
  }
+
+ fn is_property_lookup(&self) -> bool {
+ false
+ }
 }
 
 fn string_argument(name: StringKey, value: WithLocation<StringKey>) -> ConstantArgument {

compiler/crates/relay-docblock/tests/parse/fixtures/terse-relay-resolver-args.expected

@@ -128,6 +128,7 @@ Field(
  "ff0b47b51f0011ae9def59af3e3792a3",
  ),
  type_confirmed: false,
+ is_property_lookup: false,
  },
  ),
 )

compiler/crates/relay-docblock/tests/parse/fixtures/terse-relay-resolver-disallow-non-nullable-list-item.expected

@@ -85,6 +85,7 @@ Field(
  "12e28b8739ff3ab018186a28de3ca726",
  ),
  type_confirmed: false,
+ is_property_lookup: false,
  },
  ),
 )

compiler/crates/relay-docblock/tests/parse/fixtures/terse-relay-resolver-non-nullable.expected

@@ -74,6 +74,7 @@ Field(
  "ac789e28bceef3eeaab77ae5203f43a6",
  ),
  type_confirmed: false,
+ is_property_lookup: false,
  },
  ),
 )

compiler/crates/relay-docblock/tests/parse/fixtures/terse-relay-resolver-semantic-non-null.expected

@@ -114,6 +114,7 @@ Field(
  "ba2a3b6d7c4294fef33f921df3b20065",
  ),
  type_confirmed: false,
+ is_property_lookup: false,
  },
  ),
 )