rake-db 2.3.22 → 2.3.24

package/jest-setup.ts

@@ -1,3 +1,3 @@
-jest.mock('pqb', () => require('../pqb/src'), {
+jest.mock('pqb', () => require('../qb/pqb/src'), {
   virtual: true,
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rake-db",
-  "version": "2.3.22",
+  "version": "2.3.24",
   "description": "Migrations tool for Postgresql DB",
   "homepage": "https://orchid-orm.netlify.app/guide/migration-setup-and-overview.html",
   "repository": {
@@ -40,9 +40,9 @@
   "author": "Roman Kushyn",
   "license": "ISC",
   "dependencies": {
-    "enquirer": "^2.3.6",
     "pluralize": "^8.0.0",
-    "pqb": "0.9.12"
+    "pqb": "0.9.13",
+    "prompts": "^2.4.2"
   },
   "devDependencies": {
     "@swc/core": "^1.2.210",
@@ -51,6 +51,7 @@
     "@types/jest": "^28.1.2",
     "@types/node": "^18.0.1",
     "@types/pluralize": "^0.0.29",
+    "@types/prompts": "^2.4.2",
     "dotenv": "^16.0.3",
     "jest": "^28.1.2",
     "rimraf": "^3.0.2",
@@ -65,6 +66,7 @@
   "scripts": {
     "db": "ts-node -r tsconfig-paths/register app/dbScript.ts",
     "test": "jest",
+    "test:ci": "jest --coverage --coverageReporters json-summary",
     "build": "rimraf ./dist/ && rollup -c --rollup.config"
   }
 }

package/src/commands/createOrDrop.test.ts

@@ -28,6 +28,11 @@ Adapter.prototype.query = queryMock;
 const logMock = jest.fn();
 console.log = logMock;
 
+const config = {
+  ...migrationConfigDefaults,
+  basePath: __dirname,
+};
+
 describe('createOrDrop', () => {
   beforeEach(() => {
     jest.clearAllMocks();
@@ -37,7 +42,7 @@ describe('createOrDrop', () => {
     it('should create database when user is an admin', async () => {
       queryMock.mockResolvedValueOnce(undefined);
 
-      await createDb(options, migrationConfigDefaults);
+      await createDb(options, config);
 
       expect(queryMock.mock.calls).toEqual([
         [`CREATE DATABASE "dbname" OWNER "user"`],
@@ -53,7 +58,7 @@ describe('createOrDrop', () => {
 
       await createDb(
         [options, { ...options, database: 'dbname-test' }],
-        migrationConfigDefaults,
+        config,
       );
 
       expect(queryMock.mock.calls).toEqual([
@@ -70,7 +75,7 @@ describe('createOrDrop', () => {
     it('should inform if database already exists', async () => {
       queryMock.mockRejectedValueOnce({ code: '42P04' });
 
-      await createDb(options, migrationConfigDefaults);
+      await createDb(options, config);
 
       expect(queryMock.mock.calls).toEqual([
         [`CREATE DATABASE "dbname" OWNER "user"`],
@@ -79,10 +84,27 @@ describe('createOrDrop', () => {
       expect(createSchemaMigrations).toHaveBeenCalled();
     });
 
+    it('should inform if ssl is required', async () => {
+      queryMock.mockRejectedValueOnce({
+        code: 'XX000',
+        message: 'sslmode=require',
+      });
+
+      await createDb(options, config);
+
+      expect(queryMock.mock.calls).toEqual([
+        [`CREATE DATABASE "dbname" OWNER "user"`],
+      ]);
+      expect(logMock.mock.calls).toEqual([
+        ['SSL is required: append ?ssl=true to the database url string'],
+      ]);
+      expect(createSchemaMigrations).not.toHaveBeenCalled();
+    });
+
     it('should ask and use admin credentials when cannot connect', async () => {
       queryMock.mockRejectedValueOnce({ code: '42501' });
 
-      await createDb(options, migrationConfigDefaults);
+      await createDb(options, config);
 
       expect(setAdminCredentialsToOptions).toHaveBeenCalled();
       expect(queryMock.mock.calls).toEqual([
@@ -90,6 +112,9 @@ describe('createOrDrop', () => {
         [`CREATE DATABASE "dbname" OWNER "user"`],
       ]);
       expect(logMock.mock.calls).toEqual([
+        [
+          `Permission denied to create database.\nDon't use this command for database service providers, only for a local db.`,
+        ],
         [`Database dbname successfully created`],
       ]);
       expect(createSchemaMigrations).toHaveBeenCalled();
@@ -132,6 +157,23 @@ describe('createOrDrop', () => {
       expect(logMock.mock.calls).toEqual([[`Database dbname does not exist`]]);
     });
 
+    it('should inform if ssl is required', async () => {
+      queryMock.mockRejectedValueOnce({
+        code: 'XX000',
+        message: 'sslmode=require',
+      });
+
+      await createDb(options, config);
+
+      expect(queryMock.mock.calls).toEqual([
+        [`CREATE DATABASE "dbname" OWNER "user"`],
+      ]);
+      expect(logMock.mock.calls).toEqual([
+        ['SSL is required: append ?ssl=true to the database url string'],
+      ]);
+      expect(createSchemaMigrations).not.toHaveBeenCalled();
+    });
+
     it('should ask and use admin credentials when cannot connect', async () => {
       queryMock.mockRejectedValueOnce({ code: '42501' });
 
@@ -143,6 +185,9 @@ describe('createOrDrop', () => {
         [`DROP DATABASE "dbname"`],
       ]);
       expect(logMock.mock.calls).toEqual([
+        [
+          `Permission denied to drop database.\nDon't use this command for database service providers, only for a local db.`,
+        ],
         [`Database dbname was successfully dropped`],
       ]);
     });
@@ -152,7 +197,7 @@ describe('createOrDrop', () => {
     it('should drop and create database', async () => {
       queryMock.mockResolvedValue(undefined);
 
-      await resetDb(options, migrationConfigDefaults);
+      await resetDb(options, config);
 
       expect(queryMock.mock.calls).toEqual([
         [`DROP DATABASE "dbname"`],

package/src/commands/createOrDrop.ts

@@ -12,16 +12,31 @@ import { migrate } from './migrateOrRollback';
 const execute = async (
   options: AdapterOptions,
   sql: string,
-): Promise<'ok' | 'already' | 'forbidden' | { error: unknown }> => {
+): Promise<
+  'ok' | 'already' | 'forbidden' | 'ssl required' | { error: unknown }
+> => {
   const db = new Adapter(options);
+
   try {
     await db.query(sql);
     return 'ok';
   } catch (error) {
     const err = error as Record<string, unknown>;
+
+    if (
+      typeof err.message === 'string' &&
+      err.message.includes('sslmode=require')
+    ) {
+      return 'ssl required';
+    }
+
     if (err.code === '42P04' || err.code === '3D000') {
       return 'already';
-    } else if (err.code === '42501') {
+    } else if (
+      err.code === '42501' ||
+      (typeof err.message === 'string' &&
+        err.message.includes('password authentication failed'))
+    ) {
       return 'forbidden';
     } else {
       return { error };
@@ -39,7 +54,7 @@ const createOrDrop = async (
     sql(params: { database: string; user: string }): string;
     successMessage(params: { database: string }): string;
     alreadyMessage(params: { database: string }): string;
-    createVersionsTable?: boolean;
+    create?: boolean;
   },
 ) => {
   const params = getDatabaseAndUserFromOptions(options);
@@ -52,19 +67,38 @@ const createOrDrop = async (
     console.log(args.successMessage(params));
   } else if (result === 'already') {
     console.log(args.alreadyMessage(params));
+  } else if (result === 'ssl required') {
+    console.log('SSL is required: append ?ssl=true to the database url string');
+    return;
   } else if (result === 'forbidden') {
-    await createOrDrop(
+    let message = `Permission denied to ${
+      args.create ? 'create' : 'drop'
+    } database.`;
+
+    const host = adminOptions.databaseURL
+      ? new URL(adminOptions.databaseURL).hostname
+      : adminOptions.host;
+
+    const isLocal = host === 'localhost';
+    if (!isLocal) {
+      message += `\nDon't use this command for database service providers, only for a local db.`;
+    }
+
+    console.log(message);
+
+    const updatedOptions = await setAdminCredentialsToOptions(
       options,
-      await setAdminCredentialsToOptions(options),
-      config,
-      args,
+      args.create,
     );
+    if (!updatedOptions) return;
+
+    await createOrDrop(options, updatedOptions, config, args);
     return;
   } else {
     throw result.error;
   }
 
-  if (!args.createVersionsTable) return;
+  if (!args.create) return;
 
   const db = new Adapter(options);
   await createSchemaMigrations(db, config);
@@ -86,7 +120,7 @@ export const createDb = async (
       alreadyMessage({ database }) {
         return `Database ${database} already exists`;
       },
-      createVersionsTable: true,
+      create: true,
     });
   }
 };

package/src/common.test.ts

@@ -14,22 +14,13 @@ import {
   sortDesc,
   migrationConfigDefaults,
 } from './common';
-import Enquirer from 'enquirer';
+import prompts from 'prompts';
 import { Adapter } from 'pqb';
 import { readdir } from 'fs/promises';
 import path from 'path';
+import { asMock } from './test-utils';
 
-jest.mock('enquirer', () => {
-  class Snippet {
-    constructor(public params: Record<string, unknown>) {}
-    run() {}
-  }
-  Snippet.prototype.run = jest.fn();
-
-  return {
-    Snippet,
-  };
-});
+jest.mock('prompts', () => jest.fn());
 
 jest.mock('fs/promises', () => ({
   readdir: jest.fn(),
@@ -41,6 +32,7 @@ describe('common', () => {
   describe('processRakeDbConfig', () => {
     it('should return config with defaults', () => {
       const result = processRakeDbConfig({
+        basePath: __dirname,
         migrationsPath: 'custom-path',
       });
 
@@ -125,11 +117,13 @@ describe('common', () => {
 
   describe('setAdminCredentialsToOptions', () => {
     beforeEach(() => {
-      (Enquirer as any).Snippet.prototype.run.mockReturnValueOnce({
-        values: {
-          user: 'admin-user',
-          password: 'admin-password',
-        },
+      asMock(prompts).mockResolvedValueOnce({
+        confirm: true,
+      });
+
+      asMock(prompts).mockResolvedValueOnce({
+        user: 'admin-user',
+        password: 'admin-password',
       });
     });
 

package/src/common.ts

@@ -7,10 +7,10 @@ import {
   QueryLogOptions,
   singleQuote,
 } from 'pqb';
-import Enquirer from 'enquirer';
 import path from 'path';
 import { readdir } from 'fs/promises';
 import { RakeDbAst } from './ast';
+import prompts from 'prompts';
 
 type Db = DbResult<DefaultColumnTypes>;
 
@@ -152,40 +152,44 @@ export const setAdapterOptions = (
   }
 };
 
-const askAdminCredentials = async (): Promise<{
-  user: string;
-  password: string;
-}> => {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const prompt = new (Enquirer as any).Snippet({
-    message: `What are postgres admin login and password?`,
-    fields: [
-      {
-        name: 'user',
-        required: true,
-      },
-      {
-        name: 'password',
-      },
-    ],
-    values: {
-      user: 'postgres',
-      password: '',
+export const setAdminCredentialsToOptions = async (
+  options: AdapterOptions,
+  create?: boolean,
+): Promise<AdapterOptions | undefined> => {
+  const confirm = await prompts([
+    {
+      message: `Would you like to share admin credentials to ${
+        create ? 'create' : 'drop'
+      } a database`,
+      type: 'confirm',
+      name: 'confirm',
+      initial: true,
     },
-    template: 'Admin user: {{user}}\nAdmin password: {{password}}',
-  });
+  ]);
 
-  const { values } = await prompt.run();
-  if (!values.password) values.password = '';
+  if (!confirm.confirm) {
+    return;
+  }
 
-  return values;
-};
+  const values = await prompts([
+    {
+      message: 'Enter admin user:',
+      type: 'text',
+      name: 'user',
+      initial: 'postgres',
+      min: 1,
+    },
+    {
+      message: 'Enter admin password:',
+      type: 'password',
+      name: 'password',
+    },
+  ]);
 
-export const setAdminCredentialsToOptions = async (
-  options: AdapterOptions,
-): Promise<AdapterOptions> => {
-  const values = await askAdminCredentials();
-  return setAdapterOptions(options, values);
+  return setAdapterOptions(options, {
+    ...values,
+    password: values.password || undefined,
+  });
 };
 
 export const createSchemaMigrations = async (

package/tsconfig.json

@@ -6,7 +6,7 @@
     "noEmit": false,
     "baseUrl": ".",
     "paths": {
-      "pqb": ["../pqb/src"]
+      "pqb": ["../qb/pqb/src"]
     }
   }
 }