github/peerjs-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: more accurate types

Browse Source 
Closes #182
This commit is contained in:
Jonas Gloning 2023-01-08 01:59:19 +01:00
parent 2b73b5c97d
commit 68f973afb4
No known key found for this signature in database
GPG Key ID: 684639B5E59E7614
18 changed files with 101 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
bin/peerjs.ts
View File

@ -1,12 +1,12 @@
#!/usr/bin/env node
import path from "path";
import path from "node:path";
import {version} from "../package.json";
import fs from "fs";
import fs from "node:fs";
const optimistUsageLength = 98;
import yargs from "yargs";
import { PeerServer } from "../src";
import { AddressInfo } from "net";
import { AddressInfo } from "node:net";
const opts = yargs
.usage("Usage: $0")
.wrap(Math.min(optimistUsageLength, yargs.terminalWidth()))
@ -74,7 +74,7 @@ const opts = yargs
default: false,
},
})
.boolean("allow_discovery").argv;
.boolean("allow_discovery").parseSync();
process.on("uncaughtException", function (e) {
console.error("Error: " + e);

4
src/api/index.ts
View File

@ -1,9 +1,9 @@
import cors from "cors";
import express from "express";
import publicContent from "../../app.json";
import { IConfig } from "../config";
import { IRealm } from "../models/realm";
import PublicApi from "./v1/public";
import type {IConfig} from "../config";
import type {IRealm} from "../models/realm";
export const Api = ({ config, realm }: {
config: IConfig;

4
src/api/v1/public/index.ts
View File

@ -1,6 +1,6 @@
import express from "express";
import { IConfig } from "../../../config";
import { IRealm } from "../../../models/realm";
import type {IConfig} from "../../../config";
import type {IRealm} from "../../../models/realm";
export default ({ config, realm }: {
config: IConfig; realm: IRealm;

26
src/index.ts
View File

@ -1,16 +1,18 @@
import express from "express";
import http from "http";
import https from "https";
import { Server } from "net";
import http from "node:http";
import https from "node:https";
import {Server as HttpServer} from "node:http";
import {Server as HttpsServer} from "node:https";
import type {Express} from 'express-serve-static-core';
import defaultConfig, { IConfig } from "./config";
import { createInstance } from "./instance";
import type {IConfig} from "./config";
import defaultConfig from "./config";
import type {PeerServerEvents} from "./instance";
import {createInstance} from "./instance";
type Optional<T> = {
[P in keyof T]?: (T[P] | undefined);
};
export type {MessageType} from "./enums"
function ExpressPeerServer(server: Server, options?: IConfig) {
function ExpressPeerServer(server: HttpsServer | HttpServer, options?: Partial<IConfig>) {
const app = express();
const newOptions: IConfig = {
@ -31,10 +33,10 @@ function ExpressPeerServer(server: Server, options?: IConfig) {
createInstance({ app, server, options: newOptions });
});
return app;
return app as Express & PeerServerEvents
}
function PeerServer(options: Optional<IConfig> = {}, callback?: (server: Server) => void) {
function PeerServer(options: Partial<IConfig> = {}, callback?: (server: HttpsServer | HttpServer) => void) {
const app = express();
let newOptions: IConfig = {
@ -45,7 +47,7 @@ function PeerServer(options: Optional<IConfig> = {}, callback?: (server: Server)
const port = newOptions.port;
const host = newOptions.host;
let server: Server;
let server: HttpsServer | HttpServer;
const { ssl, ...restOptions } = newOptions;
if (ssl && Object.keys(ssl).length) {

38
src/instance.ts
View File

@ -1,20 +1,30 @@
import express from "express";
import { Server } from "net";
import path from "path";
import { IClient } from "./models/client";
import { IMessage } from "./models/message";
import { Realm } from "./models/realm";
import { IRealm } from "./models/realm";
import { CheckBrokenConnections } from "./services/checkBrokenConnections";
import { IMessagesExpire, MessagesExpire } from "./services/messagesExpire";
import { IWebSocketServer, WebSocketServer } from "./services/webSocketServer";
import { MessageHandler } from "./messageHandler";
import { Api } from "./api";
import { IConfig } from "./config";
import {Server as HttpServer} from "node:http";
import {Server as HttpsServer} from "node:https";
import path from "node:path";
import type {IRealm} from "./models/realm";
import {Realm} from "./models/realm";
import {CheckBrokenConnections} from "./services/checkBrokenConnections";
import type {IMessagesExpire} from "./services/messagesExpire";
import {MessagesExpire} from "./services/messagesExpire";
import type {IWebSocketServer} from "./services/webSocketServer";
import {WebSocketServer} from "./services/webSocketServer";
import {MessageHandler} from "./messageHandler";
import {Api} from "./api";
import type {IClient} from "./models/client";
import type {IMessage} from "./models/message";
import type {IConfig} from "./config";
export interface PeerServerEvents {
on(event: 'connection', listener: (client: IClient) => void): this;
on(event: "message", listener: (client: IClient, message: IMessage) => void): this;
on(event: "disconnect", listener: (client: IClient) => void): this;
on(event: "error", listener: (client: Error) => void): this;
}
export const createInstance = ({ app, server, options }: {
app: express.Application;
server: Server;
server: HttpServer | HttpsServer;
options: IConfig;
}): void => {
const config = options;
@ -72,4 +82,4 @@ export const createInstance = ({ app, server, options }: {
messagesExpire.startMessagesExpiration();
checkBrokenConnections.start();
};
};

4
src/messageHandler/handler.ts
View File

@ -1,4 +1,4 @@
import { IClient } from "../models/client";
import { IMessage } from "../models/message";
import type {IClient} from "../models/client";
import type {IMessage} from "../models/message";
export type Handler = (client: IClient | undefined, message: IMessage) => boolean;

2
src/messageHandler/handlers/heartbeat/index.ts
View File

@ -1,4 +1,4 @@
import { IClient } from "../../../models/client";
import type {IClient} from "../../../models/client";
export const HeartbeatHandler = (client: IClient | undefined): boolean => {
if (client) {

8
src/messageHandler/handlers/transmission/index.ts
View File

@ -1,7 +1,7 @@
import { MessageType } from "../../../enums";
import { IClient } from "../../../models/client";
import { IMessage } from "../../../models/message";
import { IRealm } from "../../../models/realm";
import {MessageType} from "../../../enums";
import type {IClient} from "../../../models/client";
import type {IMessage} from "../../../models/message";
import type {IRealm} from "../../../models/realm";
export const TransmissionHandler = ({ realm }: { realm: IRealm; }): (client: IClient | undefined, message: IMessage) => boolean => {
const handle = (client: IClient | undefined, message: IMessage) => {

8
src/messageHandler/handlersRegistry.ts
View File

@ -1,7 +1,7 @@
import { MessageType } from "../enums";
import { IClient } from "../models/client";
import { IMessage } from "../models/message";
import { Handler } from "./handler";
import {MessageType} from "../enums";
import type {IClient} from "../models/client";
import type {IMessage} from "../models/message";
import type {Handler} from "./handler";
export interface IHandlersRegistry {
registerHandler(messageType: MessageType, handler: Handler): void;

15
src/messageHandler/index.ts
View File

@ -1,10 +1,11 @@
import { MessageType } from "../enums";
import { IClient } from "../models/client";
import { IMessage } from "../models/message";
import { IRealm } from "../models/realm";
import { Handler } from "./handler";
import { HeartbeatHandler, TransmissionHandler } from "./handlers";
import { IHandlersRegistry, HandlersRegistry } from "./handlersRegistry";
import {MessageType} from "../enums";
import {HeartbeatHandler, TransmissionHandler} from "./handlers";
import type {IHandlersRegistry} from "./handlersRegistry";
import {HandlersRegistry} from "./handlersRegistry";
import type {IClient} from "../models/client";
import type {IMessage} from "../models/message";
import type {IRealm} from "../models/realm";
import type {Handler} from "./handler";
export interface IMessageHandler {
handle(client: IClient | undefined, message: IMessage): boolean;

4
src/models/message.ts
View File

@ -1,8 +1,8 @@
import { MessageType } from "../enums";
import type {MessageType} from "../enums";
export interface IMessage {
readonly type: MessageType;
readonly src: string;
readonly dst: string;
readonly payload?: any;
readonly payload?: string;
}

2
src/models/messageQueue.ts
View File

@ -1,4 +1,4 @@
import { IMessage } from "./message";
import type {IMessage} from "./message";
export interface IMessageQueue {
getLastReadAt(): number;

9
src/models/realm.ts
View File

@ -1,7 +1,8 @@
import { IClient } from "./client";
import { IMessage } from "./message";
import { IMessageQueue, MessageQueue } from "./messageQueue";
import {randomUUID} from "crypto";
import type {IMessageQueue} from "./messageQueue";
import {MessageQueue} from "./messageQueue";
import {randomUUID} from "node:crypto";
import type {IClient} from "./client";
import type {IMessage} from "./message";
export interface IRealm {
getClientsIds(): string[];

6
src/services/checkBrokenConnections/index.ts
View File

@ -1,6 +1,6 @@
import { IConfig } from "../../config";
import { IClient } from "../../models/client";
import { IRealm } from "../../models/realm";
import type {IConfig} from "../../config";
import type {IClient} from "../../models/client";
import type {IRealm} from "../../models/realm";
const DEFAULT_CHECK_INTERVAL = 300;

8
src/services/messagesExpire/index.ts
View File

@ -1,7 +1,7 @@
import { IConfig } from "../../config";
import { MessageType } from "../../enums";
import { IMessageHandler } from "../../messageHandler";
import { IRealm } from "../../models/realm";
import {MessageType} from "../../enums";
import type {IConfig} from "../../config";
import type {IMessageHandler} from "../../messageHandler";
import type {IRealm} from "../../models/realm";
export interface IMessagesExpire {
startMessagesExpiration(): void;

21
src/services/webSocketServer/index.ts
View File

@ -1,12 +1,15 @@
import EventEmitter from "events";
import { IncomingMessage } from "http";
import url from "url";
import WebSocketLib from "ws";
import { IConfig } from "../../config";
import { Errors, MessageType } from "../../enums";
import { Client, IClient } from "../../models/client";
import { IRealm } from "../../models/realm";
import {EventEmitter} from "node:events";
import {IncomingMessage} from "node:http";
import url from "node:url";
import type WebSocket from "ws";
import * as WebSocketLib from "ws";
import {Errors, MessageType} from "../../enums";
import type {IClient} from "../../models/client";
import {Client} from "../../models/client";
import type {IConfig} from "../../config";
import type {IRealm} from "../../models/realm";
import {Server as HttpServer} from "node:http";
import {Server as HttpsServer} from "node:https";
export interface IWebSocketServer extends EventEmitter {
readonly path: string;
@ -29,7 +32,7 @@ export class WebSocketServer extends EventEmitter implements IWebSocketServer {
private readonly config: CustomConfig;
public readonly socketServer: WebSocketLib.Server;
constructor({ server, realm, config }: { server: any; realm: IRealm; config: CustomConfig; }) {
constructor({ server, realm, config }: { server: HttpServer | HttpsServer; realm: IRealm; config: CustomConfig; }) {
super();
this.setMaxListeners(0);

15
test/services/webSocketServer/index.ts
View File

@ -1,5 +1,6 @@
import { expect } from 'chai';
import { Server, WebSocket } from 'mock-socket';
import type {Server as HttpServer} from 'node:http';
import { Realm } from '../../../src/models/realm';
import { WebSocketServer } from '../../../src/services/webSocketServer';
import { Errors, MessageType } from '../../../src/enums';
@ -52,10 +53,10 @@ const checkSequence = async (c: WebSocket, msgs: { type: MessageType; error?: Er
};
const createTestServer = ({ realm, config, url }: { realm: Realm; config: { path: string; key: string; concurrent_limit: number; }; url: string; }): Destroyable<WebSocketServer> => {
const server = new Server(url);
const server = new Server(url) as Server & HttpServer;
const webSocketServer: Destroyable<WebSocketServer> = new WebSocketServer({ server, realm, config });
server.on('connection', (socket) => {
server.on('connection', (socket: WebSocket & { on?: (eventName: string, callback: () => void) => void; }) => {
const s = webSocketServer.socketServer;
s.emit('connection', socket, { url: socket.url });
@ -101,8 +102,8 @@ describe('WebSocketServer', () => {
const realm = new Realm();
const config = { path: '/', key: 'testKey', concurrent_limit: 1 };
const config2 = { ...config, path: 'path' };
const server = new Server('path1');
const server2 = new Server('path2');
const server = new Server('path1') as Server & HttpServer;
const server2 = new Server('path2') as Server & HttpServer;
const webSocketServer = new WebSocketServer({ server, realm, config });
@ -155,11 +156,11 @@ describe('WebSocketServer', () => {
ws.destroy = async (): Promise<void> => {
ws.close();
wait(10);
wait(10);
webSocketServer.destroy?.();
webSocketServer.destroy?.();
wait(10);
wait(10);
ws.destroy = undefined;
};

2
tsconfig.json
View File

@ -14,7 +14,7 @@
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"skipLibCheck": true,
"skipLibCheck": false,
"sourceMap": true,
"outDir": "dist"
},