fix: don't use require in es modules

Author: ForbesLindesay

packages/migrations-base/src/DirectoryContext.ts

@@ -11,7 +11,7 @@ export interface IDirectoryContext<TMigration = unknown> {
   delete(filename: string): Promise<void>;
   loadMigration(
     filename: string,
-  ): Result<TMigration, MigrationWithNoValidExport>;
+  ): Promise<Result<TMigration, MigrationWithNoValidExport>>;
 }
 
 export default class DirectoryContext<TMigration>
@@ -20,12 +20,12 @@ export default class DirectoryContext<TMigration>
   private readonly _directory: string;
   private readonly _loadMigration: (
     filename: string,
-  ) => Result<TMigration, MigrationWithNoValidExport>;
+  ) => Promise<Result<TMigration, MigrationWithNoValidExport>>;
   constructor(
     directory: string,
     loadMigration: (
       filename: string,
-    ) => Result<TMigration, MigrationWithNoValidExport>,
+    ) => Promise<Result<TMigration, MigrationWithNoValidExport>>,
   ) {
     this._directory = directory;
     this._loadMigration = loadMigration;
@@ -64,7 +64,7 @@ export default class DirectoryContext<TMigration>
 
   loadMigration(
     filename: string,
-  ): Result<TMigration, MigrationWithNoValidExport> {
+  ): Promise<Result<TMigration, MigrationWithNoValidExport>> {
     return this._loadMigration(this._resolve(filename));
   }
 }

packages/migrations-base/src/methods/applyOperations.ts

