fix: support ESM in ormconfig js & ts

fixes typeorm#5003
imnotjames · Oct 5, 2020 · bbdd4d5 · bbdd4d5
1 parent 161432a
commit bbdd4d5
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/src/connection/ConnectionOptionsReader.ts b/src/connection/ConnectionOptionsReader.ts
@@ -106,11 +106,14 @@ export class ConnectionOptionsReader {
         if (PlatformTools.getEnvVariable("TYPEORM_CONNECTION") || PlatformTools.getEnvVariable("TYPEORM_URL")) {
             connectionOptions = await new ConnectionOptionsEnvReader().read();
 
-        } else if (foundFileFormat === "js" || foundFileFormat === "cjs") {
-            connectionOptions = await require(configFile);
+        } else if (foundFileFormat === "js" || foundFileFormat === "cjs" || foundFileFormat === "ts") {
+            const configModule = await require(configFile);
 
-        } else if (foundFileFormat === "ts") {
-            connectionOptions = await require(configFile);
+            if (configModule && "__esModule" in configModule && "default" in configModule) {
+                connectionOptions = configModule.default;
+            } else {
+                connectionOptions = configModule;
+            }
 
         } else if (foundFileFormat === "json") {
             connectionOptions = require(configFile);

diff --git a/test/functional/connection-options-reader/configs/test-path-config-esm.ts b/test/functional/connection-options-reader/configs/test-path-config-esm.ts
@@ -0,0 +1,5 @@
+export default [{
+  type: "sqlite",
+  name: "file",
+  database: "test-js"
+}];
diff --git a/test/functional/connection-options-reader/connection-options-reader.ts b/test/functional/connection-options-reader/connection-options-reader.ts
@@ -37,6 +37,12 @@ describe("ConnectionOptionsReader", () => {
     expect(fileOptions.database).to.have.string("/test-js-async");
   });
 
+  it("properly loads config with specified file path from esm in js", async () => {
+    const connectionOptionsReader = new ConnectionOptionsReader({ root: __dirname, configName: "configs/test-path-config-esm.js" });
+    const fileOptions: ConnectionOptions = await connectionOptionsReader.get("file");
+    expect(fileOptions.database).to.have.string("/test-js");
+  });
+
   // TODO This test requires the configs/.env file be moved to the matching directory in build/compiled
   it.skip("properly loads config from .env file", async () => {
     const connectionOptionsReader = new ConnectionOptionsReader({ root: __dirname, configName: "configs/.env" });