@mingzey/typedrpc 1.0.2 → 1.1.0

package/src/test/context.ts

@@ -1,64 +0,0 @@
-import { TypedRPCClient } from "../index.js";
-import { TypedRPCContextSymbol, type TypedRPCContext, type TypedRPCContextAware } from "../index.js";
-import { TypedRPCAPIDefine } from "../index.js";
-import { TypedRPCServer } from "../index.js";
-import { TestCase } from "./TestCase.js";
-
-interface MathServiceInterface{
-    add(a:number,b:number):number,
-}
-
-const serverAPIDefine = new TypedRPCAPIDefine<{
-    math:MathServiceInterface,
-}>();
-
-const server = new TypedRPCServer({
-    local:serverAPIDefine,
-});
-
-class MathService implements MathServiceInterface, TypedRPCContextAware{
-
-    /** 通过 TypedRPCContextAware 接口，将上下文注入到服务中，允许在方法内访问RPC调用时的上下文 */
-    [TypedRPCContextSymbol]: TypedRPCContext | null = null;
-
-    /** 使用hookService时，必须声明为TypedRPC方法，否则不予注册为hook，避免外部非法调用方法*/
-    @TypedRPCAPIDefine.method()
-    add(a: number, b: number): number {
-        const context = this[TypedRPCContextSymbol]!;
-        if(!context){
-            throw new Error('context is null');
-        }
-        return a+b;
-    }
-}
-
-server.hookService('math',new MathService());
-
-const client = new TypedRPCClient({
-    remote:serverAPIDefine,
-});
-
-
-
-
-export default class TestBasic extends TestCase{
-    name(): string {
-        return 'Context';
-    }
-    async run(): Promise<boolean> {
-        await server.listen({
-            port:3698,
-        })
-        const connection = await client.connect("localhost:3698");
-        const api = client.getAPI(connection);
-        const result = await api.math.add.call(1,2);
-        if(result == 3){
-            return true;
-        }
-        return false;
-    }
-
-    public async finally(): Promise<void> {
-        await server.close();
-    }
-}

package/src/test/expressmix.ts

@@ -1,81 +0,0 @@
-import { TypedRPCAPIDefine, TypedRPCClient, TypedRPCConnectionProviderHTTP, TypedRPCServer } from "../index.js";
-import http from 'http';
-import express from 'express';
-import { TestCase } from "./TestCase.js";
-
-const ServerAPIDefine = new TypedRPCAPIDefine<{
-    math:{
-        add:(a:number,b:number)=>number,
-    },
-}>();
-
-const httpServer = http.createServer();
-/** 
- * TypedRPCConnectionProviderHTTP 是 TypedRPCConnectionProvider 的默认实现
- * 你也可以自定义实现 TypedRPCConnectionProvider 与 TypedRPCConnection 来支持其他协议
- * 例如基于IPC协议的连接、基于Websocket协议的连接、基于udp协议的连接
- * */
-
-
-const provider = new TypedRPCConnectionProviderHTTP({
-    server:httpServer,
-})
-
-const server = new TypedRPCServer({
-    local:ServerAPIDefine,
-    connection:{
-        provider:provider,
-    }
-})
-server.hook('math','add',{
-    handler:(a,b)=>a+b,
-})
-
-
-const app = express();
-app.use("/test",(req,res) => {
-    res.end("hello world");
-})
-/**
- * 通过provider注入express中间件
- * provider会将无法识别的请求转发到express中间件
- */
-provider.use(app)
-
-
-
-const client = new TypedRPCClient({
-    remote:ServerAPIDefine,
-})
-
-export default class TextExpressMix extends TestCase{
-    name(): string {
-        return "ExpressMix";
-    }
-    async run(): Promise<boolean> {
-        await server.listen({
-            port:3698
-        });
-        await new Promise(resolve => setTimeout(resolve,100));
-
-        // RPC测试
-        const connection = await client.connect("localhost:3698");
-        const result = await client.getAPI(connection).math.add.call(1,2);
-        if(result !== 3){
-            throw new Error("RPC request result should be 3");
-        }
-
-        // express测试
-        const response = await fetch("http://localhost:3698/test");
-        const text = await response.text();
-        if(text !== "hello world"){
-            throw new Error("Express request result should be 'hello world'");
-        }
-        return true;
-    }
-
-    public async finally(): Promise<void> {
-        await server.close();
-    }
-    
-}

package/src/test/socket.ts

