For requests that use data stores or other APIs with rate limits, it would be useful t

Rate limiting features about rbx-net HOT 7 CLOSED

roblox-aurora commented on May 28, 2024

Rate limiting features

from rbx-net.

Comments (7)

Vorlias commented on May 28, 2024 1

I can add a rate limit system as well 👍

from rbx-net.

Vorlias commented on May 28, 2024 1

Had to create a separate class, because I need a wrapper callback to handle rate limitations, and don't want to do that for ALL remotes.

rbx-net/src/index.ts

Lines 313 to 362 in 967befb

 export class ThrottledServerFunction<CR extends any = any> extends ServerFunction<CR> { 

 /** @internal */ 

 public static rates = new Map<string, Array<number>>(); 

 private maxRequestsPerMinute: number = 0; 

 private clientRequests: RequestCounter; 

 constructor(name: string, rateLimit: number) { 

 super(name); 

 this.maxRequestsPerMinute = rateLimit; 

 this.clientRequests = throttler.Get(`Function~${name}`); 

 const clientValue = new Instance("IntValue", this.instance); 

 clientValue.Name = "RateLimit"; 

 clientValue.Value = rateLimit; 

 } 

 public set Callback(callback: Callback) { 

 this.instance.OnServerInvoke = (player: Player, ...args: Array<any>) => { 

 const clientRequestCount = this.clientRequests.Get(player); 

 if (clientRequestCount >= this.maxRequestsPerMinute) { 

 error(`Rate limit reached (${clientRequestCount})!`); 

 } else { 

 this.clientRequests.Increment(player); 

 return callback(player, ...args); 

 } 

 }; 

 } 

 /** 

  * The number of requests allowed per minute per user 

  */ 

 public set RateLimit(requestsPerMinute: number) { 

 this.maxRequestsPerMinute = requestsPerMinute; 

 let clientValue = this.instance.FindFirstChild<IntValue>("RateLimit"); 

 if (clientValue) { 

 clientValue.Value = requestsPerMinute; 

 } else { 

 clientValue = new Instance("IntValue", this.instance); 

 clientValue.Name = "RateLimit"; 

 clientValue.Value = requestsPerMinute; 

 } 

 } 

 public get RateLimit() { 

 return this.maxRequestsPerMinute; 

 } 

 }

How does this look for you? Works good. I'll work on adding an event equivalent as well.

from rbx-net.

Vorlias commented on May 28, 2024

ServerFunction.ClientCache can be used to cache results for RemoteFunctions.

The value is the amount of seconds the value is cached for.

e.g.

const myFunction = new Net.ServerFunction("MyFunction");
myFunction.ClientCache = 10; // cached for 10 seconds

During those 10 seconds, it will use the value from the cache rather than send another request.

from rbx-net.

catgirlinspace commented on May 28, 2024

Does the cache feature call the server if different parameters are used?

from rbx-net.

Vorlias commented on May 28, 2024

It will cache regardless of the parameters provided... unlike ModRemote where you can cache based on the first parameter.

If you want, I can also add that functionality into rbx-net.

from rbx-net.

catgirlinspace commented on May 28, 2024

A way to cache based on parameters would be similar to this, so that would work. Just my concern is someone uses an exploit to fire GetProfileDetails a lot with a different user id each time causing a data store request.

from rbx-net.

catgirlinspace commented on May 28, 2024

Skimming through it, it looks good! 👍

from rbx-net.

Rate limiting features about rbx-net HOT 7 CLOSED

Comments (7)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	export class ThrottledServerFunction<CR extends any = any> extends ServerFunction<CR> {
	/** @internal */
	public static rates = new Map<string, Array<number>>();

	private maxRequestsPerMinute: number = 0;
	private clientRequests: RequestCounter;

	constructor(name: string, rateLimit: number) {
	super(name);
	this.maxRequestsPerMinute = rateLimit;

	this.clientRequests = throttler.Get(`Function~${name}`);

	const clientValue = new Instance("IntValue", this.instance);
	clientValue.Name = "RateLimit";
	clientValue.Value = rateLimit;
	}

	public set Callback(callback: Callback) {
	this.instance.OnServerInvoke = (player: Player, ...args: Array<any>) => {
	const clientRequestCount = this.clientRequests.Get(player);
	if (clientRequestCount >= this.maxRequestsPerMinute) {
	error(`Rate limit reached (${clientRequestCount})!`);
	} else {
	this.clientRequests.Increment(player);
	return callback(player, ...args);
	}
	};
	}

	/**
	* The number of requests allowed per minute per user
	*/
	public set RateLimit(requestsPerMinute: number) {
	this.maxRequestsPerMinute = requestsPerMinute;

	let clientValue = this.instance.FindFirstChild<IntValue>("RateLimit");
	if (clientValue) {
	clientValue.Value = requestsPerMinute;
	} else {
	clientValue = new Instance("IntValue", this.instance);
	clientValue.Name = "RateLimit";
	clientValue.Value = requestsPerMinute;
	}
	}

	public get RateLimit() {
	return this.maxRequestsPerMinute;
	}
	}