chore: update some tests and add package.json fields

Author: oyyd

__test__/dgram.spec.ts

@@ -1,10 +1,10 @@
+// TODO add tests for worker_threads
 import * as path from 'path';
 import * as fs from 'fs';
 import * as os from 'os';
 import { DgramSocket } from '../js/index';
-import { kTmp, silently, createDefer } from './util';
+import { kTmp, silently, createDefer, kServerPath } from './util';
 
-const kServerPath = path.resolve(kTmp, './server.sock');
 const kClientPath = path.resolve(kTmp, './client.sock');
 const kInvalidPath = path.resolve(kTmp, './A_PATH_THAT_DOESNT_EXIST');
 
@@ -20,10 +20,7 @@ describe('DgramSocket', () => {
   });
 
   it('should work', async () => {
-    let resolve: any;
-    const readCb = new Promise((r) => {
-      resolve = r;
-    });
+    const { p: readCb, resolve } = createDefer();
     const msg = 'hello';
     const mockFn = jest.fn((buf, filepath) => {
       try {

__test__/seqpacket.spec.ts

@@ -1,3 +1,4 @@
+// TODO add tests for worker_threads
 import * as path from 'path';
 import * as fs from 'fs';
 import { SeqpacketSocket, SeqpacketServer } from '../js/seqpacket';

__test__/util.ts

@@ -5,6 +5,8 @@ export const kIsDarwin = os.platform() === 'darwin'
 
 export const kTmp = path.resolve(__dirname, './.tmp')
 
+export const kServerPath = path.resolve(kTmp, './server.sock');
+
 export function wait(t: number) {
   return new Promise<void>((resolve, reject) => {
     setTimeout(() => {

js/addon.d.ts

@@ -25,6 +25,5 @@ export function dgramSetRecvBufferSize(ee: object, size: number): void
 export function dgramGetSendBufferSize(ee: object): number
 export function dgramSetSendBufferSize(ee: object, size: number): void
 export function dgramSendTo(ee: object, buf: Buffer, offset: number, length: number, path: string, cb?: (...args: any[]) => any | undefined | null): void
-export function startRecv(ee: object): void
 export function socketNewSoReuseportFd(domain: string, port: number, ip: string): number
 export function socketClose(fd: number): void

package.json

@@ -3,7 +3,11 @@
   "version": "0.1.0",
   "main": "js/index.js",
   "types": "js/index.d.ts",
-  "description": "TODO",
+  "author": {
+    "email": "oyydoibh@gmail.com",
+    "name": "Ouyang Yadong"
+  },
+  "description": "nix-socket allows you to use SO_REUSEPORT, SOCK_SEQPACKET, SOCK_DGRAM in Node.js.",
   "scripts": {
     "artifacts": "napi artifacts",
     "build": "napi build --platform --js false --dts js/addon.d.ts && npm run build:ts",

src/dgram.rs

@@ -100,13 +100,6 @@ pub fn dgram_send_to(
   wrap.send_to(env, buf, offset, length, path, cb)
 }
 
-#[allow(dead_code)]
-#[napi]
-pub fn start_recv(env: Env, ee: JsObject) -> Result<()> {
-  let wrap = unwrap(&env, &ee)?;
-  wrap.start_recv(env)
-}
-
 #[allow(dead_code)]
 fn string_from_i8_slice(slice: &[i8]) -> Result<String> {
   let trans = i8_slice_into_u8_slice(slice);
@@ -124,7 +117,6 @@ struct MsgItem {
 
 pub struct DgramSocketWrap {
   fd: i32,
-  // TODO test in worker_threads
   env: Env,
   handle: *mut sys::uv_poll_t,
   msg_queue: LinkedList<MsgItem>,

src/seqpacket.rs

@@ -30,7 +30,6 @@ struct MsgItem {
 
 struct SeqpacketSocketWrap {
   fd: i32,
-  // TODO worker_threads
   env: Env,
   handle: *mut sys::uv_poll_t,
   msg_queue: LinkedList<MsgItem>,

src/util.rs

@@ -13,7 +13,8 @@ pub(crate) fn i8_slice_into_u8_slice<'a>(slice: &'a [i8]) -> &'a [u8] {
 }
 
 pub(crate) fn addr_to_string(addr: &sockaddr_un) -> String {
-  // sockaddr_un.sun_path/c_char has varied types in different types so that we transmute() it
+  // sockaddr_un.sun_path/c_char has varied types in different operating systems
+  // so that we directly transmute() it
   let path_ref: &[i8] = unsafe { transmute(&addr.sun_path as &[c_char]) };
   let sockname = i8_slice_into_u8_slice(path_ref);
   let sockname = unsafe { str_from_u8_nul_utf8_unchecked(sockname) };