@@ -53,7 +53,7 @@ export default async function applyOperations<TMigration>(
           }
           switch (op.kind) {
             case 'apply':
-              const migrationLoadResult = engine.directory.loadMigration(
+              const migrationLoadResult = await engine.directory.loadMigration(
                 op.value.name,
               );
 

packages/migrations-base/src/types/DatabaseEngine.ts

@@ -38,7 +38,7 @@ export default interface DatabaseEngine<TMigration> extends DatabaseEngineBase {
 
   loadMigration(
     migrationFileName: string,
-  ): Result<TMigration, MigrationWithNoValidExport>;
+  ): Promise<Result<TMigration, MigrationWithNoValidExport>>;
 
   directory: IDirectoryContext<TMigration>;
 

packages/mysql/src/__tests__/dates.test.mysql.ts

@@ -1,8 +1,6 @@
 import connect, {sql} from '..';
 
-const mysql: {
-  createConnection: (opts: any) => any;
-} = require('mysql2/promise');
+import * as mysql from 'mysql2/promise';
 
 jest.setTimeout(30000);
 
@@ -22,7 +20,9 @@ beforeAll(async () => {
 });
 afterAll(async () => {
   await db.dispose();
+  // @ts-expect-error
   (await rawConnection).close();
+  // @ts-expect-error
   (await rawConnection2).close();
 });
 

packages/pg-migrations/src/PostgresDatabaseEngine.ts

@@ -1,4 +1,6 @@
 import {extname} from 'path';
+import {fileURLToPath} from 'url';
+import {readFileSync} from 'fs';
 import {
   DatabaseEngine,
   DatabaseEngineTransaction,
@@ -11,6 +13,10 @@ import {
 } from '@databases/migrations-base';
 import {ConnectionPool, Queryable, Transaction} from '@databases/pg';
 
+const packageVersion: string = JSON.parse(
+  readFileSync(fileURLToPath(import.meta.resolve('../package.json')), 'utf8'),
+).version;
+
 export interface MigrationsConfig {
   migrationsDirectory: string;
   /**
@@ -36,9 +42,9 @@ export default class PostgresDatabaseEngine
     this.directory = new DirectoryContext(
       config.migrationsDirectory,
       // load migration:
-      (
+      async (
         migrationFileName: string,
-      ): Result<Migration, MigrationWithNoValidExport> => {
+      ): Promise<Result<Migration, MigrationWithNoValidExport>> => {
         switch (extname(migrationFileName)) {
           case '.sql':
             return Result.ok(async (db: Transaction) => {
@@ -47,10 +53,16 @@ export default class PostgresDatabaseEngine
           case '.js':
           case '.mjs':
           case '.jsx':
-            return getExport(require(migrationFileName), migrationFileName);
+            return getExport(
+              await import(migrationFileName),
+              migrationFileName,
+            );
           case '.ts':
           case '.tsx':
-            return getExport(require(migrationFileName), migrationFileName);
+            return getExport(
+              await import(migrationFileName),
+              migrationFileName,
+            );
           default:
             throw new Error(
               `Unsupported extension "${extname(migrationFileName)}"`,
@@ -63,7 +75,7 @@ export default class PostgresDatabaseEngine
   readonly databaseName = 'Postgres';
   readonly packageName = '@databases/pg-migrations';
   readonly cliName = 'pg-migrations';
-  readonly packageVersion: string = require('../package.json').version;
+  readonly packageVersion: string = packageVersion;
 
   async checkDatabaseVersion(): Promise<Result<void, DatabaseVersionError>> {
     const [major, minor] = await getPgVersion(this._connection);
@@ -203,9 +215,9 @@ export default class PostgresDatabaseEngine
     });
   }
 
-  loadMigration(
+  async loadMigration(
     migrationFileName: string,
-  ): Result<Migration, MigrationWithNoValidExport> {
+  ): Promise<Result<Migration, MigrationWithNoValidExport>> {
     switch (extname(migrationFileName)) {
       case '.sql':
         return Result.ok(async (db: Transaction) => {
@@ -214,10 +226,10 @@ export default class PostgresDatabaseEngine
       case '.js':
       case '.mjs':
       case '.jsx':
-        return getExport(require(migrationFileName), migrationFileName);
+        return getExport(await import(migrationFileName), migrationFileName);
       case '.ts':
       case '.tsx':
-        return getExport(require(migrationFileName), migrationFileName);
+        return getExport(await import(migrationFileName), migrationFileName);
       default:
         throw new Error(
           `Unsupported extension "${extname(migrationFileName)}"`,

packages/pg/src/Driver.ts

@@ -9,8 +9,9 @@ import TransactionOptions from './types/TransactionOptions';
 import EventHandlers from './types/EventHandlers';
 import QueryStreamOptions from './types/QueryStreamOptions';
 import pgFormat from './format';
-const {codeFrameColumns} = require('@babel/code-frame');
-const Cursor = require('pg-cursor');
+import {codeFrameColumns} from '@babel/code-frame';
+// @ts-expect-error
+import Cursor from 'pg-cursor';
 
 type QueryResult = {rows: any[]};
 

packages/pg/src/TypeOverrides.ts

@@ -1,7 +1,8 @@
 import PgDataTypeID from '@databases/pg-data-type-id';
 import PgClient from './types/PgClient';
 
-const {types} = require('pg');
+// @ts-expect-error
+import {types} from 'pg';
 
 export type ParseFnText = (value: string) => any;
 export type ParseFnBinary = (value: Buffer) => any;

packages/sqlite/src/index.ts

@@ -2,7 +2,8 @@ import * as sqlite from 'sqlite3';
 import {escapeSQLiteIdentifier} from '@databases/escape-identifier';
 import sql, {SQLQuery, isSqlQuery, FormatConfig} from '@databases/sql';
 import Mutex from './Mutex';
-const Queue = require('then-queue');
+// @ts-expect-error
+import Queue from 'then-queue';
 
 export type {SQLQuery};
 export {sql, isSqlQuery};

scripts/build-package.mjs

@@ -138,9 +138,13 @@ async function fixup(path) {
                 throw new Error(
                   `Unexpectedly found a reference to ${path.node.name} in ${filename}`,
                 );
-              } else if (path.node.name === 'require') {
+              } else if (
+                path.node.name === 'require' ||
+                path.node.name === '__dirname' ||
+                path.node.name === '__filename'
+              ) {
                 throw new Error(
-                  `Unexpectedly found a reference to require in ${filename}`,
+                  `Unexpectedly found a reference to ${path.node.name} in ${filename}`,
                 );
               }
             },