graph, store : fix loadRelated not working with Bytes as id

Author: incrypto32

graph/src/components/store/entity_cache.rs

@@ -199,13 +199,14 @@ impl EntityCache {
         &mut self,
         eref: &LoadRelatedRequest,
     ) -> Result<Vec<Entity>, anyhow::Error> {
-        let (base_type, field) = self.schema.get_field_related(eref)?;
+        let (base_type, field, id_is_bytes) = self.schema.get_field_related(eref)?;
 
         let query = DerivedEntityQuery {
             entity_type: EntityType::new(base_type.to_string()),
             entity_field: field.name.clone().to_snake_case().into(),
             value: eref.entity_id.clone(),
             causality_region: eref.causality_region,
+            id_is_bytes: id_is_bytes,
         };
 
         let entities = self.store.get_derived(&query)?;

graph/src/components/store/mod.rs

@@ -188,6 +188,8 @@ pub struct DerivedEntityQuery {
     pub entity_field: Word,
     /// The value to compare against
     pub value: Word,
+    /// Boolean indicating if the id is of the type `Bytes`
+    pub id_is_bytes: bool,
 
     /// This is the causality region of the data source that created the entity.
     ///

graph/src/schema/input_schema.rs

@@ -120,7 +120,34 @@ impl InputSchema {
     ///
     /// When asked to load the related entities from "Account" in the field "wallets"
     /// This function will return the type "Wallet" with the field "account"
-    pub fn get_field_related(&self, key: &LoadRelatedRequest) -> Result<(&str, &s::Field), Error> {
+    pub fn get_field_related(
+        &self,
+        key: &LoadRelatedRequest,
+    ) -> Result<(&str, &s::Field, bool), Error> {
+        let id_field = self
+            .inner
+            .schema
+            .document
+            .get_object_type_definition(key.entity_type.as_str())
+            .ok_or_else(|| {
+                anyhow!(
+                    "Entity {}[{}]: unknown entity type `{}`",
+                    key.entity_type,
+                    key.entity_id,
+                    key.entity_type,
+                )
+            })?
+            .field("id")
+            .ok_or_else(|| {
+                anyhow!(
+                    "Entity {}[{}]: unknown field `{}`",
+                    key.entity_type,
+                    key.entity_id,
+                    key.entity_field,
+                )
+            })?;
+
+        let id_is_bytes = id_field.field_type.get_base_type() == "Bytes";
         let field = self
             .inner
             .schema
@@ -171,7 +198,7 @@ impl InputSchema {
                     )
                 })?;
 
-            Ok((base_type, field))
+            Ok((base_type, field, id_is_bytes))
         } else {
             Err(anyhow!(
                 "Entity {}[{}]: field `{}` is not derived",

store/postgres/src/relational_queries.rs

@@ -1739,6 +1739,7 @@ impl<'a> QueryFragment<Pg> for FindDerivedQuery<'a> {
             entity_field,
             value: entity_id,
             causality_region,
+            id_is_bytes,
         } = self.derived_query;
 
         // Generate
@@ -1765,7 +1766,13 @@ impl<'a> QueryFragment<Pg> for FindDerivedQuery<'a> {
         }
         out.push_identifier(entity_field.as_str())?;
         out.push_sql(" = ");
-        out.push_bind_param::<Text, _>(&entity_id.as_str())?;
+        if *id_is_bytes {
+            out.push_sql("decode(");
+            out.push_bind_param::<Text, _>(&entity_id.as_str().strip_prefix("0x").unwrap())?;
+            out.push_sql(", 'hex')");
+        } else {
+            out.push_bind_param::<Text, _>(&entity_id.as_str())?;
+        }
         out.push_sql(" and ");
         if self.table.has_causality_region {
             out.push_sql("causality_region = ");

tests/integration-tests/derived-loaders/schema.graphql

@@ -1,3 +1,14 @@
+type BFoo @entity {
+  id: Bytes!
+  value: Int8!
+  bar: BBar! @derivedFrom(field: "fooValue")
+}
+
+type BBar @entity {
+  id: Bytes!
+  fooValue: BFoo!
+}
+
 type Foo @entity {
   id: ID!
   value: Int8!

tests/integration-tests/derived-loaders/src/mapping.ts

@@ -1,18 +1,34 @@
+import { Bytes, store } from "@graphprotocol/graph-ts";
 import { Trigger } from "../generated/Contract/Contract";
-import { Bar, Foo } from "../generated/schema";
+import { Bar, Foo, BFoo, BBar } from "../generated/schema";
 
 export function handleTrigger(event: Trigger): void {
-  let obj = new Foo("0");
-  obj.value = 1;
-  obj.save();
+  let foo = new Foo("0");
+  foo.value = 1;
+  foo.save();
 
-  let obj2 = new Bar("1");
-  obj2.fooValue = "0";
-  obj2.save();
+  let bar = new Bar("1");
+  bar.fooValue = "0";
+  bar.save();
 
-  let obj3 = Foo.load("0");
-  let obj4 = obj3!.bar.load();
+  let fooLoaded = Foo.load("0");
 
+  let barDerived = fooLoaded!.bar.load();
 
-  assert(obj4 !== null, "obj4 should not be null");
+  assert(barDerived !== null, "barDerived should not be null");
+
+  let bFoo = new BFoo(Bytes.fromUTF8("0"));
+  bFoo.value = 1;
+  bFoo.save();
+
+  let bBar = new BBar(Bytes.fromUTF8("1"));
+  bBar.fooValue = Bytes.fromUTF8("0");
+  bBar.save();
+
+  let bFooLoaded = BFoo.load(Bytes.fromUTF8("0"));
+  let bBarDerived = changetype<Bar[]>(
+    store.loadRelated("BFoo", bFooLoaded!.id.toHexString(), "bar")
+  );
+
+  assert(bBarDerived !== null, "bBarDerived should not be null");
 }

tests/integration-tests/derived-loaders/test/test.js

@@ -79,8 +79,27 @@ contract("Contract", (accounts) => {
     await waitForSubgraphToBeSynced();
   });
 
-  it("test query", async () => {
-    // Also test that multiple block constraints do not result in a graphql error.
+  it("should return correct BFoos", async () => {
+    let result = await fetchSubgraph({
+      query: `{
+        bfoos(orderBy: id) { id value bar { id } }
+      }`,
+    });
+
+    expect(result.errors).to.be.undefined;
+    expect(result.data).to.deep.equal({
+      bfoos: [
+        {
+          id: "0x30",
+          value: "1",
+          bar: { id: "0x31" },
+        },
+      ],
+    });
+  });
+
+
+  it("should return correct Foos", async () => {
     let result = await fetchSubgraph({
       query: `{
         foos(orderBy: id) { id value bar { id } }