Skip to content

prevent users from using Kernel with Bun #38

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

Merged
heyglassy merged 4 commits into from
Aug 13, 2025
+12 −0
Merged

prevent users from using Kernel with Bun #38

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89985e3
prevent users from using Kernel with Bun
heyglassy Aug 12, 2025
745fc0f
prettier
heyglassy Aug 12, 2025
80ec147
fix lints
heyglassy Aug 12, 2025
cfe990e
change copy and functionality
heyglassy Aug 12, 2025
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
12 changes: 12 additions & 0 deletions src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,18 @@ export class Kernel {
apiKey = readEnv('KERNEL_API_KEY'),
...opts
}: ClientOptions = {}) {
// Check for Bun runtime in a way that avoids type errors if Bun is not defined
if (
typeof globalThis !== 'undefined' &&
typeof (globalThis as any).Bun !== 'undefined' &&
(globalThis as any).Bun.version &&
!readEnv('KERNEL_SUPPRESS_BUN_WARNING')
) {
loggerFor(this).warn(
'The Bun runtime was detected. Playwright may have CDP connection issues, proceed with caution. Suppress this warning by setting the KERNEL_SUPPRESS_BUN_WARNING environment variable to true',
);
}

Copy link
Contributor

@rgarcia rgarcia Aug 12, 2025

Choose a reason for hiding this comment

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

The problem is the combination of Bun and Playwright, right? If so I think we should be more forgiving and log a warning to that effect (instead of throwing) and also give users the option to turn off the warning, e.g.

"WARNING: if you are using Playwright with Bun you will not be able to connect over CDP: {link to GitHub issue}.
Turn off this warning with KERNEL_BUN_WARNING=off"

Copy link
Contributor Author

@heyglassy heyglassy Aug 12, 2025

Choose a reason for hiding this comment

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

fixed!

if (apiKey === undefined) {
throw new Errors.KernelError(
"The KERNEL_API_KEY environment variable is missing or empty; either provide it, or instantiate the Kernel client with an apiKey option, like new Kernel({ apiKey: 'My API Key' }).",
Expand Down