@quenty/timesyncservice 5.1.0 → 5.2.1-canary.276.672e37b.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.2.1-canary.276.672e37b.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/timesyncservice@5.2.0...@quenty/timesyncservice@5.2.1-canary.276.672e37b.0) (2022-07-31)
+
+**Note:** Version bump only for package @quenty/timesyncservice
+
+
+
+
+
+# [5.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/timesyncservice@5.1.0...@quenty/timesyncservice@5.2.0) (2022-07-02)
+
+
+### Bug Fixes
+
+* Can clean up services properly ([eb45e03](https://github.com/Quenty/NevermoreEngine/commit/eb45e03ce2897b18f1ae460974bf2bbb9e27cb97))
+
+
+
+
+
 # [5.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/timesyncservice@5.0.0...@quenty/timesyncservice@5.1.0) (2022-06-21)
 
 **Note:** Version bump only for package @quenty/timesyncservice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/timesyncservice",
-  "version": "5.1.0",
+  "version": "5.2.1-canary.276.672e37b.0",
   "description": "Quenty's TimeSyncService keeps time synchronized between all clients and the server",
   "keywords": [
     "Roblox",
@@ -26,15 +26,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^5.0.0",
-    "@quenty/maid": "^2.3.0",
-    "@quenty/promise": "^5.0.0",
-    "@quenty/remoting": "^5.1.0",
-    "@quenty/signal": "^2.2.0",
-    "@quenty/table": "^3.1.0"
+    "@quenty/baseobject": "5.0.1-canary.276.672e37b.0",
+    "@quenty/loader": "5.0.0",
+    "@quenty/maid": "2.3.1-canary.276.672e37b.0",
+    "@quenty/promise": "5.0.1-canary.276.672e37b.0",
+    "@quenty/remoting": "5.1.1-canary.276.672e37b.0",
+    "@quenty/signal": "2.2.0",
+    "@quenty/table": "3.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c8732cc5dea767b3ff362db43137e2a16da7bc0d"
+  "gitHead": "672e37b9bbb8b2d4c4c6c69ed2647335be0bc469"
 }

package/src/Shared/Clocks/MasterClock.lua

@@ -3,7 +3,11 @@
 	@class MasterClock
 ]=]
 
-local MasterClock = {}
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+
+local MasterClock = setmetatable({}, BaseObject)
 MasterClock.__index = MasterClock
 MasterClock.ClassName = "MasterClock"
 
@@ -15,7 +19,7 @@ MasterClock.ClassName = "MasterClock"
 	@return MasterClock
 ]=]
 function MasterClock.new(remoteEvent, remoteFunction)
-	local self = setmetatable({}, MasterClock)
+	local self = setmetatable(BaseObject.new(), MasterClock)
 
 	self._remoteEvent = remoteEvent or error("No remoteEvent")
 	self._remoteFunction = remoteFunction or error("No remoteFunction")
@@ -23,14 +27,19 @@ function MasterClock.new(remoteEvent, remoteFunction)
 	self._remoteFunction.OnServerInvoke = function(_, timeThree)
 		return self:_handleDelayRequest(timeThree)
 	end
-	self._remoteEvent.OnServerEvent:Connect(function(player)
+	self._maid:GiveTask(self._remoteEvent.OnServerEvent:Connect(function(player)
 		 self._remoteEvent:FireClient(player, self:GetTime())
+	end))
+
+	local alive = true
+	self._maid:GiveTask(function()
+		alive = false
 	end)
 
-	task.spawn(function()
-		while true do
-			task.wait(5)
+	task.delay(5, function()
+		while alive do
 			self:_forceSync()
+			task.wait(5)
 		end
 	end)
 

package/src/Shared/Clocks/SlaveClock.lua

@@ -3,7 +3,11 @@
 	@class SlaveClock
 ]=]
 
-local SlaveClock = {}
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+
+local SlaveClock = setmetatable({}, BaseObject)
 SlaveClock.__index = SlaveClock
 SlaveClock.ClassName = "SlaveClock"
 SlaveClock._offset = -1 -- Set uncalculated values to -1
@@ -16,14 +20,14 @@ SlaveClock._offset = -1 -- Set uncalculated values to -1
 	@return SlaveClock
 ]=]
 function SlaveClock.new(remoteEvent, remoteFunction)
-	local self = setmetatable({}, SlaveClock)
+	local self = setmetatable(BaseObject.new(), SlaveClock)
 
 	self._remoteEvent = remoteEvent or error("No remoteEvent")
 	self._remoteFunction = remoteFunction or error("No remoteFunction")
 
-	self._remoteEvent.OnClientEvent:Connect(function(timeOne)
+	self._maid:GiveTask(self._remoteEvent.OnClientEvent:Connect(function(timeOne)
 		self:_handleSyncEventAsync(timeOne)
-	end)
+	end))
 
 	self._remoteEvent:FireServer() -- Request server to syncronize with us
 

