Skip to content
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

Jump to bottom

Fix: #8914 #8917

Merged
merged 3 commits into from
Aug 22, 2022
Merged

Fix: #8914 #8917

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b5d5317
Fix: await DataSource from export file to support async loading
anton-pavlov-deel Apr 20, 2022
21638f1
fix: prettier errors
anton-pavlov-deel Apr 20, 2022
34555cd
updated code style
pleerock Jun 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/commands/CommandUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,10 @@ export class CommandUtils {
}

const dataSourceExports = []
for (let fileExport in dataSourceFileExports) {
if (
InstanceChecker.isDataSource(dataSourceFileExports[fileExport])
) {
dataSourceExports.push(dataSourceFileExports[fileExport])
for (const fileExport of dataSourceFileExports) {
const awaitedFileExport = await fileExport
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can't we add a check (something like if (fileExport instanceof Promise)) in order to make it more clear? also I recommend to add a comment line and explain why this change is needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pleerock Sure, we can. It was decided to do so for sake of shortness (as far as await does not make (almost) any effect on non-Promise value this way).

But if it will be more clear this way, we can do like this (and the comment would be like that):

// It is necessary to await here in case of the exported async value (Promise<DataSource>).
// e.g. the DataSource is instantiated with an async factory in the source file
const awaitedFileExport = fileExport instanceof Promise 
  ? await fileExport
  : fileExport;

What do you think?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pleerock It's possible, but some people still use eg. Bluebird promises or compilation chains with Promise polyfills. There isn't any benefit in instanceof Promise checks, but only some obscure bug reports.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think awaiting doesn't introduce any overhead, as MDN states - Returns the fulfilled value of the promise, or the value itself if it's not a Promise. And even if there is any, it is too small. So I would agree with @Ginden on this one

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes so sometimes I prefer to have more code to make things more explicit / transparent and easier to understand.

if (InstanceChecker.isDataSource(awaitedFileExport)) {
dataSourceExports.push(awaitedFileExport)
}
}

Expand Down