Skip to content
14 changes: 14 additions & 0 deletions src/jsc/NodeModuleModule.rs
Original file line number Diff line number Diff line change
Expand Up @@ -228,21 +228,35 @@
Ok(())
}

/// Default keys of `Module._extensions` (see `JSCommonJSExtensions::finishCreation`).
const EXTENSIONS_DEFAULT_KEYS: &[&[u8]] = &[
b".js", b".json", b".node", b".ts", b".cts", b".mjs", b".mts",
];

pub fn find_longest_registered_extension<'a>(
vm: &'a VirtualMachine,
filename: &[u8],
) -> Option<&'a CustomLoader> {
let basename = bun_paths::basename(filename);
let mut next: usize = 0;
let mut last_ext: &[u8] = b"";
while let Some(i) = strings::index_of_char_pos(basename, b'.', next) {
next = i + 1;
if i == 0 {
continue;
}
let ext = &basename[i..];
last_ext = ext;
if let Some(value) = vm.commonjs_custom_extensions.get(ext) {
return Some(value);
}
if EXTENSIONS_DEFAULT_KEYS.iter().any(|k| *k == ext) {

Check failure on line 253 in src/jsc/NodeModuleModule.rs

View workflow job for this annotation

GitHub Actions / cargo clippy

using `contains()` instead of `iter().any()` is more efficient
return None;
}
}
// Node's `.js` fallback; skip for extensions Bun handles natively (e.g. `.jsx`).
if last_ext == b".cjs" || DEFAULT_LOADERS.get(last_ext).is_none() {
return vm.commonjs_custom_extensions.get(b".js".as_slice());
}
Comment thread
robobun marked this conversation as resolved.
Resolved
None
}
Expand Down
141 changes: 95 additions & 46 deletions src/jsc/bindings/JSCommonJSModule.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -235,16 +235,24 @@
bool JSCommonJSModule::load(JSC::VM& vm, Zig::GlobalObject* globalObject)
{
auto scope = DECLARE_THROW_SCOPE(vm);
if (this->hasEvaluated || this->sourceCode.isNull()) {
if (this->hasEvaluated) {
return true;
}

evaluateCommonJSModuleOnce(
globalObject->vm(),
globalObject,
this,
this->m_dirname.get(),
this->m_filename.get());
if (JSValue extension = this->m_pendingCustomExtension.get()) {
this->m_pendingCustomExtension.clear();
evaluateCommonJSCustomExtension(globalObject, this, this->m_filename.get(), extension);
this->hasEvaluated = true;
} else if (this->sourceCode.isNull()) {
return true;
} else {
evaluateCommonJSModuleOnce(
globalObject->vm(),
globalObject,
this,
this->m_dirname.get(),
this->m_filename.get());
}

if (auto exception = scope.exception()) {
(void)scope.tryClearException();
Expand Down Expand Up @@ -1189,6 +1197,7 @@
visitor.appendHidden(thisObject->m_paths);
visitor.appendHidden(thisObject->m_overriddenParent);
visitor.appendHidden(thisObject->m_overriddenCompile);
visitor.appendHidden(thisObject->m_pendingCustomExtension);
visitor.appendHidden(thisObject->m_childrenValue);
{
WTF::Locker locker { thisObject->cellLock() };
Expand Down Expand Up @@ -1551,12 +1560,22 @@
if (entry) {
if (auto* moduleObject = dynamicDowncast<JSCommonJSModule>(entry)) {
if (!moduleObject->hasEvaluated) {
evaluateCommonJSModuleOnce(
vm,
globalObject,
moduleObject,
moduleObject->m_dirname.get(),
moduleObject->m_filename.get());
if (JSValue extension = moduleObject->m_pendingCustomExtension.get()) {
moduleObject->m_pendingCustomExtension.clear();
evaluateCommonJSCustomExtension(
globalObject,
moduleObject,
moduleObject->m_filename.get(),
extension);
moduleObject->hasEvaluated = true;
} else {
evaluateCommonJSModuleOnce(
vm,
globalObject,
moduleObject,
moduleObject->m_dirname.get(),
moduleObject->m_filename.get());
}
if (auto exception = scope.exception()) {
(void)scope.tryClearException();

Expand All @@ -1581,58 +1600,88 @@
sourceURL));
}

std::optional<JSC::SourceCode> createCommonJSModule(
static JSCommonJSModule* getOrCreateCommonJSModule(
Zig::GlobalObject* globalObject,
JSC::JSString* requireMapKey,
Ref<JSC::SourceProvider>&& sourceProvider,
bool ignoreESModuleAnnotation)
const WTF::String& sourceURL,
JSC::SourceCode&& sourceCode)
{
auto& vm = JSC::getVM(globalObject);
auto scope = DECLARE_THROW_SCOPE(vm);
JSCommonJSModule* moduleObject = nullptr;
WTF::String sourceURL = sourceProvider->sourceURL();
SourceOrigin sourceOrigin = sourceProvider->sourceOrigin();

JSValue entry = globalObject->requireMap()->get(globalObject, requireMapKey);
RETURN_IF_EXCEPTION(scope, {});

RETURN_IF_EXCEPTION(scope, nullptr);
if (entry) {
moduleObject = dynamicDowncast<JSCommonJSModule>(entry);
if (auto* moduleObject = dynamicDowncast<JSCommonJSModule>(entry))
return moduleObject;
}

if (!moduleObject) {
size_t index = sourceURL.reverseFind(PLATFORM_SEP, sourceURL.length());
JSString* dirname;
JSString* filename = requireMapKey;
if (index != WTF::notFound) {
dirname = JSC::jsSubstring(globalObject, requireMapKey, 0, index);
RETURN_IF_EXCEPTION(scope, {});
} else {
dirname = jsEmptyString(vm);
}
auto requireMap = globalObject->requireMap();
if (requireMap->size() == 0) {
requireMapKey = JSC::jsString(vm, WTF::String("."_s));
}
size_t index = sourceURL.reverseFind(PLATFORM_SEP, sourceURL.length());
JSString* dirname;
JSString* filename = requireMapKey;
if (index != WTF::notFound) {
dirname = JSC::jsSubstring(globalObject, requireMapKey, 0, index);
RETURN_IF_EXCEPTION(scope, nullptr);
} else {
dirname = jsEmptyString(vm);
}
auto requireMap = globalObject->requireMap();
if (requireMap->size() == 0) {
requireMapKey = JSC::jsString(vm, WTF::String("."_s));
}

moduleObject = JSCommonJSModule::create(
vm,
globalObject->CommonJSModuleObjectStructure(),
requireMapKey, filename, dirname, JSC::SourceCode(WTF::move(sourceProvider)));
auto* moduleObject = JSCommonJSModule::create(
vm,
globalObject->CommonJSModuleObjectStructure(),
requireMapKey, filename, dirname, WTF::move(sourceCode));

moduleObject->putDirect(vm,
WebCore::clientData(vm)->builtinNames().exportsPublicName(),
JSC::constructEmptyObject(globalObject, globalObject->objectPrototype()), 0);
moduleObject->putDirect(vm,
WebCore::clientData(vm)->builtinNames().exportsPublicName(),
JSC::constructEmptyObject(globalObject, globalObject->objectPrototype()), 0);

requireMap->set(globalObject, filename, moduleObject);
RETURN_IF_EXCEPTION(scope, {});
}
requireMap->set(globalObject, filename, moduleObject);
RETURN_IF_EXCEPTION(scope, nullptr);
return moduleObject;
}

std::optional<JSC::SourceCode> createCommonJSModule(
Zig::GlobalObject* globalObject,
JSC::JSString* requireMapKey,
Ref<JSC::SourceProvider>&& sourceProvider,
bool ignoreESModuleAnnotation)
{
auto& vm = JSC::getVM(globalObject);
auto scope = DECLARE_THROW_SCOPE(vm);
WTF::String sourceURL = sourceProvider->sourceURL();
SourceOrigin sourceOrigin = sourceProvider->sourceOrigin();

auto* moduleObject = getOrCreateCommonJSModule(
globalObject, requireMapKey, sourceURL, JSC::SourceCode(WTF::move(sourceProvider)));
RETURN_IF_EXCEPTION(scope, {});
moduleObject->ignoreESModuleAnnotation = ignoreESModuleAnnotation;

return commonJSModuleSyntheticSourceCode(sourceOrigin, sourceURL);
}

std::optional<JSC::SourceCode> createCommonJSModuleForCustomExtension(
Zig::GlobalObject* globalObject,
JSC::JSString* requireMapKey,
JSC::JSValue extension)
{
auto& vm = JSC::getVM(globalObject);
auto scope = DECLARE_THROW_SCOPE(vm);
WTF::String sourceURL = requireMapKey->value(globalObject);
RETURN_IF_EXCEPTION(scope, {});
SourceOrigin sourceOrigin = Zig::toSourceOrigin(sourceURL, false);

auto* moduleObject = getOrCreateCommonJSModule(
globalObject, requireMapKey, sourceURL, JSC::SourceCode());
RETURN_IF_EXCEPTION(scope, {});
moduleObject->m_pendingCustomExtension.set(vm, moduleObject, extension);

Check warning on line 1680 in src/jsc/bindings/JSCommonJSModule.cpp

View check run for this annotation

Claude / Claude Code Review

m_pendingCustomExtension set unconditionally on already-evaluated modules

Nit: `getOrCreateCommonJSModule` can return an already-evaluated module (e.g. `createRequire()('./dep.js')` followed by `await import('./dep.js')` under a `.js` override + `"type":"commonjs"`), and this line then unconditionally stashes `m_pendingCustomExtension` on it. Both consumers — `load()` and the synthetic-generator lambda — check `!hasEvaluated` BEFORE reading/clearing the field, so it's left set forever, violating the header-documented one-shot invariant; if user code later flips `modul
Comment thread
robobun marked this conversation as resolved.
Resolved

return commonJSModuleSyntheticSourceCode(sourceOrigin, sourceURL);
}

JSObject* JSCommonJSModule::createBoundRequireFunction(VM& vm, JSGlobalObject* lexicalGlobalObject, const WTF::String& pathString)
{
ASSERT(!pathString.startsWith("file://"_s));
Expand Down
7 changes: 7 additions & 0 deletions src/jsc/bindings/JSCommonJSModule.h
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ class JSCommonJSModule final : public JSC::JSDestructibleObject {
// If compile is overridden, it is assigned to this field. The default
// compile function is not stored here, but in
mutable JSC::WriteBarrier<Unknown> m_overriddenCompile;
// `Module._extensions` handler to invoke at deferred synthetic-module eval time.
mutable JSC::WriteBarrier<Unknown> m_pendingCustomExtension;

bool ignoreESModuleAnnotation { false };
JSC::SourceCode sourceCode = JSC::SourceCode();
Expand Down Expand Up @@ -184,6 +186,11 @@ inline std::optional<JSC::SourceCode> createCommonJSModule(
return createCommonJSModule(globalObject, specifierValue, source, false);
}

std::optional<JSC::SourceCode> createCommonJSModuleForCustomExtension(
Zig::GlobalObject* globalObject,
JSC::JSString* specifierValue,
JSC::JSValue extension);

class RequireResolveFunctionPrototype final : public JSC::JSNonFinalObject {
public:
using Base = JSC::JSNonFinalObject;
Expand Down
21 changes: 19 additions & 2 deletions src/jsc/bindings/ModuleLoader.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -616,7 +616,6 @@ JSValue resolveAndFetchBuiltinModule(
void evaluateCommonJSCustomExtension(
Zig::GlobalObject* globalObject,
JSCommonJSModule* target,
String filename,
JSValue filenameValue,
JSValue extension)
{
Expand Down Expand Up @@ -864,7 +863,7 @@ JSValue fetchCommonJSModuleNonBuiltin(
JSC::throwException(globalObject, scope, JSC::createSyntaxError(globalObject, "Recursive extension. This is a bug in Bun"_s));
RELEASE_AND_RETURN(scope, {});
}
evaluateCommonJSCustomExtension(globalObject, target, specifierWtfString, specifierValue, JSC::JSValue::decode(res->result.value.cjsCustomExtension));
evaluateCommonJSCustomExtension(globalObject, target, specifierValue, JSC::JSValue::decode(res->result.value.cjsCustomExtension));
RETURN_IF_EXCEPTION(scope, {});
RELEASE_AND_RETURN(scope, target);
}
Expand Down Expand Up @@ -1114,6 +1113,24 @@ static JSValue fetchESMSourceCode(
RELEASE_AND_RETURN(scope, reject(exception));
}

if (res->result.value.tag == SyntheticModuleType::CommonJSCustomExtension) {
auto created = Bun::createCommonJSModuleForCustomExtension(
globalObject, specifierJS, JSC::JSValue::decode(res->result.value.cjsCustomExtension));
EXCEPTION_ASSERT(created.has_value() == !scope.exception());
if (created.has_value()) {
RELEASE_AND_RETURN(scope, rejectOrResolve(JSSourceCode::create(vm, WTF::move(created.value()))));
}

if constexpr (allowPromise) {
auto* exception = scope.exception();
(void)scope.tryClearException();
RELEASE_AND_RETURN(scope, rejectedInternalPromise(globalObject, exception));
} else {
scope.release();
return {};
}
}

// The JSONForObjectLoader tag is source code returned from Bun that needs
// to go through the JSON parser in JSC.
//
Expand Down
6 changes: 6 additions & 0 deletions src/jsc/bindings/ModuleLoader.h
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,10 @@ JSValue fetchBuiltinModuleWithoutResolution(
BunString* specifier,
ErrorableResolvedSource* res);

void evaluateCommonJSCustomExtension(
Zig::GlobalObject* globalObject,
JSCommonJSModule* target,
JSValue filenameValue,
JSValue extension);

} // namespace Bun
65 changes: 33 additions & 32 deletions src/runtime/jsc_hooks.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4229,19 +4229,50 @@ unsafe fn transpile_file(
}
});

// ── module_type sniff from extension / package.json ─────────────────────
let module_type: ModuleType = 'brk: {
let ext = lr.path.name().ext;
// regex /\.[cm][jt]s$/
if ext.len() == b".cjs".len() {
if ext == b".cjs" {
break 'brk ModuleType::Cjs;
}
if ext == b".mjs" {
break 'brk ModuleType::Esm;
}
if ext == b".cts" {
break 'brk ModuleType::Cjs;
}
if ext == b".mts" {
break 'brk ModuleType::Esm;
}
}
// regex /\.[jt]s$/
if ext.len() == b".ts".len() && (ext == b".js" || ext == b".ts") {
// Use the package.json module type if it exists.
break 'brk lr
.package_json
.map(|pkg| pkg.module_type)
.unwrap_or(ModuleType::Unknown);
}
// For JSX/TSX and other extensions, let the file contents decide.
ModuleType::Unknown
};

// ── force_loader / require.extensions override ──────────────────────────
if let Some(loader_type) = force_loader_type {
// Note: `@branchHint(.unlikely)` dropped (no stable Rust equiv).
debug_assert!(!is_commonjs_require);
lr.loader = Some(loader_type);
} else if is_commonjs_require
} else if (is_commonjs_require || module_type == ModuleType::Cjs)
&& lr.virtual_source.is_none()
// SAFETY: per fn contract.
&& unsafe { &*jsc_vm }.has_mutated_built_in_extensions > 0
{
use bun_jsc::node_module_module::{CustomLoader, find_longest_registered_extension};
if let Some(entry) =
// SAFETY: per fn contract.
find_longest_registered_extension(unsafe { &*jsc_vm }, _specifier.slice())
find_longest_registered_extension(unsafe { &*jsc_vm }, lr.path.text)
{
match entry {
CustomLoader::Loader(loader) => lr.loader = Some(*loader),
Expand All @@ -4262,36 +4293,6 @@ unsafe fn transpile_file(
}
}
}

// ── module_type sniff from extension / package.json ─────────────────────
let module_type: ModuleType = 'brk: {
let ext = lr.path.name().ext;
// regex /\.[cm][jt]s$/
if ext.len() == b".cjs".len() {
if ext == b".cjs" {
break 'brk ModuleType::Cjs;
}
if ext == b".mjs" {
break 'brk ModuleType::Esm;
}
if ext == b".cts" {
break 'brk ModuleType::Cjs;
}
if ext == b".mts" {
break 'brk ModuleType::Esm;
}
}
// regex /\.[jt]s$/
if ext.len() == b".ts".len() && (ext == b".js" || ext == b".ts") {
// Use the package.json module type if it exists.
break 'brk lr
.package_json
.map(|pkg| pkg.module_type)
.unwrap_or(ModuleType::Unknown);
}
// For JSX/TSX and other extensions, let the file contents decide.
ModuleType::Unknown
};
let pkg_name: Option<&[u8]> = lr
.package_json
.and_then(|pkg| (!pkg.name.is_empty()).then_some(&*pkg.name));
Expand Down
Loading
Loading