oxc/napi/parser/index.js
Herrington Darkholme c63f5123b3
feat(parser/napi): add flexbuffer to AST transfer (2x speedup) (#1680)
Hi! I have created a proof of concept of improving using oxc in
JavaScript. The method is not polished but it provides valuable insights
for future direction!

Feel free to close~ It is for reference only :)

# Context 

This is a proof of concept implementation of passing binary AST to
JavaScript. JavaScript can selectively read flexbuffers-based AST nodes
on demand to avoid the deserialization toll. More context
[here](https://dev.to/herrington_darkholme/benchmark-typescript-parsers-demystify-rust-tooling-performance-2go8).

# Changes

* Add a `parseSyncBuffer` napi method to return a binary AST from Rust
to JavaScript. The AST is in flexbuffer format.
* Add a `test_buffer.js` to test usage of flexbuffers in JavaScript. It
is in cjs format because flexbuffers does not support ESM :/

# Result
Some preliminary results, for reference only.

```
~ node test_buffer.js
testJSON: 4.043s
testBuffer: 2.395s
```

Buffer based API is 100% faster than JSON.

# Future Ideas
* Flexbuffers itself is slow. A better binary protocol is desired!
* Using binary reader to traverse AST is undesirable. A proxy-based API
to emulate object behavior will be nice.
2023-12-15 02:52:33 +00:00

260 lines
7.4 KiB
JavaScript

/* tslint:disable */
/* eslint-disable */
/* prettier-ignore */
/* auto-generated by NAPI-RS */
const { existsSync, readFileSync } = require('fs')
const { join } = require('path')
const { platform, arch } = process
let nativeBinding = null
let localFileExisted = false
let loadError = null
function isMusl() {
// For Node 10
if (!process.report || typeof process.report.getReport !== 'function') {
try {
const lddPath = require('child_process').execSync('which ldd').toString().trim();
return readFileSync(lddPath, 'utf8').includes('musl')
} catch (e) {
return true
}
} else {
const { glibcVersionRuntime } = process.report.getReport().header
return !glibcVersionRuntime
}
}
switch (platform) {
case 'android':
switch (arch) {
case 'arm64':
localFileExisted = existsSync(join(__dirname, 'parser.android-arm64.node'))
try {
if (localFileExisted) {
nativeBinding = require('./parser.android-arm64.node')
} else {
nativeBinding = require('@oxc-parser/binding-android-arm64')
}
} catch (e) {
loadError = e
}
break
case 'arm':
localFileExisted = existsSync(join(__dirname, 'parser.android-arm-eabi.node'))
try {
if (localFileExisted) {
nativeBinding = require('./parser.android-arm-eabi.node')
} else {
nativeBinding = require('@oxc-parser/binding-android-arm-eabi')
}
} catch (e) {
loadError = e
}
break
default:
throw new Error(`Unsupported architecture on Android ${arch}`)
}
break
case 'win32':
switch (arch) {
case 'x64':
localFileExisted = existsSync(
join(__dirname, 'parser.win32-x64-msvc.node')
)
try {
if (localFileExisted) {
nativeBinding = require('./parser.win32-x64-msvc.node')
} else {
nativeBinding = require('@oxc-parser/binding-win32-x64-msvc')
}
} catch (e) {
loadError = e
}
break
case 'ia32':
localFileExisted = existsSync(
join(__dirname, 'parser.win32-ia32-msvc.node')
)
try {
if (localFileExisted) {
nativeBinding = require('./parser.win32-ia32-msvc.node')
} else {
nativeBinding = require('@oxc-parser/binding-win32-ia32-msvc')
}
} catch (e) {
loadError = e
}
break
case 'arm64':
localFileExisted = existsSync(
join(__dirname, 'parser.win32-arm64-msvc.node')
)
try {
if (localFileExisted) {
nativeBinding = require('./parser.win32-arm64-msvc.node')
} else {
nativeBinding = require('@oxc-parser/binding-win32-arm64-msvc')
}
} catch (e) {
loadError = e
}
break
default:
throw new Error(`Unsupported architecture on Windows: ${arch}`)
}
break
case 'darwin':
localFileExisted = existsSync(join(__dirname, 'parser.darwin-universal.node'))
try {
if (localFileExisted) {
nativeBinding = require('./parser.darwin-universal.node')
} else {
nativeBinding = require('@oxc-parser/binding-darwin-universal')
}
break
} catch {}
switch (arch) {
case 'x64':
localFileExisted = existsSync(join(__dirname, 'parser.darwin-x64.node'))
try {
if (localFileExisted) {
nativeBinding = require('./parser.darwin-x64.node')
} else {
nativeBinding = require('@oxc-parser/binding-darwin-x64')
}
} catch (e) {
loadError = e
}
break
case 'arm64':
localFileExisted = existsSync(
join(__dirname, 'parser.darwin-arm64.node')
)
try {
if (localFileExisted) {
nativeBinding = require('./parser.darwin-arm64.node')
} else {
nativeBinding = require('@oxc-parser/binding-darwin-arm64')
}
} catch (e) {
loadError = e
}
break
default:
throw new Error(`Unsupported architecture on macOS: ${arch}`)
}
break
case 'freebsd':
if (arch !== 'x64') {
throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
}
localFileExisted = existsSync(join(__dirname, 'parser.freebsd-x64.node'))
try {
if (localFileExisted) {
nativeBinding = require('./parser.freebsd-x64.node')
} else {
nativeBinding = require('@oxc-parser/binding-freebsd-x64')
}
} catch (e) {
loadError = e
}
break
case 'linux':
switch (arch) {
case 'x64':
if (isMusl()) {
localFileExisted = existsSync(
join(__dirname, 'parser.linux-x64-musl.node')
)
try {
if (localFileExisted) {
nativeBinding = require('./parser.linux-x64-musl.node')
} else {
nativeBinding = require('@oxc-parser/binding-linux-x64-musl')
}
} catch (e) {
loadError = e
}
} else {
localFileExisted = existsSync(
join(__dirname, 'parser.linux-x64-gnu.node')
)
try {
if (localFileExisted) {
nativeBinding = require('./parser.linux-x64-gnu.node')
} else {
nativeBinding = require('@oxc-parser/binding-linux-x64-gnu')
}
} catch (e) {
loadError = e
}
}
break
case 'arm64':
if (isMusl()) {
localFileExisted = existsSync(
join(__dirname, 'parser.linux-arm64-musl.node')
)
try {
if (localFileExisted) {
nativeBinding = require('./parser.linux-arm64-musl.node')
} else {
nativeBinding = require('@oxc-parser/binding-linux-arm64-musl')
}
} catch (e) {
loadError = e
}
} else {
localFileExisted = existsSync(
join(__dirname, 'parser.linux-arm64-gnu.node')
)
try {
if (localFileExisted) {
nativeBinding = require('./parser.linux-arm64-gnu.node')
} else {
nativeBinding = require('@oxc-parser/binding-linux-arm64-gnu')
}
} catch (e) {
loadError = e
}
}
break
case 'arm':
localFileExisted = existsSync(
join(__dirname, 'parser.linux-arm-gnueabihf.node')
)
try {
if (localFileExisted) {
nativeBinding = require('./parser.linux-arm-gnueabihf.node')
} else {
nativeBinding = require('@oxc-parser/binding-linux-arm-gnueabihf')
}
} catch (e) {
loadError = e
}
break
default:
throw new Error(`Unsupported architecture on Linux: ${arch}`)
}
break
default:
throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
}
if (!nativeBinding) {
if (loadError) {
throw loadError
}
throw new Error(`Failed to load native binding`)
}
const { parseWithoutReturn, parseSync, parseSyncBuffer, parseAsync } = nativeBinding
module.exports.parseWithoutReturn = parseWithoutReturn
module.exports.parseSync = parseSync
module.exports.parseSyncBuffer = parseSyncBuffer
module.exports.parseAsync = parseAsync