fix(cli): improve db pull for relations and defaults

Prevents field name collisions during introspection by refining the naming strategy for self-referencing relations with multiple foreign keys.

Extends support for JSON and Bytes default values across MySQL, PostgreSQL, and SQLite providers to ensure consistent schema restoration.

Adds test cases for self-referencing models to verify the avoidance of duplicate fields.

Author: svetch

packages/cli/src/actions/pull/index.ts

@@ -533,13 +533,20 @@ export function syncRelation({
     sourceModel.fields.splice(firstSourceFieldId, 0, sourceFieldFactory.node); // Insert the relation field before the first FK scalar field
 
     const oppositeFieldPrefix = /[0-9]/g.test(targetModel.name.charAt(0)) ? '_' : '';
-    const { name: oppositeFieldName } = resolveNameCasing(
+    let { name: oppositeFieldName } = resolveNameCasing(
         options.fieldCasing,
         similarRelations > 0
             ? `${oppositeFieldPrefix}${lowerCaseFirst(sourceModel.name)}_${firstColumn}`
             : `${lowerCaseFirst(resolveNameCasing(options.fieldCasing, sourceModel.name).name)}${relation.references.type === 'many'? 's' : ''}`,
     );
 
+    if (targetModel.fields.find((f) => f.name === oppositeFieldName)) {
+        ({ name: oppositeFieldName } = resolveNameCasing(
+            options.fieldCasing,
+            `${lowerCaseFirst(sourceModel.name)}_${firstColumn}To${relation.references.table}_${relation.references.columns[0]}`,
+        ));
+    }
+
     const targetFieldFactory = new DataFieldFactory()
         .setContainer(targetModel)
         .setName(oppositeFieldName)

packages/cli/src/actions/pull/provider/mysql.ts

@@ -266,6 +266,10 @@ export const mysql: IntrospectionProvider = {
                     return (ab) => ab.InvocationExpr.setFunction(getFunctionRef('uuid', services));
                 }
                 return (ab) => ab.StringLiteral.setValue(val);
+            case 'Json':
+                return (ab) => ab.StringLiteral.setValue(val);
+            case 'Bytes':
+                return (ab) => ab.StringLiteral.setValue(val);
         }
 
         // Handle function calls (e.g., uuid(), now())

packages/cli/src/actions/pull/provider/postgresql.ts

@@ -284,6 +284,16 @@ export const postgresql: IntrospectionProvider = {
                     return (ab) => ab.StringLiteral.setValue(val.slice(1, -1).replace(/''/g, "'"));
                 }
                 return (ab) => ab.StringLiteral.setValue(val);
+            case 'Json':
+                if (val.includes('::')) {
+                    return typeCastingConvert({defaultValue,enums,val,services});
+                }
+                return (ab) => ab.StringLiteral.setValue(val);
+            case 'Bytes':
+                if (val.includes('::')) {
+                    return typeCastingConvert({defaultValue,enums,val,services});
+                }
+                return (ab) => ab.StringLiteral.setValue(val);
         }
 
         if (val.includes('(') && val.includes(')')) {

packages/cli/src/actions/pull/provider/sqlite.ts

@@ -394,6 +394,10 @@ export const sqlite: IntrospectionProvider = {
                     return (ab) => ab.StringLiteral.setValue(strippedName);
                 }
                 return (ab) => ab.StringLiteral.setValue(val);
+            case 'Json':
+                return (ab) => ab.StringLiteral.setValue(val);
+            case 'Bytes':
+                return (ab) => ab.StringLiteral.setValue(val);
         }
 
         console.warn(`Unsupported default value type: "${defaultValue}" for field type "${fieldType}". Skipping default value.`);

packages/cli/test/db/pull.test.ts

@@ -102,6 +102,56 @@ model Tag {
             expect(restoredSchema).toEqual(schema);
         });
 
+        it('should restore self-referencing model with multiple FK columns without duplicate fields', async () => {
+            const { workDir, schema } = await createProject(
+                `model Category {
+    id               Int       @id @default(autoincrement())
+    categoryParentId Category? @relation('Category_parentIdToCategory', fields: [parentId], references: [id])
+    parentId Int?
+    categoryBuddyId    Category?  @relation('Category_buddyIdToCategory', fields: [buddyId], references: [id])
+    buddyId  Int?
+    categoryMentorId   Category?  @relation('Category_mentorIdToCategory', fields: [mentorId], references: [id])
+    mentorId Int?
+    categoryParentIdToCategoryId Category[] @relation('Category_parentIdToCategory')
+    categoryBuddyIdToCategoryId  Category[] @relation('Category_buddyIdToCategory')
+    categoryMentorIdToCategoryId  Category[] @relation('Category_mentorIdToCategory')
+}`,
+            );
+            runCli('db push', workDir);
+
+            const schemaFile = path.join(workDir, 'zenstack/schema.zmodel');
+
+            fs.writeFileSync(schemaFile, getDefaultPrelude());
+            runCli('db pull --indent 4', workDir);
+
+            const restoredSchema = getSchema(workDir);
+
+            expect(restoredSchema).toEqual(schema);
+        });
+
+        it('should preserve self-referencing model with multiple FK columns', async () => {
+            const { workDir, schema } = await createProject(
+                `model Category {
+    id               Int       @id @default(autoincrement())
+    category Category? @relation('Category_parentIdToCategory', fields: [parentId], references: [id])
+    parentId Int?
+    buddy    Category?  @relation('Category_buddyIdToCategory', fields: [buddyId], references: [id])
+    buddyId  Int?
+    mentor   Category?  @relation('Category_mentorIdToCategory', fields: [mentorId], references: [id])
+    mentorId Int?
+    categories Category[] @relation('Category_parentIdToCategory')
+    buddys  Category[] @relation('Category_buddyIdToCategory')
+    mentees  Category[] @relation('Category_mentorIdToCategory')
+}`,
+            );
+            runCli('db push', workDir);
+            runCli('db pull --indent 4', workDir);
+
+            const restoredSchema = getSchema(workDir);
+
+            expect(restoredSchema).toEqual(schema);
+        });
+
         it('should restore one-to-one relation when FK is the single-column primary key', async () => {
             const { workDir, schema } = await createProject(
                 `model Profile {