diff --git a/doc/api/errors.md b/doc/api/errors.md index dbd64a3f11fb9f..d740afb7f92055 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -2367,6 +2367,17 @@ error indicates that the idle loop has failed to stop. An attempt was made to use operations that can only be used when building V8 startup snapshot even though Node.js isn't building one. + + +### `ERR_NOT_IN_SINGLE_EXECUTABLE_APPLICATION` + + + +The operation cannot be performed when it's not in a single-executable +application. + ### `ERR_NOT_SUPPORTED_IN_SNAPSHOT` @@ -2513,6 +2524,17 @@ The [`server.close()`][] method was called when a `net.Server` was not running. This applies to all instances of `net.Server`, including HTTP, HTTPS, and HTTP/2 `Server` instances. + + +### `ERR_SINGLE_EXECUTABLE_APPLICATION_ASSET_NOT_FOUND` + + + +A key was passed to single executable application APIs to identify an asset, +but no match could be found. + ### `ERR_SOCKET_ALREADY_BOUND` diff --git a/doc/api/single-executable-applications.md b/doc/api/single-executable-applications.md index 12c9e34a9805f3..530fbff74ae553 100644 --- a/doc/api/single-executable-applications.md +++ b/doc/api/single-executable-applications.md @@ -178,7 +178,11 @@ The configuration currently reads the following top-level fields: "output": "/path/to/write/the/generated/blob.blob", "disableExperimentalSEAWarning": true, // Default: false "useSnapshot": false, // Default: false - "useCodeCache": true // Default: false + "useCodeCache": true, // Default: false + "assets": { // Optional + "a.dat": "/path/to/a.dat", + "b.txt": "/path/to/b.txt" + } } ``` @@ -186,6 +190,42 @@ If the paths are not absolute, Node.js will use the path relative to the current working directory. The version of the Node.js binary used to produce the blob must be the same as the one to which the blob will be injected. +### Assets + +Users can include assets by adding a key-path dictionary to the configuration +as the `assets` field. At build time, Node.js would read the assets from the +specified paths and bundle them into the preparation blob. In the generated +executable, users can retrieve the assets using the [`sea.getAsset()`][] and +[`sea.getAssetAsBlob()`][] APIs. + +```json +{ + "main": "/path/to/bundled/script.js", + "output": "/path/to/write/the/generated/blob.blob", + "assets": { + "a.jpg": "/path/to/a.jpg", + "b.txt": "/path/to/b.txt" + } +} +``` + +The single-executable application can access the assets as follows: + +```cjs +const { getAsset } = require('node:sea'); +// Returns a copy of the data in an ArrayBuffer. +const image = getAsset('a.jpg'); +// Returns a string decoded from the asset as UTF8. +const text = getAsset('b.txt', 'utf8'); +// Returns a Blob containing the asset. +const blob = getAssetAsBlob('a.jpg'); +// Returns an ArrayBuffer containing the raw asset without copying. +const raw = getRawAsset('a.jpg'); +``` + +See documentation of the [`sea.getAsset()`][] and [`sea.getAssetAsBlob()`][] +APIs for more information. + ### Startup snapshot support The `useSnapshot` field can be used to enable startup snapshot support. In this @@ -229,11 +269,79 @@ execute the script, which would improve the startup performance. **Note:** `import()` does not work when `useCodeCache` is `true`. -## Notes +## In the injected main script + +### Single-executable application API + +The `node:sea` builtin allows interaction with the single-executable application +from the JavaScript main script embedded into the executable. + +#### `sea.isSea()` + + + +* Returns: {boolean} Whether this script is running inside a single-executable + application. + +### `sea.getAsset(key[, encoding])` -### `require(id)` in the injected module is not file based + + +This method can be used to retrieve the assets configured to be bundled into the +single-executable application at build time. +An error is thrown when no matching asset can be found. + +* `key` {string} the key for the asset in the dictionary specified by the + `assets` field in the single-executable application configuration. +* `encoding` {string} If specified, the asset will be decoded as + a string. Any encoding supported by the `TextDecoder` is accepted. + If unspecified, an `ArrayBuffer` containing a copy of the asset would be + returned instead. +* Returns: {string|ArrayBuffer} + +### `sea.getAssetAsBlob(key[, options])` + + + +Similar to [`sea.getAsset()`][], but returns the result in a [`Blob`][]. +An error is thrown when no matching asset can be found. + +* `key` {string} the key for the asset in the dictionary specified by the + `assets` field in the single-executable application configuration. +* `options` {Object} + * `type` {string} An optional mime type for the blob. +* Returns: {Blob} + +### `sea.getRawAsset(key)` -`require()` in the injected module is not the same as the [`require()`][] + + +This method can be used to retrieve the assets configured to be bundled into the +single-executable application at build time. +An error is thrown when no matching asset can be found. + +Unlike `sea.getRawAsset()` or `sea.getAssetAsBlob()`, this method does not +return a copy. Instead, it returns the raw asset bundled inside the executable. + +For now, users should avoid writing to the returned array buffer. If the +injected section is not marked as writable or not aligned properly, +writes to the returned array buffer is likely to result in a crash. + +* `key` {string} the key for the asset in the dictionary specified by the + `assets` field in the single-executable application configuration. +* Returns: {string|ArrayBuffer} + +### `require(id)` in the injected main script is not file based + +`require()` in the injected main script is not the same as the [`require()`][] available to modules that are not injected. It also does not have any of the properties that non-injected [`require()`][] has except [`require.main`][]. It can only be used to load built-in modules. Attempting to load a module that can @@ -250,15 +358,17 @@ const { createRequire } = require('node:module'); require = createRequire(__filename); ``` -### `__filename` and `module.filename` in the injected module +### `__filename` and `module.filename` in the injected main script -The values of `__filename` and `module.filename` in the injected module are -equal to [`process.execPath`][]. +The values of `__filename` and `module.filename` in the injected main script +are equal to [`process.execPath`][]. -### `__dirname` in the injected module +### `__dirname` in the injected main script -The value of `__dirname` in the injected module is equal to the directory name -of [`process.execPath`][]. +The value of `__dirname` in the injected main script is equal to the directory +name of [`process.execPath`][]. + +## Notes ### Single executable application creation process @@ -298,9 +408,12 @@ to help us document them. [Mach-O]: https://en.wikipedia.org/wiki/Mach-O [PE]: https://en.wikipedia.org/wiki/Portable_Executable [Windows SDK]: https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/ +[`Blob`]: https://developer.mozilla.org/en-US/docs/Web/API/Blob [`process.execPath`]: process.md#processexecpath [`require()`]: modules.md#requireid [`require.main`]: modules.md#accessing-the-main-module +[`sea.getAsset()`]: #seagetassetkey-encoding +[`sea.getAssetAsBlob()`]: #seagetassetasblobkey-options [`v8.startupSnapshot.setDeserializeMainFunction()`]: v8.md#v8startupsnapshotsetdeserializemainfunctioncallback-data [`v8.startupSnapshot` API]: v8.md#startup-snapshot-api [documentation about startup snapshot support in Node.js]: cli.md#--build-snapshot diff --git a/lib/internal/bootstrap/realm.js b/lib/internal/bootstrap/realm.js index 57ab47178d033d..5b22d7c9d89ffa 100644 --- a/lib/internal/bootstrap/realm.js +++ b/lib/internal/bootstrap/realm.js @@ -128,6 +128,7 @@ const legacyWrapperList = new SafeSet([ // beginning with "internal/". // Modules that can only be imported via the node: scheme. const schemelessBlockList = new SafeSet([ + 'sea', 'test', 'test/reporters', ]); diff --git a/lib/internal/errors.js b/lib/internal/errors.js index d2250f5c7f053c..9c189f65acbd32 100644 --- a/lib/internal/errors.js +++ b/lib/internal/errors.js @@ -1632,6 +1632,8 @@ E('ERR_NETWORK_IMPORT_DISALLOWED', "import of '%s' by %s is not supported: %s", Error); E('ERR_NOT_BUILDING_SNAPSHOT', 'Operation cannot be invoked when not building startup snapshot', Error); +E('ERR_NOT_IN_SINGLE_EXECUTABLE_APPLICATION', + 'Operation cannot be invoked when not in a single-executable application', Error); E('ERR_NOT_SUPPORTED_IN_SNAPSHOT', '%s is not supported in startup snapshot', Error); E('ERR_NO_CRYPTO', 'Node.js is not compiled with OpenSSL crypto support', Error); @@ -1715,6 +1717,8 @@ E('ERR_SCRIPT_EXECUTION_INTERRUPTED', E('ERR_SERVER_ALREADY_LISTEN', 'Listen method has been called more than once without closing.', Error); E('ERR_SERVER_NOT_RUNNING', 'Server is not running.', Error); +E('ERR_SINGLE_EXECUTABLE_APPLICATION_ASSET_NOT_FOUND', + 'Cannot find asset %s for the single executable application', Error); E('ERR_SOCKET_ALREADY_BOUND', 'Socket is already bound', Error); E('ERR_SOCKET_BAD_BUFFER_SIZE', 'Buffer size must be a positive integer', TypeError); diff --git a/lib/sea.js b/lib/sea.js new file mode 100644 index 00000000000000..f7727014c4e3c9 --- /dev/null +++ b/lib/sea.js @@ -0,0 +1,76 @@ +'use strict'; +const { + ArrayBufferPrototypeSlice, +} = primordials; + +const { isSea, getAsset: getAssetInternal } = internalBinding('sea'); +const { TextDecoder } = require('internal/encoding'); +const { validateString } = require('internal/validators'); +const { + ERR_NOT_IN_SINGLE_EXECUTABLE_APPLICATION, + ERR_SINGLE_EXECUTABLE_APPLICATION_ASSET_NOT_FOUND, +} = require('internal/errors').codes; +const { Blob } = require('internal/blob'); + +/** + * Look for the asset in the injected SEA blob using the key. If + * no matching asset is found an error is thrown. The returned + * ArrayBuffer should not be mutated or otherwise the process + * can crash due to access violation. + * @param {string} key + * @returns {ArrayBuffer} + */ +function getRawAsset(key) { + validateString(key, 'key'); + + if (!isSea()) { + throw new ERR_NOT_IN_SINGLE_EXECUTABLE_APPLICATION(); + } + + const asset = getAssetInternal(key); + if (asset === undefined) { + throw new ERR_SINGLE_EXECUTABLE_APPLICATION_ASSET_NOT_FOUND(key); + } + return asset; +} + +/** + * Look for the asset in the injected SEA blob using the key. If the + * encoding is specified, return a string decoded from it by TextDecoder, + * otherwise return *a copy* of the original data in an ArrayBuffer. If + * no matching asset is found an error is thrown. + * @param {string} key + * @param {string|undefined} encoding + * @returns {string|ArrayBuffer} + */ +function getAsset(key, encoding) { + if (encoding !== undefined) { + validateString(encoding, 'encoding'); + } + const asset = getRawAsset(key); + if (encoding === undefined) { + return ArrayBufferPrototypeSlice(asset); + } + const decoder = new TextDecoder(encoding); + return decoder.decode(asset); +} + +/** + * Look for the asset in the injected SEA blob using the key. If + * no matching asset is found an error is thrown. The data is returned + * in a Blob. If no matching asset is found an error is thrown. + * @param {string} key + * @param {ConstructorParameters[1]} [options] + * @returns {Blob} + */ +function getAssetAsBlob(key, options) { + const asset = getRawAsset(key); + return new Blob([asset], options); +} + +module.exports = { + isSea, + getAsset, + getRawAsset, + getAssetAsBlob, +}; diff --git a/src/blob_serializer_deserializer-inl.h b/src/blob_serializer_deserializer-inl.h index 354d9267cf1f41..1d1204a96e6101 100644 --- a/src/blob_serializer_deserializer-inl.h +++ b/src/blob_serializer_deserializer-inl.h @@ -140,10 +140,11 @@ std::string_view BlobDeserializer::ReadStringView(StringLogMode mode) { Debug("ReadStringView(), length=%zu: ", length); std::string_view result(sink.data() + read_total, length); - Debug("%p, read %zu bytes\n", result.data(), result.size()); + Debug("%p, read %zu bytes", result.data(), result.size()); if (mode == StringLogMode::kAddressAndContent) { - Debug("%s", result); + Debug(", content:%s%s", length > 32 ? "\n" : " ", result); } + Debug("\n"); read_total += length; return result; diff --git a/src/json_parser.cc b/src/json_parser.cc index 1b445193bc8ceb..878028d0d2dd61 100644 --- a/src/json_parser.cc +++ b/src/json_parser.cc @@ -4,6 +4,7 @@ #include "util-inl.h" namespace node { +using v8::Array; using v8::Context; using v8::Isolate; using v8::Local; @@ -101,4 +102,51 @@ std::optional JSONParser::GetTopLevelBoolField(std::string_view field) { return value->BooleanValue(isolate); } +std::optional JSONParser::GetTopLevelStringDict( + std::string_view field) { + Isolate* isolate = isolate_.get(); + v8::HandleScope handle_scope(isolate); + Local context = context_.Get(isolate); + Local content_object = content_.Get(isolate); + Local value; + bool has_field; + // It's not a real script, so don't print the source line. + errors::PrinterTryCatch bootstrapCatch( + isolate, errors::PrinterTryCatch::kDontPrintSourceLine); + Local field_local; + if (!ToV8Value(context, field, isolate).ToLocal(&field_local)) { + return std::nullopt; + } + if (!content_object->Has(context, field_local).To(&has_field)) { + return std::nullopt; + } + if (!has_field) { + return StringDict(); + } + if (!content_object->Get(context, field_local).ToLocal(&value) || + !value->IsObject()) { + return std::nullopt; + } + Local dict = value.As(); + Local keys; + if (!dict->GetOwnPropertyNames(context).ToLocal(&keys)) { + return std::nullopt; + } + std::unordered_map result; + uint32_t length = keys->Length(); + for (uint32_t i = 0; i < length; ++i) { + Local key; + Local value; + if (!keys->Get(context, i).ToLocal(&key) || !key->IsString()) + return StringDict(); + if (!dict->Get(context, key).ToLocal(&value) || !value->IsString()) + return StringDict(); + + Utf8Value key_utf8(isolate, key); + Utf8Value value_utf8(isolate, value); + result.emplace(*key_utf8, *value_utf8); + } + return result; +} + } // namespace node diff --git a/src/json_parser.h b/src/json_parser.h index 9e6c00ef8d8712..d491736d68fb0a 100644 --- a/src/json_parser.h +++ b/src/json_parser.h @@ -6,6 +6,7 @@ #include #include #include +#include #include "util.h" #include "v8.h" @@ -15,11 +16,13 @@ namespace node { // complicates things. class JSONParser { public: + using StringDict = std::unordered_map; JSONParser(); ~JSONParser() = default; bool Parse(const std::string& content); std::optional GetTopLevelStringField(std::string_view field); std::optional GetTopLevelBoolField(std::string_view field); + std::optional GetTopLevelStringDict(std::string_view field); private: // We might want a lighter-weight JSON parser for this use case. But for now diff --git a/src/node_sea.cc b/src/node_sea.cc index c4fa84303034ff..a254c910edf238 100644 --- a/src/node_sea.cc +++ b/src/node_sea.cc @@ -110,6 +110,19 @@ size_t SeaSerializer::Write(const SeaResource& sea) { written_total += WriteStringView(sea.code_cache.value(), StringLogMode::kAddressOnly); } + + if (!sea.assets.empty()) { + Debug("Write SEA resource assets size %zu\n", sea.assets.size()); + written_total += WriteArithmetic(sea.assets.size()); + for (auto const& [key, content] : sea.assets) { + Debug("Write SEA resource asset %s at %p, size=%zu\n", + key, + content.data(), + content.size()); + written_total += WriteStringView(key, StringLogMode::kAddressAndContent); + written_total += WriteStringView(content, StringLogMode::kAddressOnly); + } + } return written_total; } @@ -157,7 +170,22 @@ SeaResource SeaDeserializer::Read() { code_cache.data(), code_cache.size()); } - return {flags, code_path, code, code_cache}; + + std::unordered_map assets; + if (static_cast(flags & SeaFlags::kIncludeAssets)) { + size_t assets_size = ReadArithmetic(); + Debug("Read SEA resource assets size %zu\n", assets_size); + for (size_t i = 0; i < assets_size; ++i) { + std::string_view key = ReadStringView(StringLogMode::kAddressAndContent); + std::string_view content = ReadStringView(StringLogMode::kAddressOnly); + Debug("Read SEA resource asset %s at %p, size=%zu\n", + key, + content.data(), + content.size()); + assets.emplace(key, content); + } + } + return {flags, code_path, code, code_cache, assets}; } std::string_view FindSingleExecutableBlob() { @@ -298,6 +326,7 @@ struct SeaConfig { std::string main_path; std::string output_path; SeaFlags flags = SeaFlags::kDefault; + std::unordered_map assets; }; std::optional ParseSingleExecutableConfig( @@ -371,6 +400,17 @@ std::optional ParseSingleExecutableConfig( result.flags |= SeaFlags::kUseCodeCache; } + auto assets_opt = parser.GetTopLevelStringDict("assets"); + if (!assets_opt.has_value()) { + FPrintF(stderr, + "\"assets\" field of %s is not a map of strings\n", + config_path); + return std::nullopt; + } else if (!assets_opt.value().empty()) { + result.flags |= SeaFlags::kIncludeAssets; + result.assets = std::move(assets_opt.value()); + } + return result; } @@ -468,6 +508,21 @@ std::optional GenerateCodeCache(std::string_view main_path, return code_cache; } +int BuildAssets(const std::unordered_map& config, + std::unordered_map* assets) { + for (auto const& [key, path] : config) { + std::string blob; + int r = ReadFileSync(&blob, path.c_str()); + if (r != 0) { + const char* err = uv_strerror(r); + FPrintF(stderr, "Cannot read asset %s: %s\n", path.c_str(), err); + return r; + } + assets->emplace(key, std::move(blob)); + } + return 0; +} + ExitCode GenerateSingleExecutableBlob( const SeaConfig& config, const std::vector& args, @@ -513,13 +568,22 @@ ExitCode GenerateSingleExecutableBlob( } } + std::unordered_map assets; + if (!config.assets.empty() && BuildAssets(config.assets, &assets) != 0) { + return ExitCode::kGenericUserError; + } + std::unordered_map assets_view; + for (auto const& [key, content] : assets) { + assets_view.emplace(key, content); + } SeaResource sea{ config.flags, config.main_path, builds_snapshot_from_main ? std::string_view{snapshot_blob.data(), snapshot_blob.size()} : std::string_view{main_script.data(), main_script.size()}, - optional_sv_code_cache}; + optional_sv_code_cache, + assets_view}; SeaSerializer serializer; serializer.Write(sea); @@ -554,6 +618,29 @@ ExitCode BuildSingleExecutableBlob(const std::string& config_path, return ExitCode::kGenericUserError; } +void GetAsset(const FunctionCallbackInfo& args) { + CHECK_EQ(args.Length(), 1); + CHECK(args[0]->IsString()); + Utf8Value key(args.GetIsolate(), args[0]); + SeaResource sea_resource = FindSingleExecutableResource(); + if (sea_resource.assets.empty()) { + return; + } + auto it = sea_resource.assets.find(*key); + if (it == sea_resource.assets.end()) { + return; + } + // We cast away the constness here, the JS land should ensure that + // the data is not mutated. + std::unique_ptr store = ArrayBuffer::NewBackingStore( + const_cast(it->second.data()), + it->second.size(), + [](void*, size_t, void*) {}, + nullptr); + Local ab = ArrayBuffer::New(args.GetIsolate(), std::move(store)); + args.GetReturnValue().Set(ab); +} + void Initialize(Local target, Local unused, Local context, @@ -565,6 +652,7 @@ void Initialize(Local target, IsExperimentalSeaWarningNeeded); SetMethod(context, target, "getCodePath", GetCodePath); SetMethod(context, target, "getCodeCache", GetCodeCache); + SetMethod(context, target, "getAsset", GetAsset); } void RegisterExternalReferences(ExternalReferenceRegistry* registry) { @@ -572,6 +660,7 @@ void RegisterExternalReferences(ExternalReferenceRegistry* registry) { registry->Register(IsExperimentalSeaWarningNeeded); registry->Register(GetCodePath); registry->Register(GetCodeCache); + registry->Register(GetAsset); } } // namespace sea diff --git a/src/node_sea.h b/src/node_sea.h index c443de9e4d0adc..bea9d579a2aa64 100644 --- a/src/node_sea.h +++ b/src/node_sea.h @@ -10,6 +10,7 @@ #include #include #include +#include #include #include "node_exit_code.h" @@ -27,6 +28,7 @@ enum class SeaFlags : uint32_t { kDisableExperimentalSeaWarning = 1 << 0, kUseSnapshot = 1 << 1, kUseCodeCache = 1 << 2, + kIncludeAssets = 1 << 3, }; struct SeaResource { @@ -34,6 +36,7 @@ struct SeaResource { std::string_view code_path; std::string_view main_code_or_snapshot; std::optional code_cache; + std::unordered_map assets; bool use_snapshot() const; static constexpr size_t kHeaderSize = sizeof(kMagic) + sizeof(SeaFlags); diff --git a/test/fixtures/sea/get-asset-raw.js b/test/fixtures/sea/get-asset-raw.js new file mode 100644 index 00000000000000..0ba9858c01109e --- /dev/null +++ b/test/fixtures/sea/get-asset-raw.js @@ -0,0 +1,31 @@ +'use strict'; + +const { isSea, getAsset, getRawAsset } = require('node:sea'); +const { readFileSync } = require('fs'); +const assert = require('assert'); + +assert(isSea()); + +{ + assert.throws(() => getRawAsset('nonexistent'), { + code: 'ERR_SINGLE_EXECUTABLE_APPLICATION_ASSET_NOT_FOUND' + }); + assert.throws(() => getRawAsset(null), { + code: 'ERR_INVALID_ARG_TYPE' + }); + assert.throws(() => getRawAsset(1), { + code: 'ERR_INVALID_ARG_TYPE' + }); +} + +{ + // Check that the asset embedded is the same as the original. + const assetOnDisk = readFileSync(process.env.__TEST_PERSON_JPG); + const assetCopy = getAsset('person.jpg') + const assetCopyBuffer = Buffer.from(assetCopy); + assert.deepStrictEqual(assetCopyBuffer, assetOnDisk); + + // Check that the copied asset is the same as the raw one. + const rawAsset = getRawAsset('person.jpg'); + assert.deepStrictEqual(rawAsset, assetCopy); +} diff --git a/test/fixtures/sea/get-asset.js b/test/fixtures/sea/get-asset.js new file mode 100644 index 00000000000000..e1a2189aa4da26 --- /dev/null +++ b/test/fixtures/sea/get-asset.js @@ -0,0 +1,102 @@ +'use strict'; + +const { isSea, getAsset, getAssetAsBlob } = require('node:sea'); +const { readFileSync } = require('node:fs'); +const assert = require('node:assert'); + +assert(isSea()); + +// Test invalid getAsset() calls. +{ + assert.throws(() => getAsset('utf8_test_text.txt', 'invalid'), { + code: 'ERR_ENCODING_NOT_SUPPORTED' + }); + + [ + 1, + 1n, + Symbol(), + false, + () => {}, + {}, + [], + null, + undefined, + ].forEach(arg => assert.throws(() => getAsset(arg), { + code: 'ERR_INVALID_ARG_TYPE' + })); + + assert.throws(() => getAsset('nonexistent'), { + code: 'ERR_SINGLE_EXECUTABLE_APPLICATION_ASSET_NOT_FOUND' + }); +} + +// Test invalid getAssetAsBlob() calls. +{ + // Invalid options argument. + [ + 123, + 123n, + Symbol(), + '', + true, + ].forEach(arg => assert.throws(() => { + getAssetAsBlob('utf8_test_text.txt', arg) + }, { + code: 'ERR_INVALID_ARG_TYPE' + })); + + assert.throws(() => getAssetAsBlob('nonexistent'), { + code: 'ERR_SINGLE_EXECUTABLE_APPLICATION_ASSET_NOT_FOUND' + }); +} + +const textAssetOnDisk = readFileSync(process.env.__TEST_UTF8_TEXT_PATH, 'utf8'); +const binaryAssetOnDisk = readFileSync(process.env.__TEST_PERSON_JPG); + +// Check getAsset() buffer copies. +{ + // Check that the asset embedded is the same as the original. + const assetCopy1 = getAsset('person.jpg') + const assetCopyBuffer1 = Buffer.from(assetCopy1); + assert.deepStrictEqual(assetCopyBuffer1, binaryAssetOnDisk); + + const assetCopy2 = getAsset('person.jpg'); + const assetCopyBuffer2 = Buffer.from(assetCopy2); + assert.deepStrictEqual(assetCopyBuffer2, binaryAssetOnDisk); + + // Zero-fill copy1. + assetCopyBuffer1.fill(0); + + // Test that getAsset() returns an immutable copy. + assert.deepStrictEqual(assetCopyBuffer2, binaryAssetOnDisk); + assert.notDeepStrictEqual(assetCopyBuffer1, binaryAssetOnDisk); +} + +// Check getAsset() with encoding. +{ + const actualAsset = getAsset('utf8_test_text.txt', 'utf8') + assert.strictEqual(actualAsset, textAssetOnDisk); + // Log it out so that the test could compare it and see if + // it's encoded/decoded correctly in the SEA. + console.log(actualAsset); +} + +// Check getAssetAsBlob(). +{ + let called = false; + async function test() { + const blob = getAssetAsBlob('person.jpg'); + const buffer = await blob.arrayBuffer(); + assert.deepStrictEqual(Buffer.from(buffer), binaryAssetOnDisk); + const blob2 = getAssetAsBlob('utf8_test_text.txt'); + const text = await blob2.text(); + assert.strictEqual(text, textAssetOnDisk); + } + test().then(() => { + called = true; + }); + process.on('exit', () => { + assert(called); + }); +} diff --git a/test/sequential/sequential.status b/test/sequential/sequential.status index c8c9428e7df3e6..0cbcd5a04b966d 100644 --- a/test/sequential/sequential.status +++ b/test/sequential/sequential.status @@ -49,6 +49,8 @@ test-performance-eventloopdelay: PASS, FLAKY [$system==linux && $arch==ppc64] # https://github.com/nodejs/node/issues/50740 +test-single-executable-application-assets-raw: PASS, FLAKY +test-single-executable-application-assets: PASS, FLAKY test-single-executable-application-disable-experimental-sea-warning: PASS, FLAKY test-single-executable-application-empty: PASS, FLAKY test-single-executable-application-snapshot-and-code-cache: PASS, FLAKY diff --git a/test/sequential/test-single-executable-application-assets-raw.js b/test/sequential/test-single-executable-application-assets-raw.js new file mode 100644 index 00000000000000..6f0a8a77486fb6 --- /dev/null +++ b/test/sequential/test-single-executable-application-assets-raw.js @@ -0,0 +1,73 @@ +'use strict'; + +const common = require('../common'); + +const { + injectAndCodeSign, + skipIfSingleExecutableIsNotSupported, +} = require('../common/sea'); + +skipIfSingleExecutableIsNotSupported(); + +// This tests the snapshot support in single executable applications. +const tmpdir = require('../common/tmpdir'); + +const { copyFileSync, writeFileSync, existsSync } = require('fs'); +const { + spawnSyncAndExitWithoutError, +} = require('../common/child_process'); +const assert = require('assert'); +const fixtures = require('../common/fixtures'); + +tmpdir.refresh(); +if (!tmpdir.hasEnoughSpace(120 * 1024 * 1024)) { + common.skip('Not enough disk space'); +} + +const configFile = tmpdir.resolve('sea-config.json'); +const seaPrepBlob = tmpdir.resolve('sea-prep.blob'); +const outputFile = tmpdir.resolve(process.platform === 'win32' ? 'sea.exe' : 'sea'); + +{ + tmpdir.refresh(); + copyFileSync(fixtures.path('sea', 'get-asset-raw.js'), tmpdir.resolve('sea.js')); + copyFileSync(fixtures.path('person.jpg'), tmpdir.resolve('person.jpg')); + writeFileSync(configFile, ` + { + "main": "sea.js", + "output": "sea-prep.blob", + "assets": { + "person.jpg": "person.jpg" + } + } + `, 'utf8'); + + spawnSyncAndExitWithoutError( + process.execPath, + ['--experimental-sea-config', 'sea-config.json'], + { + env: { + NODE_DEBUG_NATIVE: 'SEA', + ...process.env, + }, + cwd: tmpdir.path + }, + {}); + + assert(existsSync(seaPrepBlob)); + + copyFileSync(process.execPath, outputFile); + injectAndCodeSign(outputFile, seaPrepBlob); + + spawnSyncAndExitWithoutError( + outputFile, + { + env: { + ...process.env, + NODE_DEBUG_NATIVE: 'SEA', + __TEST_PERSON_JPG: fixtures.path('person.jpg'), + } + }, + { } + ); +} diff --git a/test/sequential/test-single-executable-application-assets.js b/test/sequential/test-single-executable-application-assets.js new file mode 100644 index 00000000000000..366b606e37ce64 --- /dev/null +++ b/test/sequential/test-single-executable-application-assets.js @@ -0,0 +1,130 @@ +'use strict'; + +const common = require('../common'); + +const { + injectAndCodeSign, + skipIfSingleExecutableIsNotSupported, +} = require('../common/sea'); + +skipIfSingleExecutableIsNotSupported(); + +// This tests the snapshot support in single executable applications. +const tmpdir = require('../common/tmpdir'); + +const { copyFileSync, writeFileSync, existsSync } = require('fs'); +const { + spawnSyncAndExit, + spawnSyncAndExitWithoutError, +} = require('../common/child_process'); +const assert = require('assert'); +const fixtures = require('../common/fixtures'); + +tmpdir.refresh(); +if (!tmpdir.hasEnoughSpace(120 * 1024 * 1024)) { + common.skip('Not enough disk space'); +} + +const configFile = tmpdir.resolve('sea-config.json'); +const seaPrepBlob = tmpdir.resolve('sea-prep.blob'); +const outputFile = tmpdir.resolve(process.platform === 'win32' ? 'sea.exe' : 'sea'); + +{ + tmpdir.refresh(); + copyFileSync(fixtures.path('sea', 'get-asset.js'), tmpdir.resolve('sea.js')); + writeFileSync(configFile, ` + { + "main": "sea.js", + "output": "sea-prep.blob", + "assets": "invalid" + } + `); + + spawnSyncAndExit( + process.execPath, + ['--experimental-sea-config', 'sea-config.json'], + { + cwd: tmpdir.path + }, + { + status: 1, + signal: null, + stderr: /"assets" field of sea-config\.json is not a map of strings/ + }); +} + +{ + tmpdir.refresh(); + copyFileSync(fixtures.path('sea', 'get-asset.js'), tmpdir.resolve('sea.js')); + writeFileSync(configFile, ` + { + "main": "sea.js", + "output": "sea-prep.blob", + "assets": { + "nonexistent": "nonexistent.txt" + } + } + `); + + spawnSyncAndExit( + process.execPath, + ['--experimental-sea-config', 'sea-config.json'], + { + cwd: tmpdir.path + }, + { + status: 1, + signal: null, + stderr: /Cannot read asset nonexistent\.txt: no such file or directory/ + }); +} + +{ + tmpdir.refresh(); + copyFileSync(fixtures.path('sea', 'get-asset.js'), tmpdir.resolve('sea.js')); + copyFileSync(fixtures.utf8TestTextPath, tmpdir.resolve('utf8_test_text.txt')); + copyFileSync(fixtures.path('person.jpg'), tmpdir.resolve('person.jpg')); + writeFileSync(configFile, ` + { + "main": "sea.js", + "output": "sea-prep.blob", + "assets": { + "utf8_test_text.txt": "utf8_test_text.txt", + "person.jpg": "person.jpg" + } + } + `, 'utf8'); + + spawnSyncAndExitWithoutError( + process.execPath, + ['--experimental-sea-config', 'sea-config.json'], + { + env: { + NODE_DEBUG_NATIVE: 'SEA', + ...process.env, + }, + cwd: tmpdir.path + }, + {}); + + assert(existsSync(seaPrepBlob)); + + copyFileSync(process.execPath, outputFile); + injectAndCodeSign(outputFile, seaPrepBlob); + + spawnSyncAndExitWithoutError( + outputFile, + { + env: { + ...process.env, + NODE_DEBUG_NATIVE: 'SEA', + __TEST_PERSON_JPG: fixtures.path('person.jpg'), + __TEST_UTF8_TEXT_PATH: fixtures.path('utf8_test_text.txt'), + } + }, + { + trim: true, + stdout: fixtures.utf8TestText, + } + ); +}