fix bug for multiple backlinks with the same property id, but different type targets (#573)

Author: nikgraf

apps/events/src/routes/podcasts.lazy.tsx

@@ -1,6 +1,6 @@
 import { useEntities, useEntity, usePublicSpaces } from '@graphprotocol/hypergraph-react';
 import { createLazyFileRoute } from '@tanstack/react-router';
-import { Person, Podcast, Topic } from '@/schema';
+import { Person, PersonHostTest, Podcast, Topic } from '@/schema';
 
 export const Route = createLazyFileRoute('/podcasts')({
   component: RouteComponent,
@@ -64,6 +64,22 @@ function RouteComponent() {
   });
   console.log({ podcast, invalidEntity, invalidRelationEntities });
 
+  const { data: personHostTest } = useEntities(PersonHostTest, {
+    mode: 'public',
+    first: 10,
+    filter: {
+      name: {
+        startsWith: 'Joe',
+      },
+    },
+    space: space,
+    include: {
+      hostedPodcasts: {},
+      hostedEpisodes: {},
+    },
+  });
+  console.log({ personHostTest });
+
   const { data, isLoading, isError } = useEntities(Podcast, {
     mode: 'public',
     first: 10,

apps/events/src/schema.ts

@@ -335,3 +335,43 @@ export const Space = Entity.Schema(
 );
 
 export type Space = Entity.Entity<typeof Space>;
+
+export const EpisodeHostTest = Entity.Schema(
+  {
+    name: Type.String,
+  },
+  {
+    types: [Id('972d201a-d780-4568-9e01-543f67b26bee')],
+    properties: {
+      name: Id(SystemIds.NAME_PROPERTY),
+    },
+  },
+);
+
+export const PodcastHostTest = Entity.Schema(
+  {
+    name: Type.String,
+  },
+  {
+    types: [Id('4c81561d-1f95-4131-9cdd-dd20ab831ba2')],
+    properties: {
+      name: Id(SystemIds.NAME_PROPERTY),
+    },
+  },
+);
+
+export const PersonHostTest = Entity.Schema(
+  {
+    name: Type.String,
+    hostedPodcasts: Type.Backlink(PodcastHostTest),
+    hostedEpisodes: Type.Backlink(EpisodeHostTest),
+  },
+  {
+    types: [Id('7ed45f2b-c48b-419e-8e46-64d5ff680b0d')],
+    properties: {
+      name: Id(SystemIds.NAME_PROPERTY),
+      hostedPodcasts: Id('c72d9abb-bca8-4e86-b7e8-b71e91d2b37e'),
+      hostedEpisodes: Id('c72d9abb-bca8-4e86-b7e8-b71e91d2b37e'),
+    },
+  },
+);

packages/hypergraph/src/utils/convert-relations.ts

@@ -106,7 +106,7 @@ export const convertRelations = <_S extends Schema.Schema.AnyNoContext>(
 
       if (relationMetadata) {
         // Use the aliased field to get relations for this specific type ID
-        const alias = getRelationAlias(result.value);
+        const alias = getRelationAlias(result.value, relationMetadata.targetTypeIds);
         relationConnection = queryEntity[alias as keyof RecursiveQueryEntity] as RelationsListWithNodes | undefined;
         if (relationMetadata.includeNodes) {
           allRelationsWithTheCorrectPropertyTypeId = relationConnection?.nodes;

packages/hypergraph/src/utils/relation-query-helpers.ts

@@ -1,4 +1,5 @@
 import type { RelationTypeIdInfo } from './get-relation-type-ids.js';
+import { canonicalize } from './jsc.js';
 
 type SpaceSelectionMode = 'single' | 'many' | 'all';
 
@@ -56,7 +57,24 @@ const buildRelationSpaceFilter = (
   return `spaceId: {in: ${formatGraphQLStringArray(override)}}, `;
 };
 
-export const getRelationAlias = (typeId: string) => `relations_${typeId.replace(/-/g, '_')}`;
+const sanitizeAliasComponent = (value: string) => {
+  const collapsed = value.replace(/[^A-Za-z0-9]+/g, '_').replace(/^_+|_+$/g, '');
+  return collapsed.length > 0 ? collapsed : 'all';
+};
+
+const buildTargetTypeAliasComponent = (targetTypeIds?: readonly string[]) => {
+  if (!targetTypeIds || targetTypeIds.length === 0) {
+    return '';
+  }
+
+  const canonicalTypeIds = canonicalize(Array.from(new Set(targetTypeIds)).sort());
+  const sanitized = sanitizeAliasComponent(canonicalTypeIds);
+
+  return sanitized.length > 0 ? `_${sanitized}` : '';
+};
+
+export const getRelationAlias = (typeId: string, targetTypeIds?: readonly string[]) =>
+  `relations_${typeId.replace(/-/g, '_')}${buildTargetTypeAliasComponent(targetTypeIds)}`;
 
 const buildRelationTypeIdsFilter = (listField: RelationTypeIdInfo['listField'], typeIds?: readonly string[]) => {
   if (!typeIds || typeIds.length === 0) return '';
@@ -65,7 +83,7 @@ const buildRelationTypeIdsFilter = (listField: RelationTypeIdInfo['listField'],
 };
 
 const buildRelationsListFragment = (info: RelationTypeIdInfo, level: 1 | 2, spaceSelectionMode: SpaceSelectionMode) => {
-  const alias = getRelationAlias(info.typeId);
+  const alias = getRelationAlias(info.typeId, info.targetTypeIds);
   const nestedPlaceholder = info.includeNodes && level === 1 ? '__LEVEL2_RELATIONS__' : '';
   const listField = info.listField ?? 'relations';
   const connectionField = listField === 'backlinks' ? 'backlinks' : 'relations';

packages/hypergraph/test/entity/find-many-public.test.ts

@@ -76,8 +76,9 @@ describe('findManyPublic parseResult', () => {
   });
 
   it('collects invalidRelationEntities when nested relations fail to decode', () => {
-    const relationAlias = getRelationAlias(CHILDREN_RELATION_PROPERTY_ID);
     const relationInfo = getRelationTypeIds(Parent, { children: {} });
+    const childrenRelationInfo = relationInfo.find((info) => info.propertyName === 'children');
+    const relationAlias = getRelationAlias(CHILDREN_RELATION_PROPERTY_ID, childrenRelationInfo?.targetTypeIds);
 
     const queryData = {
       entities: [

packages/hypergraph/test/entity/find-one-public.test.ts

@@ -3,6 +3,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { findOnePublic } from '../../src/entity/find-one-public.js';
 import * as Entity from '../../src/entity/index.js';
 import * as Type from '../../src/type/type.js';
+import { getRelationTypeIds } from '../../src/utils/get-relation-type-ids.js';
 import { getRelationAlias } from '../../src/utils/relation-query-helpers.js';
 
 const mockRequest = vi.hoisted(() => vi.fn());
@@ -76,7 +77,9 @@ describe('findOnePublic', () => {
   });
 
   it('collects invalidRelationEntities when nested relations fail to decode', async () => {
-    const relationAlias = getRelationAlias(CHILDREN_RELATION_PROPERTY_ID);
+    const relationInfo = getRelationTypeIds(Parent, { children: {} });
+    const childrenRelationInfo = relationInfo.find((info) => info.propertyName === 'children');
+    const relationAlias = getRelationAlias(CHILDREN_RELATION_PROPERTY_ID, childrenRelationInfo?.targetTypeIds);
 
     const entity = {
       id: 'parent-2',

packages/hypergraph/test/utils/relation-config-overrides.test.ts

@@ -3,7 +3,7 @@ import { describe, expect, it } from 'vitest';
 import * as Entity from '../../src/entity/index.js';
 import * as Type from '../../src/type/type.js';
 import { getRelationTypeIds } from '../../src/utils/get-relation-type-ids.js';
-import { buildRelationsSelection } from '../../src/utils/relation-query-helpers.js';
+import { buildRelationsSelection, getRelationAlias } from '../../src/utils/relation-query-helpers.js';
 
 const FRIENDS_RELATION_PROPERTY_ID = Id('f44ae32a-2f13-4d3f-875f-19d2338a32b8');
 const CHILDREN_RELATION_PROPERTY_ID = Id('8a6dcb99-9c7b-4ca9-9f7b-98f2f404b405');
@@ -100,6 +100,11 @@ describe('relation include config overrides', () => {
     } satisfies Entity.EntityInclude<typeof Parent>;
 
     const relationInfo = getRelationTypeIds(Parent, include);
+    const childrenRelationInfo = relationInfo.find((info) => info.propertyName === 'children');
+    const childrenAlias = getRelationAlias(
+      childrenRelationInfo?.typeId ?? CHILDREN_RELATION_PROPERTY_ID,
+      childrenRelationInfo?.targetTypeIds,
+    );
     expect(relationInfo[0]).toMatchObject({
       relationSpaces: ['space-rel', 'space-rel-2'],
       valueSpaces: ['space-values'],
@@ -114,9 +119,7 @@ describe('relation include config overrides', () => {
     expect(selection).toContain('valuesList(filter: {spaceId: {in: ["space-values"]}})');
     expect(selection).toContain(`toEntity: { typeIds: { in: ${stringifyTypeIds(CHILD_TYPES)} } }`);
     expect(selection).toContain(`toEntity: { typeIds: { in: ${stringifyTypeIds(FRIEND_TYPES)} } }`);
-    expect(selection.split('relations_f44ae32a_2f13_4d3f_875f_19d2338a32b8')[0]).not.toContain(
-      'spaceId: {is: $spaceId}',
-    );
+    expect(selection.split(childrenAlias)[0]).not.toContain('spaceId: {is: $spaceId}');
   });
 
   it('omits filters entirely when overrides use "all"', () => {

packages/hypergraph/test/utils/relation-query-helpers.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, it } from 'vitest';
+import { getRelationAlias } from '../../src/utils/relation-query-helpers.js';
+
+describe('getRelationAlias', () => {
+  it('falls back to property typeId when no target typeIds are provided', () => {
+    expect(getRelationAlias('f44ae32a-2f13-4d3f-875f-19d2338a32b8')).toBe(
+      'relations_f44ae32a_2f13_4d3f_875f_19d2338a32b8',
+    );
+  });
+
+  it('includes canonicalized target typeIds in the alias', () => {
+    const alias = getRelationAlias('f44ae32a-2f13-4d3f-875f-19d2338a32b8', ['type-b', 'type-a']);
+
+    expect(alias).toBe('relations_f44ae32a_2f13_4d3f_875f_19d2338a32b8_type_a_type_b');
+  });
+
+  it('produces the same alias regardless of target typeId order or duplicates', () => {
+    const aliasA = getRelationAlias('type-id', ['type-b', 'type-a', 'type-b']);
+    const aliasB = getRelationAlias('type-id', ['type-a', 'type-b']);
+
+    expect(aliasA).toBe(aliasB);
+  });
+});