myde-unix-socket 0.1.0

package/Cargo.lock

@@ -0,0 +1,203 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
+
+[[package]]
+name = "bitflags"
+version = "2.11.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "843867be96c8daad0d758b57df9392b6d8d271134fce549de6ce169ff98a92af"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "either"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "48c757948c5ede0e46177b7add2e67155f70e33c07fea8284df6576da70b3719"
+
+[[package]]
+name = "getrandom"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ff2abc00be7fca6ebc474524697ae276ad847ad0a6b3faa4bcb027e9a4614ad0"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wasi",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.183"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b5b646652bf6661599e1da8901b3b9522896f01e736bad5f723fe7a3a27f899d"
+
+[[package]]
+name = "libloading"
+version = "0.8.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d7c4b02199fee7c5d21a5ae7d8cfa79a6ef5bb2fc834d6e9058e89c825efdc55"
+dependencies = [
+ "cfg-if",
+ "windows-link",
+]
+
+[[package]]
+name = "linkme"
+version = "0.3.35"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5e3283ed2d0e50c06dd8602e0ab319bb048b6325d0bba739db64ed8205179898"
+dependencies = [
+ "linkme-impl",
+]
+
+[[package]]
+name = "linkme-impl"
+version = "0.3.35"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e5cec0ec4228b4853bb129c84dbf093a27e6c7a20526da046defc334a1b017f7"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "myde-unix-socket"
+version = "0.1.0"
+dependencies = [
+ "libc",
+ "neon",
+ "nix",
+]
+
+[[package]]
+name = "neon"
+version = "1.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "74c1d298c79e60a3f5a1e638ace1f9c1229d2a97bd3a9e40a63b67c8efa0f1e1"
+dependencies = [
+ "either",
+ "getrandom",
+ "libloading",
+ "linkme",
+ "neon-macros",
+ "once_cell",
+ "semver",
+ "send_wrapper",
+ "smallvec",
+]
+
+[[package]]
+name = "neon-macros"
+version = "1.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c39e43767817fc963f90f400600967a2b2403602c6440685d09a6bc4e02b70b1"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "nix"
+version = "0.27.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2eb04e9c688eff1c89d72b407f168cf79bb9e867a9d3323ed6c01519eb9cc053"
+dependencies = [
+ "bitflags",
+ "cfg-if",
+ "libc",
+ "memoffset",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "semver"
+version = "1.0.27"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d767eb0aabc880b29956c35734170f26ed551a859dbd361d140cdbeca61ab1e2"
+
+[[package]]
+name = "send_wrapper"
+version = "0.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cd0b0ec5f1c1ca621c432a25813d8d60c88abe6d3e08a3eb9cf37d97a0fe3d73"
+
+[[package]]
+name = "smallvec"
+version = "1.15.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03"
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "wasi"
+version = "0.11.1+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b"
+
+[[package]]
+name = "windows-link"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"

package/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "myde-unix-socket"
+version = "0.1.0"
+license = "ISC"
+edition = "2024"
+exclude = ["index.node"]
+
+[lib]
+crate-type = ["cdylib"]
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+neon = "1.1"
+nix = { version = "0.27", features = ["fs", "socket", "uio", "poll"] }
+libc = "0.2"

package/LICENSE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,262 @@
+# unix-socket
+
+高性能的 Node.js Unix socket 库，使用 Rust (Neon) 实现，支持文件描述符传递 (SCM_RIGHTS)。
+
+## 特性
+
+- 🚀 **高性能** - 使用 Rust 实现，比纯 JavaScript 方案更快
+- 📁 **文件描述符传递** - 支持通过 Unix socket 传递文件描述符 (SCM_RIGHTS)
+- 🔄 **非阻塞 I/O** - 支持非阻塞的 accept 操作
+- 📦 **TypeScript 支持** - 完整的类型定义
+- 🧪 **测试覆盖** - 完整的测试用例
+
+## 安装
+
+```bash
+npm install unix-socket
+# 或
+pnpm add unix-socket
+# 或
+yarn add unix-socket
+```
+
+## 快速开始
+
+### 基本用法
+
+```typescript
+import { UServer, USocket } from "unix-socket";
+
+// 创建服务器
+const server = new UServer();
+server.listen("/tmp/my-socket");
+
+server.on("listening", () => {
+    console.log("Server listening");
+});
+
+// 创建客户端连接
+const client = new USocket("/tmp/my-socket");
+
+// 等待服务器接受连接
+let serverSocket: USocket | null = null;
+while (!serverSocket) {
+    serverSocket = server.accept();
+}
+
+// 发送数据
+const message = Buffer.from("Hello, Server!");
+client.write(message);
+
+// 读取数据
+let data: Buffer | null = null;
+while (!data) {
+    data = serverSocket.read(1024);
+}
+console.log(data.toString()); // "Hello, Server!"
+
+// 清理
+client.close();
+serverSocket.close();
+server.close();
+```
+
+### 文件描述符传递
+
+```typescript
+import { UServer, USocket } from "unix-socket";
+import * as fs from "fs";
+
+// 创建服务器
+const server = new UServer();
+server.listen("/tmp/fd-socket");
+
+// 创建客户端
+const client = new USocket("/tmp/fd-socket");
+
+// 等待服务器接受连接
+let serverSocket: USocket | null = null;
+while (!serverSocket) {
+    serverSocket = server.accept();
+}
+
+// 客户端打开文件并发送 fd
+const fileFd = fs.openSync("/tmp/test.txt", "r");
+const message = Buffer.from("fd-transfer");
+client.write(message, [fileFd]);
+
+// 服务器接收 fd
+let result = null;
+while (!result || result.fds.length === 0) {
+    result = serverSocket.readWithFds(1024);
+}
+
+// 使用接收到的 fd 读取文件
+const receivedFd = result.fds[0];
+const content = fs.readFileSync(receivedFd, "utf-8");
+console.log(content);
+
+// 清理
+fs.closeSync(fileFd);
+fs.closeSync(receivedFd);
+client.close();
+serverSocket.close();
+server.close();
+```
+
+## API
+
+### USocket
+
+Unix socket 客户端类。
+
+#### 构造函数
+
+```typescript
+new USocket(opts?: USocketOptions | string)
+```
+
+- `opts.path` - 连接的 socket 路径
+- `opts.fd` - 使用现有的文件描述符
+
+#### 方法
+
+##### `connect(opts: USocketOptions | string): void`
+
+连接到 Unix socket 服务器。
+
+##### `write(data: Buffer, fds?: number[]): number`
+
+发送数据，可选择发送文件描述符数组。
+
+- `data` - 要发送的数据
+- `fds` - 要发送的文件描述符数组 (可选)
+- 返回实际写入的字节数
+
+##### `read(size: number): Buffer | null`
+
+读取数据。
+
+- `size` - 要读取的最大字节数
+- 返回读取的数据或 null
+
+##### `readWithFds(size: number): ReadWithFdsResult | null`
+
+读取数据和文件描述符。
+
+返回对象：
+
+- `data` - 读取的数据 (Buffer | null)
+- `fds` - 接收到的文件描述符数组
+
+##### `shutdown(): void`
+
+关闭 socket 连接。
+
+##### `close(): void`
+
+关闭并释放资源。
+
+### UServer
+
+Unix socket 服务器类，继承自 EventEmitter。
+
+#### 构造函数
+
+```typescript
+new UServer();
+```
+
+#### 方法
+
+##### `listen(path: string, backlog?: number, cb?: () => void): void`
+
+开始监听指定路径。
+
+- `path` - socket 文件路径
+- `backlog` - 连接队列长度 (默认: 16)
+- `cb` - 监听成功回调 (可选)
+
+##### `accept(): USocket | null`
+
+接受新的连接。
+
+- 返回新的 USocket 实例，如果没有连接则返回 null
+
+##### `pause(): void`
+
+暂停接受连接。
+
+##### `resume(): void`
+
+恢复接受连接。
+
+##### `close(): void`
+
+关闭服务器。
+
+#### 事件
+
+- `listening` - 服务器开始监听时触发
+
+## 构建
+
+### 前置要求
+
+- Node.js >= 18
+- Rust 和 Cargo
+- pnpm (或 npm/yarn)
+
+### 构建步骤
+
+```bash
+# 安装依赖
+pnpm install
+
+# 构建
+pnpm run build
+
+# 运行测试
+pnpm test
+
+# 监视模式测试
+pnpm run test:watch
+
+# 生成测试覆盖率报告
+pnpm run test:coverage
+```
+
+### 构建脚本
+
+- `pnpm run build` - 完整构建 (Rust + TypeScript + 类型定义)
+- `pnpm run build:rust` - 仅构建 Rust 原生模块
+- `pnpm run build:ts` - 仅构建 TypeScript
+- `pnpm run build:types` - 仅生成类型定义
+- `pnpm test` - 运行测试
+- `pnpm run test:rust` - 运行 Rust 测试
+
+## 项目结构
+
+```
+├── src/
+│   ├── index.ts          # TypeScript 入口
+│   ├── socket.rs         # Rust 实现
+│   └── socket.test.ts    # 测试文件
+├── dist/                 # 构建输出
+├── Cargo.toml           # Rust 配置
+├── package.json         # Node.js 配置
+├── tsconfig.json        # TypeScript 配置
+└── vite.config.ts       # Vite 配置
+```
+
+## 技术栈
+
+- **Rust** - 核心实现
+- **Neon** - Rust 和 Node.js 的桥梁
+- **Vite** - TypeScript 打包
+- **Vitest** - 测试框架
+- **nix** - Unix 系统调用
+
+## 相关项目
+
+- [neon](https://neon-bindings.com/) - Rust 和 Node.js 的绑定

package/dist/index.cjs

@@ -0,0 +1 @@
+Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});let e=require(`node:events`);var t=require(`../index.node`),n=class{constructor(e){this._wrap=null,typeof e==`string`&&(e={path:e}),(e?.fd||e?.path)&&this.connect(e)}connect(e){if(this._wrap)throw Error(`connect on already connected USocket`);if(typeof e==`string`&&(e={path:e}),this._wrap=t.USocketWrap(),typeof e.fd==`number`){let n=t.USocketWrap_adopt(this._wrap,e.fd);this.fd=n>=0?n:void 0}else if(typeof e.path==`string`){let n=t.USocketWrap_connect(this._wrap,e.path);this.fd=n>=0?n:void 0}}write(e,n){if(!this._wrap)throw Error(`USocket not connected`);return t.USocketWrap_write(this._wrap,e,n)}read(e){return this._wrap?t.USocketWrap_read(this._wrap,e):null}readWithFds(e){return this._wrap?t.USocketWrap_read_with_fds(this._wrap,e):null}shutdown(){this._wrap&&t.USocketWrap_shutdown(this._wrap)}close(){this._wrap&&=(t.USocketWrap_close(this._wrap),null)}},r=class extends e.EventEmitter{constructor(){super(),this.listening=!1,this.paused=!1,this._wrap=null}listen(e,n,r){if(this._wrap||this.listening)throw Error(`listen on already listened UServer`);if(typeof e==`object`?(n=e.backlog,e=e.path,r=n):typeof n==`function`&&(r=n,n=0),n||=16,typeof e!=`string`)throw Error(`UServer expects valid path`);typeof r==`function`&&this.once(`listening`,r),this._wrap=t.UServerWrap();let i=t.UServerWrap_listen(this._wrap,e,n);this.fd=i>=0?i:void 0,this.listening=!0,this.emit(`listening`),this.paused||this.resume()}accept(){if(!this._wrap)return null;let e=t.UServerWrap_accept(this._wrap);return e===null?null:new n({fd:e})}pause(){this.paused=!0}resume(){this.paused=!1}close(){this._wrap&&=(t.UServerWrap_close(this._wrap),null)}},i={USocket:n,UServer:r};exports.UServer=r,exports.USocket=n,exports.default=i;