@quenty/servicebag 11.2.0 → 11.3.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [11.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/servicebag@11.2.0...@quenty/servicebag@11.3.0) (2024-05-03)
+
+
+### Features
+
+* Add logging to service bag ([d1a2804](https://github.com/Quenty/NevermoreEngine/commit/d1a28048a9fc02d8ab2d272f7a0eb1c81c4f60f6))
+
+
+
+
+
 # [11.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/servicebag@11.1.0...@quenty/servicebag@11.2.0) (2024-04-27)
 
 **Note:** Version bump only for package @quenty/servicebag

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/servicebag",
-  "version": "11.2.0",
+  "version": "11.3.0",
   "description": "Service providing mechanisms for Nevermore",
   "keywords": [
     "Roblox",
@@ -33,5 +33,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5c9eab1eac73f0d54953cca5017b7be968182f72"
+  "gitHead": "afbb66378d568ebb9450db13de0b4fe61113a2f1"
 }

package/src/Shared/ServiceBag.lua

@@ -26,6 +26,7 @@ local require = require(script.Parent.loader).load(script)
 
 local Signal = require("Signal")
 local BaseObject = require("BaseObject")
+local ServiceInitLogger = require("ServiceInitLogger")
 
 --[=[
 	@interface Service
@@ -61,6 +62,9 @@ function ServiceBag.new(parentProvider)
 	self._initializing = false
 	self._destructing = false
 
+	self._serviceInitLogger = ServiceInitLogger.new("initialized")
+	self._serviceStartLogger = ServiceInitLogger.new("started")
+
 	self._serviceTypesToStart = {}
 
 	self._destroyingSignal = Signal.new()
@@ -68,6 +72,11 @@ function ServiceBag.new(parentProvider)
 	return self
 end
 
+function ServiceBag:PrintInitialization()
+	self._serviceInitLogger:Print()
+	self._serviceStartLogger:Print()
+end
+
 --[=[
 	Returns whether the value is a serviceBag
 
@@ -161,9 +170,13 @@ function ServiceBag:Start()
 		if service.Start then
 			local current
 			task.spawn(function()
+				local stopClock = self._serviceStartLogger:StartInitClock(serviceName)
+
 				debug.setmemorycategory(serviceName)
 				current = coroutine.running()
 				service:Start()
+
+				stopClock()
 			end)
 
 			local isDead = coroutine.status(current) == "dead"
@@ -272,8 +285,13 @@ function ServiceBag:_initService(serviceType)
 		local current
 		task.spawn(function()
 			debug.setmemorycategory(serviceName)
+
+			local stopClock = self._serviceInitLogger:StartInitClock(serviceName)
+
 			current = coroutine.running()
 			service:Init(self)
+
+			stopClock()
 		end)
 
 		local isDead = coroutine.status(current) == "dead"

package/src/Shared/ServiceInitLogger.lua

@@ -0,0 +1,100 @@
+--[=[
+	@class ServiceInitLogger
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local EPSILON = 1e-6
+
+local ServiceInitLogger = {}
+ServiceInitLogger.ClassName = "ServiceInitLogger"
+ServiceInitLogger.__index = ServiceInitLogger
+
+function ServiceInitLogger.new(action)
+	assert(type(action) == "string", "Bad action")
+	local self = setmetatable({}, ServiceInitLogger)
+
+	self._action = action
+	self._rootNode = {
+		name = "ROOT";
+		children = {}
+	}
+	self._stack = { self._rootNode }
+	self._totalTimeUsed = 0
+	self._initIndent = 0
+	self._totalServices = 0
+
+	self._startLogs = {}
+
+	return self
+end
+
+function ServiceInitLogger:StartInitClock(serviceName)
+	assert(type(serviceName) == "string", "serviceName")
+
+	local startTime = os.clock()
+
+	local initialIndent = self._initIndent
+	local initialTotalTimeUsed = self._totalTimeUsed
+	local initialTotalServices = self._totalServices
+
+	self._initIndent = initialIndent + 1
+	self._totalServices = self._totalServices + 1
+
+	local parent = self._stack[#self._stack]
+	local entry = {
+		name = serviceName;
+		children = {};
+		log = string.format("%sService is not loaded", string.rep("  ", initialIndent), serviceName)
+	}
+	table.insert(parent.children, entry)
+	table.insert(self._stack, entry)
+
+	return function()
+		for i=#self._stack, 1, -1 do
+			if self._stack[i] == entry then
+				table.remove(self._stack, i)
+				break
+			end
+		end
+
+		local timeUsed = (os.clock() - startTime)
+		local otherServiceTime = self._totalTimeUsed - initialTotalTimeUsed
+		local internalTimeUsed = timeUsed - otherServiceTime
+		local totalServices = self._totalServices - initialTotalServices - 1
+
+		self._totalTimeUsed = self._totalTimeUsed + internalTimeUsed
+		self._initIndent = self._initIndent - 1
+
+		if math.abs(internalTimeUsed - timeUsed) <= EPSILON then
+			entry.log = string.format("%sService %s %s in %0.2f ms",
+				string.rep("  ", initialIndent),
+				serviceName,
+				self._action,
+				1000*internalTimeUsed)
+		else
+			entry.log = string.format("%sService %s %s in %0.2f ms (%0.2f ms total for %d descendants)",
+				string.rep("  ", initialIndent),
+				serviceName,
+				self._action,
+				1000*internalTimeUsed,
+				1000*timeUsed,
+				totalServices)
+		end
+	end
+end
+
+function ServiceInitLogger:Print()
+	local function recurse(node)
+		print(node.log)
+		for _, childNode in pairs(node.children) do
+			recurse(childNode)
+		end
+	end
+
+	for _, child in pairs(self._rootNode.children) do
+		recurse(child)
+	end
+end
+
+return ServiceInitLogger