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.

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

Only use last line as fileName when packing #115

Merged
merged 5 commits into from
Nov 28, 2024

Conversation

hjellek
Copy link
Contributor

@hjellek hjellek commented Nov 25, 2024

Fixes #114

@@ -48,7 +48,8 @@ export async function pack(srcDir: string, dstDir: string) {
);
});

const fileName = path.basename(stdout.trim());
const lastLine = stdout.trim().split("\n").pop() || "";
Copy link
Owner

@0x80 0x80 Nov 26, 2024

Choose a reason for hiding this comment

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

I think it would be better to throw a descriptive error if lastLine is undefined, don't you think? Maybe even add the stdout to the message, like Failed to parse last line from stdout: ${stdout.trim()}

If basename can't parse the empty string, or if fileName becomes an empty string, the resulting error might not be so obvious.

Also, I have a slight preference for at(-1) instead of pop(), but that's nitpicking :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed, updated now!

Copy link
Owner

@0x80 0x80 left a comment

Choose a reason for hiding this comment

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

See comment...

log.error(
`Failed to parse last line from stdout: ${stdout.trim()}`
);
throw new Error("Unable to find fileName from pack output");
Copy link
Owner

@0x80 0x80 Nov 26, 2024

Choose a reason for hiding this comment

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

I don't see a need to log and throw, as the thrown error message should appear anyway.

Please throw the message from log.error, as it is more informative.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure I understand exactly what you want me to do - only log, or only throw?

Copy link
Owner

Choose a reason for hiding this comment

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

Only throw, but throw an error with the message that you currently use in log.error. Thanks!

Copy link
Owner

@0x80 0x80 Nov 28, 2024

Choose a reason for hiding this comment

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

... unless you can convince me that logging + throwing has a clear benefit. I never do that myself(*), but that doesn't mean I'm right necessarily ;)

(*) Unless the thrown error ends up being visible to the end-user and the system needs to log more/sensitive information internally.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Gotcha, updated!

Well, I guess it depends on the error and log handling in general so I just did it both 😅
As you say, sometimes the error is shown to the user and the log message can contain more useful stuff for debugging.

Copy link
Owner

Choose a reason for hiding this comment

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

Please run prettier (pnpm format) to make the checks pass, then I can merge it...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

And thank you for your swift response, and efforts on the library in general 😊

0x80
0x80 previously approved these changes Nov 28, 2024
@0x80 0x80 merged commit b3cd98d into 0x80:main Nov 28, 2024
1 check passed
@0x80
Copy link
Owner

0x80 commented Nov 28, 2024

@hjellek I've published it under @next. Maybe you can give it a try and confirm that it works for you?

I will include it in firebase-tools-with-isolate when a new minor version of the upstream firebase-tools comes out.

@hjellek
Copy link
Contributor Author

hjellek commented Nov 28, 2024

@hjellek I've published it under @next. Maybe you can give it a try and confirm that it works for you?

I'll be happy to test, but I can't find a branch or tag called next now?

@hjellek hjellek deleted the fix-prepack-postpack-scripts branch November 28, 2024 19:08
@0x80
Copy link
Owner

0x80 commented Nov 29, 2024

@hjellek It's available on npm under @next. So something like pnpm add isolate-package@next -D should work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Running script in prepack fails the packing process
2 participants