@quenty/loader 10.2.0 → 10.3.0

package/CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [10.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/loader@10.2.0...@quenty/loader@10.3.0) (2024-05-09)
+
+
+### Bug Fixes
+
+* Fix .package-lock.json replicating in packages ([75d0efe](https://github.com/Quenty/NevermoreEngine/commit/75d0efeef239f221d93352af71a5b3e930ec23c5))
+* Fix hoarcekat asset addition logic ([89e2c18](https://github.com/Quenty/NevermoreEngine/commit/89e2c181f83f9bca4d659477702d695af6e7b0cd))
+* Immediate replication mode for loader and ability to bootstrap stories faster ([43967ec](https://github.com/Quenty/NevermoreEngine/commit/43967ecf3947241138dd3a44ba23ffe05de6d2b0))
+
+
+
+
+
 # [10.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/loader@10.1.0...@quenty/loader@10.2.0) (2024-04-27)
 
 **Note:** Version bump only for package @quenty/loader

package/default.project.json

@@ -1,5 +1,6 @@
 {
   "name": "loader",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
   "tree": {
     "$path": "src"
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/loader",
-  "version": "10.2.0",
+  "version": "10.3.0",
   "description": "A simple module loader for Roblox",
   "keywords": [
     "Roblox",
@@ -26,5 +26,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5c9eab1eac73f0d54953cca5017b7be968182f72"
+  "gitHead": "3fd5cdca3128bf34c8d9dfae1e92d62533b6e6f5"
 }

package/src/Dependencies/PackageTracker.lua

@@ -427,7 +427,7 @@ function PackageTracker:_tryStorePackage(fullPackageName, packageInst)
 	return function()
 		local index = table.find(self._subpackagesTrackerList, packageTracker)
 		if index then
-			table.remove(self._subpackagesTrackerList, packageTracker)
+			table.remove(self._subpackagesTrackerList, index)
 		end
 
 		if self._subpackagesMap[fullPackageName] == packageInst then

package/src/LoaderLink/LoaderLink.lua

@@ -22,4 +22,9 @@ local function waitForValue(objectValue)
 	return objectValue.Changed:Wait()
 end
 
-return require(waitForValue(script:WaitForChild("LoaderLink")))
+local loader = waitForValue(script:WaitForChild("LoaderLink"))
+if not loader:IsDescendantOf(game) then
+	error("Cannot load loader that is unparented from game")
+end
+
+return require(loader)

package/src/LoaderLink/LoaderLinkCreator.lua

@@ -29,9 +29,29 @@ function LoaderLinkCreator.new(root, references, isRoot)
 	self._hasLoaderCount = self._maid:Add(Instance.new("IntValue"))
 	self._hasLoaderCount.Value = 0
 
-	self._needsLoader = self._maid:Add(Instance.new("BoolValue"))
-	self._needsLoader.Value = false
+	self._provideLoader = self._maid:Add(Instance.new("BoolValue"))
+	self._provideLoader.Value = false
 
+	-- prevent frame delay
+	self:_setupEventTracking()
+	self:_setupRendering()
+
+	return self
+end
+
+function LoaderLinkCreator:_setupEventTracking()
+	self._maid:GiveTask(self._root.ChildAdded:Connect(function(child)
+		self:_handleChildAdded(child)
+	end))
+	self._maid:GiveTask(self._root.ChildRemoved:Connect(function(child)
+		self:_handleChildRemoved(child)
+	end))
+
+	for _, child in pairs(self._root:GetChildren()) do
+		self:_handleChildAdded(child)
+	end
+
+	-- Need to do this AFTER child added loop
 	if self._references then
 		self._maid:GiveTask(self._references:ObserveReferenceChanged(loader, function(replicatedLoader)
 			if replicatedLoader and replicatedLoader ~= loader then
@@ -40,52 +60,49 @@ function LoaderLinkCreator.new(root, references, isRoot)
 				self._maid._trackFakeLoader = nil
 			end
 		end))
+	else
+		self._maid:GiveTask(self:_countLoaderReferences(loader))
+	end
+
+	-- Update state
+	self._maid:GiveTask(self._childRequiresLoaderCount.Changed:Connect(function()
+		self:_updateProviderLoader()
+	end))
+	self._maid:GiveTask(self._hasLoaderCount.Changed:Connect(function()
+		self:_updateProviderLoader()
+	end))
+	self:_updateProviderLoader()
+end
 
-		self._maid:GiveTask(self._needsLoader.Changed:Connect(function()
-			if self._needsLoader.Value then
+function LoaderLinkCreator:_setupRendering()
+	if self._references then
+		local function renderLoader()
+			if self._provideLoader.Value then
 				self._maid._loader = self:_renderLoaderWithReferences()
 			else
 				self._maid._loader = nil
 			end
-		end))
+		end
+
+		self._maid:GiveTask(self._provideLoader.Changed:Connect(renderLoader))
+		renderLoader()
 	else
-		-- No references, just render as needed
-		self._maid:GiveTask(self._needsLoader.Changed:Connect(function()
-			if self._needsLoader.Value then
+		local function renderLoader()
+			if self._provideLoader.Value then
 				self._maid._loader = self:_doLoaderRender(loader)
 			else
 				self._maid._loader = nil
 			end
-		end))
-
-		self._maid:GiveTask(self:_countLoaderReferences(loader))
-	end
-
-	-- Update state
-	self._maid:GiveTask(self._childRequiresLoaderCount.Changed:Connect(function()
-		self:_updateNeedsLoader()
-	end))
-	self._maid:GiveTask(self._hasLoaderCount.Changed:Connect(function()
-		self:_updateNeedsLoader()
-	end))
-	self:_updateNeedsLoader()
+		end
 
-	-- Do actual setup
-	self._maid:GiveTask(self._root.ChildAdded:Connect(function(child)
-		self:_handleChildAdded(child)
-	end))
-	self._maid:GiveTask(self._root.ChildRemoved:Connect(function(child)
-		self:_handleChildRemoved(child)
-	end))
-	for _, child in pairs(self._root:GetChildren()) do
-		self:_handleChildAdded(child)
+		-- No references, just render as needed
+		self._maid:GiveTask(self._provideLoader.Changed:Connect(renderLoader))
+		renderLoader()
 	end
-
-	return self
 end
 
-function LoaderLinkCreator:_updateNeedsLoader()
-	self._needsLoader.Value = (self._childRequiresLoaderCount.Value > 0) and self._hasLoaderCount.Value <= 0
+function LoaderLinkCreator:_updateProviderLoader()
+	self._provideLoader.Value = (self._childRequiresLoaderCount.Value > 0) and self._hasLoaderCount.Value <= 0
 end
 
 function LoaderLinkCreator:_handleChildRemoved(child)
@@ -96,7 +113,13 @@ function LoaderLinkCreator:_handleChildAdded(child)
 	assert(typeof(child) == "Instance", "Bad child")
 
 	if child:IsA("ModuleScript") then
-		self._maid[child] = self:_incrementNeededLoader(1)
+		if child.Name ~= "loader" then
+			self._maid[child] = self:_incrementNeededLoader(1)
+		else
+			if child ~= self._lastProvidedLoader then
+				self._maid[child] = self:_addToHasLoaderCount(1)
+			end
+		end
 	elseif child:IsA("Folder") then
 		-- TODO: Maybe add to children with node_modules explicitly in its list.
 		self._maid[child] = LoaderLinkCreator.new(child, self._references)
@@ -119,8 +142,11 @@ end
 
 function LoaderLinkCreator:_doLoaderRender(value)
 	local loaderLink = LoaderLinkUtils.create(value, loader.Name)
+	self._lastProvidedLoader = loaderLink
+
 	loaderLink.Parent = self._root
 
+
 	return loaderLink
 end
 
@@ -133,7 +159,7 @@ function LoaderLinkCreator:_incrementNeededLoader(amount)
 	end
 end
 
-function LoaderLinkCreator:_addToLoaderCount(amount)
+function LoaderLinkCreator:_addToHasLoaderCount(amount)
 	assert(type(amount) == "number", "Bad amount")
 
 	self._hasLoaderCount.Value = self._hasLoaderCount.Value + amount
@@ -149,12 +175,12 @@ function LoaderLinkCreator:_countLoaderReferences(robloxInst)
 
 	-- TODO: Maybe handle loader reparenting more elegantly? this seems deeply unlikely.
 	if robloxInst.Parent == self._root then
-		maid._current = self:_addToLoaderCount(1)
+		maid._current = self:_addToHasLoaderCount(1)
 	end
 
 	maid:GiveTask(robloxInst:GetPropertyChangedSignal("Parent"):Connect(function()
 		if robloxInst.Parent == self._root then
-			maid._current = self:_addToLoaderCount(1)
+			maid._current = self:_addToHasLoaderCount(1)
 		else
 			maid._current = nil
 		end

package/src/Replication/ReplicatorReferences.lua

@@ -48,6 +48,10 @@ function ReplicatorReferences:UnsetReference(orig, replicated)
 	end
 end
 
+function ReplicatorReferences:GetReference(orig)
+	return self._lookup[orig]
+end
+
 function ReplicatorReferences:_fireSubs(orig, newValue)
 	assert(typeof(orig) == "Instance", "Bad orig")
 

package/src/init.lua

@@ -55,10 +55,6 @@ function Loader.bootstrapGame(packages)
 
 	GLOBAL_PACKAGE_TRACKER:AddPackageRoot(packages)
 
-	-- We need to wait here once we "populate" the loader so the Ancestry/query events can
-	-- fire in Signal deferred mode.
-	self:_waitForNextDeferFrame()
-
 	return self
 end
 
@@ -71,9 +67,25 @@ function Loader.bootstrapPlugin(packages)
 
 	GLOBAL_PACKAGE_TRACKER:AddPackageRoot(packages)
 
-	-- We need to wait here once we "populate" the loader so the Ancestry/query events can
-	-- fire in Signal deferred mode.
-	self:_waitForNextDeferFrame()
+	return self
+end
+
+function Loader.bootstrapStory(storyScript)
+	assert(typeof(storyScript) == "Instance", "Bad storyScript")
+
+	-- Prepopulate global package roots
+	local topNodeModule = storyScript
+	for node_modules in DependencyUtils.iterNodeModules(storyScript) do
+		if not node_modules:IsDescendantOf(topNodeModule) then
+			topNodeModule = node_modules
+		end
+	end
+
+	local self = Loader.new(topNodeModule.Parent, ReplicationType.PLUGIN)
+
+	self:_setupLoaderPopulation()
+
+	GLOBAL_PACKAGE_TRACKER:AddPackageRoot(topNodeModule.Parent)
 
 	return self
 end
@@ -103,15 +115,6 @@ function Loader:__call(request)
 	end
 end
 
-function Loader:_waitForNextDeferFrame()
-	local signal = Instance.new("BindableEvent")
-	task.defer(function()
-		signal:Fire()
-	end)
-	signal.Event:Wait()
-	signal:Destroy()
-end
-
 function Loader:_findDependency(request)
 	assert(type(request) == "string", "Bad request")
 
@@ -141,9 +144,7 @@ function Loader:_findDependency(request)
 	-- Just standard dependency search
 	local foundBackup = DependencyUtils.findDependency(self._packages, request, self._replicationType)
 	if foundBackup then
-		if RunService:IsRunning() then
-			warn(string.format("[Loader] - Failed to find package %q in package tracker\n%s", request, debug.traceback()))
-		end
+		warn(string.format("[Loader] - Failed to find package %q in package tracker\n%s", request, debug.traceback()))
 
 		-- Ensure hoarcekat story has a link to use
 		-- TODO: Maybe add to global package cache instead...