🐛 set columnName and name of the constraint if it's not provided

Author: tnyo43

frontend/packages/db-structure/src/parser/schemarb/index.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, it } from 'vitest'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
 import type { Table } from '../../schema/index.js'
 import {
   aCheckConstraint,
@@ -11,10 +11,21 @@ import {
   aUniqueConstraint,
   anIndex,
 } from '../../schema/index.js'
+import * as GenerateRandomIdentifier from './generateRandomIdentifier.js'
 import { UnsupportedTokenError, processor } from './index.js'
 
 import { createParserTestCases } from '../__tests__/index.js'
 
+beforeEach(() => {
+  vi.spyOn(GenerateRandomIdentifier, 'generateRandomIdentifier')
+    .mockImplementationOnce((length) => `[identifier(${length})_#1]`)
+    .mockImplementation(() => {
+      throw Error(
+        '"generateRandomIdentifier" is called more times than expected. Please add additional "mockImplementationOnce" calls if need',
+      )
+    })
+})
+
 describe(processor, () => {
   const userTable = (override?: Partial<Table>) =>
     aSchema({
@@ -302,6 +313,38 @@ describe(processor, () => {
       })
     })
 
+    it('foreign key (without explicit constraint name and column options)', async () => {
+      const { value } = await processor(/* Ruby */ `
+        create_table "posts" do |t|
+          t.bigint "user_id"
+        end
+
+        add_foreign_key "posts", "users"
+      `)
+
+      expect(value.relationships).toEqual({
+        users_id_to_posts_user_id: aRelationship({
+          name: 'users_id_to_posts_user_id',
+          foreignTableName: 'posts',
+          foreignColumnName: 'user_id',
+          primaryTableName: 'users',
+          primaryColumnName: 'id',
+        }),
+      })
+      expect(value.tables['posts']?.constraints).toEqual({
+        PRIMARY_id: aPrimaryKeyConstraint({
+          name: 'PRIMARY_id',
+          columnName: 'id',
+        }),
+        'fk_rails_[identifier(10)_#1]': aForeignKeyConstraint({
+          name: 'fk_rails_[identifier(10)_#1]',
+          columnName: 'user_id',
+          targetTableName: 'users',
+          targetColumnName: 'id',
+        }),
+      })
+    })
+
     describe('foreign key cardinality', () => {
       it('foreign key (one-to-many)', async () => {
         const keyName = 'fk_posts_user_id'

frontend/packages/db-structure/src/parser/schemarb/parser.ts

@@ -50,6 +50,7 @@ import {
   handleOneToOneRelationships,
 } from '../utils/index.js'
 import { convertColumnType } from './convertColumnType.js'
+import { generateRandomIdentifier } from './generateRandomIdentifier.js'
 import { loadPrism } from './loadPrism.js'
 import { singularize } from './singularize.js'
 
@@ -422,7 +423,9 @@ function extractForeignKeyOptions(
 
   // ref: https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-add_foreign_key
   if (relation.foreignColumnName === '') {
-    relation.foreignColumnName = `${singularize(relation.primaryTableName)}_id`
+    const columnName = `${singularize(relation.primaryTableName)}_id`
+    relation.foreignColumnName = columnName
+    foreignKeyConstraint.columnName = columnName
   }
 
   if (relation.name === '') {
@@ -433,6 +436,10 @@ function extractForeignKeyOptions(
       relation.foreignColumnName,
     )
   }
+
+  if (foreignKeyConstraint.name === '') {
+    foreignKeyConstraint.name = `fk_rails_${generateRandomIdentifier(10)}`
+  }
 }
 
 class SchemaFinder extends Visitor {