@rbxts/batch-collector v1.0.3

Batch Collector

Batch Collector is a module for collecting batches of items, be they logs or tasks, to be posted together in order.

Installation

roblox-ts

Simply install to your roblox-ts project as follows:

npm i @rbxts/batch-collector

Wally

Wally users can install this package by adding the following line to their Wally.toml under [dependencies]:

BatchCollector = "bytebit/batch-collector@1.0.3"

Then just run wally install.

From model file

Model files are uploaded to every release as .rbxmx files. You can download the file from the Releases page and load it into your project however you see fit.

From model asset

New versions of the asset are uploaded with every release. The asset can be added to your Roblox Inventory and then inserted into your Place via Toolbox by getting it here.

Documentation

Documentation can be found here, is included in the TypeScript files directly, and was generated using TypeDoc.

Example

We'll write a class that uses a BatchCollector to collect in-game events that will then be sent to a backend server that tracks all events across all servers and allows them to be viewed by a developer in some sort of dashboard.

import { BatchCollector, BatchPostRateLimitingConfiguration, IBatchCollector } from "@rbxts/batch-collector";

type GameEvent = {
  readonly eventTypeName: string
};

const batchPostRateLimitingConfiguration: BatchPostRateLimitingConfiguration = {
  maxNumberOfItems: 50; // don't want too many events at once
  maxTimeBetweenPostsInSeconds: 30; // don't want too much of a time discrepancy
  minTimeBetweenPostsInSeconds: 10; // want to make sure we don't send too many and hit the HttpService limits
};

export class GameEventsPoster {
  private readonly batchCollector: IBatchCollector<GameEvent>;

  public constructor() {
    this.batchCollector = BatchCollector.create(
      (gameEventsBatch) => this.postGameEvents(gameEventsBatch),
      batchPostRateLimitingConfiguration,
    );
  }

  public logGameEvent(gameEvent: GameEvent) {
    this.batchCollector.pushItem(gameEvent);
  }

  private postGameEvents(gameEvents: ReadonlyArray<GameEvent>) {
    // logic to post game events to backend server using HttpService
  }
}

local BatchCollector = require(path.to.modules["batch-collector"]).BatchCollector

local batchPostRateLimitingConfiguration = {
  maxNumberOfItems = 50, -- don't want too many events at once
  maxTimeBetweenPostsInSeconds = 30, -- don't want too much of a time discrepancy
  minTimeBetweenPostsInSeconds = 10 -- want to make sure we don't send too many and hit the HttpService limits
}

local GameEventsPoster = {}
GameEventsPoster.__index = GameEventsPoster

function new()
  local self = {}
  setmetatable(self, GameEventsPoster)

  self.batchCollector = BatchCollector.create(
    function (gameEventsBatch)
      _postGameEvents(self, gameEventsBatch)
    end,
    batchPostRateLimitingConfiguration
  )

  return self
end

function GameEventsPoster:logGameEvent(gameEvent)
  self.batchCollector(pushItem(gameEvent))
end

function _postGameEvents(self, gameEventsBatch)
  -- logic to post game events to backend server using HttpService
end

return {
  new = new
}