Merge pull request #629 from supabase/fix/sort-relationships-by-referenced-table

fix(typegen): sort relationships by (fkey name, referenced table)

Author: soedirgo

src/server/templates/typescript.ts

@@ -160,8 +160,10 @@ export interface Database {
                           relationship.schema === table.schema &&
                           relationship.relation === table.name
                       )
-                      .sort(({ foreign_key_name: a }, { foreign_key_name: b }) =>
-                        a.localeCompare(b)
+                      .sort(
+                        (a, b) =>
+                          a.foreign_key_name.localeCompare(b.foreign_key_name) ||
+                          a.referenced_relation.localeCompare(b.referenced_relation)
                       )
                       .map(
                         (relationship) => `{

test/db/00-init.sql

@@ -101,3 +101,5 @@ create table user_details (
   user_id int8 references users(id) primary key,
   details text
 );
+
+create view a_view as select id from users;

test/server/typegen.ts

@@ -85,6 +85,13 @@ test('typegen', async () => {
               "user-id"?: number
             }
             Relationships: [
+              {
+                foreignKeyName: "todos_user-id_fkey"
+                columns: ["user-id"]
+                isOneToOne: false
+                referencedRelation: "a_view"
+                referencedColumns: ["id"]
+              },
               {
                 foreignKeyName: "todos_user-id_fkey"
                 columns: ["user-id"]
@@ -115,6 +122,13 @@ test('typegen', async () => {
               user_id?: number
             }
             Relationships: [
+              {
+                foreignKeyName: "user_details_user_id_fkey"
+                columns: ["user_id"]
+                isOneToOne: true
+                referencedRelation: "a_view"
+                referencedColumns: ["id"]
+              },
               {
                 foreignKeyName: "user_details_user_id_fkey"
                 columns: ["user_id"]
@@ -172,6 +186,18 @@ test('typegen', async () => {
           }
         }
         Views: {
+          a_view: {
+            Row: {
+              id: number | null
+            }
+            Insert: {
+              id?: number | null
+            }
+            Update: {
+              id?: number | null
+            }
+            Relationships: []
+          }
           todos_matview: {
             Row: {
               details: string | null
@@ -186,6 +212,13 @@ test('typegen', async () => {
                 referencedRelation: "users"
                 referencedColumns: ["id"]
               },
+              {
+                foreignKeyName: "todos_user-id_fkey"
+                columns: ["user-id"]
+                isOneToOne: false
+                referencedRelation: "a_view"
+                referencedColumns: ["id"]
+              },
               {
                 foreignKeyName: "todos_user-id_fkey"
                 columns: ["user-id"]
@@ -219,6 +252,13 @@ test('typegen', async () => {
                 referencedRelation: "users"
                 referencedColumns: ["id"]
               },
+              {
+                foreignKeyName: "todos_user-id_fkey"
+                columns: ["user-id"]
+                isOneToOne: false
+                referencedRelation: "a_view"
+                referencedColumns: ["id"]
+              },
               {
                 foreignKeyName: "todos_user-id_fkey"
                 columns: ["user-id"]