fix: errors with relationships duplicates

Author: avallete

src/select-query-parser/utils.ts

@@ -37,6 +37,22 @@ type FilterRelationNodes<Nodes extends Node[]> = UnionToArray<
   }[number]
 >
 
+/*
+ ** Because of pg-meta types generation there is some cases where a same relationship can be duplicated
+ ** if the relation is across schemas and views this ensure that we dedup those relations and treat them
+ ** as postgrest would.
+ ** TODO: This is necessary to allow the check for required desambiguation but shouldn't if the
+ ** generated relationships were correct pointing out that each realation is actually toward a different schema
+ */
+export type DeduplicateRelationships<T extends readonly unknown[]> = T extends readonly [
+  infer First,
+  ...infer Rest
+]
+  ? First extends Rest[number]
+    ? DeduplicateRelationships<Rest extends readonly unknown[] ? Rest : []>
+    : [First, ...DeduplicateRelationships<Rest extends readonly unknown[] ? Rest : []>]
+  : T
+
 export type ResolveRelationships<
   Schema extends GenericSchema,
   RelationName extends string,
@@ -110,7 +126,7 @@ export type CheckDuplicateEmbededReference<
       RelationsNodes
     > extends infer ResolvedRels
     ? ResolvedRels extends unknown[]
-      ? FindDuplicates<ResolvedRels> extends infer Duplicates
+      ? FindDuplicates<DeduplicateRelationships<ResolvedRels>> extends infer Duplicates
         ? Duplicates extends never
           ? false
           : Duplicates extends { fieldName: infer FieldName extends string }
@@ -127,7 +143,7 @@ export type CheckDuplicateEmbededReference<
  * Returns a boolean representing whether there is a foreign key referencing
  * a given relation.
  */
-type HasFKeyToFRel<FRelName, Relationships> = Relationships extends [infer R]
+export type HasFKeyToFRel<FRelName, Relationships> = Relationships extends [infer R]
   ? R extends { referencedRelation: FRelName }
     ? true
     : false
@@ -139,7 +155,7 @@ type HasFKeyToFRel<FRelName, Relationships> = Relationships extends [infer R]
 /**
  * Checks if there is more than one relation to a given foreign relation name in the Relationships.
  */
-type HasMultipleFKeysToFRel<FRelName, Relationships> = Relationships extends [
+export type HasMultipleFKeysToFRel<FRelName, Relationships> = Relationships extends [
   infer R,
   ...infer Rest
 ]
@@ -166,7 +182,10 @@ type CheckRelationshipError<
       direction: 'reverse'
     }
   ? // We check if there is possible confusion with other relations with this table
-    HasMultipleFKeysToFRel<RelatedRelationName, Relationships> extends true
+    HasMultipleFKeysToFRel<
+      RelatedRelationName,
+      DeduplicateRelationships<Relationships>
+    > extends true
     ? // If there is, postgrest will fail at runtime, and require desambiguation via hinting
       RequireHintingSelectQueryError<
         RelatedRelationName,
@@ -184,7 +203,7 @@ type CheckRelationshipError<
     }
   ? HasMultipleFKeysToFRel<
       RelatedRelationName,
-      TablesAndViews<Schema>[From]['Relationships']
+      DeduplicateRelationships<TablesAndViews<Schema>[From]['Relationships']>
     > extends true
     ? RequireHintingSelectQueryError<From extends string ? From : 'unknown', RelatedRelationName>
     : FoundRelation
@@ -236,7 +255,10 @@ type ResolveReverseRelationship<
             from: CurrentTableOrView
           }
         : // If the relation was found via implicit relation naming, we must ensure there is no conflicting matches
-        HasMultipleFKeysToFRel<RelatedRelationName, Relationships> extends true
+        HasMultipleFKeysToFRel<
+            RelatedRelationName,
+            DeduplicateRelationships<Relationships>
+          > extends true
         ? RequireHintingSelectQueryError<
             RelatedRelationName,
             CurrentTableOrView extends string ? CurrentTableOrView : 'unknown'

test/select-query-parser/types.test-d.ts

@@ -8,6 +8,7 @@ import {
 import { expectType } from 'tsd'
 import { TypeEqual } from 'ts-expect'
 import {
+  DeduplicateRelationships,
   FindMatchingRelationships,
   FindMatchingTableRelationships,
   IsRelationNullable,
@@ -178,3 +179,56 @@ import { ParseQuery } from '../../src/select-query-parser/parser/parser'
   type r2 = ProcessNodes<Schema, Row, RelationName, Relationships, ParsedQuery>
   expectType<r2>(expected!)
 }
+
+// Deduplicate exact sames relationships
+{
+  type rels = [
+    {
+      foreignKeyName: 'test_fkey'
+      columns: ['project_id']
+      referencedRelation: 'project_subscriptions'
+      referencedColumns: ['project_id']
+    },
+    {
+      foreignKeyName: 'test_fkey'
+      columns: ['project_id']
+      referencedRelation: 'projects'
+      referencedColumns: ['id']
+    },
+    {
+      foreignKeyName: 'test_fkey'
+      columns: ['project_id']
+      referencedRelation: 'projects'
+      referencedColumns: ['id']
+    },
+    {
+      foreignKeyName: 'test_fkey'
+      columns: ['project_id']
+      referencedRelation: 'sls_physical_backups_monitoring'
+      referencedColumns: ['project_id']
+    }
+  ]
+  type expected = [
+    {
+      foreignKeyName: 'test_fkey'
+      columns: ['project_id']
+      referencedRelation: 'project_subscriptions'
+      referencedColumns: ['project_id']
+    },
+    {
+      foreignKeyName: 'test_fkey'
+      columns: ['project_id']
+      referencedRelation: 'projects'
+      referencedColumns: ['id']
+    },
+    {
+      foreignKeyName: 'test_fkey'
+      columns: ['project_id']
+      referencedRelation: 'sls_physical_backups_monitoring'
+      referencedColumns: ['project_id']
+    }
+  ]
+
+  type result = DeduplicateRelationships<rels>
+  expectType<TypeEqual<result, expected>>(true)
+}