Merge pull request #641 from supabase/feat/optional-one-to-one-rels-detection

feat(typegen): make 1-to-1 relationships detection optional

Author: soedirgo

package.json

@@ -21,8 +21,8 @@
     "clean": "rimraf dist tsconfig.tsbuildinfo",
     "format": "prettier --write \"{src,test}/**/*.ts\"",
     "build": "tsc -p tsconfig.json && cpy 'src/lib/sql/*.sql' dist/lib/sql",
-    "docs:export": "node --loader ts-node/esm src/server/server.ts docs export > openapi.json",
-    "gen:types:typescript": "node --loader ts-node/esm src/server/server.ts gen types typescript",
+    "docs:export": "PG_META_EXPORT_DOCS=true node --loader ts-node/esm src/server/server.ts > openapi.json",
+    "gen:types:typescript": "PG_META_GENERATE_TYPES=typescript node --loader ts-node/esm src/server/server.ts",
     "start": "node dist/server/server.js",
     "dev": "trap 'npm run db:clean' INT && run-s db:clean db:run && nodemon --exec node --loader ts-node/esm src/server/server.ts | pino-pretty --colorize",
     "pkg": "run-s clean build && pkg .pkg.config.json",

src/server/constants.ts

@@ -33,11 +33,13 @@ if (PG_META_DB_SSL_ROOT_CERT) {
   new crypto.X509Certificate(PG_META_DB_SSL_ROOT_CERT)
 }
 
-export const EXPORT_DOCS = process.argv[2] === 'docs' && process.argv[3] === 'export'
-export const GENERATE_TYPES =
-  process.argv[2] === 'gen' && process.argv[3] === 'types' ? process.argv[4] : undefined
-export const GENERATE_TYPES_INCLUDED_SCHEMAS =
-  GENERATE_TYPES && process.argv[5] === '--include-schemas' ? process.argv[6]?.split(',') ?? [] : []
+export const EXPORT_DOCS = process.env.PG_META_EXPORT_DOCS === 'true'
+export const GENERATE_TYPES = process.env.PG_META_GENERATE_TYPES
+export const GENERATE_TYPES_INCLUDED_SCHEMAS = GENERATE_TYPES
+  ? process.env.PG_META_GENERATE_TYPES_INCLUDED_SCHEMAS?.split(',') ?? []
+  : []
+export const GENERATE_TYPES_DETECT_ONE_TO_ONE_RELATIONSHIPS =
+  process.env.PG_META_GENERATE_TYPES_DETECT_ONE_TO_ONE_RELATIONSHIPS === 'true'
 
 export const DEFAULT_POOL_CONFIG: PoolConfig = {
   max: 1,

src/server/routes/generators/typescript.ts

@@ -10,13 +10,15 @@ export default async (fastify: FastifyInstance) => {
     Querystring: {
       excluded_schemas?: string
       included_schemas?: string
+      detect_one_to_one_relationships?: string
     }
   }>('/', async (request, reply) => {
     const connectionString = request.headers.pg
     const excludedSchemas =
       request.query.excluded_schemas?.split(',').map((schema) => schema.trim()) ?? []
     const includedSchemas =
       request.query.included_schemas?.split(',').map((schema) => schema.trim()) ?? []
+    const detectOneToOneRelationships = request.query.detect_one_to_one_relationships === 'true'
 
     const pgMeta: PostgresMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
     const { data: schemas, error: schemasError } = await pgMeta.schemas.list()
@@ -111,6 +113,7 @@ export default async (fastify: FastifyInstance) => {
       ),
       types: types.filter(({ name }) => name[0] !== '_'),
       arrayTypes: types.filter(({ name }) => name[0] === '_'),
+      detectOneToOneRelationships,
     })
   })
 }

src/server/server.ts

@@ -6,6 +6,7 @@ import {
   DEFAULT_POOL_CONFIG,
   EXPORT_DOCS,
   GENERATE_TYPES,
+  GENERATE_TYPES_DETECT_ONE_TO_ONE_RELATIONSHIPS,
   GENERATE_TYPES_INCLUDED_SCHEMAS,
   PG_CONNECTION,
   PG_META_HOST,
@@ -110,6 +111,7 @@ if (EXPORT_DOCS) {
       ),
       types: types.filter(({ name }) => name[0] !== '_'),
       arrayTypes: types.filter(({ name }) => name[0] === '_'),
+      detectOneToOneRelationships: GENERATE_TYPES_DETECT_ONE_TO_ONE_RELATIONSHIPS,
     })
   )
 } else {

src/server/templates/typescript.ts

@@ -20,6 +20,7 @@ export const apply = ({
   functions,
   types,
   arrayTypes,
+  detectOneToOneRelationships,
 }: {
   schemas: PostgresSchema[]
   tables: Omit<PostgresTable, 'columns'>[]
@@ -30,6 +31,7 @@ export const apply = ({
   functions: PostgresFunction[]
   types: PostgresType[]
   arrayTypes: PostgresType[]
+  detectOneToOneRelationships: boolean
 }): string => {
   const columnsByTableId = columns
     .sort(({ name: a }, { name: b }) => a.localeCompare(b))
@@ -169,8 +171,11 @@ export interface Database {
                         (relationship) => `{
                         foreignKeyName: ${JSON.stringify(relationship.foreign_key_name)}
                         columns: ${JSON.stringify(relationship.columns)}
-                        isOneToOne: ${relationship.is_one_to_one}
-                        referencedRelation: ${JSON.stringify(relationship.referenced_relation)}
+                        ${
+                          detectOneToOneRelationships
+                            ? `isOneToOne: ${relationship.is_one_to_one};`
+                            : ''
+                        }referencedRelation: ${JSON.stringify(relationship.referenced_relation)}
                         referencedColumns: ${JSON.stringify(relationship.referenced_columns)}
                       }`
                       )}
@@ -238,8 +243,11 @@ export interface Database {
                         (relationship) => `{
                         foreignKeyName: ${JSON.stringify(relationship.foreign_key_name)}
                         columns: ${JSON.stringify(relationship.columns)}
-                        isOneToOne: ${relationship.is_one_to_one}
-                        referencedRelation: ${JSON.stringify(relationship.referenced_relation)}
+                        ${
+                          detectOneToOneRelationships
+                            ? `isOneToOne: ${relationship.is_one_to_one};`
+                            : ''
+                        }referencedRelation: ${JSON.stringify(relationship.referenced_relation)}
                         referencedColumns: ${JSON.stringify(relationship.referenced_columns)}
                       }`
                       )}