Fixes #7778: Add import.meta.dirname, import.meta.filename for Node compatibility
#7787
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…or compatibility with Node
…rt.meta.dirname and import.meta.filename
paperdave
requested changes
Jan 9, 2024
| * | ||
| * Does not have trailing slash | ||
| */ | ||
| readonly dirname: string; |
There was a problem hiding this comment.
i think you opened this before our big @types/bun PR. but can you remove these type declarations. they should be provided by @types/node
| @@ -641,6 +683,24 @@ void ImportMetaObject::finishCreation(VM& vm) | |||
|
|
|||
| init.set(jsString(init.vm, filename)); | |||
| }); | |||
| this->filenameProperty.initLater([](const JSC::LazyProperty<JSC::JSObject, JSC::JSString>::Initializer& init) { | |||
There was a problem hiding this comment.
this lazy property is identical to this->pathProperty please remove it.
| @@ -615,6 +635,28 @@ void ImportMetaObject::finishCreation(VM& vm) | |||
|
|
|||
| init.set(jsString(init.vm, dirname)); | |||
| }); | |||
| this->dirnameProperty.initLater([](const JSC::LazyProperty<JSC::JSObject, JSC::JSString>::Initializer& init) { | |||
There was a problem hiding this comment.
this lazy property is identical to this->dirProperty please remove it.
| { "file"_s, static_cast<unsigned>(JSC::PropertyAttribute::ReadOnly | JSC::PropertyAttribute::CustomAccessor | PropertyAttribute::DontDelete), NoIntrinsic, { HashTableValue::GetterSetterType, jsImportMetaObjectGetter_file, 0 } }, | ||
| { "filename"_s, static_cast<unsigned>(JSC::PropertyAttribute::ReadOnly | JSC::PropertyAttribute::CustomAccessor | PropertyAttribute::DontDelete), NoIntrinsic, { HashTableValue::GetterSetterType, jsImportMetaObjectGetter_filename, 0 } }, |
There was a problem hiding this comment.
Suggested change
| { "filename"_s, static_cast<unsigned>(JSC::PropertyAttribute::ReadOnly | JSC::PropertyAttribute::CustomAccessor | PropertyAttribute::DontDelete), NoIntrinsic, { HashTableValue::GetterSetterType, jsImportMetaObjectGetter_filename, 0 } }, | |
| { "filename"_s, static_cast<unsigned>(JSC::PropertyAttribute::ReadOnly | JSC::PropertyAttribute::CustomAccessor | PropertyAttribute::DontDelete), NoIntrinsic, { HashTableValue::GetterSetterType, jsImportMetaObjectGetter_path, 0 } }, |
There was a problem hiding this comment.
we probably need to check if it's readonly in node
| @@ -454,6 +456,14 @@ JSC_DEFINE_CUSTOM_GETTER(jsImportMetaObjectGetter_dir, (JSGlobalObject * globalO | |||
|
|
|||
| return JSValue::encode(thisObject->dirProperty.getInitializedOnMainThread(thisObject)); | |||
| } | |||
| JSC_DEFINE_CUSTOM_GETTER(jsImportMetaObjectGetter_dirname, (JSGlobalObject * globalObject, JSC::EncodedJSValue thisValue, PropertyName propertyName)) | |||
| @@ -462,6 +472,14 @@ JSC_DEFINE_CUSTOM_GETTER(jsImportMetaObjectGetter_file, (JSGlobalObject * global | |||
|
|
|||
| return JSValue::encode(thisObject->fileProperty.getInitializedOnMainThread(thisObject)); | |||
| } | |||
| JSC_DEFINE_CUSTOM_GETTER(jsImportMetaObjectGetter_filename, (JSGlobalObject * globalObject, JSC::EncodedJSValue thisValue, PropertyName propertyName)) | |||
|
Superseded by #8127 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR fixes #7778 by adding
import.meta.dirnameandimport.meta.filename, replicating new additions to Node v.21.2.0As suggested in the issue above,
import.meta.dirnamehas the same behaviour as Bun's existingimport.meta.dir.Bun's
import.meta.filedoes not prepend the path to the filename - so forimport.meta.filenamewe return a value equivalent to${import.meta.dir}/${import.meta.file}as suggested in the original issue.There are some slight changes on the desired output listed in #7778 since none of these
import.metaproperties should currently returnundefined:dirundefined/home/ubuntu/home/ubuntudirname/home/ubuntuundefined/home/ubuntufileundefinedtest.mjstest.mjsfilename/home/ubuntu/test.mjsundefined/home/ubuntu/test.mjsHow did you verify your code works?
Regression tests
Updating tests in
test/js/bun/resolve/import-meta.test.jsto cover new cases.I checked the lifetime of memory allocated to verify it's (1) freed and (2) only freed when it should be
I included a test for the new code, or an existing test covers it
JSValue used outside outside of the stack is either wrapped in a JSC.Strong or is JSValueProtect'ed
I wrote TypeScript/JavaScript tests and they pass locally (
bun-debug test test/js/bun/resolve/import-meta.test.js test/regression/issue/07778.test.ts)