@@ -1,90 +0,0 @@
-import { TestCase } from "./TestCase.js";
-import { TypedRPCAPIDefine, TypedRPCClient, TypedRPCConnectionProviderSocket, TypedRPCServer } from "../index.js";
-
-const ServerAPIDefine = new TypedRPCAPIDefine<{
-    math: {
-        add: (a: number, b: number) => number,
-    }
-}>
-
-const ClientAPIDefine = new TypedRPCAPIDefine<{
-    status: {
-        time: () => number,
-    }
-}>
-
-const server = new TypedRPCServer({
-    local: ServerAPIDefine,
-    remote: ClientAPIDefine,
-    connection: {
-        provider: new TypedRPCConnectionProviderSocket(),
-    }
-})
-
-server.hook('math', 'add', {
-    handler: (a, b) => {
-        return a + b;
-    }
-})
-
-const client = new TypedRPCClient({
-    local: ClientAPIDefine,
-    remote: ServerAPIDefine,
-    connection: {
-        provider: new TypedRPCConnectionProviderSocket(),
-    }
-})
-
-client.hook('status', 'time', {
-    handler: () => {
-        return Date.now();
-    }
-})
-
-
-class TestSocket extends TestCase {
-    name(): string {
-        return 'Socket';
-    }
-    async run(): Promise<boolean> {
-        let requestToServer: Promise<boolean>;
-        let requestToClient: Promise<boolean>;
-
-        requestToClient = new Promise<boolean>((resolve) => {
-            server.emitter.on('connection', async (connectionToClient) => {
-                const apiToClient = server.getAPI(connectionToClient);
-                const result = await apiToClient.status.time.call();
-                if (result != null) {
-                    resolve(true);
-                } else {
-                    resolve(false);
-                }
-            })
-        })
-
-        await server.listen({
-            port: 3698,
-        })
-
-        requestToServer = new Promise<boolean>(async (resolve) => {
-            const connectionToServer = await client.connect("localhost:3698");
-            const apiToServer = client.getAPI(connectionToServer);
-            const result = await apiToServer.math.add.call(1, 2);
-            if (result == 3) {
-                resolve(true);
-            } else {
-                resolve(false);
-            }
-        })
-
-        const resultToClient = await requestToClient;
-        const resultToServer = await requestToServer;
-        return resultToClient && resultToServer;
-    }
-    public async finally(): Promise<void> {
-        await server.close();
-    }
-
-}
-
-export default TestSocket;

package/src/test/socketio.ts

@@ -1,96 +0,0 @@
-/**
- * 测试全双工通信实现双向调用
- * TypedRPC的默认实现是基于http的，全双工必须实现自定义的Provider
- * 这里使用socket.io作为Provider的底层通讯
- */
-import { TestCase } from "./TestCase.js";
-import { TypedRPCAPIDefine, TypedRPCConnectionProviderSocketIO } from "../index.js";
-import { TypedRPCServer } from "../index.js";
-import { TypedRPCClient } from "../index.js";
-
-
-
-const ServerAPIDefine = new TypedRPCAPIDefine<{
-    math:{
-        add:(a:number,b:number) => number,
-    }
-}>
-
-const ClientAPIDefine = new TypedRPCAPIDefine<{
-    status:{
-        time:() => number,
-    }
-}>
-
-const server = new TypedRPCServer({
-    local:ServerAPIDefine,
-    remote:ClientAPIDefine,
-    connection:{
-        provider:new TypedRPCConnectionProviderSocketIO(),
-    }
-})
-
-server.hook('math','add',{
-    handler:(a,b) => {
-        return a + b;
-    }
-})
-
-const client = new TypedRPCClient({
-    local:ClientAPIDefine,
-    remote:ServerAPIDefine,
-    connection:{
-        provider:new TypedRPCConnectionProviderSocketIO(),
-    }
-})
-
-client.hook('status','time',{
-    handler:() => {
-        return Date.now();
-    }
-})
-
-export default class TestSocketIO extends TestCase{
-    name(): string {
-        return "SocketIO";
-    }
-    async run(): Promise<boolean> {
-        let requestToServer:Promise<boolean>;
-        let requestToClient:Promise<boolean>;
-
-        requestToClient = new Promise<boolean>((resolve) => {
-            server.emitter.on('connection',async (connectionToClient) => {
-                const apiToClient = server.getAPI(connectionToClient);
-                const result = await apiToClient.status.time.call();
-                if(result != null){
-                    resolve(true);
-                }else{
-                    resolve(false);
-                }
-            })
-        })
-
-        await server.listen({
-            port:3698,
-        })
-
-        requestToServer = new Promise<boolean>(async (resolve) => {
-            const connectionToServer = await client.connect("localhost:3698");
-            const apiToServer = client.getAPI(connectionToServer);
-            const result = await apiToServer.math.add.call(1,2);
-            if(result == 3){
-                resolve(true);
-            }else{
-                resolve(false);
-            }
-        })
-        
-        const resultToClient = await requestToClient;
-        const resultToServer = await requestToServer;
-        return resultToClient && resultToServer;
-    }
-    public async finally(): Promise<void> {
-        await server.close();
-    }
-}
-

package/src/test.ts

