Async remote function callbacks

rbxts-flamework · Oct 9, 2021 · 862f82e · 862f82e
1 parent b1bec96
commit 862f82e
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 20 deletions.
diff --git a/src/events/createClientHandler.ts b/src/events/createClientHandler.ts
@@ -26,9 +26,7 @@ export function createClientHandler<S, C>(
 		const middlewareProcessor = createMiddlewareProcessor(
 			middlewareFactoryList?.[name as never],
 			networkInfo,
-			(_, ...args) => {
-				bindables.get(name)?.Fire(...args);
-			},
+			(_, ...args) => bindables.get(name)?.Fire(...args),
 		);
 
 		processors.set(name, middlewareProcessor);

diff --git a/src/events/createServerHandler.ts b/src/events/createServerHandler.ts
@@ -25,9 +25,7 @@ export function createServerHandler<S, C>(
 		const middlewareProcessor = createMiddlewareProcessor(
 			middlewareFactoryList?.[name as never],
 			networkInfo,
-			(player, ...args) => {
-				bindables.get(name)?.Fire(player, ...args);
-			},
+			(player, ...args) => bindables.get(name)?.Fire(player, ...args),
 		);
 
 		remote.OnServerEvent.Connect((player, ...args) => {

diff --git a/src/functions/createClientHandler.ts b/src/functions/createClientHandler.ts
@@ -2,7 +2,7 @@ export {};
 import { t } from "@rbxts/t";
 import { getFunctionError, NetworkingFunctionError } from "./errors";
 import { createMiddlewareProcessor } from "../middleware/createMiddlewareProcessor";
-import { FunctionMiddlewareList, Middleware, MiddlewareFactory } from "../middleware/types";
+import { FunctionMiddlewareList, Middleware, MiddlewareFactory, MiddlewareProcessor } from "../middleware/types";
 import { NetworkInfo } from "../types";
 import { ArbitaryGuards, ClientHandler, ClientReceiver, ClientSender, RequestInfo } from "./types";
 import { Skip } from "middleware/skip";
@@ -18,7 +18,7 @@ export function createClientHandler<S, C>(
 	middlewareFactoryList?: FunctionMiddlewareList<C>,
 ): ClientHandler<S, C> {
 	const handler = {} as ClientHandler<S, C>;
-	const processors = new Map<string, Middleware<unknown[], unknown>>();
+	const processors = new Map<string, MiddlewareProcessor<unknown[], unknown>>();
 	const requestInfo: RequestInfo = {
 		nextId: 0,
 		requests: new Map(),
@@ -75,7 +75,13 @@ export function createClientHandler<S, C>(
 			const processor = processors.get(name);
 			if (processor) {
 				const result = processor(undefined, ...args);
-				remote.FireServer(id, result === Skip ? NetworkingFunctionError.Cancelled : true, result);
+				result
+					.then((value) => remote.FireServer(id, getProcessResult(value), value))
+					.catch((reason) => {
+						warn(`Failed to process request to ${name}`);
+						warn(reason);
+						remote.FireServer(id, false);
+					});
 			} else {
 				remote.FireServer(id, false);
 			}
@@ -149,3 +155,7 @@ function createClientMethod(
 function timeout(timeout: number, rejectValue: unknown) {
 	return Promise.delay(timeout).then(() => Promise.reject(rejectValue));
 }
+
+function getProcessResult(value: unknown) {
+	return value === Skip ? NetworkingFunctionError.Cancelled : true;
+}
diff --git a/src/functions/createServerHandler.ts b/src/functions/createServerHandler.ts
@@ -2,7 +2,7 @@ import { Players } from "@rbxts/services";
 import { t } from "@rbxts/t";
 import { getFunctionError, NetworkingFunctionError } from "./errors";
 import { createMiddlewareProcessor } from "../middleware/createMiddlewareProcessor";
-import { FunctionMiddlewareList, Middleware, MiddlewareFactory } from "../middleware/types";
+import { FunctionMiddlewareList, Middleware, MiddlewareFactory, MiddlewareProcessor } from "../middleware/types";
 import { NetworkInfo } from "../types";
 import { ArbitaryGuards, RequestInfo, ServerHandler, ServerReceiver, ServerSender } from "./types";
 import { Skip } from "middleware/skip";
@@ -17,7 +17,7 @@ export function createServerHandler<S, C>(
 	middlewareFactoryList?: FunctionMiddlewareList<S>,
 ): ServerHandler<C, S> {
 	const handler = {} as ServerHandler<C, S>;
-	const processors = new Map<string, Middleware<unknown[], unknown>>();
+	const processors = new Map<string, MiddlewareProcessor<unknown[], unknown>>();
 	const players = new Map<Player, RequestInfo>();
 
 	function createMethod(name: string, networkInfo: NetworkInfo, remote: RemoteEvent) {
@@ -73,7 +73,13 @@ export function createServerHandler<S, C>(
 			const processor = processors.get(name);
 			if (processor) {
 				const result = processor(player, ...args);
-				remote.FireClient(player, id, result === Skip ? NetworkingFunctionError.Cancelled : true, result);
+				result
+					.then((value) => remote.FireClient(player, id, getProcessResult(value), value))
+					.catch((reason) => {
+						warn(`Failed to process request to ${name}`);
+						warn(reason);
+						remote.FireClient(player, id, false);
+					});
 			} else {
 				remote.FireClient(player, id, false);
 			}
@@ -165,3 +171,7 @@ function getRequestInfo(player: Player, map: Map<Player, RequestInfo>) {
 function timeout(timeout: number, rejectValue: unknown) {
 	return Promise.delay(timeout).then(() => Promise.reject(rejectValue));
 }
+
+function getProcessResult(value: unknown) {
+	return value === Skip ? NetworkingFunctionError.Cancelled : true;
+}
diff --git a/src/functions/types.d.ts b/src/functions/types.d.ts
@@ -19,7 +19,7 @@ export interface ServerReceiver<I extends unknown[], O> {
 	 * @param callback The callback that will be invoked
 	 * @param guards A list of guards that will only be used on this connection
 	 */
-	setCallback(callback: (player: Player, ...args: I) => O): void;
+	setCallback(callback: (player: Player, ...args: I) => O | Promise<O>): void;
 
 	/**
 	 * Invokes a server function using player as the sender.
@@ -43,7 +43,7 @@ export interface ClientReceiver<I extends unknown[], O> {
 	 * @param event The function to connect to
 	 * @param callback The callback that will be invoked
 	 */
-	setCallback(callback: (...args: I) => O): void;
+	setCallback(callback: (...args: I) => O | Promise<O>): void;
 
 	/**
 	 * Invokes a client function.

diff --git a/src/middleware/createMiddlewareProcessor.ts b/src/middleware/createMiddlewareProcessor.ts
@@ -1,21 +1,22 @@
 import { NetworkInfo } from "../types";
-import { Middleware, MiddlewareFactory } from "./types";
+import { Middleware, MiddlewareFactory, MiddlewareProcessor } from "./types";
 
 export function createMiddlewareProcessor<I extends readonly unknown[], O>(
 	middlewareFactories: MiddlewareFactory<I, O>[] | undefined,
 	networkInfo: NetworkInfo,
 	finalize: Middleware<I, O>,
-) {
+): MiddlewareProcessor<I, O> {
 	const middleware = new Array<Middleware<I, O>>();
 
 	if (!middlewareFactories || middlewareFactories.size() === 0) {
 		middleware[0] = finalize;
 	} else {
 		for (let i = middlewareFactories.size() - 1; i >= 0; i--) {
 			const factory = middlewareFactories[i];
-			middleware[i] = factory(middleware[i + 1] ?? finalize, networkInfo);
+			const processNext = middleware[i + 1] ?? finalize;
+			middleware[i] = factory(async (player, ...args) => processNext(player, ...args), networkInfo);
 		}
 	}
 
-	return middleware[0];
+	return async (player?: Player, ...args: I) => middleware[0](player, ...args);
 }
diff --git a/src/middleware/types.d.ts b/src/middleware/types.d.ts
@@ -1,9 +1,13 @@
 import { NetworkInfo } from "../types";
 import { Skip } from "./skip";
 
-export type Middleware<I extends readonly unknown[] = unknown[], O = void> = (player?: Player, ...args: I) => O;
+export type MiddlewareProcessor<I extends readonly unknown[], O> = (player?: Player, ...args: I) => Promise<O>;
+export type Middleware<I extends readonly unknown[] = unknown[], O = void> = (
+	player?: Player,
+	...args: I
+) => O | Promise<O>;
 export type MiddlewareFactory<I extends readonly unknown[] = [], O = void> = (
-	processNext: Middleware<I, O>,
+	processNext: MiddlewareProcessor<I, O>,
 	event: NetworkInfo,
 ) => Middleware<I, O>;