mirror of
https://github.com/nodejs/node.git
synced 2025-04-30 15:41:06 +00:00
ce8f085d26
With this patch:
Users can now 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()` API.
```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');
```
Drive-by: update the documentation to include a section dedicated
to the injected main script and refer to it as "injected main
script" instead of "injected module" because it's a script, not
a module.
PR-URL: https://github.com/nodejs/node/pull/50960
Refs: https://github.com/nodejs/single-executable/issues/68
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
131 lines
3.0 KiB
JavaScript
131 lines
3.0 KiB
JavaScript
'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,
|
|
}
|
|
);
|
|
}
|