package/src/Shared/TimeSyncService.lua

@@ -1,5 +1,7 @@
 --[=[
-	Syncronizes time
+	Syncronizes time between the server and client. This creates a shared timestamp that can be used to reasonably time
+	events between the server and client.
+
 	@class TimeSyncService
 ]=]
 
@@ -17,13 +19,20 @@ local PromiseUtils = require("PromiseUtils")
 local SlaveClock = require("SlaveClock")
 local TimeSyncConstants = require("TimeSyncConstants")
 local TimeSyncUtils = require("TimeSyncUtils")
+local Maid = require("Maid")
 
 local TimeSyncService = {}
 
+--[=[
+	Initializes the TimeSyncService
+]=]
 function TimeSyncService:Init()
 	assert(not self._clockPromise, "TimeSyncService is already initialized!")
 
+	self._maid = Maid.new()
+
 	self._clockPromise = Promise.new()
+	self._maid:GiveTask(self._clockPromise)
 
 	if not RunService:IsRunning() then
 		error("Cannot initialize in test mode")
@@ -37,6 +46,12 @@ function TimeSyncService:Init()
 	end
 end
 
+--[=[
+	Returns true if the clock is synced. If the clock is synced, then it can
+	be retrieved.
+
+	@return boolean
+]=]
 function TimeSyncService:IsSynced()
 	if not RunService:IsRunning() then
 		return true
@@ -46,6 +61,12 @@ function TimeSyncService:IsSynced()
 	return self._clockPromise:IsFulfilled()
 end
 
+--[=[
+	Waits for the synced clock, or throws an error.
+
+	@yields
+	@return MasterClock | SlaveClock
+]=]
 function TimeSyncService:WaitForSyncedClock()
 	if not RunService:IsRunning() then
 		return self:_buildMockClock()
@@ -55,6 +76,11 @@ function TimeSyncService:WaitForSyncedClock()
 	return self._clockPromise:Wait()
 end
 
+--[=[
+	Returns a synced clock if there is one available. Otherwise, returns nil.
+
+	@return MasterClock | SlaveClock | nil
+]=]
 function TimeSyncService:GetSyncedClock()
 	if not RunService:IsRunning() then
 		return self:_buildMockClock()
@@ -68,6 +94,11 @@ function TimeSyncService:GetSyncedClock()
 	return nil
 end
 
+--[=[
+	Promises a synced clock
+
+	@return Promise<MasterClock | SlaveClock>
+]=]
 function TimeSyncService:PromiseSyncedClock()
 	if not RunService:IsRunning() then
 		return Promise.resolved(self:_buildMockClock())
@@ -95,16 +126,28 @@ function TimeSyncService:_buildMasterClock()
 	local remoteEvent = GetRemoteEvent(TimeSyncConstants.REMOTE_EVENT_NAME)
 	local remoteFunction = GetRemoteFunction(TimeSyncConstants.REMOTE_FUNCTION_NAME)
 
-	return MasterClock.new(remoteEvent, remoteFunction)
+	local clock = MasterClock.new(remoteEvent, remoteFunction)
+	self._maid:GiveTask(clock)
+
+	return clock
 end
 
 function TimeSyncService:_promiseSlaveClock()
-	return PromiseUtils.all({
+	return self._maid:GivePromise(PromiseUtils.all({
 		PromiseGetRemoteEvent(TimeSyncConstants.REMOTE_EVENT_NAME);
 		PromiseGetRemoteFunction(TimeSyncConstants.REMOTE_FUNCTION_NAME);
-	}):Then(function(remoteEvent, remoteFunction)
-		return TimeSyncUtils.promiseClockSynced(SlaveClock.new(remoteEvent, remoteFunction))
+	})):Then(function(remoteEvent, remoteFunction)
+		local clock = SlaveClock.new(remoteEvent, remoteFunction)
+		self._maid:GiveTask(clock)
+		return TimeSyncUtils.promiseClockSynced(clock)
 	end)
 end
 
+--[=[
+	Cleans up the time syncronization service.
+]=]
+function TimeSyncService:Destroy()
+	self._maid:DoCleaning()
+end
+
 return TimeSyncService

package/src/Shared/TimeSyncUtils.lua

@@ -1,4 +1,5 @@
 --[=[
+	Helper functions for the TimeSyncService.
 	@class TimeSyncUtils
 ]=]
 
@@ -9,6 +10,12 @@ local Maid = require("Maid")
 
 local TimeSyncUtils = {}
 
+--[=[
+	Given a clock, returns a promise that resolves when the clock is syncronized.
+
+	@param clock MasterClock | SlaveClock
+	@return Promise<MasterClock | SlaveClock>
+]=]
 function TimeSyncUtils.promiseClockSynced(clock)
 	if clock:IsSynced() then
 		return Promise.resolved(clock)