From 74c80c50e942030515ccf4ad14a630fba17833e6 Mon Sep 17 00:00:00 2001
From: Noikoio <noikoio1@gmail.com>
Date: Fri, 8 Dec 2017 13:54:29 -0800
Subject: [PATCH] Adding notes, possible goals for this branch

---
 Module/EntityCache/EntityCache.cs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/Module/EntityCache/EntityCache.cs b/Module/EntityCache/EntityCache.cs
index 36a66df..352d436 100644
--- a/Module/EntityCache/EntityCache.cs
+++ b/Module/EntityCache/EntityCache.cs
@@ -16,6 +16,17 @@ namespace Noikoio.RegexBot.Module.EntityCache
     /// </summary>
     class EntityCache : BotModule
     {
+        /*
+         * Future plans:
+         * Have this, or something connected to this class, be accessible throughout the bot.
+         * 
+         * There should be a system that holds a small in-memory cache of users (as EntityCache objects)
+         * for quick lookups by other parts of the bot.
+         * Without this system, we'll be having future bot features constantly querying the database
+         * on their own to look up entity cache records, which (among other things) could result in
+         * a race conditions where an event becomes aware of a user before it has been recorded.
+         */
+
         private readonly DatabaseConfig _db;
 
         public override string Name => nameof(EntityCache);