rake-db 2.3.17 → 2.3.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rake-db",
-  "version": "2.3.17",
+  "version": "2.3.19",
   "description": "Migrations tool for Postgresql DB",
   "homepage": "https://orchid-orm.netlify.app/guide/migration-setup-and-overview.html",
   "repository": {
@@ -63,7 +63,7 @@
     "typescript": "^4.7.4"
   },
   "scripts": {
-    "db": "ts-node -r tsconfig-paths/register db.ts",
+    "db": "ts-node -r tsconfig-paths/register app/dbScript.ts",
     "test": "jest",
     "build": "rimraf ./dist/ && rollup -c --rollup.config"
   }

package/src/commands/createOrDrop.ts

@@ -34,7 +34,7 @@ const execute = async (
 const createOrDrop = async (
   options: AdapterOptions,
   adminOptions: AdapterOptions,
-  config: RakeDbConfig,
+  config: Pick<RakeDbConfig, 'migrationsTable'>,
   args: {
     sql(params: { database: string; user: string }): string;
     successMessage(params: { database: string }): string;

package/src/commands/generate.ts

@@ -12,7 +12,7 @@ export const writeMigrationFile = async (
   name: string,
   content: string,
 ) => {
-  await mkdir(path.resolve(config.migrationsPath), { recursive: true });
+  await mkdir(config.migrationsPath, { recursive: true });
 
   const filePath = path.resolve(
     config.migrationsPath,

package/src/commands/migrateOrRollback.test.ts

@@ -4,6 +4,7 @@ import { getMigrationFiles } from '../common';
 import { Adapter, noop, TransactionAdapter } from 'pqb';
 import { change } from '../migration/change';
 import { asMock } from '../test-utils';
+import * as url from 'url';
 
 jest.mock('../common', () => ({
   ...jest.requireActual('../common'),
@@ -33,10 +34,11 @@ Adapter.prototype.transaction = (cb) => {
 const transactionQueryMock = jest.fn();
 TransactionAdapter.prototype.query = transactionQueryMock;
 
-const requireTsMock = jest.fn();
+const importMock = jest.fn();
 const config = {
   ...migrationConfigDefaults,
-  requireTs: requireTsMock,
+  basePath: __dirname,
+  import: importMock,
   log: false,
   logger: {
     log: jest.fn(),
@@ -64,7 +66,7 @@ getMigratedVersionsArrayMock.mockImplementation(() => ({
 describe('migrateOrRollback', () => {
   beforeEach(() => {
     jest.clearAllMocks();
-    requireTsMock.mockImplementation(() => undefined);
+    importMock.mockImplementation(() => undefined);
   });
 
   describe('migrate', () => {
@@ -73,6 +75,7 @@ describe('migrateOrRollback', () => {
       migratedVersions = ['1'];
       const conf = {
         ...config,
+        basePath: __dirname,
         beforeMigrate: jest.fn(),
         afterMigrate: jest.fn(),
       };
@@ -84,8 +87,8 @@ describe('migrateOrRollback', () => {
       expect(conf.beforeMigrate).toBeCalled();
       expect(conf.afterMigrate).toBeCalled();
 
-      expect(requireTsMock).toBeCalledWith('file2');
-      expect(requireTsMock).toBeCalledWith('file3');
+      expect(importMock).toBeCalledWith(url.pathToFileURL('file2').pathname);
+      expect(importMock).toBeCalledWith(url.pathToFileURL('file3').pathname);
 
       expect(transactionQueryMock).toBeCalledWith(
         `INSERT INTO "schemaMigrations" VALUES ('2')`,
@@ -109,7 +112,7 @@ describe('migrateOrRollback', () => {
 
       expect(getMigrationFiles).toBeCalledWith(config, true);
       expect(createSchemaMigrations).toBeCalled();
-      expect(requireTsMock).not.toBeCalled();
+      expect(importMock).not.toBeCalled();
       expect(transactionQueryMock).not.toBeCalled();
       expect(config.logger.log).not.toBeCalled();
     });
@@ -117,7 +120,7 @@ describe('migrateOrRollback', () => {
     it('should call appCodeUpdater only on the first run', async () => {
       migrationFiles = [files[0]];
       migratedVersions = [];
-      requireTsMock.mockImplementationOnce(createTableCallback);
+      importMock.mockImplementationOnce(createTableCallback);
       const appCodeUpdater = jest.fn();
 
       await migrate(
@@ -132,7 +135,7 @@ describe('migrateOrRollback', () => {
     it('should not call appCodeUpdater when useCodeUpdater is set to false in config', async () => {
       migrationFiles = [files[0]];
       migratedVersions = [];
-      requireTsMock.mockImplementation(createTableCallback);
+      importMock.mockImplementation(createTableCallback);
       const appCodeUpdater = jest.fn();
 
       await migrate(
@@ -147,7 +150,7 @@ describe('migrateOrRollback', () => {
     it('should not call appCodeUpdater when having argument --code false', async () => {
       migrationFiles = [files[0]];
       migratedVersions = [];
-      requireTsMock.mockImplementation(createTableCallback);
+      importMock.mockImplementation(createTableCallback);
       const appCodeUpdater = jest.fn();
 
       await migrate(
@@ -162,7 +165,7 @@ describe('migrateOrRollback', () => {
     it('should call appCodeUpdater when having argument --code', async () => {
       migrationFiles = [files[0]];
       migratedVersions = [];
-      requireTsMock.mockImplementation(createTableCallback);
+      importMock.mockImplementation(createTableCallback);
       const appCodeUpdater = jest.fn();
 
       await migrate(
@@ -192,8 +195,8 @@ describe('migrateOrRollback', () => {
 
       expect(getMigrationFiles).toBeCalledWith(conf, false);
 
-      expect(requireTsMock).toBeCalledTimes(1);
-      expect(requireTsMock).toBeCalledWith('file2');
+      expect(importMock).toBeCalledTimes(1);
+      expect(importMock).toBeCalledWith(url.pathToFileURL('file2').pathname);
 
       expect(transactionQueryMock).toBeCalledTimes(1);
       expect(transactionQueryMock).toBeCalledWith(
@@ -214,7 +217,7 @@ describe('migrateOrRollback', () => {
 
       expect(getMigrationFiles).toBeCalledWith(config, false);
       expect(createSchemaMigrations).toBeCalled();
-      expect(requireTsMock).not.toBeCalled();
+      expect(importMock).not.toBeCalled();
       expect(transactionQueryMock).not.toBeCalled();
       expect(config.logger.log).not.toBeCalled();
     });

package/src/commands/migrateOrRollback.ts

@@ -23,6 +23,7 @@ import {
   getCurrentChangeCallback,
 } from '../migration/change';
 import { createMigrationInterface } from '../migration/migration';
+import { pathToFileURL } from 'url';
 
 const getDb = (adapter: Adapter) => createDb({ adapter });
 
@@ -123,7 +124,7 @@ const processMigration = async (
     if (callback) {
       change(callback);
     } else {
-      await config.requireTs(file.path);
+      await config.import(pathToFileURL(file.path).pathname);
       changeCache[file.path] = getCurrentChangeCallback();
     }
 

package/src/common.test.ts

@@ -2,17 +2,17 @@ import {
   createSchemaMigrations,
   getDatabaseAndUserFromOptions,
   getFirstWordAndRest,
-  getMigrationConfigWithDefaults,
+  processRakeDbConfig,
   getMigrationFiles,
   getTextAfterTo,
   joinColumns,
   joinWords,
-  migrationConfigDefaults,
   quoteWithSchema,
   setAdapterOptions,
   setAdminCredentialsToOptions,
   sortAsc,
   sortDesc,
+  migrationConfigDefaults,
 } from './common';
 import Enquirer from 'enquirer';
 import { Adapter } from 'pqb';
@@ -35,17 +35,20 @@ jest.mock('fs/promises', () => ({
   readdir: jest.fn(),
 }));
 
+const config = { ...migrationConfigDefaults, basePath: __dirname };
+
 describe('common', () => {
-  describe('getMigrationConfigWithDefaults', () => {
+  describe('processRakeDbConfig', () => {
     it('should return config with defaults', () => {
-      const result = getMigrationConfigWithDefaults({
+      const result = processRakeDbConfig({
         migrationsPath: 'custom-path',
       });
 
       expect(result).toEqual({
-        migrationsPath: 'custom-path',
+        basePath: __dirname,
+        migrationsPath: path.resolve(__dirname, 'custom-path'),
         migrationsTable: 'schemaMigrations',
-        requireTs: expect.any(Function),
+        import: expect.any(Function),
         log: true,
         logger: console,
         useCodeUpdater: true,
@@ -179,7 +182,7 @@ describe('common', () => {
     it('should create a "schemaMigrations" table', async () => {
       mockedQuery.mockReturnValueOnce(undefined);
 
-      await createSchemaMigrations(db, migrationConfigDefaults);
+      await createSchemaMigrations(db, config);
 
       expect(mockedQuery.mock.calls).toEqual([
         [`CREATE TABLE "schemaMigrations" ( version TEXT NOT NULL )`],
@@ -191,7 +194,7 @@ describe('common', () => {
     it('should inform if table already exists', async () => {
       mockedQuery.mockRejectedValue({ code: '42P07' });
 
-      await createSchemaMigrations(db, migrationConfigDefaults);
+      await createSchemaMigrations(db, config);
 
       expect(mockedQuery.mock.calls).toEqual([
         [`CREATE TABLE "schemaMigrations" ( version TEXT NOT NULL )`],
@@ -227,10 +230,10 @@ describe('common', () => {
       const files = [`${version}_a.ts`, `${version}_b.ts`, `${version}_c.ts`];
       (readdir as jest.Mock).mockReturnValueOnce(files);
 
-      const result = await getMigrationFiles(migrationConfigDefaults, true);
+      const result = await getMigrationFiles(config, true);
       expect(result).toEqual(
         files.map((file) => ({
-          path: path.join(migrationConfigDefaults.migrationsPath, file),
+          path: path.resolve(config.migrationsPath, file),
           version,
         })),
       );
@@ -239,24 +242,22 @@ describe('common', () => {
     it('should return empty array on error', async () => {
       (readdir as jest.Mock).mockRejectedValue(new Error());
 
-      const result = await getMigrationFiles(migrationConfigDefaults, true);
+      const result = await getMigrationFiles(config, true);
       expect(result).toEqual([]);
     });
 
     it('should throw if file is not a .ts file', async () => {
       (readdir as jest.Mock).mockReturnValueOnce(['file.js']);
 
-      await expect(
-        getMigrationFiles(migrationConfigDefaults, true),
-      ).rejects.toThrow('Only .ts files are supported');
+      await expect(getMigrationFiles(config, true)).rejects.toThrow(
+        'Only .ts files are supported',
+      );
     });
 
     it('should throw on improper version', async () => {
       (readdir as jest.Mock).mockReturnValueOnce(['1234567890_file.ts']);
 
-      await expect(
-        getMigrationFiles(migrationConfigDefaults, true),
-      ).rejects.toThrow(
+      await expect(getMigrationFiles(config, true)).rejects.toThrow(
         'Migration file name should start with 14 digit version',
       );
     });

package/src/common.ts

@@ -11,10 +11,12 @@ import Enquirer from 'enquirer';
 import path from 'path';
 import { readdir } from 'fs/promises';
 import { RakeDbAst } from './ast';
+import CallSite = NodeJS.CallSite;
 
 type Db = DbResult<DefaultColumnTypes>;
 
 export type RakeDbConfig = {
+  basePath: string;
   migrationsPath: string;
   migrationsTable: string;
   commands: Record<
@@ -25,7 +27,7 @@ export type RakeDbConfig = {
       args: string[],
     ) => Promise<void>
   >;
-  requireTs(path: string): Promise<void>;
+  import(path: string): Promise<void>;
   noPrimaryKey?: NoPrimaryKeyOption;
   appCodeUpdater?: AppCodeUpdater;
   useCodeUpdater?: boolean;
@@ -38,23 +40,56 @@ export type RakeDbConfig = {
 export type AppCodeUpdater = (params: {
   ast: RakeDbAst;
   options: AdapterOptions;
+  basePath: string;
   cache: object;
 }) => Promise<void>;
 
-export const migrationConfigDefaults: RakeDbConfig = {
-  migrationsPath: path.resolve('src', 'db', 'migrations'),
+export const migrationConfigDefaults: Omit<RakeDbConfig, 'basePath'> = {
+  migrationsPath: path.join('src', 'db', 'migrations'),
   migrationsTable: 'schemaMigrations',
   commands: {},
-  requireTs: (path: string) => import(path),
+  import: (path: string) => import(path),
   log: true,
   logger: console,
   useCodeUpdater: true,
 };
 
-export const getMigrationConfigWithDefaults = (
+export const processRakeDbConfig = (
   config: Partial<RakeDbConfig>,
-) => {
-  return { ...migrationConfigDefaults, ...config };
+): RakeDbConfig => {
+  const result = { ...migrationConfigDefaults, ...config };
+
+  if (!result.basePath) {
+    let stack: CallSite[] | undefined;
+    Error.prepareStackTrace = (_, s) => (stack = s);
+    new Error().stack;
+    if (stack) {
+      const thisFile = stack[0]?.getFileName();
+      for (const item of stack) {
+        const file = item.getFileName();
+        if (!file || file === thisFile || /\bnode_modules\b/.test(file)) {
+          continue;
+        }
+        result.basePath = path.dirname(file);
+        break;
+      }
+    }
+
+    if (!result.basePath) {
+      throw new Error(
+        'Failed to determine path to db script. Please set basePath option of rakeDb',
+      );
+    }
+  }
+
+  if (!path.isAbsolute(result.migrationsPath)) {
+    result.migrationsPath = path.resolve(
+      result.basePath,
+      result.migrationsPath,
+    );
+  }
+
+  return result as RakeDbConfig;
 };
 
 export const getDatabaseAndUserFromOptions = (
@@ -140,7 +175,7 @@ export const setAdminCredentialsToOptions = async (
 
 export const createSchemaMigrations = async (
   db: Adapter,
-  config: RakeDbConfig,
+  config: Pick<RakeDbConfig, 'migrationsTable'>,
 ) => {
   try {
     await db.query(
@@ -209,7 +244,7 @@ export const getMigrationFiles = async (
 
   let files: string[];
   try {
-    files = await readdir(path.resolve(migrationsPath));
+    files = await readdir(migrationsPath);
   } catch (_) {
     return [];
   }

package/src/migration/migration.ts

@@ -460,6 +460,7 @@ export const runCodeUpdater = (migration: MigrationBase, ast: RakeDbAst) => {
   return migration.options.appCodeUpdater?.({
     ast,
     options: migration.adapterOptions,
+    basePath: migration.options.basePath,
     cache: migration.appCodeUpdaterCache,
   });
 };

package/src/pull/pull.test.ts

@@ -1,6 +1,6 @@
 import { DbStructure } from './dbStructure';
 import { pullDbStructure } from './pull';
-import { getMigrationConfigWithDefaults } from '../common';
+import { processRakeDbConfig } from '../common';
 import { writeMigrationFile } from '../commands/generate';
 
 jest.mock('./dbStructure', () => {
@@ -76,7 +76,7 @@ describe('pull', () => {
       },
     ];
 
-    const config = getMigrationConfigWithDefaults({
+    const config = processRakeDbConfig({
       migrationsPath: 'migrations',
     });
 

package/src/rakeDb.test.ts

@@ -5,7 +5,7 @@ import { generate } from './commands/generate';
 import { pullDbStructure } from './pull/pull';
 
 jest.mock('./common', () => ({
-  getMigrationConfigWithDefaults: (config: unknown) => config,
+  processRakeDbConfig: (config: unknown) => config,
 }));
 
 jest.mock('./commands/createOrDrop', () => ({

package/src/rakeDb.ts

@@ -1,7 +1,7 @@
 import { AdapterOptions, MaybeArray, toArray } from 'pqb';
 import { createDb, dropDb, resetDb } from './commands/createOrDrop';
 import { migrate, rollback } from './commands/migrateOrRollback';
-import { getMigrationConfigWithDefaults, RakeDbConfig } from './common';
+import { processRakeDbConfig, RakeDbConfig } from './common';
 import { generate } from './commands/generate';
 import { pullDbStructure } from './pull/pull';
 
@@ -10,7 +10,7 @@ export const rakeDb = async (
   partialConfig: Partial<RakeDbConfig> = {},
   args: string[] = process.argv.slice(2),
 ) => {
-  const config = getMigrationConfigWithDefaults(partialConfig);
+  const config = processRakeDbConfig(partialConfig);
 
   const command = args[0]?.split(':')[0];
 

package/src/test-utils.ts

@@ -12,11 +12,13 @@ export const getDb = () => {
     {} as unknown as TransactionAdapter,
     true,
     {
+      basePath: __dirname,
       log: false,
       migrationsPath: 'migrations-path',
       migrationsTable: 'schemaMigrations',
-      requireTs: require,
+      import: require,
       appCodeUpdater: appCodeUpdaterMock,
+      commands: {},
     },
     {},
     {},

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "extends": "../../tsconfig.json",
-  "include": ["./src", "jest-setup.ts", "db.ts", "./migrations"],
+  "include": ["./src", "jest-setup.ts", "app"],
   "compilerOptions": {
     "outDir": "./dist",
     "noEmit": false,