refactor: improve how models are fetched by batching such requests, like bulk model permission request fetching

frontend/src/Model.ts

@@ -296,7 +296,7 @@ export default class Model {
 
 		this._permissions = await ModelPermissionFetcher.fetchModelPermissions(
 			this.getName(),
-			this._id
+			this.getId()
 		);
 
 		return this._permissions;

frontend/src/stores/model.ts

@@ -5,6 +5,151 @@ import { forEachIn } from "@common/utils/forEachIn";
 import { useWebsocketStore } from "./websocket";
 import Model from "@/Model";
 
+class DeferredPromise<T = any> {
+	promise: Promise<T>;
+
+	reject;
+
+	resolve;
+
+	// eslint-disable-next-line require-jsdoc
+	constructor() {
+		this.promise = new Promise<T>((resolve, reject) => {
+			this.reject = reject;
+			this.resolve = resolve;
+		});
+	}
+}
+
+interface ModelFetcherRequest {
+	promise: DeferredPromise;
+	payload: {
+		modelName: string;
+		modelIds: string[];
+	};
+}
+
+// TODO combine the ModelFetcher and the ModelPermissionFetcher
+/**
+ * Class used for fetching models in bulk, every 25ms max, per model type
+ * So if we tried to fetch 100 different minifiedUser models separately, it would do only 1 request to fetch the models, not 100 separate ones
+ */
+class ModelFetcher {
+	private static requestsQueued: ModelFetcherRequest[] = [];
+
+	private static timeoutActive = false;
+
+	private static responseCache = {};
+
+	private static fetch() {
+		// If there is no other timeout running, indicate we will run one. Otherwise, return, as a timeout is already running
+		if (!this.timeoutActive) this.timeoutActive = true;
+		else return;
+
+		setTimeout(() => {
+			// Reset timeout active, so another one can run
+			this.timeoutActive = false;
+			// Make a copy of all requests currently queued, and then take those requests out of the queue so we can request them
+			const requests = this.requestsQueued;
+			this.requestsQueued = [];
+
+			// Splits the requests per model
+			const requestsPerModel = {};
+			requests.forEach(request => {
+				const { modelName } = request.payload;
+				if (!Array.isArray(requestsPerModel[modelName]))
+					requestsPerModel[modelName] = [];
+				requestsPerModel[modelName].push(request);
+			});
+
+			const modelNames = Object.keys(requestsPerModel);
+
+			const { runJob } = useWebsocketStore();
+
+			// TODO somehow make the following forEachIn run at the same time for all modelNames
+			// Runs the requests per model
+			forEachIn(modelNames, async modelName => {
+				// All already cached model ids
+				let cachedModelIds = Object.keys(this.responseCache[modelName]);
+
+				// Gets a unique list of all model ids for the current model that we want to request permissions for, that are not already cached
+				const modelIds = Array.from(
+					new Set(
+						requestsPerModel[modelName].flatMap(
+							request => request.payload.modelIds
+						)
+					)
+				).filter((modelId: string) => !cachedModelIds.includes(modelId));
+
+				// Only do a request if more than one model isn't already cached
+				if (modelIds.length > 0) {
+					console.log(`Requesting model ids`, modelName, modelIds);
+					const result = await runJob(`data.${modelName}.findManyById`, {
+						_ids: modelIds
+					}) as any[];
+					
+					// Cache the responses for the requested model ids
+					modelIds.forEach(modelId => {
+						const model = result.find(model => model._id === modelId);
+						console.log(`Caching ${modelName}.${modelId}`, model);
+						this.responseCache[modelName][modelId] = model;
+					});
+				}
+
+				const requests = requestsPerModel[modelName];
+				// For all requests, resolve the deferred promise with the returned model(s) that was requested
+				requests.forEach(request => {
+					const { payload, promise } = request;
+					const { modelIds } = payload;
+					const models = modelIds.map(modelId => this.responseCache[modelName][modelId]).filter(model => model);
+					promise.resolve(models);
+				});
+
+				// A unique list of model ids that are will be requested in the next batch for the current model type
+				const queuedModelIds = Array.from(new Set(this.requestsQueued.filter(request => request.payload.modelName).flatMap(request => request.payload.modelIds)));
+				// A list of model ids responses currently cached
+				cachedModelIds = Object.keys(this.responseCache[modelName]);
+				// A list of the cached model responses that can safely be deleted, because no queued up request needs it
+				const cachedModelIdsToDelete = cachedModelIds.filter(cachedModelId => !queuedModelIds.includes(cachedModelId));
+				console.log(`Queued model ids`, modelName, queuedModelIds);
+				console.log(`Cached model ids`, modelName, cachedModelIds);
+				console.log(`Cached model ids to delete`, modelName, cachedModelIdsToDelete);
+
+				// TODO In theory, we could check if any of the queued requests can be resolved here. Not worth it at the moment.
+
+				cachedModelIdsToDelete.forEach(cachedModelIdToDelete => {
+					delete this.responseCache[modelName][cachedModelIdToDelete];
+				});
+			});
+		}, 25);
+	}
+
+	public static fetchModelsByIds(modelName: string, modelIds: string[]) {
+		this.responseCache[modelName] ??= {};
+
+		return new Promise(resolve => {
+			const promise = new DeferredPromise();
+
+			// Listens for the deferred promise response, before we actually push and fetch
+			promise.promise.then(result => {
+				resolve(result);
+			});
+
+			// Pushes the request to the queue
+			this.requestsQueued.push({
+				payload: {
+					modelName,
+					modelIds
+				},
+				promise
+			});
+
+			// Calls the fetch function, which will start a timeout if one isn't already running, which will actually request the model
+			this.fetch();
+		});
+	}
+}
+
 /**
  * Pinia store for managing models
  */
@@ -192,7 +337,9 @@ export const useModelStore = defineStore("model", () => {
 
 		if (existingModel) return existingModel;
 
-		return runJob(`data.${modelName}.findById`, { _id: modelId });
+		const [model] = await ModelFetcher.fetchModelsByIds(modelName, [modelId]) as unknown[];
+
+		return model;
 	};
 
 	/**
@@ -213,9 +360,7 @@ export const useModelStore = defineStore("model", () => {
 
 		let fetchedModels = [];
 		if (missingModelIds.length > 0)
-			fetchedModels = (await runJob(`data.${modelName}.findManyById`, {
-				_ids: missingModelIds
-			})) as unknown[];
+			fetchedModels = await ModelFetcher.fetchModelsByIds(modelName, missingModelIds) as unknown[];
 
 		const allModels = existingModels.concat(fetchedModels);
 
@@ -285,8 +430,6 @@ export const useModelStore = defineStore("model", () => {
 				return;
 			delete models[modelName][modelIdToRemove];
 		});
-
-		console.log("After unregister", JSON.parse(JSON.stringify(models)));
 	};
 
 	/**
@@ -301,7 +444,6 @@ export const useModelStore = defineStore("model", () => {
 	): Promise<Model[]> => {
 		console.info("Register models", documentsOrModels, relations);
 
-		console.log(123123, documentsOrModels);
 		const existingModels = documentsOrModels
 			.map(({ _name, _id }) =>
 				models[_name] ? models[_name][_id] ?? null : null
@@ -414,7 +556,6 @@ export const useModelStore = defineStore("model", () => {
 		);
 
 		const fetchedModels = await findManyById(modelName, missingModelIds);
-		console.log(999, modelName, missingModelIds, fetchedModels);
 		const registeredModels = await registerModels(
 			Object.values(fetchedModels)
 				.filter(model => !!model)
@@ -428,7 +569,6 @@ export const useModelStore = defineStore("model", () => {
 			)
 			.map(modelId => [modelId, null]);
 
-		console.log(123, registeredModels, modelsNotFound, fetchedModels);
 		return Object.fromEntries(
 			registeredModels
 				.map(model => [model.getId(), model])