Compare commits

..

4 Commits

Author SHA1 Message Date
calebboyd 58f276fae6 chore: bump resolve-dependencies 2020-06-26 11:42:23 -05:00
calebboyd 7c539db738 chore: bump resolve-dependencies 2020-06-26 10:26:53 -05:00
calebboyd ae51cc6b87 fix: set explicit release 2020-06-21 20:16:45 -05:00
calebboyd cf23147c9c fix: windows build 10.16 2019-06-24 15:57:54 -05:00
41 changed files with 2729 additions and 8569 deletions
-1
View File
@@ -1 +0,0 @@
custom: https://www.paypal.me/calebsboyd
-23
View File
@@ -1,23 +0,0 @@
---
name: Bug Report
about: Report a bug encountered while running Nexe
labels: bug
---
<!-- Please use this template while reporting a bug and provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. Thanks!
-->
**What happened**:
**What you expected to happen**:
**How to reproduce it (as minimally and precisely as possible)**:
**Anything else we need to know?**:
**Environment**:
- Platform(OS/Version):
- Host Node Version:
- Target Node Version:
- Nexe version:
- Python Version:
-11
View File
@@ -1,11 +0,0 @@
---
name: Feature Request
about: Suggest an feature request
labels: feature
---
<!-- Please only use this template for submitting feature requests -->
**What would you like to be added**:
**Why is this needed**:
-11
View File
@@ -1,11 +0,0 @@
**What this PR does / why we need it**:
**Which issue(s) this PR fixes**:
<!--
*Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
_If PR is about `failing-tests or flakes`, please post the related issues/tests in a comment and do not use `Fixes`_*
-->
Fixes #
**Special notes for your reviewer**:
@@ -1,21 +0,0 @@
name: No Response
# Both `issue_comment` and `scheduled` event types are required for this Action
# to work properly.
on:
issue_comment:
types: [created]
schedule:
# 9AM Central
- cron: '0 14 * * *'
jobs:
noResponse:
runs-on: ubuntu-latest
steps:
- uses: lee-dohm/no-response@v0.5.0
with:
token: ${{ github.token }}
closeComment: 'Closed awaiting response from OP, please open a new issue with the requested information and/or examples'
daysUntilClose: 21
responseRequiredLabel: more-information-needed
+21 -55
View File
@@ -1,4 +1,3 @@
<p align="center"><img src="https://cloud.githubusercontent.com/assets/2391349/23598327/a17bb68a-01ee-11e7-8f55-88a5fc96e997.png" /></p>
<p align="center">
@@ -6,10 +5,9 @@
<a href="https://www.npmjs.com/package/nexe"><img src="https://img.shields.io/npm/dt/nexe.svg" alt="Downloads"></a>
<a href="https://www.npmjs.com/package/nexe"><img src="https://img.shields.io/npm/v/nexe.svg" alt="Version"></a>
<a href="https://www.npmjs.com/package/nexe"><img src="https://img.shields.io/npm/l/nexe.svg" alt="License"></a>
<a href="https://discord.gg/2qTH52zNcZ"><img src="https://discordapp.com/api/guilds/814334925049561168/widget.png?style=shield"></a>
</p>
<p align="center">Install:&nbsp<code>npm i nexe -g</code></p>
<p align="center"><code>npm i nexe -g</code></p>
<p align="center">Nexe is a command-line utility that compiles your Node.js application into a single executable file.</p>
<p align="center">
@@ -49,39 +47,10 @@ For more CLI options see: `nexe --help`
Additional files or resources can be added to the binary by passing `-r "glob/pattern/**/*"`. These included files can be read in the application by using `fs.readFile` or `fs.readFileSync`.
## Compiling the nexe Executable
## Compiling Node
By default `nexe` will attempt to download a pre-built executable. These are listed on the [releases page](https://github.com/nexe/nexe/releases/tag/v3.3.3). The exact version you want may be unavailable or you may want to customize what is built. See `nexe --help` for a list of options available when passing the [`--build`](#build-boolean) option. You will also need to ensure your environment is setup to [build node](https://github.com/nodejs/node/blob/master/BUILDING.md). Note: the `python` binary in your path should be an acceptable version of python 3; you can create a [symlink](https://github.com/nexe/nexe/issues/354#issuecomment-319874486) or use the `--python` parameter (e.g. `nexe --build --python=$(which python3)`).
### Linux and macOS
[Prerequisites & details](https://github.com/nodejs/node/blob/master/BUILDING.md#unix-and-macos)
### Windows
The fastest and most reliable way to get started is simply to run the commands below. If you'd rather read the details or perform a manual install of the prerequisites, [you can find that here](https://github.com/nodejs/node/blob/master/BUILDING.md#windows).
The instructions below are the fastest and most reliable method.
Run the following sets of commands with PowerShell (running as Administrator).
**Install all required build tools (and dependencies):**
```
Set-ExecutionPolicy Unrestricted -Force
iex ((New-Object System.Net.WebClient).DownloadString('https://boxstarter.org/bootstrapper.ps1'))
get-boxstarter -Force
Install-BoxstarterPackage https://raw.githubusercontent.com/nodejs/node/master/tools/bootstrap/windows_boxstarter -DisableReboots
```
**Set config:**
```
npm config set msvs_version 2019
npm config set python python3.8
```
Where `2019` is the version of Visual Studio you have (if you have it).
**Notes:**
- The above works and has been tested with node.js `14.5.4` and `15.8.0`
- Python 3 and Python 2 can coexist and `nexe` will still work, considering the `set config` area above
- Don't use `npm install windows-build-tools` unless you're having some type of issue, because the above commands configures and installs the latest/preferred too.
By default `nexe` will attempt to download a pre-built executable. However, It may be unavailable ([github releases](https://github.com/nexe/nexe/releases))
or you may want to customize what is built. See `nexe --help` for a list of options available when passing the [`--build`](#build-boolean) option. You will also need to ensure your environment is setup to [build node](https://github.com/nodejs/node/blob/master/BUILDING.md). Note: the `python` binary in your path should be an acceptable version of python 2. eg. Systems that have python2 will need to create a [symlink](https://github.com/nexe/nexe/issues/354#issuecomment-319874486).
## Node.js API
@@ -148,13 +117,11 @@ compile({
- default: true
- #### `build: boolean`
- Build node from source, passing this flag tells nexe to download and build from source. Subsequently using this flag will cause nexe to use the previously built binary. To rebuild, first add [`--clean`](#clean-boolean)
- #### `remote: string`
- Provide a custom remote location for fetching pre-built nexe binaries from. This can either be an HTTP or HTTPS URL.
- default: `null`
- #### `asset: string`
- Provide a pre-built nexe binary asset, this is a file path is resolved relative to cwd.
- Provide a pre-built nexe binary asset, this can either be an http or https URL or a file path.
- default: `null`
- #### `python: string`
- On Linux this is the path pointing to your python3 executable
- On Linux this is the path pointing to your python2 executable
- On Windows this is the directory where `python` can be accessed
- default: `null`
- #### `flags: string[]`
@@ -236,7 +203,7 @@ For examples, see the built in patches: [src/patches](src/patches).
- Quickly perform a replace in a file within the downloaded Node.js source. The rest arguments are passed along to `String.prototype.replace`
- `readFileAsync(filename: string): Promise<NexeFile>`
- Access (or create) a file within the downloaded Node.js source.
- `addResource(filename: string, contents: Buffer): Promise<void>`
- `addResource(filename: string, contents: Buffer): void`
- Add a resource to the nexe bundle
- `files: NexeFile[]`
- The cache of the currently read, modified, or created files within the downloaded Node.js source.
@@ -250,20 +217,9 @@ Any modifications made to `NexeFile#contents` will be maintained in the cache _w
## Native Modules
In order to use native modules, the native binaries must be shipped alongside the binary generated by nexe.
TODO
## Troubleshooting
`Error: Entry file "" not found!` means you need to provide `nexe` with input. Either use `-i` or pipe data to it.
`Error: https://github.com/nexe/nexe/releases/download/v3.3.3/windows-x64-15.8.0 is not available, create it using the --build flag` or similar message means that it either:
- You are having networking issues such as the download being blocked
- You should specify the target so `nexe` knows what version of the executable to use.
- See the [releases page](https://github.com/nexe/nexe/releases) to find the executable's version number
- Example
- `nexe -i "app.js" -r "public/**/*.html" -o "dist/myApp.exe" -t x64-14.15.3`
- where `-i` specifies the input, `-r` specifies resources to embed, `-o` specifies the output, `-t` specifies the target.
- Alternatively you can compile the executable yourself, see that section for details
- [ ] Implement support for `node-pre-gyp#find`.
## Contributing
@@ -271,10 +227,20 @@ Building
```
$ git clone git@github.com:nexe/nexe.git
$ cd nexe
$ npm i && npm run build
$ yarn
```
Testing
```
$ npm test
```
## Maintainers
[![Jared Allard](https://avatars.githubusercontent.com/u/2391349?s=130)](https://jaredallard.me/) | [![Caleb Boyd](https://avatars.githubusercontent.com/u/5818726?s=130)](https://github.com/calebboyd) | [![Dustin Greif](https://avatars.githubusercontent.com/u/3026298?s=130)](https://github.com/dgreif) |
---|---|---|
[Jared Allard](https://github.com/jaredallard) | [Caleb Boyd](http://github.com/calebboyd) | [Dustin Greif](https://github.com/dgreif) |
### Former
- [Craig Condon](http://crcn.codes/)
+7 -20
View File
@@ -19,13 +19,13 @@ schedules:
- master
jobs:
- job: BaseBuild
timeoutInMinutes: 360
timeoutInMinutes: 180
strategy:
matrix:
linux:
imageName: 'ubuntu-16.04'
mac:
imageName: 'macos-10.15'
imageName: 'macos-10.13'
windows_2017:
imageName: 'vs2017-win2016'
windows_2015:
@@ -43,31 +43,18 @@ jobs:
- task: NodeTool@0
displayName: Install Node
inputs:
versionSpec: '12.x'
versionSpec: '10.x'
- script: sudo apt-get update && sudo apt-get install -y libc6-dev-i386 gcc-multilib g++-multilib
condition: contains(variables['Agent.JobName'], 'linux')
displayName: Install Linux build dependencies
- script: npm config set msvs_version 2015
- script: choco install visualcpp-build-tools --version 14.0.25420.1 -fy && npm config set msvs_version 2015
condition: contains(variables['Agent.JobName'], 'windows_2015')
displayName: Install Windows build dependencies
- script: choco install nasm -fy
displayName: Install Windows Assembler (NASM)
condition: contains(variables['Agent.JobName'], 'windows')
- script: npm install && npm run ci:build
displayName: Build Nexe
env:
GITHUB_TOKEN: $(PersonalGithubToken)
NEXE_VERBOSE: $(NEXE_VERBOSE)
msbuild_args: /3G
condition: not(contains(variables['Agent.JobName'], 'windows'))
- powershell: |
choco install nasm
npm install
npm run ci:build
displayName: Build Nexe (Windows)
condition: contains(variables['Agent.JobName'], 'windows')
env:
GITHUB_TOKEN: $(PersonalGithubToken)
NEXE_VERBOSE: $(NEXE_VERBOSE)
- script: npm run test:integration
displayName: Test built artefact
env:
NEXE_VERBOSE: $(NEXE_VERBOSE)
BUILD: ''
+19
View File
@@ -0,0 +1,19 @@
<!-- If you need help or think you have found a bug, please help us with your issue by entering the following information (otherwise you can delete this text): -->
**Is this a BUG or a FEATURE REQUEST?:**
**What happened:**
**What you expected to happen:**
**How to reproduce it (as minimally and precisely as possible):**
**Anything else we need to know?:**
**Environment**
- Platform(OS/Version):
- Host Node Version:
- Target Node Version:
- Nexe version:
- Python Version:
+2020 -7444
View File
File diff suppressed because it is too large Load Diff
+35 -53
View File
@@ -2,7 +2,7 @@
"name": "nexe",
"description": "Create a single executable out of your Node.js application",
"license": "MIT",
"version": "5.0.0-beta.1",
"version": "3.3.5",
"contributors": [
"Craig Condon <craig.j.condon@gmail.com> (http://crcn.io)",
"Jared Allard <jaredallard@outlook.com>",
@@ -11,14 +11,10 @@
"scripts": {
"ci:build": "ts-node tasks/build",
"test": "mocha",
"test:integration": "node index.js --target 14.15.3 -i test/integration/index.js -o integration-tests --verbose -r test/integration -r node_modules/ && npm run test:integration:run",
"test:integration:run": "run-script-os",
"test:integration:run:win32": "integration-tests.exe",
"test:integration:run:default": "./integration-tests",
"lint": "tslint \"{src,plugins,tasks}/**/*.ts\" --fix",
"prepare": "npm run lint && npm run build && npm test",
"prebuild": "rimraf lib",
"build": "tsc --declaration && tsc -p tasks && webpack",
"build": "tsc --declaration",
"postbuild": "ts-node tasks/post-build"
},
"repository": {
@@ -34,61 +30,47 @@
"nexe": "index.js"
},
"engines": {
"node": ">=10"
},
"mocha": {
"spec": "./test/**/*.spec.ts",
"checkLeaks": true,
"require": [
"ts-node/register"
]
"node": ">=6"
},
"dependencies": {
"@yarnpkg/fslib": "^2.6.0-rc.8",
"@yarnpkg/libzip": "^2.2.2",
"app-builder": "^7.0.4",
"archiver": "^5.3.1",
"@calebboyd/semaphore": "^1.3.1",
"app-builder": "^5.2.0",
"caw": "^2.0.1",
"chalk": "^2.4.2",
"download": "^8.0.0",
"globby": "^11.0.2",
"got": "^11.8.2",
"meriyah": "^4.3.3",
"minimist": "^1.2.6",
"mkdirp": "^1.0.4",
"multistream": "^4.1.0",
"cherow": "1.6.9",
"download": "^7.1.0",
"globby": "^9.2.0",
"got": "^9.6.0",
"minimist": "^1.2.0",
"mkdirp": "^0.5.1",
"multistream": "^2.1.1",
"ora": "^3.4.0",
"resolve-dependencies": "^6.0.8",
"rimraf": "^3.0.2",
"run-script-os": "^1.1.6",
"webpack-config-prefabs": "0.0.5"
"pify": "^4.0.1",
"resolve-dependencies": "^4.2.3",
"rimraf": "^2.6.3"
},
"devDependencies": {
"@types/archiver": "^5.3.2",
"@types/chai": "^4",
"@types/download": "^6",
"@types/globby": "^9",
"@types/got": "^9.6.12",
"@types/highland": "^2.12.14",
"@types/lodash": "^4.14.173",
"@types/minimist": "^1.2.2",
"@types/mkdirp": "^1.0.2",
"@types/mocha": "^9.0.0",
"@types/multistream": "^4.1.0",
"@types/node": "^16.10.2",
"@types/chai": "^4.1.7",
"@types/download": "^6.2.4",
"@types/execa": "^0.9.0",
"@types/globby": "^9.1.0",
"@types/got": "^9.6.0",
"@types/minimist": "^1.2.0",
"@types/mkdirp": "^0.5.2",
"@types/mocha": "^5.2.7",
"@types/multistream": "^2.1.1",
"@types/ora": "^3.2.0",
"@types/rimraf": "3.0.2",
"@types/semver": "^7.3.8",
"chai": "^4.3.6",
"execa": "^5.1.1",
"lodash": "^4.17.21",
"mocha": "^10.0.0",
"prettier": "^2.6.2",
"ts-node": "^10.7.0",
"tslint": "^6.1.1",
"@types/pify": "3.0.2",
"@types/rimraf": "2.0.2",
"@types/semver": "^6.0.0",
"chai": "^4.2.0",
"execa": "^1.0.0",
"mocha": "^6.1.4",
"prettier": "^1.18.2",
"ts-node": "^8.3.0",
"tslint": "^5.17.0",
"tslint-config-prettier": "^1.18.0",
"tslint-plugin-prettier": "^2.3.0",
"typescript": "^4.6.4",
"webpack-cli": "^4.8.0"
"tslint-plugin-prettier": "^2.0.1",
"typescript": "^3.5.2"
}
}
+43 -46
View File
@@ -11,16 +11,12 @@ import {
dequote,
isWindows,
bound,
semverGt,
wrap,
semverGt
} from './util'
import { NexeOptions, version } from './options'
import { NexeTarget } from './target'
import { PassThrough, Readable, Stream, Transform } from 'stream'
import MultiStream = require('multistream')
import combineStreams = require('multistream')
import { Bundle, toStream } from './fs/bundle'
import { File } from 'resolve-dependencies'
import { FactoryStream, LazyStream } from 'multistream'
const isBsd = Boolean(~process.platform.indexOf('bsd'))
const make = isWindows ? 'vcbuild.bat' : isBsd ? 'gmake' : 'make'
@@ -31,7 +27,7 @@ type StringReplacer = (match: string) => string
export interface NexeFile {
filename: string
absPath: string
contents: string | Buffer
contents: string
}
export { NexeOptions }
@@ -112,10 +108,12 @@ export class NexeCompiler {
//SOMEDAY iterate over multiple targets with `--outDir`
this.targets = options.targets as NexeTarget[]
this.target = this.targets[0]
if (!/https?\:\/\//.test(options.remote)) {
throw new NexeError(`Invalid remote URI scheme (must be http or https): ${options.remote}`)
if (options.asset && options.asset.startsWith('http')) {
this.remoteAsset = options.asset
} else {
this.remoteAsset =
'https://github.com/nexe/nexe/releases/download/v3.3.3/' + this.target.toString()
}
this.remoteAsset = options.remote + this.target.toString()
this.src = join(this.options.temp, this.target.version)
this.configureScript = configure + (semverGt(this.target.version, '10.10.0') ? '.py' : '')
this.nodeSrcBinPath = isWindows
@@ -138,23 +136,31 @@ export class NexeCompiler {
}
@bound
addResource(absoluteFileName: string, content?: Buffer | string | File) {
return this.bundle.addResource(absoluteFileName, content)
addResource(file: string, content?: Buffer | string) {
return this.bundle.addResource(file, content)
}
get binaryConfiguration() {
return { resources: this.bundle.index }
}
get resourceSize() {
return this.bundle.blobSize
}
@bound
async readFileAsync(file: string) {
this.assertBuild()
let cachedFile = this.files.find((x) => normalize(x.filename) === normalize(file))
let cachedFile = this.files.find(x => normalize(x.filename) === normalize(file))
if (!cachedFile) {
const absPath = join(this.src, file)
cachedFile = {
absPath,
filename: file,
contents: await readFileAsync(absPath, 'utf-8').catch((x) => {
contents: await readFileAsync(absPath, 'utf-8').catch(x => {
if (x.code === 'ENOENT') return ''
throw x
}),
})
}
this.files.push(cachedFile)
}
@@ -170,11 +176,11 @@ export class NexeCompiler {
@bound
async replaceInFileAsync(file: string, replace: string | RegExp, value: string | StringReplacer) {
const entry = await this.readFileAsync(file)
entry.contents = entry.contents.toString().replace(replace, value as any)
entry.contents = entry.contents.replace(replace, value as any)
}
@bound
async setFileContentsAsync(file: string, contents: string | Buffer) {
async setFileContentsAsync(file: string, contents: string) {
const entry = await this.readFileAsync(file)
entry.contents = contents
}
@@ -192,7 +198,7 @@ export class NexeCompiler {
}
public getNodeExecutableLocation(target?: NexeTarget) {
if (this.options.asset) {
if (this.options.asset && !this.options.asset.startsWith('http')) {
return resolve(this.options.cwd, this.options.asset)
}
if (target) {
@@ -205,11 +211,11 @@ export class NexeCompiler {
if (this.log.verbose) {
this.compileStep!.pause()
}
return new Promise<void>((resolve, reject) => {
return new Promise((resolve, reject) => {
spawn(command, args, {
cwd: this.src,
env: this.env,
stdio: this.log.verbose ? 'inherit' : 'ignore',
stdio: this.log.verbose ? 'inherit' : 'ignore'
})
.once('error', (e: Error) => {
if (this.log.verbose) {
@@ -236,7 +242,7 @@ export class NexeCompiler {
}
return this._runBuildCommandAsync(this.env.PYTHON || 'python', [
this.configureScript,
...this.options.configure,
...this.options.configure
])
}
@@ -255,7 +261,10 @@ export class NexeCompiler {
return createReadStream(this.getNodeExecutableLocation())
}
private async _shouldCompileBinaryAsync(binary: NodeJS.ReadableStream | null, location: string) {
private async _shouldCompileBinaryAsync(
binary: NodeJS.ReadableStream | null,
location: string | undefined
) {
//SOMEDAY combine make/configure/vcBuild/and modified times of included files
const { snapshot, build } = this.options
@@ -289,34 +298,22 @@ export class NexeCompiler {
return [this.shims.join(''), this.startup].join(';')
}
private async _assembleDeliverable(binary: Readable) {
private _assembleDeliverable(binary: NodeJS.ReadableStream) {
if (!this.options.mangle) {
return binary
}
const launchCode = this.code()
const codeSize = Buffer.byteLength(launchCode)
const sentinel = Buffer.from('<nexe~~sentinel>')
let vfsSize = 0
const streams = [binary, toStream(launchCode), this.bundle.toStream().pipe(new Transform({
transform: (chunk, _, cb) => {
vfsSize || this.bundle.finalize()
chunk && (vfsSize += chunk.length)
cb(null, chunk)
},
}))]
const startup = this.code(),
codeSize = Buffer.byteLength(startup)
let done = false
return new MultiStream((cb) => {
if (done) cb(null, null)
else if (streams.length) cb(null, streams.shift() as Readable)
else {
done = true
const trailers = Buffer.alloc(16)
trailers.writeDoubleLE(codeSize, 0)
trailers.writeDoubleLE(vfsSize, 8)
cb(null, toStream(Buffer.concat([sentinel, trailers])))
}
})
const lengths = Buffer.from(Array(16))
lengths.writeDoubleLE(codeSize, 0)
lengths.writeDoubleLE(this.bundle.blobSize, 8)
return combineStreams([
binary,
toStream(startup),
this.bundle.toStream(),
toStream(Buffer.concat([Buffer.from('<nexe~~sentinel>'), lengths]))
])
}
}
-383
View File
@@ -1,383 +0,0 @@
import { Libzip } from '@yarnpkg/libzip'
import {
FakeFS,
PortablePath,
ZipFS,
ZipOpenFS,
RmdirOptions,
OpendirOptions,
} from '@yarnpkg/fslib'
import { BasePortableFakeFS, Dirent, MkdirOptions, Dir } from '@yarnpkg/fslib/lib/FakeFS'
import { CustomDir } from '@yarnpkg/fslib/lib/algorithms/opendir'
import { FSPath, ppath, npath, Filename } from '@yarnpkg/fslib/lib/path'
import { resolve, toNamespacedPath } from 'path'
import { constants } from 'fs'
export type SnapshotZipFSOptions = {
baseFs: FakeFS<PortablePath>
libzip: Libzip | (() => Libzip)
zipFs: ZipFS
}
const uniqBy = (arr: Array<string | Dirent>, pick: (...arg: any[]) => any) => {
return arr.filter((x, i, self) => i === self.findIndex((y) => pick(x) === pick(y)))
}
function uniqReaddir(arr: Array<string | Dirent>) {
return uniqBy(arr, (s: string | Dirent) => (typeof s === 'string' ? s : s.name))
}
export class SnapshotZipFS extends BasePortableFakeFS {
zipFs: ZipFS
baseFs: FakeFS<PortablePath>
constructor(opts: SnapshotZipFSOptions) {
super()
this.zipFs = opts.zipFs
this.baseFs = opts.baseFs
}
private readonly fdMap: Map<number, [ZipFS, number]> = new Map()
private nextFd = 3
async makeCallPromise<T>(
p: FSPath<PortablePath>,
discard: () => Promise<T>,
accept: (zipFS: ZipFS, zipInfo: { subPath: PortablePath }) => Promise<T>,
{ requireSubpath = true }: { requireSubpath?: boolean } = {}
): Promise<T> {
if (typeof p !== 'string') return await discard()
const normalizedP = this.resolve(p)
const zipInfo = this.findZip(normalizedP)
if (!zipInfo) return await discard()
if (requireSubpath && zipInfo.subPath === '/') return await discard()
return await accept(this.zipFs, zipInfo)
}
makeCallSync<T>(
p: FSPath<PortablePath>,
discard: () => T,
accept: (zipFS: ZipFS, zipInfo: { subPath: PortablePath; archivePath: string }) => T,
{ requireSubpath = true }: { requireSubpath?: boolean } = {}
): T {
if (typeof p !== 'string') return discard()
const normalizedP = this.resolve(p)
const zipInfo = this.findZip(normalizedP)
if (!zipInfo) return discard()
if (requireSubpath && zipInfo.subPath === '/') return discard()
return accept(this.zipFs, { archivePath: '', ...zipInfo })
}
async realpathPromise(p: PortablePath) {
return await this.makeCallPromise(
p,
async () => {
return await this.baseFs.realpathPromise(p)
},
async (zipFs, { subPath }) => {
return await zipFs.realpathPromise(subPath)
}
)
}
realpathSync(p: PortablePath) {
return this.makeCallSync(
p,
() => {
return this.baseFs.realpathSync(p)
},
(zipFs, { subPath }) => {
return zipFs.realpathSync(subPath)
}
)
}
findZip(p: PortablePath) {
p = this.resolve(p)
const pathsToTry = Array.from(
new Set([
p,
resolve('/snapshot', p),
ppath.resolve(
npath.toPortablePath('/snapshot'),
npath.toPortablePath(
npath.relative(npath.fromPortablePath(process.cwd()), npath.fromPortablePath(p))
)
),
ppath.resolve(
npath.toPortablePath('/snapshot'),
npath.toPortablePath(
npath.relative(
toNamespacedPath(npath.fromPortablePath(process.cwd())),
toNamespacedPath(npath.fromPortablePath(p))
)
)
),
])
)
for (const path of pathsToTry) {
const portablePath = npath.toPortablePath(path)
if (this.zipFs.existsSync(portablePath)) {
return {
subPath: portablePath,
}
}
}
}
async copyFilePromise(sourceP: PortablePath, destP: PortablePath, flags: number = 0) {
const fallback = async (
sourceFs: FakeFS<PortablePath>,
sourceP: PortablePath,
destFs: FakeFS<PortablePath>,
destP: PortablePath
) => {
if ((flags & constants.COPYFILE_FICLONE_FORCE) !== 0)
throw Object.assign(
new Error(`EXDEV: cross-device clone not permitted, copyfile '${sourceP}' -> ${destP}'`),
{ code: `EXDEV` }
)
if (flags & constants.COPYFILE_EXCL && (await this.existsPromise(sourceP)))
throw Object.assign(
new Error(`EEXIST: file already exists, copyfile '${sourceP}' -> '${destP}'`),
{ code: `EEXIST` }
)
let content
try {
content = await sourceFs.readFilePromise(sourceP)
} catch (error) {
throw Object.assign(
new Error(`EINVAL: invalid argument, copyfile '${sourceP}' -> '${destP}'`),
{ code: `EINVAL` }
)
}
await destFs.writeFilePromise(destP, content)
}
return await this.makeCallPromise(
sourceP,
async () => {
return await this.baseFs.copyFilePromise(sourceP, destP, flags)
},
async (zipFsS, { subPath: subPathS }) => {
return await fallback(zipFsS, subPathS, this.baseFs, destP)
}
)
}
copyFileSync(sourceP: PortablePath, destP: PortablePath, flags: number = 0) {
const fallback = (
sourceFs: FakeFS<PortablePath>,
sourceP: PortablePath,
destFs: FakeFS<PortablePath>,
destP: PortablePath
) => {
if ((flags & constants.COPYFILE_FICLONE_FORCE) !== 0)
throw Object.assign(
new Error(`EXDEV: cross-device clone not permitted, copyfile '${sourceP}' -> ${destP}'`),
{ code: `EXDEV` }
)
if (flags & constants.COPYFILE_EXCL && this.existsSync(sourceP))
throw Object.assign(
new Error(`EEXIST: file already exists, copyfile '${sourceP}' -> '${destP}'`),
{ code: `EEXIST` }
)
let content
try {
content = sourceFs.readFileSync(sourceP)
} catch (error) {
throw Object.assign(
new Error(`EINVAL: invalid argument, copyfile '${sourceP}' -> '${destP}'`),
{ code: `EINVAL` }
)
}
destFs.writeFileSync(destP, content)
}
return this.makeCallSync(
sourceP,
() => {
return this.baseFs.copyFileSync(sourceP, destP, flags)
},
(zipFsS, { subPath: subPathS }) => {
return fallback(zipFsS, subPathS, this.baseFs, destP)
}
)
}
async readdirPromise(p: PortablePath): Promise<Array<Filename>>
async readdirPromise(
p: PortablePath,
opts: { withFileTypes: false } | null
): Promise<Array<Filename>>
async readdirPromise(p: PortablePath, opts: { withFileTypes: true }): Promise<Array<Dirent>>
async readdirPromise(
p: PortablePath,
opts: { withFileTypes: boolean }
): Promise<Array<Filename> | Array<Dirent>>
async readdirPromise(
p: PortablePath,
opts?: { withFileTypes?: boolean } | null
): Promise<Array<string | Dirent>> {
const fallback = async () => {
return await this.baseFs.readdirPromise(p, opts as any)
}
return await this.makeCallPromise(
p,
fallback,
async (zipFs, { subPath }) => {
const fallbackPaths: Array<string | Dirent> = await fallback().catch(() => [])
return Promise.resolve(
uniqReaddir(
(fallbackPaths as any[]).concat(await zipFs.readdirPromise(subPath, opts as any))
)
)
},
{
requireSubpath: false,
}
)
}
readdirSync(p: PortablePath): Array<Filename>
readdirSync(p: PortablePath, opts: { withFileTypes: false } | null): Array<Filename>
readdirSync(p: PortablePath, opts: { withFileTypes: true }): Array<Dirent>
readdirSync(p: PortablePath, opts: { withFileTypes: boolean }): Array<Filename> | Array<Dirent>
readdirSync(p: PortablePath, opts?: { withFileTypes?: boolean } | null): Array<string | Dirent> {
const fallback = () => {
return this.baseFs.readdirSync(p, opts as any)
}
return this.makeCallSync(
p,
fallback,
(zipFs, { subPath }) => {
let fallbackPaths: Array<string | Dirent> = []
try {
fallbackPaths = fallback()
} catch (e) {}
return (fallbackPaths as any[]).concat(uniqReaddir(zipFs.readdirSync(subPath, opts as any)))
},
{
requireSubpath: false,
}
)
}
async mkdirPromise(p: PortablePath, opts?: MkdirOptions) {
return await this.baseFs.mkdirPromise(p, opts)
}
mkdirSync(p: PortablePath, opts?: MkdirOptions) {
return this.baseFs.mkdirSync(p, opts)
}
async rmdirPromise(p: PortablePath, opts?: RmdirOptions) {
return await this.baseFs.rmdirPromise(p, opts)
}
rmdirSync(p: PortablePath, opts?: RmdirOptions) {
return this.baseFs.rmdirSync(p, opts)
}
async opendirPromise(p: PortablePath, opts?: OpendirOptions) {
return Promise.resolve(this.zipFs.opendirSync(p, opts))
}
opendirSync(p: PortablePath, opts?: OpendirOptions) {
const zipInfo = this.findZip(p)
let zipFsDir: Dir<PortablePath> | null = null
if (zipInfo) {
zipFsDir = this.zipFs.opendirSync(zipInfo.subPath)
}
let realFsDir: Dir<PortablePath> | null = null
try {
realFsDir = this.baseFs.opendirSync(p)
} catch (e) {
if (!zipFsDir) throw e
}
const seen = new Set()
const nextDirent = () => {
const entry = realFsDir?.readSync() || zipFsDir?.readSync()
if (entry && !seen.has(entry.name)) {
seen.add(entry.name)
return entry
}
return null
}
const onClose = () => {
zipFsDir?.closeSync()
realFsDir?.closeSync()
}
return new CustomDir(p, nextDirent, { onClose })
}
accessPromise = ZipOpenFS.prototype.accessPromise
accessSync = ZipOpenFS.prototype.accessSync
appendFilePromise = ZipOpenFS.prototype.appendFilePromise
appendFileSync = ZipOpenFS.prototype.appendFileSync
chmodPromise = ZipOpenFS.prototype.chmodPromise
chmodSync = ZipOpenFS.prototype.chmodSync
fchmodPromise = ZipOpenFS.prototype.fchmodPromise
fchmodSync = ZipOpenFS.prototype.fchmodSync
chownPromise = ZipOpenFS.prototype.chownPromise
chownSync = ZipOpenFS.prototype.chownSync
fchownPromise = ZipOpenFS.prototype.fchownPromise
fchownSync = ZipOpenFS.prototype.fchownSync
closePromise = ZipOpenFS.prototype.closePromise
closeSync = ZipOpenFS.prototype.closeSync
createReadStream = ZipOpenFS.prototype.createReadStream
createWriteStream = ZipOpenFS.prototype.createWriteStream
existsPromise = ZipOpenFS.prototype.existsPromise
existsSync = ZipOpenFS.prototype.existsSync
fstatPromise = ZipOpenFS.prototype.fstatPromise
fstatSync = ZipOpenFS.prototype.fstatSync
getExtractHint = ZipOpenFS.prototype.getExtractHint
getRealPath = ZipOpenFS.prototype.getRealPath
linkPromise = ZipOpenFS.prototype.linkPromise
linkSync = ZipOpenFS.prototype.linkSync
lstatPromise = ZipOpenFS.prototype.lstatPromise
lstatSync = ZipOpenFS.prototype.lstatSync
openPromise = ZipOpenFS.prototype.openPromise
openSync = ZipOpenFS.prototype.openSync
readFilePromise = ZipOpenFS.prototype.readFilePromise
readFileSync = ZipOpenFS.prototype.readFileSync
readlinkPromise = ZipOpenFS.prototype.readlinkPromise
readlinkSync = ZipOpenFS.prototype.readlinkSync
readPromise = ZipOpenFS.prototype.readPromise
readSync = ZipOpenFS.prototype.readSync
renamePromise = ZipOpenFS.prototype.renamePromise
renameSync = ZipOpenFS.prototype.renameSync
resolve = ZipOpenFS.prototype.resolve
statPromise = ZipOpenFS.prototype.statPromise
statSync = ZipOpenFS.prototype.statSync
symlinkPromise = ZipOpenFS.prototype.symlinkPromise
symlinkSync = ZipOpenFS.prototype.symlinkSync
truncatePromise = ZipOpenFS.prototype.truncatePromise
truncateSync = ZipOpenFS.prototype.truncateSync
ftruncatePromise = ZipOpenFS.prototype.ftruncatePromise
ftruncateSync = ZipOpenFS.prototype.ftruncateSync
unlinkPromise = ZipOpenFS.prototype.unlinkPromise
unlinkSync = ZipOpenFS.prototype.unlinkSync
unwatchFile = ZipOpenFS.prototype.unwatchFile
utimesPromise = ZipOpenFS.prototype.utimesPromise
utimesSync = ZipOpenFS.prototype.utimesSync
watch = ZipOpenFS.prototype.watch
watchFile = ZipOpenFS.prototype.watchFile
writeFilePromise = ZipOpenFS.prototype.writeFilePromise
writeFileSync = ZipOpenFS.prototype.writeFileSync
writePromise = ZipOpenFS.prototype.writePromise
writeSync = ZipOpenFS.prototype.writeSync
// @ts-ignore
remapFd = ZipOpenFS.prototype.remapFd
}
+50 -31
View File
@@ -1,51 +1,70 @@
import { stat as getStat, Stats, createReadStream } from 'fs'
import { relative } from 'path'
import { Readable } from 'stream'
import { File } from 'resolve-dependencies'
import archiver from 'archiver'
import combineStreams = require('multistream')
function makeRelativeToZip(cwd: string, path: string) {
return '/snapshot/' + relative(cwd, path)
const stat = (file: string): Promise<Stats> => {
return new Promise((resolve, reject) => {
getStat(file, (err, stats) => (err ? reject(err) : resolve(stats)))
})
}
function makeRelative(cwd: string, path: string) {
return './' + relative(cwd, path)
}
export function toStream(content: Buffer | string) {
const readable = new Readable({
read() {
this.push(content)
this.push(null)
},
})
const readable = new Readable({ read() {} })
readable.push(content)
readable.push(null)
return readable
}
export class Bundle {
export type File = { absPath: string; contents: string; deps: FileMap }
export type FileMap = { [absPath: string]: File | null }
export interface BundleOptions {
entries: string[]
cwd: string
files = new Set<string>()
zip: any
expand: boolean
loadContent: boolean
files: FileMap
}
export class Bundle {
constructor({ cwd }: { cwd: string } = { cwd: process.cwd() }) {
this.cwd = cwd
this.zip = archiver('zip')
}
cwd: string
blobSize: number = 0
index: { [relativeFilePath: string]: [number, number] } = {}
streams: (Readable | (() => Readable))[] = []
get list() {
return Array.from(this.files)
}
public addResource(absoluteFileName: string, content?: File | Buffer | string) {
const destPath = makeRelativeToZip(this.cwd, absoluteFileName)
if (!this.files.has(destPath)) {
if (content == null) {
this.zip.file(absoluteFileName, { name: destPath })
} else {
this.zip.append(content, { name: destPath })
}
this.files.add(destPath)
async addResource(absoluteFileName: string, content?: Buffer | string) {
let length = 0
if (content !== undefined) {
length = Buffer.byteLength(content)
} else {
const stats = await stat(absoluteFileName)
length = stats.size
}
const start = this.blobSize
this.blobSize += length
this.index[makeRelative(this.cwd, absoluteFileName)] = [start, length]
this.streams.push(() => (content ? toStream(content) : createReadStream(absoluteFileName)))
}
public finalize() {
return this.zip.finalize()
concat() {
throw new Error('Not Implemented')
}
public toStream(): Readable {
return this.zip
toStream() {
return combineStreams(this.streams)
}
toJSON() {
return this.index
}
}
+337 -68
View File
@@ -1,101 +1,370 @@
import { getLibzipSync } from '@yarnpkg/libzip'
import { patchFs, npath, PosixFS, NodeFS, ZipFS } from '@yarnpkg/fslib'
import { SnapshotZipFS } from './SnapshotZipFS'
import * as assert from 'assert'
import * as constants from 'constants'
import { Stats } from 'fs'
export interface NexeHeader {
export interface NexeBinary {
blobPath: string
resources: { [key: string]: number[] }
layout: {
stat: Stats
resourceStart: number
resourceSize: number
contentSize: number
contentStart: number
contentSize?: number
contentStart?: number
resourceSize?: number
}
}
let originalFsMethods: any = null
let lazyRestoreFs = () => {}
const patches = (process as any).nexe.patches || {}
delete (process as any).nexe
function shimFs(binary: NexeHeader, fs: typeof import('fs') = require('fs')) {
function shimFs(binary: NexeBinary, fs: any = require('fs')) {
if (originalFsMethods !== null) {
return
}
originalFsMethods = Object.assign({}, fs)
const realFs: typeof fs = { ...fs }
const nodeFs = new NodeFS(realFs)
const blob = Buffer.allocUnsafe(binary.layout.resourceSize)
const blobFd = realFs.openSync(binary.blobPath, 'r')
const bytesRead = realFs.readSync(
blobFd,
blob,
0,
binary.layout.resourceSize,
binary.layout.resourceStart
)
assert.equal(bytesRead, binary.layout.resourceSize)
const zipFs = new ZipFS(blob, {
libzip: getLibzipSync(),
readOnly: true,
})
const snapshotZipFS = new SnapshotZipFS({
libzip: getLibzipSync(),
zipFs,
baseFs: nodeFs,
})
const posixSnapshotZipFs = new PosixFS(snapshotZipFS)
patchFs(fs, posixSnapshotZipFs)
const { readFileSync } = fs
const { blobPath, resources: manifest } = binary,
{ resourceStart, stat } = binary.layout,
directories: { [key: string]: { [key: string]: boolean } } = {},
notAFile = '!@#$%^&*',
isWin = process.platform.startsWith('win'),
isString = (x: any): x is string => typeof x === 'string' || x instanceof String,
noop = () => {},
path = require('path'),
baseDir = path.dirname(process.execPath)
let log = (_: string) => true
let loggedManifest = false
if ((process.env.DEBUG || '').toLowerCase().includes('nexe:require')) {
log = (text: string) => {
if (!loggedManifest) {
// TODO anything meaningful to log here?
loggedManifest = true
log = (text: string) => process.stderr.write('[nexe] - ' + text + '\n')
}
const winPath = (key: string) => {
if (isWin && key.substr(1, 2) === ':\\') {
key = key[0].toUpperCase() + key.substr(1)
}
return key
}
const getKey = function getKey(filepath: string | Buffer | null): string {
if (Buffer.isBuffer(filepath)) {
filepath = filepath.toString()
}
if (!isString(filepath)) {
return notAFile
}
let key = path.resolve(baseDir, filepath)
return winPath(key)
}
const statTime = function() {
return {
dev: 0,
ino: 0,
nlink: 0,
rdev: 0,
uid: 123,
gid: 500,
blksize: 4096,
blocks: 0,
atime: new Date(stat.atime),
atimeMs: stat.atime.getTime(),
mtime: new Date(stat.mtime),
mtimeMs: stat.mtime.getTime(),
ctime: new Date(stat.ctime),
ctimMs: stat.ctime.getTime(),
birthtime: new Date(stat.birthtime),
birthtimeMs: stat.birthtime.getTime()
}
}
const createStat = function(extensions: any) {
return Object.assign(new fs.Stats(), binary.layout.stat, statTime(), extensions)
}
const ownStat = function(filepath: any) {
setupManifest()
const key = getKey(filepath)
if (directories[key]) {
let mode = binary.layout.stat.mode
mode |= fs.constants.S_IFDIR
mode &= ~fs.constants.S_IFREG
return createStat({ mode, size: 0 })
}
if (manifest[key]) {
return createStat({ size: manifest[key][1] })
}
}
function makeLong(filepath: string) {
return (path as any)._makeLong && (path as any)._makeLong(filepath)
}
function fileOpts(options: any) {
return !options ? {} : isString(options) ? { encoding: options } : options
}
let setupManifest = () => {
Object.keys(manifest).forEach(filepath => {
const entry = manifest[filepath]
const absolutePath = getKey(filepath)
const longPath = makeLong(absolutePath)
const normalizedPath = winPath(path.normalize(filepath))
if (!manifest[absolutePath]) {
manifest[absolutePath] = entry
}
if (longPath && !manifest[longPath]) {
manifest[longPath] = entry
}
if (!manifest[normalizedPath]) {
manifest[normalizedPath] = manifest[filepath]
}
let currentDir = path.dirname(absolutePath)
let prevDir = absolutePath
while (currentDir !== prevDir) {
directories[currentDir] = directories[currentDir] || {}
directories[currentDir][path.basename(prevDir)] = true
const longDir = makeLong(currentDir)
if (longDir && !directories[longDir]) {
directories[longDir] = directories[currentDir]
}
prevDir = currentDir
currentDir = path.dirname(currentDir)
}
})
;(manifest[notAFile] as any) = false
;(directories[notAFile] as any) = false
setupManifest = noop
}
//naive patches intended to work for most use cases
const nfs: any = {
existsSync: function existsSync(filepath: string) {
setupManifest()
const key = getKey(filepath)
if (manifest[key] || directories[key]) {
return true
}
return originalFsMethods.existsSync.apply(fs, arguments)
},
realpath: function realpath(filepath: any, options: any, cb: any): void {
setupManifest()
const key = getKey(filepath)
if (isString(filepath) && (manifest[filepath] || manifest[key])) {
return process.nextTick(() => cb(null, filepath))
}
return originalFsMethods.realpath.call(fs, filepath, options, cb)
},
realpathSync: function realpathSync(filepath: any, options: any) {
setupManifest()
const key = getKey(filepath)
if (manifest[key]) {
return filepath
}
return originalFsMethods.realpathSync.call(fs, filepath, options)
},
readdir: function readdir(filepath: string | Buffer, options: any, callback: any) {
setupManifest()
const dir = directories[getKey(filepath)]
if (dir) {
if ('function' === typeof options) {
callback = options
options = { encoding: 'utf8' }
}
process.nextTick(() => callback(null, Object.keys(dir)))
} else {
return originalFsMethods.readdir.apply(fs, arguments)
}
},
readdirSync: function readdirSync(filepath: string | Buffer, options: any) {
setupManifest()
const dir = directories[getKey(filepath)]
if (dir) {
return Object.keys(dir)
}
return originalFsMethods.readdirSync.apply(fs, arguments)
},
readFile: function readFile(filepath: any, options: any, callback: any) {
setupManifest()
const entry = manifest[getKey(filepath)]
if (!entry) {
return originalFsMethods.readFile.apply(fs, arguments)
}
const [offset, length] = entry
const resourceOffset = resourceStart + offset
const encoding = fileOpts(options).encoding
callback = typeof options === 'function' ? options : callback
originalFsMethods.open(blobPath, 'r', function(err: Error, fd: number) {
if (err) return callback(err, null)
originalFsMethods.read(fd, Buffer.alloc(length), 0, length, resourceOffset, function(
error: Error,
bytesRead: number,
result: Buffer
) {
if (error) {
return originalFsMethods.close(fd, function() {
callback(error, null)
})
}
originalFsMethods.close(fd, function(err: Error) {
if (err) {
return callback(err, result)
}
callback(err, encoding ? result.toString(encoding) : result)
})
})
})
},
createReadStream: function createReadStream(filepath: any, options: any) {
setupManifest()
const entry = manifest[getKey(filepath)]
if (!entry) {
return originalFsMethods.createReadStream.apply(fs, arguments)
}
const [offset, length] = entry
const resourceOffset = resourceStart + offset
const opts = fileOpts(options)
return originalFsMethods.createReadStream(
blobPath,
Object.assign({}, opts, {
start: resourceOffset,
end: resourceOffset + length - 1
})
)
},
readFileSync: function readFileSync(filepath: any, options: any) {
setupManifest()
const entry = manifest[getKey(filepath)]
if (!entry) {
return originalFsMethods.readFileSync.apply(fs, arguments)
}
const [offset, length] = entry
const resourceOffset = resourceStart + offset
const encoding = fileOpts(options).encoding
const fd = originalFsMethods.openSync(process.execPath, 'r')
const result = Buffer.alloc(length)
originalFsMethods.readSync(fd, result, 0, length, resourceOffset)
originalFsMethods.closeSync(fd)
return encoding ? result.toString(encoding) : result
},
statSync: function statSync(filepath: string | Buffer) {
const stat = ownStat(filepath)
if (stat) {
return stat
}
return originalFsMethods.statSync.apply(fs, arguments)
},
stat: function stat(filepath: string | Buffer, callback: any) {
const stat = ownStat(filepath)
if (stat) {
process.nextTick(() => {
callback(null, stat)
})
} else {
return originalFsMethods.stat.apply(fs, arguments)
}
return process.stderr.write('[nexe] - ' + text + '\n')
}
}
patches.internalModuleReadFile = function (this: any, original: any, ...args: any[]) {
log(`internalModuleReadFile ${args[0]}`)
try {
return fs.readFileSync(args[0], 'utf-8')
} catch (e) {
return null
if (typeof fs.exists === 'function') {
nfs.exists = function(filepath: string, cb: Function) {
cb = cb || noop
const exists = nfs.existsSync(filepath)
process.nextTick(() => cb(exists))
}
}
let returningArray: boolean
patches.internalModuleReadJSON = function (this: any, original: any, ...args: any[]) {
if (returningArray == null) returningArray = Array.isArray(original.call(this, ''))
const res = patches.internalModuleReadFile.call(this, original, ...args)
return returningArray && !Array.isArray(res)
? [res, /"(main|name|type|exports|imports)"/.test(res)]
: res
const patches = (process as any).nexe.patches || {}
delete (process as any).nexe
patches.internalModuleReadFile = function(this: any, original: any, ...args: any[]) {
const [filepath] = args
setupManifest()
if (manifest[filepath]) {
log('read (hit) ' + filepath)
return nfs.readFileSync(filepath, 'utf-8')
}
log('read (miss) ' + filepath)
return original.call(this, ...args)
}
patches.internalModuleStat = function (this: any, original: any, ...args: any[]) {
log(`internalModuleStat ${args[0]}`)
try {
const stat = fs.statSync(args[0])
if (stat.isDirectory()) return 1
patches.internalModuleReadJSON = patches.internalModuleReadFile
patches.internalModuleStat = function(this: any, original: any, ...args: any[]) {
setupManifest()
const [filepath] = args
if (manifest[filepath]) {
log('stat (hit) ' + filepath + ' ' + 0)
return 0
} catch (e) {
return -constants.ENOENT
}
if (directories[filepath]) {
log('stat dir (hit) ' + filepath + ' ' + 1)
return 1
}
const res = original.call(this, ...args)
if (res === 0) {
log('stat (miss) ' + filepath + ' ' + res)
} else if (res === 1) {
log('stat dir (miss) ' + filepath + ' ' + res)
} else {
log('stat (fail) ' + filepath + ' ' + res)
}
return res
}
if (typeof fs.exists === 'function') {
nfs.exists = function(filepath: string, cb: Function) {
cb = cb || noop
const exists = nfs.existsSync(filepath)
if (!exists) {
return originalFsMethods.exists(filepath, cb)
}
process.nextTick(() => cb(exists))
}
}
// TODO restore patches in restoreFs
if (typeof fs.copyFile === 'function') {
nfs.copyFile = function(filepath: string, dest: string, flags: number, callback: Function) {
setupManifest()
const entry = manifest[getKey(filepath)]
if (!entry) {
return originalFsMethods.copyFile.apply(fs, arguments)
}
if (typeof flags === 'function') {
callback = flags
flags = 0
}
nfs.readFile(filepath, (err: any, buffer: any) => {
if (err) {
return callback(err)
}
originalFsMethods.writeFile(dest, buffer, (err: any) => {
if (err) {
return callback(err)
}
callback(null)
})
})
}
nfs.copyFileSync = function(filepath: string, dest: string) {
setupManifest()
const entry = manifest[getKey(filepath)]
if (!entry) {
return originalFsMethods.copyFileSync.apply(fs, arguments)
}
return originalFsMethods.writeFileSync(dest, nfs.readFileSync(filepath))
}
}
Object.assign(fs, nfs)
lazyRestoreFs = () => {
Object.assign(fs, originalFsMethods)
Object.keys(nfs).forEach(key => {
fs[key] = originalFsMethods[key]
})
lazyRestoreFs = () => {}
}
return true
}
function restoreFs() {
+3 -3
View File
@@ -24,7 +24,7 @@ export class Logger {
this.ora = ora({
text: 'Starting...',
color: 'blue',
spinner: 'dots',
spinner: 'dots'
})
this.ora.stop()
}
@@ -35,7 +35,7 @@ export class Logger {
flush() {
!this.silent && this.ora.succeed()
return new Promise((resolve) => setTimeout(resolve, frameLength))
return new Promise(resolve => setTimeout(resolve, frameLength))
}
_write(update: string, color = 'green') {
@@ -66,7 +66,7 @@ export class Logger {
modify: this.modify,
log: this.verbose ? this.write : this.modify,
pause: () => this.ora.stopAndPersist(),
resume: () => this.ora.start(),
resume: () => this.ora.start()
} as LogStep
}
}
+2 -2
View File
@@ -15,7 +15,7 @@ async function compile(
compilerOptions?: Partial<NexeOptions>,
callback?: (err: Error | null) => void
) {
let error: Error | null = null,
let error = null,
options: NexeOptions | null = null,
compiler: NexeCompiler | null = null
@@ -32,7 +32,7 @@ async function compile(
options.build ? [artifacts, ...patches, ...(options.patches as NexePatch[])] : [],
options.plugins as NexePatch[]
)(compiler)
} catch (e: any) {
} catch (e) {
error = e
}
+22 -27
View File
@@ -1,4 +1,4 @@
import parseArgv from 'minimist'
import * as parseArgv from 'minimist'
import { NexeCompiler, NexeError } from './compiler'
import { isWindows, STDIN_FLAG } from './util'
import { basename, extname, join, isAbsolute, resolve } from 'path'
@@ -9,7 +9,7 @@ import { resolveSync } from 'resolve-dependencies'
const caw = require('caw')
const c = process.platform === 'win32' ? chalk.constructor({ enabled: false }) : chalk
export const version = '{{ version }}'
export const version = '{{replace:0}}'
export interface NexePatch {
(compiler: NexeCompiler, next: () => Promise<void>): Promise<void>
@@ -21,7 +21,6 @@ export interface NexeOptions {
output: string
targets: (string | NexeTarget)[]
name: string
remote: string
asset: string
cwd: string
fs: boolean | string[]
@@ -71,18 +70,17 @@ const defaults = {
build: false,
bundle: true,
patches: [],
plugins: [],
remote: 'https://github.com/nexe/nexe/releases/download/v3.3.3/',
plugins: []
}
const alias = {
i: 'input',
o: 'output',
v: 'version',
a: 'asset',
t: 'target',
b: 'build',
n: 'name',
r: 'resource',
a: 'asset',
p: 'python',
f: 'flag',
c: 'configure',
@@ -90,7 +88,7 @@ const alias = {
h: 'help',
l: 'loglevel',
'fake-argv': 'fakeArgv',
'gh-token': 'ghToken',
'gh-token': 'ghToken'
}
const argv = parseArgv(process.argv, { alias, default: { ...defaults } })
let help = `
@@ -103,18 +101,18 @@ ${c.bold('nexe <entry-file> [options]')}
-t --target -- node version description
-n --name -- main app module name
-r --resource -- *embed files (glob) within the binary
--remote -- alternate location (URL) to download pre-built base (nexe) binaries from
-a --asset -- alternate asset path, file or url pointing to a base (nexe) binary
--plugin -- extend nexe runtime behavior
${c.underline.bold('Building from source:')}
-b --build -- build from source
-p --python -- python3 (as python) executable path
-p --python -- python2 (as python) executable path
-f --flag -- *v8 flags to include during compilation
-c --configure -- *arguments to the configure step
-m --make -- *arguments to the make/build step
--patch -- module with middleware default export for adding a build patch
--no-mangle -- used when generating base binaries, or when patching _third_party_main manually
--no-mangle -- used when generating base binaries, or when patching _third_party_main manually.
--snapshot -- path to a warmup snapshot
--ico -- file name for alternate icon file (windows)
--rc-* -- populate rc file options (windows)
@@ -135,7 +133,7 @@ ${c.bold('nexe <entry-file> [options]')}
help = EOL + help + EOL
function flatten(...args: any[]): string[] {
return ([] as string[]).concat(...args).filter((x) => x)
return ([] as string[]).concat(...args).filter(x => x)
}
/**
@@ -146,13 +144,16 @@ function flatten(...args: any[]): string[] {
*/
function extractCliMap(match: RegExp, options: any) {
return Object.keys(options)
.filter((x) => match.test(x))
.reduce((map: any, option: any) => {
const key = option.split('-')[1]
map[key] = options[option]
delete options[option]
return map
}, {} as any)
.filter(x => match.test(x))
.reduce(
(map: any, option: any) => {
const key = option.split('-')[1]
map[key] = options[option]
delete options[option]
return map
},
{} as any
)
}
function extractLogLevel(options: NexeOptions) {
@@ -251,19 +252,13 @@ function normalizeOptions(input?: Partial<NexeOptions>): NexeOptions {
options.configure = flatten(options.configure)
options.resources = flatten(opts.resource, options.resources)
if (!options.remote.endsWith('/')) {
options.remote += '/'
}
options.downloadOptions = options.downloadOptions || {}
options.downloadOptions.headers = options.downloadOptions.headers || {}
options.downloadOptions.headers['User-Agent'] = 'nexe (https://www.npmjs.com/package/nexe)'
options.downloadOptions.agent = process.env.HTTPS_PROXY
? caw(process.env.HTTPS_PROXY, { protocol: 'https' })
: options.downloadOptions.agent || require('https').globalAgent
options.downloadOptions.rejectUnauthorized = process.env.NODE_TLS_REJECT_UNAUTHORIZED
? false
: true
options.downloadOptions.rejectUnauthorized = process.env.HTTPS_PROXY ? false : true
options.rc = options.rc || extractCliMap(/^rc-.*/, options)
options.output =
@@ -297,8 +292,8 @@ function normalizeOptions(input?: Partial<NexeOptions>): NexeOptions {
}
Object.keys(alias)
.filter((k) => k !== 'rc')
.forEach((x) => delete opts[x])
.filter(k => k !== 'rc')
.forEach(x => delete opts[x])
return options
}
+9 -10
View File
@@ -1,15 +1,14 @@
const fs = require('fs'),
fd = fs.openSync(process.execPath, 'r'),
stat = fs.statSync(process.execPath),
tailSize = Math.min(stat.size, 4096),
tailSize = Math.min(stat.size, 16000),
tailWindow = Buffer.from(Array(tailSize))
fs.readSync(fd, tailWindow, 0, tailSize, stat.size - tailSize)
const footerPosition = tailWindow.indexOf('<nexe~~sentinel>')
if (footerPosition === -1) {
process.stderr.write('Invalid Nexe binary')
process.exit(1)
if (footerPosition == -1) {
throw 'Invalid Nexe binary'
}
const footer = tailWindow.slice(footerPosition, footerPosition + 32),
@@ -21,13 +20,13 @@ const footer = tailWindow.slice(footerPosition, footerPosition + 32),
Object.defineProperty(
process,
'__nexe',
(function () {
(function() {
let nexeHeader: any = null
return {
get: function () {
get: function() {
return nexeHeader
},
set: function (value: any) {
set: function(value: any) {
if (nexeHeader) {
throw new Error('This property is readonly')
}
@@ -38,13 +37,13 @@ Object.defineProperty(
contentSize,
contentStart,
resourceSize,
resourceStart,
},
resourceStart
}
})
Object.freeze(nexeHeader)
},
enumerable: false,
configurable: false,
configurable: false
}
})()
)
+4 -4
View File
@@ -9,11 +9,11 @@ export default async function disableNodeCli(compiler: NexeCompiler, next: () =>
if (semverGt(compiler.target.version, '11.6.0')) {
await compiler.replaceInFileAsync(
'src/node.cc',
/(?<!int )ProcessGlobalArgs\(argv[^;]*;/gm,
'0;/*$&*/'
/(?<!int )ProcessGlobalArgs\(/g,
'0;//ProcessGlobalArgs('
)
} else if (semverGt(compiler.target.version, '10.9')) {
await compiler.replaceInFileAsync('src/node.cc', /(?<!void )ProcessArgv\(argv/g, '//$&')
await compiler.replaceInFileAsync('src/node.cc', /(?<!void )ProcessArgv\(/g, '//ProcessArgv(')
} else if (semverGt(compiler.target.version, '9.999')) {
await compiler.replaceInFileAsync(
'src/node.cc',
@@ -21,7 +21,7 @@ export default async function disableNodeCli(compiler: NexeCompiler, next: () =>
'int i = v8_argc; i < v8_argc; i++'
)
let matches = 0
await compiler.replaceInFileAsync('src/node.cc', /v8_argc > 1/g, (match) => {
await compiler.replaceInFileAsync('src/node.cc', /v8_argc > 1/g, match => {
if (matches++) {
return 'false'
}
+2 -2
View File
@@ -13,8 +13,8 @@ export default async function nodeGyp(
`
${nodeGypMarker}
${files
.filter((x) => x.filename.startsWith('lib'))
.map((x) => `'${x.filename}'`)
.filter(x => x.filename.startsWith('lib'))
.map(x => `'${x.filename}'`)
.toString()},
`.trim()
)
+7 -8
View File
@@ -8,19 +8,18 @@ export default async function nodeRc(compiler: NexeCompiler, next: () => Promise
const file = await compiler.readFileAsync('src/res/node.rc')
Object.keys(options).forEach((key) => {
Object.keys(options).forEach(key => {
let value = options[key]
const isVar = /^[A-Z_]+$/.test(value)
value = isVar ? value : `"${value}"`
file.contents = file.contents
.toString()
.replace(new RegExp(`VALUE "${key}",.*`), `VALUE "${key}", ${value}`)
file.contents = file.contents.replace(
new RegExp(`VALUE "${key}",.*`),
`VALUE "${key}", ${value}`
)
})
;['PRODUCTVERSION', 'FILEVERSION'].forEach((x) => {
;['PRODUCTVERSION', 'FILEVERSION'].forEach(x => {
if (options[x]) {
file.contents = file.contents
.toString()
.replace(new RegExp(x + ' .*$', 'm'), `${x} ${options[x]}`)
file.contents = file.contents.replace(new RegExp(x + ' .*$', 'm'), `${x} ${options[x]}`)
}
})
+1 -1
View File
@@ -2,7 +2,7 @@ import { resolve } from 'path'
import { NexeCompiler } from '../compiler'
import { semverGt } from '../util'
export default async function (compiler: NexeCompiler, next: () => Promise<void>) {
export default async function(compiler: NexeCompiler, next: () => Promise<void>) {
const { snapshot, warmup, cwd } = compiler.options
if (!snapshot) {
+17 -40
View File
@@ -1,5 +1,5 @@
import { NexeCompiler } from '../compiler'
import { parse } from 'meriyah'
import { parse } from 'cherow'
import { wrap, semverGt } from '../util'
function walkSome(node: any, visit: Function) {
@@ -29,8 +29,6 @@ export default async function main(compiler: NexeCompiler, next: () => Promise<v
if (version.startsWith('4.')) {
bootFile = 'src/node.js'
} else if (semverGt(version, '18.11.99')) {
bootFile = 'lib/internal/process/pre_execution.js'
} else if (semverGt(version, '11.99')) {
bootFile = 'lib/internal/bootstrap/pre_execution.js'
} else if (semverGt(version, '9.10.1')) {
@@ -38,11 +36,13 @@ export default async function main(compiler: NexeCompiler, next: () => Promise<v
}
const file = await compiler.readFileAsync(bootFile),
ast = parse(file.contents.toString(), {
ast = parse(file.contents, {
loc: true,
tolerant: true,
next: true,
globalReturn: true,
loc: true,
specDeviation: true,
node: true,
skipShebang: true
}),
location = { start: { line: 0 } }
@@ -54,55 +54,32 @@ export default async function main(compiler: NexeCompiler, next: () => Promise<v
}
})
const fileLines = file.contents.toString().split('\n')
const fileLines = file.contents.split('\n')
fileLines.splice(
location.start.line,
0,
'{{ file("lib/fs/bootstrap.js") }}' +
'{{replace:lib/fs/bootstrap.js}}' +
'\n' +
(semverGt(version, '11.99') ? 'expandArgv1 = false;\n' : '')
)
file.contents = fileLines.join('\n')
if (semverGt(version, '11.99')) {
if (semverGt(version, '12.17.99')) {
await compiler.replaceInFileAsync(
bootFile,
'initializeFrozenIntrinsics();',
'initializeFrozenIntrinsics();\n' + wrap('{{ file("lib/patches/boot-nexe.js") }}')
)
} else {
await compiler.replaceInFileAsync(
bootFile,
'initializePolicy();',
'initializePolicy();\n' + wrap('{{ file("lib/patches/boot-nexe.js") }}')
)
}
await compiler.replaceInFileAsync(
bootFile,
'assert(!CJSLoader.hasLoadedAnyUserCJSModule)',
'/*assert(!CJSLoader.hasLoadedAnyUserCJSModule)*/'
'initializePolicy();',
'initializePolicy();\n' + wrap('{{replace:lib/patches/boot-nexe.js}}')
)
await compiler.replaceInFileAsync(
'src/node.cc',
'MaybeLocal<Value> StartMainThreadExecution(Environment* env) {',
'MaybeLocal<Value> StartMainThreadExecution(Environment* env) {\n' +
' return StartExecution(env, "internal/main/run_main_module");\n'
)
const { contents: nodeccContents } = await compiler.readFileAsync('src/node.cc')
if (nodeccContents.includes('if (env->worker_context() != nullptr) {')) {
await compiler.replaceInFileAsync(
'src/node.cc',
'if (env->worker_context() != nullptr) {',
'if (env->worker_context() == nullptr) {\n' +
' return StartExecution(env, "internal/main/run_main_module"); } else {\n'
)
} else {
await compiler.replaceInFileAsync(
'src/node.cc',
'MaybeLocal<Value> StartMainThreadExecution(Environment* env) {',
'MaybeLocal<Value> StartMainThreadExecution(Environment* env) {\n' +
' return StartExecution(env, "internal/main/run_main_module");\n'
)
}
} else {
await compiler.setFileContentsAsync(
'lib/_third_party_main.js',
'{{ file("lib/patches/boot-nexe.js") }}'
'{{replace:lib/patches/boot-nexe.js}}'
)
}
return next()
+9 -11
View File
@@ -2,7 +2,7 @@ import got = require('got')
import { platforms, architectures, NexeTarget, getTarget, targetsEqual } from './target'
export { NexeTarget }
const versionsToSkip = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 13, 15, 17, 19, 21, 22]
const versionsToSkip = [0, 1, 2, 3, 4, 5, 7, 9, 11]
export interface GitAsset {
name: string
url: string
@@ -25,21 +25,19 @@ async function getJson<T>(url: string, options?: any) {
}
function isBuildableVersion(version: string) {
if (version === '12.11.0') {
return false
}
return !versionsToSkip.includes(Number(version.split('.')[0]))
const major = Number(version.split('.')[0])
return !versionsToSkip.includes(major) || version === '4.8.4'
}
export function getLatestGitRelease(options?: any) {
return getJson<GitRelease>('https://api.github.com/repos/nexe/nexe/releases/latest', options)
export function getV3GitRelease(options?: any) {
return getJson<GitRelease>('https://api.github.com/repos/nexe/nexe/releases/7567580/', options)
}
export async function getUnBuiltReleases(options?: any) {
const nodeReleases = await getJson<NodeRelease[]>(
'https://nodejs.org/download/release/index.json'
)
const existingVersions = (await getLatestGitRelease(options)).assets.map((x) => getTarget(x.name))
const existingVersions = (await getV3GitRelease(options)).assets.map(x => getTarget(x.name))
const versionMap: { [key: string]: true } = {}
return nodeReleases
@@ -49,8 +47,8 @@ export async function getUnBuiltReleases(options?: any) {
return versions
}
versionMap[version] = true
platforms.forEach((platform) => {
architectures.forEach((arch) => {
platforms.forEach(platform => {
architectures.forEach(arch => {
if (arch === 'x86' && platform === 'mac') return
if (arch.includes('arm')) return
versions.push(getTarget({ platform, arch, version }))
@@ -58,5 +56,5 @@ export async function getUnBuiltReleases(options?: any) {
})
return versions
}, [])
.filter((x) => !existingVersions.some((t) => targetsEqual(t, x)))
.filter(x => !existingVersions.some(t => targetsEqual(t, x)))
}
+13 -12
View File
@@ -1,28 +1,29 @@
import { join, dirname } from 'path'
import * as fs from 'fs'
import { promisify } from 'util'
import { readdir, unlink } from 'fs'
import { readFileAsync, writeFileAsync, isDirectoryAsync } from '../util'
import mkdirpAsync = require('mkdirp')
import * as mkdirp from 'mkdirp'
import { NexeCompiler } from '../compiler'
import pify = require('pify')
const unlinkAsync = promisify(fs.unlink),
readdirAsync = promisify(fs.readdir)
const mkdirpAsync = pify(mkdirp)
const unlinkAsync = pify(unlink)
const readdirAsync = pify(readdir)
function readDirAsync(dir: string): Promise<string[]> {
return readdirAsync(dir).then((paths) => {
return readdirAsync(dir).then(paths => {
return Promise.all(
paths.map((file: string) => {
const path = join(dir, file)
return isDirectoryAsync(path).then((x) => (x ? readDirAsync(path) : (path as any)))
return isDirectoryAsync(path).then(x => (x ? readDirAsync(path) : (path as any)))
})
).then((result) => {
).then(result => {
return [].concat(...(result as any))
})
})
}
function maybeReadFileContentsAsync(file: string) {
return readFileAsync(file, 'utf-8').catch((e) => {
return readFileAsync(file, 'utf-8').catch(e => {
if (e.code === 'ENOENT') {
return ''
}
@@ -46,16 +47,16 @@ export default async function artifacts(compiler: NexeCompiler, next: () => Prom
const tmpFiles = await readDirAsync(temp)
await Promise.all(
tmpFiles.map(async (path) => {
tmpFiles.map(async path => {
return compiler.writeFileAsync(path.replace(temp, ''), await readFileAsync(path, 'utf-8'))
})
)
await next()
await Promise.all(tmpFiles.map((x) => unlinkAsync(x)))
await Promise.all(tmpFiles.map(x => unlinkAsync(x)))
return Promise.all(
compiler.files.map(async (file) => {
compiler.files.map(async file => {
const sourceFile = join(src, file.filename)
const tempFile = join(temp, file.filename)
const fileContents = await maybeReadFileContentsAsync(sourceFile)
+13 -20
View File
@@ -1,12 +1,13 @@
import { NexeCompiler, NexeError } from '../compiler'
import { resolve, relative } from 'path'
import { each } from '@calebboyd/semaphore'
import resolveFiles, { resolveSync } from 'resolve-dependencies'
import { dequote, STDIN_FLAG, semverGt, each } from '../util'
import { dequote, STDIN_FLAG, semverGt } from '../util'
import { Readable } from 'stream'
function getStdIn(stdin: Readable): Promise<string> {
let out = ''
return new Promise((resolve) => {
return new Promise(resolve => {
stdin
.setEncoding('utf8')
.on('readable', () => {
@@ -25,7 +26,7 @@ function getStdIn(stdin: Readable): Promise<string> {
}
export default async function bundle(compiler: NexeCompiler, next: any) {
const { bundle: doBundle, cwd, input: inputPath } = compiler.options
const { bundle, cwd, input: inputPath } = compiler.options
let input = inputPath
compiler.entrypoint = './' + relative(cwd, input)
@@ -35,14 +36,14 @@ export default async function bundle(compiler: NexeCompiler, next: any) {
compiler.startup = ';require("module").runMain();'
}
if (!doBundle) {
if (!bundle) {
await compiler.addResource(resolve(cwd, input))
return next()
}
let code = ''
if (typeof doBundle === 'string') {
code = await require(doBundle).createBundle(compiler.options)
if (typeof bundle === 'string') {
code = await require(bundle).createBundle(compiler.options)
}
if (input === STDIN_FLAG && (code = code || dequote(await getStdIn(process.stdin)))) {
@@ -61,28 +62,20 @@ export default async function bundle(compiler: NexeCompiler, next: any) {
compiler.entrypoint = './' + relative(cwd, input)
}
const step = compiler.log.step('Resolving dependencies...')
const { files, warnings } = await resolveFiles(
input,
...Object.keys(compiler.bundle.list).filter((x) => x.endsWith('.js') || x.endsWith('.mjs')),
{ cwd, expand: 'variable', loadContent: false }
...Object.keys(compiler.bundle.index).filter(x => x.endsWith('.js')),
{ cwd, expand: 'all', loadContent: false }
)
if (
warnings.filter((x) => x.startsWith('Error parsing file') && !x.includes('node_modules')).length
warnings.filter(x => x.startsWith('Error parsing file') && !x.includes('node_modules')).length
) {
throw new NexeError('Parsing Error:\n' + warnings.join('\n'))
}
//TODO: warnings.forEach((x) => console.log(x))
await Promise.all(
Object.entries(files).map(([key]) => {
step.log(`Including dependency: ${key}`)
return compiler.addResource(key)
})
)
await each(Object.keys(files), (filename: string) => compiler.addResource(filename), {
concurrency: 10
})
return next()
}
+3 -3
View File
@@ -11,7 +11,7 @@ function fetchNodeSourceAsync(dest: string, url: string, step: LogStep, options
.on('response', (res: IncomingMessage) => {
const total = +res.headers['content-length']!
let current = 0
res.on('data', (data) => {
res.on('data', data => {
current += data.length
setText((current / total) * 100)
if (current === total) {
@@ -32,13 +32,13 @@ async function fetchPrebuiltBinary(compiler: NexeCompiler, step: any) {
(res: IncomingMessage) => {
const total = +res.headers['content-length']!
let current = 0
res.on('data', (data) => {
res.on('data', data => {
current += data.length
step!.modify(`Downloading...${((current / total) * 100).toFixed()}%`)
})
}
)
} catch (e: any) {
} catch (e) {
if (e.statusCode === 404) {
throw new NexeError(`${remoteAsset} is not available, create it using the --build flag`)
} else {
+9 -12
View File
@@ -1,25 +1,22 @@
import { each } from '../util'
import { isDirectoryAsync, each } from '../util'
import globs from 'globby'
import { resolve } from 'path'
import { NexeCompiler } from '../compiler'
export default async function resource(compiler: NexeCompiler, next: () => Promise<any>) {
const { cwd, resources } = compiler.options
if (!resources.length) {
const { cwd } = compiler.options
if (!compiler.options.resources.length) {
return next()
}
const step = compiler.log.step('Bundling Resources...')
let count = 0
// workaround for https://github.com/sindresorhus/globby/issues/127
// and https://github.com/mrmlnc/fast-glob#pattern-syntax
const resourcesWithForwardSlashes = resources.map((r) => r.replace(/\\/g, '/'))
await each(globs(resourcesWithForwardSlashes, { cwd, onlyFiles: true }), async (file) => {
await each(globs(compiler.options.resources, { cwd }), async file => {
if (await isDirectoryAsync(file)) {
return
}
count++
step.log(`Including file: ${file}`)
await compiler.addResource(resolve(cwd, file))
await compiler.addResource(file)
})
step.log(`Included ${count} file(s)`)
step.log(`Included ${count} file(s). ${(compiler.resourceSize / 1e6).toFixed(3)} MB`)
return next()
}
+7 -13
View File
@@ -1,21 +1,13 @@
import { NexeCompiler } from '../compiler'
import { wrap } from '../util'
export default async function (compiler: NexeCompiler, next: () => Promise<void>) {
await next()
export default function(compiler: NexeCompiler, next: () => Promise<void>) {
compiler.shims.push(
wrap(
[
'process.__nexe = {};',
'const fsPatcher = (function() {',
'const module = {exports: {}};',
'const exports = module.exports;',
'{{file("lib/fs/patch.bundle.js")}}',
'return module.exports;',
'})()',
'fsPatcher.shimFs(process.__nexe);',
compiler.options.fs ? '' : 'restoreFs();',
].join('\n')
`process.__nexe = ${JSON.stringify(compiler.binaryConfiguration)};\n` +
'{{replace:lib/fs/patch.js}}' +
'\nshimFs(process.__nexe)' +
`\n${compiler.options.fs ? '' : 'restoreFs()'}`
//TODO support only restoring specific methods
)
)
@@ -40,4 +32,6 @@ export default async function (compiler: NexeCompiler, next: () => Promise<void>
}
`)
)
return next()
}
+10 -10
View File
@@ -1,8 +1,8 @@
export type NodePlatform = 'windows' | 'mac' | 'alpine' | 'linux'
export type NodeArch = 'x86' | 'x64' | 'arm' | 'arm64'
export type NodeArch = 'x86' | 'x64' | 'arm7l' | 'arm6l' | 'arm64'
const platforms: NodePlatform[] = ['windows', 'mac', 'alpine', 'linux'],
architectures: NodeArch[] = ['x86', 'x64', 'arm', 'arm64']
architectures: NodeArch[] = ['x86', 'x64', 'arm7l', 'arm6l', 'arm64']
export { platforms, architectures }
@@ -21,21 +21,21 @@ const prettyPlatform: { [key: string]: NodePlatform } = {
mac: 'mac',
linux: 'linux',
static: 'alpine',
alpine: 'alpine',
alpine: 'alpine'
}
const prettyArch: { [key: string]: NodeArch } = {
x86: 'x86',
arm6: 'arm',
arm6: 'arm6l',
arm64: 'arm64',
arm6l: 'arm',
arm: 'arm',
arm7: 'arm',
arm7l: 'arm',
arm6l: 'arm6l',
arm: 'arm7l',
arm7: 'arm7l',
arm7l: 'arm7l',
amd64: 'x64',
ia32: 'x86',
x32: 'x86',
x64: 'x64',
x64: 'x64'
}
function isVersion(x: string) {
@@ -80,7 +80,7 @@ export function getTarget(target: string | Partial<NexeTarget> = ''): NexeTarget
target
.toLowerCase()
.split('-')
.forEach((x) => {
.forEach(x => {
if (isVersion(x)) {
version = x.replace(/v/g, '')
}
+12 -12
View File
@@ -1,9 +1,9 @@
import { readFile, writeFile, stat } from 'fs'
import { execFile } from 'child_process'
import { promisify } from 'util'
import pify = require('pify')
import rimraf = require('rimraf')
const rimrafAsync = promisify(rimraf)
const rimrafAsync = pify(rimraf)
export const STDIN_FLAG = '[stdin]'
export async function each<T>(
@@ -26,7 +26,7 @@ function falseOnEnoent(e: any) {
}
function padRight(str: string, l: number) {
return (str + ' '.repeat(l)).slice(0, l)
return (str + ' '.repeat(l)).substr(0, l)
}
const bound: MethodDecorator = function bound<T>(
@@ -42,10 +42,10 @@ const bound: MethodDecorator = function bound<T>(
Object.defineProperty(this, propertyKey as string, {
configurable,
value,
writable: true,
writable: true
})
return value
},
}
}
}
@@ -64,21 +64,21 @@ export interface ReadFileAsync {
(path: string, encoding: string): Promise<string>
}
const readFileAsync = promisify(readFile)
const writeFileAsync = promisify(writeFile)
const statAsync = promisify(stat)
const execFileAsync = promisify(execFile)
const readFileAsync = pify(readFile)
const writeFileAsync = pify(writeFile)
const statAsync = pify(stat)
const execFileAsync = pify(execFile)
const isWindows = process.platform === 'win32'
function pathExistsAsync(path: string) {
return statAsync(path)
.then((x) => true)
.then(x => true)
.catch(falseOnEnoent)
}
function isDirectoryAsync(path: string) {
return statAsync(path)
.then((x) => x.isDirectory())
.then(x => x.isDirectory())
.catch(falseOnEnoent)
}
/**
@@ -109,5 +109,5 @@ export {
readFileAsync,
pathExistsAsync,
isDirectoryAsync,
writeFileAsync,
writeFileAsync
}
+16 -16
View File
@@ -1,9 +1,9 @@
import * as nexe from '../lib/nexe'
import { getUnBuiltReleases, getLatestGitRelease } from '../lib/releases'
import { getUnBuiltReleases, getV3GitRelease } from '../lib/releases'
import { runDockerBuild } from './docker'
import { getTarget, targetsEqual, NexeTarget } from '../lib/target'
import { pathExistsAsync, readFileAsync, execFileAsync, semverGt } from '../lib/util'
import got from 'got'
import got = require('got')
import { cpus } from 'os'
const env = process.env,
@@ -14,12 +14,12 @@ const env = process.env,
isMac = process.platform === 'darwin',
headers = {
Authorization: 'token ' + env.GITHUB_TOKEN,
'User-Agent': 'nexe (https://www.npmjs.com/package/nexe)',
'User-Agent': 'nexe (https://www.npmjs.com/package/nexe)'
}
if (require.main === module) {
if (!isPullRequest) {
build().catch((x) => {
build().catch(x => {
console.error(x)
process.exit(1)
})
@@ -31,10 +31,10 @@ async function build() {
if (!releases.length) {
return
}
const windowsBuild = releases.find((x) => x.platform === 'windows'),
macBuild = releases.find((x) => x.platform === 'mac'),
linux = releases.find((x) => x.platform === 'linux'),
alpine = releases.find((x) => x.platform === 'alpine')
const windowsBuild = releases.find(x => x.platform === 'windows'),
macBuild = releases.find(x => x.platform === 'mac'),
linux = releases.find(x => x.platform === 'linux'),
alpine = releases.find(x => x.platform === 'alpine')
let target: NexeTarget | undefined
@@ -62,7 +62,7 @@ async function build() {
verbose: Boolean(env.NEXE_VERBOSE!),
target,
make: ['-j' + cpus().length],
output,
output
}
console.log('Building: ' + target + ' on ' + buildHost)
const stop = keepalive()
@@ -78,21 +78,21 @@ async function build() {
stop()
if (await pathExistsAsync(output)) {
await assertNexeBinary(output)
const gitRelease = await getLatestGitRelease({ headers }),
const gitRelease = await getV3GitRelease({ headers }),
unbuiltReleases = await getUnBuiltReleases({ headers })
if (!unbuiltReleases.some((x) => targetsEqual(x, target!))) {
if (!unbuiltReleases.some(x => targetsEqual(x, target!))) {
console.log(`${target} already uploaded.`)
process.exit(0)
return
}
await got(gitRelease.upload_url.split('{')[0], {
searchParams: { name: target.toString() },
query: { name: target.toString() },
body: await readFileAsync(output),
headers: {
...headers,
'Content-Type': 'application/octet-stream',
},
}).catch((reason) => {
'Content-Type': 'application/octet-stream'
}
}).catch(reason => {
console.log(reason && reason.response && reason.response.body)
throw reason
})
@@ -107,7 +107,7 @@ function keepalive() {
}
function assertNexeBinary(file: string) {
return execFileAsync(file).catch((e) => {
return execFileAsync(file).catch(e => {
if (e && e.stack && e.stack.includes('Invalid Nexe binary')) {
return
}
+18 -19
View File
@@ -1,12 +1,12 @@
import { NexeTarget, architectures } from '../lib/target'
import { writeFileAsync, readFileAsync } from '../lib/util'
import got from 'got'
import got = require('got')
import execa = require('execa')
import { appendFileSync } from 'fs'
function alpine(target: NexeTarget) {
return `
FROM ${target.arch === 'x64' ? '' : 'i386/'}alpine:3.12
FROM ${target.arch === 'x64' ? '' : 'i386/'}alpine:3.4
RUN apk add --no-cache curl make gcc g++ binutils-gold python linux-headers paxctl libgcc libstdc++ git vim tar gzip wget
ENV NODE_VERSION=${target.version}
ENV NEXE_VERSION=latest
@@ -46,11 +46,11 @@ export async function runDockerBuild(target: NexeTarget) {
let output: any = []
try {
output.push(await execa(`docker build -t nexe-docker .`, { shell: true }))
output.push(await execa(`docker run -d --name nexe nexe-docker sh`, { shell: true }))
output.push(await execa(`docker cp nexe:/out out`, { shell: true }))
output.push(await execa(`docker rm nexe`, { shell: true }))
} catch (e: any) {
output.push(await execa.shell(`docker build -t nexe-docker .`))
output.push(await execa.shell(`docker run -d --name nexe nexe-docker sh`))
output.push(await execa.shell(`docker cp nexe:/out out`))
output.push(await execa.shell(`docker rm nexe`))
} catch (e) {
console.log('Error running docker')
appendFileSync(outFilename, e.message)
} finally {
@@ -58,17 +58,16 @@ export async function runDockerBuild(target: NexeTarget) {
appendFileSync(outFilename, x.stderr)
appendFileSync(outFilename, x.stdout)
})
try {
const { body } = await got(
`https://transfer.sh/${Math.random().toString(36).substring(2)}.txt`,
{
body: await readFileAsync(outFilename),
method: 'PUT',
}
)
console.log('Posted docker log: ', body)
} catch (e) {
console.log('Error posting log', e)
}
await got(
`https://transfer.sh/${Math.random()
.toString(36)
.substring(2)}.txt`,
{
body: await readFileAsync(outFilename),
method: 'PUT'
}
)
.then(x => console.log('Posted docker log: ', x.body))
.catch(e => console.log('Error posting log', e))
}
}
+15 -8
View File
@@ -1,10 +1,11 @@
import { writeFileSync, readFileSync } from 'fs'
import { template } from 'lodash'
/**
* post build step to insert code files into code files.
* post build step to insert code files into code files (naively).
* '{{replace:path/to/file}}' => "file contents"
* And the package.json version.
*/
//inject('plugins/nexe-daemon/lib/index.js')
cp('src/fs/package.json', 'lib/fs/package.json')
cp('src/fs/bootstrap.js', 'lib/fs/bootstrap.js')
cp('src/fs/README.md', 'lib/fs/README.md')
@@ -13,12 +14,18 @@ inject('lib/patches/third-party-main.js')
inject('lib/steps/shim.js')
inject('lib/options.js', JSON.stringify(require('../package.json').version))
function inject(filename: string, version?: string) {
const contents = template(readFileSync(filename, 'utf8'), {
interpolate: /'\{\{([\s\S]*?)\}\}'/,
})({
file: (path: string) => JSON.stringify(readFileSync(path, 'utf8')),
version,
function inject(filename: string, ...replacements: string[]) {
let contents = readFileSync(filename, 'utf8')
contents = contents.replace(/('{{(.*)}}')/g, (substring: string, ...matches: string[]) => {
if (!matches || !matches[1]) {
return substring
}
const [replace, file] = matches[1].split(':')
if (replace !== 'replace') {
return substring
}
console.log('Replacing: ', substring)
return replacements[+file] ? replacements[+file] : JSON.stringify(readFileSync(file, 'utf8'))
})
writeFileSync(filename, contents)
console.log(`Wrote: ${filename}`)
-10
View File
@@ -1,10 +0,0 @@
{
"extends": "../tsconfig.json",
"compilerOptions": {
"noEmit": true
},
"include":[
"*.ts"
]
}
-18
View File
@@ -1,18 +0,0 @@
const { mkdtemp } = require('fs/promises')
const os = require('os')
const path = require('path')
const rimraf = require('rimraf')
async function runTests() {
const tempdir = await mkdtemp(path.join(os.tmpdir(), 'nexe-'))
process.on('beforeExit', () => rimraf.sync(tempdir))
process.chdir(tempdir)
const Mocha = require('mocha')
const mocha = new Mocha()
mocha.addFile('test/integration/tests.integration-spec.js')
mocha.run((failures) => {
process.exitCode = failures ? 1 : 0
})
}
runTests()
-112
View File
@@ -1,112 +0,0 @@
const { expect } = require('chai')
const fs = require('fs')
const { dirname, basename }= require('path')
const files = { zipFs: 'test/integration/tests.integration-spec.js', real: 'real', real2: 'real2' }
describe('SnapshotZipFS', () => {
console.error('Note: these tests are order dependant, so subsequent failures are likely a flow on effect.')
it('checks existance from the zipFs', () => expect(fs.existsSync(files.zipFs)).to.equal(true))
it('checks non-existance from the zipFs', () => expect(fs.existsSync('not found')).to.equal(false))
it('reads from the zipFs', () => expect(fs.readFileSync(files.zipFs, 'utf8')).to.include('SnapshotZipFS'))
it('copies from the zipFs', () => expect(() => fs.copyFileSync(files.zipFs, files.real)).not.to.throw())
it('reads from the real fs', () => expect(fs.readFileSync(files.real, 'utf8')).to.include('SnapshotZipFS'))
it('checks non-existance from the real fs', () => expect(fs.existsSync(files.real2)).to.equal(false))
it('copies from the real fs', () => expect(() => fs.copyFileSync(files.real, files.real2)).not.to.throw())
it('checks existance from the real fs', () => expect(fs.existsSync(files.real2)).to.equal(true))
it('unlinks from the real fs', () => expect(() => fs.unlinkSync(files.real2)).not.to.throw())
it('symlinks the real fs', () => expect(() => fs.symlinkSync('tmp', files.real2)).not.to.throw())
it('readlinks the real fs', () => expect(fs.readlinkSync(files.real2)).to.equal('tmp'))
it('truncates the real fs', () => expect(() => fs.truncateSync(files.real)).not.to.throw())
it('writeFiles the real fs', () => expect(() => fs.writeFileSync(files.real2, 'testing')).not.to.throw())
it('accesses the real fs', () => expect(() => fs.accessSync(files.real)).not.to.throw())
it('accesses the zipFs', () => expect(() => fs.accessSync(files.zipFs)).not.to.throw())
it('stats the real fs', () => expect(fs.statSync(files.real2).size).to.be.greaterThan(0))
it('stats the zipFs', () => expect(fs.statSync(files.zipFs).size).to.be.greaterThan(0))
it('readdirs from the zipFs', () => expect(fs.readdirSync(dirname(files.zipFs))).to.include(basename(files.zipFs)))
it('readdirs from the real fs', () => expect(fs.readdirSync('.')).to.include(files.real))
it('readdirs from both', () => {
expect(fs.readdirSync('.')).to.include(files.real),
expect(fs.readdirSync('.')).to.include('test')
})
let dir
it('opendirs the zipFs fs', async () => {
expect(() => dir = fs.opendirSync(dirname(files.zipFs))).not.to.throw()
const names = []
for await (const dirent of dir) {
names.push(dirent.name)
}
expect(names).to.include(basename(files.zipFs))
})
it('opendirs the real fs and zipFs', async () => {
expect(() => dir = fs.opendirSync('.')).not.to.throw()
const names = []
for await (const dirent of dir) {
names.push(dirent.name)
}
expect(names).to.include(files.real)
expect(names).to.include('test')
})
it('createWriteStreams to the real fs', () => expect(() => fs.createWriteStream('createWriteStream')).not.to.throw())
it('createReadStreams to the real fs', () => expect(() => fs.createReadStream(files.real)).not.to.throw())
it('createReadStreams to the zipFs', () => expect(() => fs.createReadStream(files.zipFs)).not.to.throw())
it('renames to the realFs', () => {
expect(() => fs.renameSync(files.real2, 'rename')).not.to.throw()
expect(fs.existsSync('rename')).to.equal(true)
})
describe('write actions to the zipFs', () => {
it(`won't truncate to the zipFs`, () => expect(() => fs.truncateSync(files.zipFs)).to.throw())
it(`won't unlink from the zipFs`, () => expect(() => fs.unlinkSync(files.zipFs)).to.throw())
it(`won't appendFile to the zipFs`, () => expect(() => fs.appendFileSync(files.zipFs, 'xxx')).to.throw())
it(`won't symlink to the zipFs`, () => expect(() => fs.symlinkSync('tmp', files.zipFs)).to.throw())
it(`won't chmod to the zipFs`, () => expect(() => fs.chmodSync(files.zipFs, 0o666)).to.throw())
it(`won't chown to the zipFs`, () => expect(() => fs.chownSync(files.zipFs, 0, 0)).to.throw())
it(`won't writeFile the zipFs`, () => expect(() => fs.writeFileSync(files.zipFs, 'testing')).to.throw())
it(`won't createWriteStreams to the zipFs`, () => expect(() => fs.createWriteStream(files.zipFs)).to.throw())
it(`won't rename to the zipFs`, () => expect(() => fs.renameSync(files.real, files.zipFs)).to.throw())
})
;[ 'zipFs', 'real' ].forEach((k) => {
it(`watches the ${k} fs`, () => expect(() => fs.watch(files[k], () => null).close()).not.to.throw())
it(`watchFiles the ${k} fs`, () => expect(() => fs.watchFile(files[k], () => null)).not.to.throw())
it(`unwatchFiles the ${k} fs`, () => expect(() => fs.unwatchFile(files[k])).not.to.throw())
})
let buffer = Buffer.alloc(8092), fd
describe('zipfs file descriptors', () => {
it('opens files in the zipFs', () => {
expect(() => (fd = fs.openSync(files.zipFs, 'a+'))).not.to.throw()
expect(fd).to.not.be.null
})
it('reads file descriptors from the zipFs', () => {
expect(() => fs.readSync(fd, buffer)).not.to.throw()
expect(buffer.toString()).to.include('SnapshotZipFS')
})
it('fstats the zipFs', () => expect(fs.fstatSync(fd).size).to.be.greaterThan(0))
it(`won't write to the zipFs`, () => expect(() => fs.writeSync(fd, 'xxx')).to.throw())
it(`won't fchmod the zipFs`, () => expect(() => fs.fchmodSync(fd)).to.throw())
it(`won't fchown the zipFs`, () => expect(() => fs.fchownSync(fd)).to.throw())
it(`won't ftruncate the zipFs`, () => expect(() => fs.ftruncateSync(fd)).to.throw())
it('closes file descriptors from the zipFs', () => expect(() => fs.closeSync(fd)).not.to.throw())
})
fd = null
buffer = Buffer.alloc(8092)
describe('real file descriptors', () => {
it('opens files in the real fs', () => {
expect(() => (fd = fs.openSync(files.real2, 'a+'))).not.to.throw()
expect(fd).to.not.be.null
})
it('reads file descriptors from the real', () => {
expect(() => fs.readSync(fd, buffer)).not.to.throw()
expect(buffer.toString()).to.include('SnapshotZipFS')
})
it('will write to the real fs', () => expect(() => fs.writeSync(fd, 'xxx')).not.to.throw())
it('fstats the real fs', () => expect(fs.fstatSync(fd).size).to.be.greaterThan(0))
it('closes file descriptors from the real fs', () => expect(() => fs.closeSync(fd)).not.to.throw())
})
describe('path clashes', () => {
it('delegates directory creation to the real fs', () => expect(() => fs.mkdirSync('test')).not.to.throw())
it('delegates directory removal to the real fs', () => expect(() => fs.rmdirSync('test')).not.to.throw())
})
})
+4
View File
@@ -0,0 +1,4 @@
./test/**/*.spec.ts
--check-leaks
--require ts-node/register
--recursive
-20
View File
@@ -39,26 +39,6 @@ describe('options', () => {
expect(options.output).to.equal(path.resolve(cwd, `abc${ext}`))
})
})
describe('remote', () => {
it('should use default remote', () => {
const options = normalizeOptions({})
expect(options.remote).to.equal('https://github.com/nexe/nexe/releases/download/v3.3.3/')
})
it('should append trailing slash to third-party remote if necessary', () => {
const options = normalizeOptions({
remote: 'https://sitejs.org/nexe'
})
expect(options.remote).to.equal('https://sitejs.org/nexe/')
})
it('should not append trailing slash to third-party remote that already has one', () => {
const options = normalizeOptions({
remote: 'https://sitejs.org/nexe/'
})
expect(options.remote).to.equal('https://sitejs.org/nexe/')
})
})
describe('output', () => {
it('should work', () => {
const options = normalizeOptions({
+1 -2
View File
@@ -1,9 +1,8 @@
{
"compilerOptions": {
"target":"es2015",
"target":"es5",
"skipLibCheck": true,
"experimentalDecorators": true,
"esModuleInterop": true,
"lib": ["es2018"],
"module": "commonjs",
"outDir": "./lib",
-7
View File
@@ -1,7 +0,0 @@
import * as wcp from 'webpack-config-prefabs'
export = wcp.nodeLibrary(module, {
enableTypescript: true,
entry: './src/fs/patch.ts',
minimize: false,
outputFilepath: './lib/fs/patch.bundle.js',
});