rake-db 2.1.2 → 2.1.4

package/src/migration/createTable.test.ts

@@ -7,16 +7,15 @@ const db = getDb();
     beforeEach(resetDb);
 
     it(`should ${action} with comment`, async () => {
-      await db[action](
-        'name',
-        { comment: 'this is a table comment' },
-        () => ({}),
-      );
+      await db[action]('name', { comment: 'this is a table comment' }, (t) => ({
+        id: t.serial().primaryKey(),
+      }));
 
       if (action === 'createTable') {
         expectSql([
           `
             CREATE TABLE "name" (
+              "id" serial PRIMARY KEY
             )
           `,
           `COMMENT ON TABLE "name" IS 'this is a table comment'`,
@@ -170,7 +169,7 @@ const db = getDb();
 
     it('should support composite index', async () => {
       await db[action]('table', (t) => ({
-        id: t.integer(),
+        id: t.serial().primaryKey(),
         name: t.text(),
         ...t.index(['id', { column: 'name', order: 'DESC' }], {
           name: 'compositeIndexOnTable',
@@ -181,7 +180,7 @@ const db = getDb();
         expectSql([
           `
             CREATE TABLE "table" (
-              "id" integer NOT NULL,
+              "id" serial PRIMARY KEY,
               "name" text NOT NULL
             )
           `,
@@ -198,7 +197,7 @@ const db = getDb();
 
     it('should support composite unique index', async () => {
       await db[action]('table', (t) => ({
-        id: t.integer(),
+        id: t.serial().primaryKey(),
         name: t.text(),
         ...t.unique(['id', { column: 'name', order: 'DESC' }], {
           name: 'compositeIndexOnTable',
@@ -209,7 +208,7 @@ const db = getDb();
         expectSql([
           `
             CREATE TABLE "table" (
-              "id" integer NOT NULL,
+              "id" serial PRIMARY KEY,
               "name" text NOT NULL
             )
           `,
@@ -226,7 +225,7 @@ const db = getDb();
 
     it('should support composite foreign key', async () => {
       await db[action]('table', (t) => ({
-        id: t.integer(),
+        id: t.serial().primaryKey(),
         name: t.text(),
         ...t.foreignKey(
           ['id', 'name'],
@@ -253,7 +252,7 @@ const db = getDb();
 
         expectSql(`
           CREATE TABLE "table" (
-            "id" integer NOT NULL,
+            "id" serial PRIMARY KEY,
             "name" text NOT NULL,
             ${expectedConstraint}
           )
@@ -264,5 +263,50 @@ const db = getDb();
         `);
       }
     });
+
+    describe('noPrimaryKey', () => {
+      const { warn } = console;
+      afterAll(() => {
+        db.options.noPrimaryKey = undefined;
+        console.warn = warn;
+      });
+
+      it('should throw by default when no primary key', async () => {
+        await expect(() => db[action]('table', () => ({}))).rejects.toThrow(
+          'Table table has no primary key',
+        );
+      });
+
+      it('should throw when no primary key and noPrimaryKey is set to `error`', async () => {
+        db.options.noPrimaryKey = 'error';
+
+        await expect(() => db[action]('table', () => ({}))).rejects.toThrow(
+          'Table table has no primary key',
+        );
+      });
+
+      it('should warn when no primary key and noPrimaryKey is set to `warning`', async () => {
+        console.warn = jest.fn();
+        db.options.noPrimaryKey = 'warning';
+
+        db[action]('table', () => ({}));
+
+        expect(console.warn).toBeCalledWith('Table table has no primary key');
+      });
+
+      it('should not throw when no primary key and noPrimaryKey is set to `ignore`', async () => {
+        db.options.noPrimaryKey = 'ignore';
+
+        expect(() => db[action]('table', () => ({}))).not.toThrow();
+      });
+
+      it(`should not throw if option is set to \`true\` as a ${action} option`, async () => {
+        db.options.noPrimaryKey = 'error';
+
+        expect(() =>
+          db[action]('table', { noPrimaryKey: true }, () => ({})),
+        ).not.toThrow();
+      });
+    });
   });
 });

package/src/migration/createTable.ts

@@ -120,6 +120,29 @@ export const createTable = async (
   fn: ColumnsShapeCallback,
 ) => {
   const shape = getColumnTypes(types, fn);
+  const tableData = getTableData();
+
+  const { noPrimaryKey } = migration.options;
+  if (!options.noPrimaryKey && (!noPrimaryKey || noPrimaryKey !== 'ignore')) {
+    let hasPrimaryKey = !!tableData.primaryKey?.columns?.length;
+    if (!hasPrimaryKey) {
+      for (const key in shape) {
+        if (shape[key].isPrimaryKey) {
+          hasPrimaryKey = true;
+          break;
+        }
+      }
+    }
+
+    if (!hasPrimaryKey) {
+      const message = `Table ${tableName} has no primary key`;
+      if (!noPrimaryKey || noPrimaryKey === 'error') {
+        throw new Error(message);
+      } else {
+        console.warn(message);
+      }
+    }
+  }
 
   if (!up) {
     const { dropMode } = options;
@@ -152,7 +175,6 @@ export const createTable = async (
     lines.push(`\n  ${columnToSql(key, item, state)}`);
   }
 
-  const tableData = getTableData();
   if (tableData.primaryKey) {
     lines.push(`\n  ${primaryKeyToSql(tableData.primaryKey)}`);
   }

package/src/migration/migration.ts

@@ -10,7 +10,6 @@ import {
   QueryArraysResult,
   QueryInput,
   QueryLogObject,
-  QueryLogOptions,
   QueryResult,
   QueryResultRow,
   Sql,
@@ -20,11 +19,16 @@ import {
 } from 'pqb';
 import { createJoinTable, createTable } from './createTable';
 import { changeTable, TableChangeData, TableChanger } from './changeTable';
-import { quoteTable } from '../common';
+import { MigrationConfig, quoteTable } from '../common';
 
 export type DropMode = 'CASCADE' | 'RESTRICT';
 
-export type TableOptions = { dropMode?: DropMode; comment?: string };
+export type TableOptions = {
+  dropMode?: DropMode;
+  comment?: string;
+  noPrimaryKey?: boolean;
+};
+
 export type ColumnsShapeCallback = (
   t: ColumnTypes & { raw: typeof raw },
 ) => ColumnsShape;
@@ -56,7 +60,7 @@ export class Migration extends TransactionAdapter {
   constructor(
     tx: TransactionAdapter,
     public up: boolean,
-    options: QueryLogOptions,
+    public options: MigrationConfig,
   ) {
     super(tx.pool, tx.client, tx.types);
     this.log = logParamToLogObject(options.logger || console, options.log);

package/src/test-utils.ts

@@ -8,6 +8,9 @@ export const getDb = () => {
 
   db = new Migration({} as unknown as TransactionAdapter, true, {
     log: false,
+    migrationsPath: 'migrations-path',
+    migrationsTable: 'schemaMigrations',
+    requireTs: require,
   });
   db.query = queryMock;
   return db;