oox 0.3.5 → 0.3.7

package/modules/socketio/server.js

@@ -1,200 +0,0 @@
-import * as http from 'node:http';
-import * as https from 'node:https';
-import { Server } from 'socket.io';
-import * as oox from '../../index.js';
-import { Module } from '../../index.js';
-import SocketIOAdapter from './adapter.js';
-import { OOXEvent } from './utils.js';
-export class SocketIOConfig {
-    enabled = true;
-    // listen port
-    port = 0;
-    // service path
-    path = '/socket.io';
-    // browser cross origin
-    origin = '';
-    // https options
-    ssl = {
-        // enable https
-        enabled: false,
-        // ssl certificate path
-        cert: '',
-        // ssl private key path
-        key: '',
-        // ssl ca path
-        ca: ''
-    };
-}
-export default class SocketIOServer extends Module {
-    name = 'socketio';
-    config = new SocketIOConfig;
-    /**
-     * means this.server created by myself<SocketIOServer>
-     */
-    #isSelfServer = false;
-    server = null;
-    socketServer = null;
-    adapter = new SocketIOAdapter();
-    constructor() {
-        super();
-        oox.keepAliveConnectionAdapters.set(this.name, this.adapter);
-    }
-    getURL() {
-        const { host } = oox.config;
-        const { port, path } = this.config;
-        const protocol = this.config.ssl.enabled ? 'wss:' : 'ws:';
-        return new URL(`${protocol}//${host}:${port}${path}`);
-    }
-    setConfig(config) {
-        Object.assign(this.config, config);
-        if (!config.hasOwnProperty('port')) {
-            this.config.port = oox.config.port;
-        }
-        if (!config.hasOwnProperty('origin')) {
-            this.config.origin = oox.config.origin;
-        }
-    }
-    getConfig() {
-        return this.config;
-    }
-    async serve() {
-        await this.stop();
-        const { port, ssl } = this.config;
-        const isSelfServer = this.#isSelfServer = this.server ? true : false;
-        let server = null;
-        if (isSelfServer) {
-            if (!this.server)
-                throw new Error('HTTP Server is not created');
-            server = this.server;
-        }
-        else {
-            if (ssl.enabled) {
-                const fs = await import('node:fs');
-                const options = {
-                    key: ssl.key ? fs.readFileSync(ssl.key) : undefined,
-                    cert: ssl.cert ? fs.readFileSync(ssl.cert) : undefined,
-                    ca: ssl.ca ? fs.readFileSync(ssl.ca) : undefined
-                };
-                if (!options.key || !options.cert) {
-                    throw new Error('HTTPS enabled but missing key or cert');
-                }
-                server = https.createServer(options, (_request, response) => response.end('No HTTP Gateway'));
-            }
-            else {
-                server = http.createServer((_request, response) => response.end('No HTTP Gateway'));
-            }
-        }
-        this.server = server;
-        if (!server.listening)
-            server.listen(port);
-        const address = server.address();
-        if (!address || 'object' !== typeof address)
-            throw new Error('Cannot read socket.io server port');
-        this.config.port = address.port;
-        this.createSocketIOServer();
-    }
-    async stop() {
-        const { server, socketServer } = this;
-        if (socketServer)
-            await new Promise((resolve, reject) => socketServer.close(error => error ? reject(error) : resolve()));
-        if (this.#isSelfServer)
-            await new Promise((resolve, reject) => server?.close(error => error ? reject(error) : resolve()));
-    }
-    genSocketIOServerOptions() {
-        const options = {
-            /**
-             * name of the path to capture
-             * @default "/socket.io"
-             */
-            path: this.config.path,
-            /**
-             * how many ms before a client without namespace is closed
-             * @default 45000
-             */
-            connectTimeout: 5000,
-            /**
-             * how many ms without a pong packet to consider the connection closed
-             * @default 5000
-             */
-            pingTimeout: 2000,
-            /**
-             * how many ms before sending a new ping packet
-             * @default 25000
-             */
-            pingInterval: 10000,
-            /**
-             * how many bytes or characters a message can be, before closing the session (to avoid DoS).
-             * @default 1e5 (100 KB)
-             */
-            maxHttpBufferSize: 1e5
-        };
-        const { origin } = this.config;
-        if (origin)
-            options.cors = { origin };
-        return options;
-    }
-    createSocketIOServer() {
-        const { server } = this;
-        if (!server)
-            throw new Error('HTTP Server is not created');
-        const socketServer = this.socketServer = new Server(server, this.genSocketIOServerOptions());
-        socketServer.on('connection', async (socket) => {
-            try {
-                this.serverOnSocketConnection(socket);
-            }
-            catch (error) {
-                console.error(error);
-                socket.send(error.message).disconnect(true);
-            }
-        });
-    }
-    /**
-     * 服务端Socket连接事件
-     */
-    serverOnSocketConnection(socket) {
-        const headers = socket.handshake.headers;
-        const callerId = String(headers['x-caller-id'] || '') || socket.id;
-        // client ip or caller service ip
-        const ip = String(headers['x-real-ip'] || socket.handshake.address);
-        // service name
-        const caller = String(headers['x-caller'] || 'anonymous');
-        const token = String(headers['x-token'] || '');
-        // check token
-        const { allow, reason } = oox.checkAllow(ip, caller, token);
-        if (!allow) {
-            socket.send(reason).disconnect(true);
-            return;
-        }
-        const connection = new oox.KeepAliveConnection(this.adapter, socket, {
-            ip,
-            name: caller,
-            id: callerId,
-            token,
-        });
-        oox.addKeepAliveConnection(connection);
-        this.bindServerConnectionEvents(connection);
-        this.adapter.bindCall(connection);
-        socket.emit(OOXEvent.READY, {
-            id: oox.config.id,
-            name: oox.config.name
-        });
-        connection.enabled = true;
-    }
-    /**
-     * 绑定服务器连接事件
-     * @param connection
-     */
-    bindServerConnectionEvents(connection) {
-        const socket = connection.nativeConnection;
-        socket.on(OOXEvent.REGISTRY_SYNC_CONNECTIONS, async (fn) => {
-            if ('function' !== typeof fn)
-                return;
-            oox.registry.onSyncConnections(connection, {}, fn);
-        });
-        socket.on('disconnecting', (reason) => {
-            oox.removeKeepAliveConnection(connection);
-            socket.removeAllListeners();
-            connection.emit('disconnect');
-        });
-    }
-}

package/modules/socketio/socket.js

@@ -1 +0,0 @@
-export {};

package/modules/socketio/utils.js

@@ -1,41 +0,0 @@
-export var OOXEvent;
-(function (OOXEvent) {
-    OOXEvent["READY"] = "oox:ready";
-    OOXEvent["ENABLED"] = "oox:enabled";
-    OOXEvent["DISABLED"] = "oox:disabled";
-    OOXEvent["REGISTRY_SYNC_CONNECTIONS"] = "oox:registry:sync_connections";
-    OOXEvent["REGISTRY_SUBSCRIBE"] = "oox:registry:subscribe";
-    OOXEvent["REGISTRY_NOTIFY"] = "oox:registry:notify";
-})(OOXEvent || (OOXEvent = {}));
-export function isWebSocketURL(url) {
-    if ('string' === typeof url) {
-        return /^wss?:\/\/.+$/.test(url);
-    }
-    else {
-        return url.protocol === 'ws:' || url.protocol === 'wss:';
-    }
-}
-export function genWebSocketURL(url) {
-    // :6000
-    if (url.startsWith(':'))
-        url = 'ws://localhost' + url;
-    // 127.0.0.1:6000
-    if (!/^\w+?:\/.+$/.test(url))
-        url = 'ws://' + url;
-    const urlObject = new URL(url);
-    // :8000 => :8000/socket.io
-    const notSetPath = !urlObject.pathname || (urlObject.pathname === '/'
-        && !url.endsWith('/')
-        && !urlObject.search
-        && !urlObject.hash);
-    if (notSetPath) {
-        urlObject.pathname = '/socket.io';
-    }
-    if (urlObject.protocol !== 'wss:') {
-        if (urlObject.port === '443')
-            urlObject.protocol = 'wss:';
-        else
-            urlObject.protocol = 'ws:';
-    }
-    return urlObject;
-}

package/types/modules/socketio/adapter.d.ts

@@ -1,14 +0,0 @@
-import * as oox from '../../index.js';
-import { Socket } from './socket.js';
-import { OOXEvent } from './utils.js';
-import { SampleKeepAliveConnectionAdapter } from '../../samples/index.js';
-export default class SocketIOAdapter extends SampleKeepAliveConnectionAdapter<Socket> {
-    name: string;
-    OOXEvent: typeof OOXEvent;
-    nativeEvent: {
-        CONNECT: string;
-        DISCONNECT: string;
-        ERROR: string;
-    };
-    newConnection(identify: string | URL | oox.KeepAliveConnectionData): oox.KeepAliveConnection<Socket>;
-}

package/types/modules/socketio/index.d.ts

@@ -1,4 +0,0 @@
-import SocketINServer from './server.js';
-export default class SocketIOModule extends SocketINServer {
-    serve(): Promise<void>;
-}

package/types/modules/socketio/server.d.ts

@@ -1,44 +0,0 @@
-import * as http from 'node:http';
-import * as https from 'node:https';
-import { Server, ServerOptions } from 'socket.io';
-import * as oox from '../../index.js';
-import { Module, ModuleConfig } from '../../index.js';
-import { Socket } from './socket.js';
-import SocketIOAdapter from './adapter.js';
-export declare class SocketIOConfig implements ModuleConfig {
-    enabled: boolean;
-    port: number;
-    path: string;
-    origin: string | string[];
-    ssl: {
-        enabled: boolean;
-        cert: string;
-        key: string;
-        ca: string;
-    };
-}
-export default class SocketIOServer extends Module {
-    #private;
-    name: string;
-    config: SocketIOConfig;
-    server: http.Server | https.Server | null;
-    socketServer: Server | null;
-    adapter: SocketIOAdapter;
-    constructor();
-    getURL(): URL;
-    setConfig(config: SocketIOConfig): void;
-    getConfig(): SocketIOConfig;
-    serve(): Promise<void>;
-    stop(): Promise<void>;
-    genSocketIOServerOptions(): Partial<ServerOptions>;
-    createSocketIOServer(): void;
-    /**
-     * 服务端Socket连接事件
-     */
-    serverOnSocketConnection(socket: Socket<'server'>): void;
-    /**
-     * 绑定服务器连接事件
-     * @param connection
-     */
-    bindServerConnectionEvents(connection: oox.KeepAliveConnection<Socket<'server'>>): void;
-}

package/types/modules/socketio/socket.d.ts

@@ -1,8 +0,0 @@
-import { Socket as ServerSocket } from 'socket.io';
-import { Socket as ClientSocket } from 'socket.io-client';
-export type SocketMap = {
-    [key: string]: ServerSocket | ClientSocket;
-    server: ServerSocket;
-    client: ClientSocket;
-};
-export type Socket<T extends keyof SocketMap = keyof SocketMap> = SocketMap[T];

package/types/modules/socketio/utils.d.ts

@@ -1,10 +0,0 @@
-export declare enum OOXEvent {
-    READY = "oox:ready",
-    ENABLED = "oox:enabled",
-    DISABLED = "oox:disabled",
-    REGISTRY_SYNC_CONNECTIONS = "oox:registry:sync_connections",
-    REGISTRY_SUBSCRIBE = "oox:registry:subscribe",
-    REGISTRY_NOTIFY = "oox:registry:notify"
-}
-export declare function isWebSocketURL(url: string | URL): boolean;
-export declare function genWebSocketURL(url: string): URL;