rake-db 2.3.1 → 2.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rake-db",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "description": "Migrations tool for Postgresql DB",
   "homepage": "https://orchid-orm.netlify.app/guide/migration-setup-and-overview.html",
   "repository": {
@@ -42,7 +42,7 @@
   "dependencies": {
     "enquirer": "^2.3.6",
     "pluralize": "^8.0.0",
-    "pqb": "0.9.1"
+    "pqb": "0.9.2"
   },
   "devDependencies": {
     "@swc/core": "^1.2.210",

package/src/pull/astToMigration.test.ts

@@ -59,6 +59,41 @@ describe('astToMigration', () => {
       );
     });
 
+    it('should add columns with indexes and foreignKeys', () => {
+      const result = astToMigration([
+        {
+          ...tableAst,
+          shape: {
+            someId: columnTypes
+              .integer()
+              .unique({ name: 'indexName' })
+              .foreignKey('otherTable', 'otherId', {
+                name: 'fkey',
+                match: 'FULL',
+                onUpdate: 'CASCADE',
+                onDelete: 'CASCADE',
+              }),
+          },
+        },
+      ]);
+
+      expect(result).toBe(`import { change } from 'rake-db';
+
+change(async (db) => {
+  await db.createTable('schema.table', (t) => ({
+    someId: t.integer().foreignKey('otherTable', 'otherId', {
+      name: 'fkey',
+      match: 'FULL',
+      onUpdate: 'CASCADE',
+      onDelete: 'CASCADE',
+    }).unique({
+      name: 'indexName',
+    }),
+  }));
+});
+`);
+    });
+
     it('should add composite primaryKeys, indexes, foreignKeys', () => {
       const result = astToMigration([
         {

package/src/pull/astToMigration.ts

@@ -3,11 +3,14 @@ import {
   addCode,
   Code,
   codeToString,
+  ColumnType,
   foreignKeyToCode,
   indexToCode,
+  isRaw,
   primaryKeyToCode,
   quoteObjectKey,
   singleQuote,
+  TimestampColumn,
 } from 'pqb';
 import { quoteSchemaTable } from '../common';
 
@@ -40,13 +43,24 @@ const createTable = (ast: RakeDbAst.Table) => {
   const code: Code[] = [];
   addCode(code, `await db.createTable(${quoteSchemaTable(ast)}, (t) => ({`);
 
+  const hasTimestamps =
+    isTimestamp(ast.shape.createdAt) && isTimestamp(ast.shape.updatedAt);
+
   for (const key in ast.shape) {
+    if (hasTimestamps && (key === 'createdAt' || key === 'updatedAt')) continue;
+
     const line: Code[] = [`${quoteObjectKey(key)}: `];
-    addCode(line, ast.shape[key].toCode('t'));
+    for (const part of ast.shape[key].toCode('t')) {
+      addCode(line, part);
+    }
     addCode(line, ',');
     code.push(line);
   }
 
+  if (hasTimestamps) {
+    code.push(['...t.timestamps(),']);
+  }
+
   if (ast.primaryKey) {
     code.push([primaryKeyToCode(ast.primaryKey, 't')]);
   }
@@ -63,3 +77,17 @@ const createTable = (ast: RakeDbAst.Table) => {
 
   return code;
 };
+
+const isTimestamp = (column?: ColumnType) => {
+  if (!column) return false;
+
+  const { default: def } = column.data;
+  return (
+    column instanceof TimestampColumn &&
+    !column.data.isNullable &&
+    def &&
+    typeof def === 'object' &&
+    isRaw(def) &&
+    def.__raw === 'now()'
+  );
+};

package/src/pull/pull.test.ts

@@ -56,6 +56,24 @@ describe('pull', () => {
         type: 'text',
         isNullable: false,
       },
+      {
+        schemaName: 'public',
+        tableName: 'table2',
+        name: 'createdAt',
+        type: 'timestamp',
+        dateTimePrecision: 6,
+        isNullable: false,
+        default: 'now()',
+      },
+      {
+        schemaName: 'public',
+        tableName: 'table2',
+        name: 'updatedAt',
+        type: 'timestamp',
+        dateTimePrecision: 6,
+        isNullable: false,
+        default: 'now()',
+      },
     ];
 
     const config = getMigrationConfigWithDefaults({
@@ -84,6 +102,7 @@ change(async (db) => {
 
   await db.createTable('table2', (t) => ({
     text: t.text(),
+    ...t.timestamps(),
   }));
 });
 `,

package/src/pull/pull.ts

@@ -9,8 +9,12 @@ export const pullDbStructure = async (
   options: AdapterOptions,
   config: RakeDbConfig,
 ) => {
-  const db = new DbStructure(new Adapter(options));
+  const adapter = new Adapter(options);
+  const db = new DbStructure(adapter);
   const ast = await structureToAst(db);
+
+  await adapter.close();
+
   const result = astToMigration(ast);
   if (!result) return;
 

package/src/pull/structureToAst.test.ts

@@ -4,6 +4,8 @@ import {
   BigSerialColumn,
   DecimalColumn,
   IntegerColumn,
+  isRaw,
+  RawExpression,
   SerialColumn,
   SmallSerialColumn,
   TextColumn,
@@ -121,7 +123,9 @@ describe('structureToAst', () => {
       db.getTables = async () => [
         { schemaName: 'public', name: 'table', comment: 'comment' },
       ];
+
       const ast = await structureToAst(db);
+
       expect(ast).toEqual([
         {
           type: 'table',
@@ -139,7 +143,9 @@ describe('structureToAst', () => {
     it('should add table with schema', async () => {
       const db = new DbStructure(adapter);
       db.getTables = async () => [{ schemaName: 'custom', name: 'table' }];
+
       const ast = await structureToAst(db);
+
       expect(ast).toEqual([
         {
           type: 'table',
@@ -154,9 +160,20 @@ describe('structureToAst', () => {
       ]);
     });
 
+    it('should ignore schemaMigrations table', async () => {
+      const db = new DbStructure(adapter);
+      db.getTables = async () => [
+        { schemaName: 'public', name: 'schemaMigrations' },
+      ];
+
+      const ast = await structureToAst(db);
+
+      expect(ast).toEqual([]);
+    });
+
     it('should add columns', async () => {
       const db = new DbStructure(adapter);
-      db.getTables = async () => [{ schemaName: 'public', name: 'table' }];
+      db.getTables = async () => [table];
       db.getColumns = async () => columns;
 
       const [ast] = (await structureToAst(db)) as [RakeDbAst.Table];
@@ -167,6 +184,18 @@ describe('structureToAst', () => {
       expect(ast.shape.name).toBeInstanceOf(TextColumn);
     });
 
+    it('should wrap column default into raw', async () => {
+      const db = new DbStructure(adapter);
+      db.getTables = async () => [table];
+      db.getColumns = async () => [{ ...timestampColumn, default: 'now()' }];
+
+      const [ast] = (await structureToAst(db)) as [RakeDbAst.Table];
+
+      const { default: def } = ast.shape.timestamp.data;
+      expect(def && typeof def === 'object' && isRaw(def)).toBe(true);
+      expect((def as RawExpression).__raw).toBe('now()');
+    });
+
     describe('serial column', () => {
       it('should add serial column based on various default values', async () => {
         const db = new DbStructure(adapter);
@@ -231,7 +260,7 @@ describe('structureToAst', () => {
 
     it('should set maxChars to char column', async () => {
       const db = new DbStructure(adapter);
-      db.getTables = async () => [{ schemaName: 'public', name: 'table' }];
+      db.getTables = async () => [table];
       db.getColumns = async () => [varCharColumn];
 
       const [ast] = (await structureToAst(db)) as [RakeDbAst.Table];
@@ -243,7 +272,7 @@ describe('structureToAst', () => {
 
     it('should set numericPrecision and numericScale to decimal column', async () => {
       const db = new DbStructure(adapter);
-      db.getTables = async () => [{ schemaName: 'public', name: 'table' }];
+      db.getTables = async () => [table];
       db.getColumns = async () => [decimalColumn];
 
       const [ast] = (await structureToAst(db)) as [RakeDbAst.Table];
@@ -256,7 +285,7 @@ describe('structureToAst', () => {
 
     it('should set dateTimePrecision to timestamp column', async () => {
       const db = new DbStructure(adapter);
-      db.getTables = async () => [{ schemaName: 'public', name: 'table' }];
+      db.getTables = async () => [table];
       db.getColumns = async () => [timestampColumn];
 
       const [ast] = (await structureToAst(db)) as [RakeDbAst.Table];
@@ -270,7 +299,7 @@ describe('structureToAst', () => {
 
     it('should set primaryKey to column', async () => {
       const db = new DbStructure(adapter);
-      db.getTables = async () => [{ schemaName: 'public', name: 'table' }];
+      db.getTables = async () => [table];
       db.getColumns = async () => columns;
       db.getPrimaryKeys = async () => [primaryKey];
 
@@ -283,7 +312,7 @@ describe('structureToAst', () => {
 
     it('should add composite primary key', async () => {
       const db = new DbStructure(adapter);
-      db.getTables = async () => [{ schemaName: 'public', name: 'table' }];
+      db.getTables = async () => [table];
       db.getColumns = async () => columns;
       db.getPrimaryKeys = async () => [
         { ...primaryKey, columnNames: ['id', 'name'] },
@@ -301,7 +330,7 @@ describe('structureToAst', () => {
 
     it('should ignore primary key name if it is standard', async () => {
       const db = new DbStructure(adapter);
-      db.getTables = async () => [{ schemaName: 'public', name: 'table' }];
+      db.getTables = async () => [table];
       db.getColumns = async () => columns;
       db.getPrimaryKeys = async () => [
         { ...primaryKey, columnNames: ['id', 'name'], name: 'table_pkey' },

package/src/pull/structureToAst.ts

@@ -15,8 +15,8 @@ const matchMap = {
 };
 
 const fkeyActionMap = {
-  a: 'NO ACTION',
-  r: undefined, // default
+  a: undefined, // default
+  r: 'RESTRICT',
   c: 'CASCADE',
   n: 'SET NULL',
   d: 'SET DEFAULT',
@@ -56,6 +56,8 @@ export const structureToAst = async (db: DbStructure): Promise<RakeDbAst[]> => {
   for (const table of tables) {
     const { schemaName, name } = table;
 
+    if (name === 'schemaMigrations') continue;
+
     const belongsToTable = makeBelongsToTable(schemaName, name);
 
     const columns = allColumns.filter(belongsToTable);
@@ -66,13 +68,14 @@ export const structureToAst = async (db: DbStructure): Promise<RakeDbAst[]> => {
     const shape: ColumnsShape = {};
     for (let item of columns) {
       const isSerial = getIsSerial(item);
+      if (isSerial) {
+        item = { ...item, default: undefined };
+      }
+
       const klass = columnsByType[getColumnType(item, isSerial)];
       if (!klass) {
         throw new Error(`Column type \`${item.type}\` is not supported`);
       }
-      if (isSerial) {
-        item = { ...item, default: undefined };
-      }
 
       let column = instantiateColumn(klass, item);