Refactor package structure

.gitignore

@@ -1,5 +1,5 @@
 /node_modules
-/dist
+/lib
 /test_dist
 /coverage
 /.nyc_output

README.md

@@ -41,7 +41,7 @@ npm run build
 or
 
 ```sh
-node dist/run-uws-tracker.js [config.json]
+node lib/run-uws-tracker.js [config.json]
 ```
 
 or

bin/wt-tracker

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-import "../dist/run-uws-tracker.js";
+import "../lib/run-uws-tracker.js";

package.json

@@ -5,9 +5,14 @@
   "license": "Apache-2.0",
   "author": "Novage",
   "homepage": "https://github.com/Novage/wt-tracker",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "exports": "./src/index.ts",
+  "types": "./src/index.ts",
+  "publishConfig": {
+    "exports": "lib/index.js",
+    "types": "lib/index.d.ts"
+  },
   "type": "module",
+  "sideEffects": false,
   "engines": {
     "node": ">=16.0.0"
   },
@@ -26,11 +31,11 @@
     "websockets"
   ],
   "scripts": {
-    "start": "node ./dist/run-uws-tracker.js",
+    "start": "node ./lib/run-uws-tracker.js",
     "build": "npm run lint && npm run clean && npm run compile",
     "compile": "tsc",
-    "lint": "eslint --ext .ts lib",
-    "clean": "rimraf dist",
+    "lint": "eslint --ext .ts src",
+    "clean": "rimraf lib",
     "watch": "tsc --watch",
     "test": "vitest",
     "test:coverage": "vitest run --coverage",

lib/fast-tracker.ts → src/fast-tracker.ts

@@ -158,29 +158,29 @@ export class FastTracker implements Tracker {
     return this.#swarms;
   }
 
-  public processMessage(jsonObject: object, peer: SocketContext): void {
+  public processMessage(jsonObject: object, socket: SocketContext): void {
     const json = jsonObject as UnknownObject;
     const action = json.action;
 
     if (action === "announce") {
       const event = json.event;
       if (event === undefined) {
         if (json.answer === undefined) {
-          this.processAnnounce(json, peer);
+          this.processAnnounce(json, socket);
         } else {
           this.processAnswer(json);
         }
       } else if (event === "started") {
-        this.processAnnounce(json, peer);
+        this.processAnnounce(json, socket);
       } else if (event === "stopped") {
         this.processStop(json);
       } else if (event === "completed") {
-        this.processAnnounce(json, peer, true);
+        this.processAnnounce(json, socket, true);
       } else {
         throw new TrackerError("unknown announce event");
       }
     } else if (action === "scrape") {
-      this.processScrape(json, peer);
+      this.processScrape(json, socket);
     } else {
       throw new TrackerError("unknown action");
     }

lib/index.ts → src/index.ts

@@ -15,9 +15,9 @@
  * limitations under the License.
  */
 
-export type { UWebSocketsTracker } from "./uws-tracker.js";
-export type { FastTracker } from "./fast-tracker.js";
-export type {
+export { UWebSocketsTracker } from "./uws-tracker.js";
+export { FastTracker } from "./fast-tracker.js";
+export {
   Tracker,
   SocketContext as PeerContext,
   TrackerError,

lib/tracker.ts → src/tracker.ts

@@ -18,11 +18,11 @@ export interface SocketContext {
   sendMessage: (json: object, peer: SocketContext) => void;
 }
 
-export type Swarm = {
+export interface Swarm {
   infoHash: string;
   completedPeers?: Set<string>;
   peers: PeerContext[];
-};
+}
 
 export interface PeerContext {
   peerId: string;
@@ -35,8 +35,8 @@ export interface PeerContext {
 export interface Tracker {
   readonly swarms: ReadonlyMap<string, { peers: readonly PeerContext[] }>;
   readonly settings: object;
-  processMessage: (json: object, peer: SocketContext) => void;
-  disconnectPeersFromSocket: (peer: SocketContext) => void;
+  processMessage: (json: object, socket: SocketContext) => void;
+  disconnectPeersFromSocket: (socket: SocketContext) => void;
 }
 
 export class TrackerError extends Error {}

test/announce.test.ts

@@ -14,19 +14,9 @@
  * limitations under the License.
  */
 
-import { FastTracker } from "../lib/fast-tracker.js";
-import { PeerContext } from "../lib/tracker.js";
+import { FastTracker } from "../src/fast-tracker.js";
 import { describe, it, expect } from "vitest";
 
-import {
-  mock,
-  instance,
-  anything,
-  verify,
-  capture,
-  resetCalls,
-} from "ts-mockito";
-
 describe("announce", () => {
   it("should add peers to swarms on announce", () => {
     const tracker = new FastTracker();

test/memory/heap-usage.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import { FastTracker } from "../../lib/fast-tracker.js";
-import { SocketContext } from "../../lib/tracker.js";
+import { FastTracker } from "../../src/fast-tracker.js";
+import { SocketContext } from "../../src/tracker.js";
 
 const peersCount = 100000;
 const swarmsCount = 1000000000;
@@ -47,7 +47,7 @@ console.log(
 );
 console.log("\nadding peers to swarms");
 
-const peers: SocketContext[] = [];
+const sockets: SocketContext[] = [];
 for (let p = 0; p < peersCount; p++) {
   message.peer_id = p.toPrecision(19).toString();
   message.info_hash = Math.floor(swarmsCount * Math.random())
@@ -57,7 +57,7 @@ for (let p = 0; p < peersCount; p++) {
     sendMessage: () => p,
   };
   tracker.processMessage(message, peer);
-  peers.push(peer);
+  sockets.push(peer);
 }
 
 let peersCountAfter = 0;
@@ -73,11 +73,11 @@ console.log(
 
 console.log("\nremoving peers");
 
-for (const peer of peers) {
+for (const peer of sockets) {
   tracker.disconnectPeersFromSocket(peer);
 }
 
-peers.length = 0;
+sockets.length = 0;
 
 if (global.gc) {
   global.gc();

test/performance/announce.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import { FastTracker } from "../../lib/fast-tracker.js";
-import { Tracker } from "../../lib/tracker.js";
+import { FastTracker } from "../../src/fast-tracker.js";
+import { Tracker } from "../../src/tracker.js";
 
 function sendMessage() {}
 const peersCount = 100000;

test/simulation.test.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import { FastTracker } from "../lib/fast-tracker.js";
-import { SocketContext } from "../lib/tracker.js";
+import { FastTracker } from "../src/fast-tracker.js";
+import { SocketContext } from "../src/tracker.js";
 import { describe, it, expect } from "vitest";
 
 describe("simulation", () => {
@@ -28,13 +28,13 @@ describe("simulation", () => {
 
     const tracker = new FastTracker();
 
-    const peers: SocketContext[] = [];
+    const sockets: SocketContext[] = [];
     const peersData: Array<{ infoHash?: string; peerId: string }> = [];
 
     for (let i = 0; i < peersCount; i++) {
-      peers.push({
+      sockets.push({
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        sendMessage: (_json: object, _peer: SocketContext) => {},
+        sendMessage: (_json: object, _socket: SocketContext) => {},
       });
       peersData.push({
         peerId: (i % Math.floor(peersCount * sameIdPeersRatio)).toString(),
@@ -57,8 +57,8 @@ describe("simulation", () => {
     }
 
     function doIteration() {
-      const peerIndex = Math.floor(Math.random() * peers.length);
-      const peer = peers[peerIndex];
+      const peerIndex = Math.floor(Math.random() * sockets.length);
+      const peer = sockets[peerIndex];
       const peerData = peersData[peerIndex];
 
       if (peerData.infoHash) {
@@ -82,7 +82,7 @@ describe("simulation", () => {
           // disconnect
           tracker.disconnectPeersFromSocket(peer);
           peerData.infoHash = undefined;
-          peers[peerIndex] = { sendMessage: peer.sendMessage };
+          sockets[peerIndex] = { sendMessage: peer.sendMessage };
           return;
         } else {
           // announce on the same torrent

tsconfig.json

@@ -5,7 +5,7 @@
     "lib": ["ES2020"],
     "moduleResolution": "NodeNext",
     "declaration": true,
-    "outDir": "./dist",
+    "outDir": "./lib",
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": false,
@@ -15,5 +15,5 @@
     "types": ["node"]
   },
   "compileOnSave": true,
-  "include": ["lib/**/*"]
+  "include": ["src/**/*"]
 }

tsconfig.lint.json

@@ -1,4 +1,4 @@
 {
   "extends": "./tsconfig.json",
-  "include": ["lib/**/*", "test/**/*", ".eslintrc.cjs", "vitest.config.ts"]
+  "include": ["src/**/*", "test/**/*", ".eslintrc.cjs", "vitest.config.ts"]
 }

tsconfig.test.json

@@ -4,5 +4,5 @@
     "outDir": "./test_dist",
     "types": ["node", "mocha"]
   },
-  "include": ["lib/tracker.ts", "lib/fast-tracker.ts", "test/**/*"]
+  "include": ["src/tracker.ts", "src/fast-tracker.ts", "test/**/*"]
 }

vitest.config.ts

@@ -4,7 +4,7 @@ export default defineConfig({
   test: {
     include: ["test/*.{test,spec}.{js,ts,jsx,tsx}"],
     coverage: {
-      include: ["lib/fast-tracker.ts", "lib/tracker.ts"],
+      include: ["src/fast-tracker.ts", "src/tracker.ts"],
     },
   },
 });