@@ -1,35 +0,0 @@
-import type { TestCase } from './test/TestCase.js';
-
-const testList = [
-    import('./test/basic.js'),
-    import('./test/context.js'),
-    import('./test/socketio.js'),
-    import('./test/authorization.js'),
-    import('./test/expressmix.js'),
-    import('./test/socket.js'),
-]
-
-async function main() {
-    for(let i of testList){
-        let exp = await i;
-        let test = new (exp.default)() as TestCase;
-        let result = await test.run().catch((e) => {
-            console.log(`Test:${test.name()} failed. ${e}`);
-            throw e;
-        })
-        await test.finally();
-        if(result){
-            console.log(`\x1b[32m[PASS]\x1b[0m ${test.name()}`);
-        }else{
-            console.log(`\x1b[31m[FAIL]\x1b[0m ${test.name()}`);
-        }
-
-    }
-}
-
-main().then(() => {
-    console.log('TypedRPC test finished.');
-}).catch((e) => {
-    console.log(`TypedRPC test failed. ${e}`);
-    throw e;
-})

package/src/utils.ts

@@ -1,95 +0,0 @@
-import type { TypedRPCAPIDefine } from "./define.js";
-import type { TypedRPCRequestPacket, TypedRPCResponsePacket } from "./packet.js";
-
-export type FunctionTypeToPromiseFunctionType<T extends (...args: any[]) => any> = 
-    T extends (...args: infer P) => Promise<infer R> ? 
-        (...args: P) => Promise<R | undefined>
-    : T extends (...args: infer P) => infer R ? 
-        (...args: P) => Promise<R | undefined>
-    : never
-;
-
-export type TypedRPCDefineToTypedRPCAPI<T extends TypedRPCAPIDefine<any>> = T extends TypedRPCAPIDefine<infer U> ? 
-    {
-        [S in keyof U]:{
-            [M in keyof U[S]]:{
-                /** 调用该方法 */
-                call:FunctionTypeToPromiseFunctionType<U[S][M]>,
-                /** 获取方法id */
-                request:(config:{
-                    args:Parameters<U[S][M]>,
-                    callback?:(result:ReturnType<U[S][M]>,req:TypedRPCRequestPacket,res:TypedRPCResponsePacket) => void,
-                    error?:(error:any,req:TypedRPCRequestPacket,res:TypedRPCResponsePacket) => void,
-                }) => string,
-                id:string,
-                /** 获取方法路径 */
-                path:string,
-            }
-        }
-    }
-: never;
-
-export type TypedRPCDefineServiceName<T extends TypedRPCAPIDefine<any>> = T extends TypedRPCAPIDefine<infer U> ? keyof U & string : never;
-export type TypedRPCDefineMethodName<T extends TypedRPCAPIDefine<any>,S extends TypedRPCDefineServiceName<T>> = T extends TypedRPCAPIDefine<infer U> ? keyof U[S] & string: never;
-export type TypedRPCDefineMethodBody<T extends TypedRPCAPIDefine<any>,S extends TypedRPCDefineServiceName<T>,M extends TypedRPCDefineMethodName<T,S>> = T extends TypedRPCAPIDefine<infer U> ? U[S][M] : never;
-export type TypedRPCDefineServiceInstance<T extends TypedRPCAPIDefine<any>,S extends TypedRPCDefineServiceName<T>> = T extends TypedRPCAPIDefine<infer U> ? U[S] : never;
-
-
-export type TypedEmitterEvents = {
-    [key:string]:(...args:any[]) => void
-}
-
-export class TypedEmitter<T extends TypedEmitterEvents> {
-
-    private record:Map<keyof T,Set<T[keyof T]>> = new Map();
-
-    on<K extends keyof T>(event:K,callback:T[K]){
-        if(!this.record.has(event)){
-            this.record.set(event,new Set());
-        }
-        this.record.get(event)!.add(callback);
-        return () => {
-            this.off(event,callback);
-        }
-    }
-
-    off<K extends keyof T>(event:K,callback:T[K]){
-        if(!this.record.has(event)){
-            return;
-        }
-        this.record.get(event)!.delete(callback);
-    }
-
-    emit<K extends keyof T>(event:K,...args:Parameters<T[K]>){
-        if(!this.record.has(event)){
-            return;
-        }
-        for(const callback of this.record.get(event)!){
-            callback(...args);
-        }
-    }
-
-    once<K extends keyof T>(event:K,callback:T[K]){
-        const wrapper = (...args:Parameters<T[K]>) => {
-            callback(...args);
-            this.off(event,wrapper as T[K]);
-        }
-        this.on(event,wrapper as T[K]);
-    }
-}
-
-export class IdMaker{
-
-    public static instance = new IdMaker();
-
-    static makeId():string{
-        return IdMaker.instance.makeId();
-    }
-
-    public makeId():string{
-        // 生成12位随机字符串
-        const suffix = Math.random().toString(36).substring(2,10);
-        const timestamp = Date.now().toString(36);
-        return `${timestamp}${suffix}`;
-    }
-}