Skip to content

openapi-framework: Fix dynamic import to work with jest (fixes #909) #908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
coryasilva wants to merge 1 commit into
base: main
Choose a base branch
from
Open

openapi-framework: Fix dynamic import to work with jest (fixes #909) #908

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions packages/openapi-framework/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import os from 'node:os';
import fsRoutes from 'fs-routes';
import OpenAPIDefaultSetter from 'openapi-default-setter';
import OpenAPIRequestCoercer from 'openapi-request-coercer';
Expand Down Expand Up @@ -230,12 +231,20 @@ export default class OpenAPIFramework implements IOpenAPIFramework {
})
.map(async (fsRoutesItem) => {
routesCheckMap[fsRoutesItem.route] = true;
// There are two cases to distinguish:
// - file is a CommonJS script, and `module.export` appears
// as `default` property
// - file is a ECMAScript module, and `export default` appears
// at top-level
const imported = await import(`file://${fsRoutesItem.path}`);
/**
* There are a few cases to distinguish:
* - file is a CommonJS script, and `module.export` appears
* as `default` property.
* - file is a ECMAScript module, and `export default` appears
* at top-level.
* - OS is Windows needs absolute path while others support
* relative paths.
*/
let importPath = fsRoutesItem.path;
if (os.type().includes('Windows')) {
importPath = `file://${importPath}`;
}
const imported = await import(importPath);
return {
path: fsRoutesItem.route,
module: imported.default ?? imported,
Expand Down