@isentinel/jest-roblox 0.0.2 → 0.0.4

package/plugin/out/shared/runner.luau

@@ -0,0 +1,172 @@
+--!strict
+local HttpService = game:GetService("HttpService")
+local LogService = game:GetService("LogService")
+
+local InstanceResolver = require(script.Parent:FindFirstChild('instance-resolver'))
+local SnapshotPatch = require(script.Parent:FindFirstChild('snapshot-patch'))
+
+type Config = {
+	jestPath: string?,
+	projects: { string }?,
+	setupFiles: { string }?,
+	setupFilesAfterEnv: { string }?,
+	_timing: boolean?,
+}
+
+local function fail(err: string)
+	return {
+		success = false,
+		err = err,
+	}
+end
+
+local module = {}
+
+function module.run(callingScript: LuaSourceContainer, config: Config): (string, string)
+	local t0 = os.clock()
+	local timingEnabled = config._timing
+
+	local t_findJest0 = os.clock()
+	local findSuccess, findValue = pcall(InstanceResolver.getJest, config)
+	local t_findJest = os.clock()
+
+	if not findSuccess then
+		local logSuccess, logHistory = pcall(function()
+			return HttpService:JSONEncode(LogService:GetLogHistory())
+		end)
+
+		return HttpService:JSONEncode(fail(findValue :: any)),
+			if logSuccess then logHistory else "[]"
+	end
+
+	LogService:ClearOutput()
+
+	local snapshotWrites: { [string]: string } = {}
+
+	local t_patchSnapshot0 = os.clock()
+	local patchState = SnapshotPatch.patch(findValue, snapshotWrites)
+	local t_patchSnapshot = os.clock()
+
+	local t_requireJest0 = os.clock()
+	local Jest = (require :: any)(findValue)
+	local t_requireJest = os.clock()
+
+	local function runTests()
+		local t_resolveProjects0 = os.clock()
+		local projects = {}
+
+		assert(
+			config.projects and #config.projects > 0,
+			"No projects configured. Set 'projects' in jest.config.ts or pass --projects."
+		)
+
+		for _, projectPath in config.projects do
+			table.insert(projects, InstanceResolver.findInstance(projectPath))
+		end
+
+		config.projects = {}
+		local t_resolveProjects = os.clock()
+
+		local t_resolveSetupFiles0 = os.clock()
+		if config.setupFiles and #config.setupFiles > 0 then
+			local resolved = {}
+
+			for _, setupPath in config.setupFiles do
+				table.insert(resolved, InstanceResolver.findInstance(setupPath))
+			end
+
+			config.setupFiles = resolved :: any
+		end
+		if config.setupFilesAfterEnv and #config.setupFilesAfterEnv > 0 then
+			local resolved = {}
+
+			for _, setupPath in config.setupFilesAfterEnv do
+				table.insert(resolved, InstanceResolver.findInstance(setupPath))
+			end
+
+			config.setupFilesAfterEnv = resolved :: any
+		end
+		local t_resolveSetupFiles = os.clock()
+
+		config._timing = nil :: any
+
+		local t_jestRunCLI0 = os.clock()
+		local jestResult = Jest.runCLI(callingScript, config, projects):expect()
+		local t_jestRunCLI = os.clock()
+
+		local result: { [string]: any } = {
+			success = true,
+			value = jestResult,
+		}
+
+		if timingEnabled then
+			result._timing = {
+				findJest = t_findJest - t_findJest0,
+				patchSnapshot = t_patchSnapshot - t_patchSnapshot0,
+				requireJest = t_requireJest - t_requireJest0,
+				resolveProjects = t_resolveProjects - t_resolveProjects0,
+				resolveSetupFiles = t_resolveSetupFiles - t_resolveSetupFiles0,
+				jestRunCLI = t_jestRunCLI - t_jestRunCLI0,
+				total = os.clock() - t0,
+			}
+		end
+
+		if next(snapshotWrites) then
+			result._snapshotWrites = snapshotWrites
+		end
+
+		return result
+	end
+
+	local jestDone = false
+	local runSuccess = false
+	local runValue: any = nil
+
+	task.spawn(function()
+		local ok, val = pcall(runTests)
+		jestDone = true
+		runSuccess = ok
+		runValue = val
+	end)
+
+	local infiniteYieldMessage: string? = nil
+	local watchdogConnection = LogService.MessageOut:Connect(
+		function(message: string, messageType: Enum.MessageType)
+			if
+				messageType == Enum.MessageType.MessageWarning
+				and string.find(message, "Infinite yield possible")
+				and not infiniteYieldMessage
+			then
+				infiniteYieldMessage = message
+			end
+		end
+	)
+
+	while not jestDone and not infiniteYieldMessage do
+		task.wait(0.1)
+	end
+
+	watchdogConnection:Disconnect()
+
+	if not jestDone and infiniteYieldMessage then
+		runSuccess = false
+		runValue = "Infinite yield detected, aborting tests: " .. infiniteYieldMessage
+	end
+
+	SnapshotPatch.unpatch(patchState)
+
+	local jestResult
+	if not runSuccess then
+		jestResult = HttpService:JSONEncode(fail(runValue :: any))
+	else
+		jestResult = HttpService:JSONEncode(runValue)
+	end
+
+	local logSuccess, logHistory = pcall(function()
+		return HttpService:JSONEncode(LogService:GetLogHistory())
+	end)
+
+	return jestResult, if logSuccess then logHistory else "[]"
+end
+
+return module

package/plugin/out/shared/snapshot-patch.luau

@@ -0,0 +1,99 @@
+--!strict
+local CoreScriptSyncService = require(script.Parent:FindFirstChild('mock'):FindFirstChild('CoreScriptSyncService'))
+local InstanceResolver = require(script.Parent:FindFirstChild('instance-resolver'))
+
+local module = {}
+
+function module.createMockGetDataModelService(snapshotWrites: { [string]: string })
+	local FileSystemService = require(script.Parent:FindFirstChild('mock'):FindFirstChild('FileSystemService'))(snapshotWrites)
+
+	return function(service: string): any
+		if service == "FileSystemService" then
+			return FileSystemService
+		elseif service == "CoreScriptSyncService" then
+			return CoreScriptSyncService
+		end
+
+		local success, result = pcall(function()
+			local service_ = game:GetService(service)
+			local _ = service_.Name
+			return service_
+		end)
+
+		return if success then result else nil
+	end
+end
+
+export type PatchState = {
+	robloxSharedExports: any,
+	originalGetDataModelService: any,
+	Runtime: any,
+	originalRequireInternalModule: any,
+}
+
+function module.patch(jestModule: ModuleScript, snapshotWrites: { [string]: string }): PatchState?
+	local mockGetDataModelService = module.createMockGetDataModelService(snapshotWrites)
+
+	local robloxSharedInstance = InstanceResolver.findRobloxShared(jestModule)
+	if not robloxSharedInstance then
+		warn("Could not find RobloxShared; snapshot support unavailable")
+		return nil
+	end
+
+	local robloxSharedExports = (require :: any)(robloxSharedInstance)
+	local originalGetDataModelService = robloxSharedExports.getDataModelService
+	robloxSharedExports.getDataModelService = mockGetDataModelService
+
+	local getDataModelServiceChild = robloxSharedInstance:FindFirstChild("getDataModelService")
+
+	local jestRuntimeModule =
+		InstanceResolver.findSiblingPackage(jestModule, "JestRuntime", "jest-runtime")
+	if not jestRuntimeModule then
+		warn("Could not find JestRuntime; snapshot interception unavailable")
+		return {
+			robloxSharedExports = robloxSharedExports,
+			originalGetDataModelService = originalGetDataModelService,
+			Runtime = nil,
+			originalRequireInternalModule = nil,
+		}
+	end
+
+	local Runtime = (require :: any)(jestRuntimeModule)
+	local originalRequireInternalModule = Runtime.requireInternalModule
+
+	Runtime.requireInternalModule = function(self: any, from: any, to: any, ...): any
+		local target = if to ~= nil then to else from
+		if
+			getDataModelServiceChild
+			and typeof(target) == "Instance"
+			and target == getDataModelServiceChild
+		then
+			return mockGetDataModelService
+		end
+
+		return originalRequireInternalModule(self, from, to, ...)
+	end
+
+	return {
+		robloxSharedExports = robloxSharedExports,
+		originalGetDataModelService = originalGetDataModelService,
+		Runtime = Runtime,
+		originalRequireInternalModule = originalRequireInternalModule,
+	}
+end
+
+function module.unpatch(state: PatchState?)
+	if not state then
+		return
+	end
+
+	if state.robloxSharedExports and state.originalGetDataModelService then
+		state.robloxSharedExports.getDataModelService = state.originalGetDataModelService
+	end
+
+	if state.Runtime and state.originalRequireInternalModule then
+		state.Runtime.requireInternalModule = state.originalRequireInternalModule
+	end
+end
+
+return module

package/plugin/plugin.project.json

@@ -1,6 +1,9 @@
 {
 	"name": "JestRobloxRunner",
 	"tree": {
-		"$path": "src"
+		"$path": "src",
+		"shared": {
+			"$path": "out/shared"
+		}
 	}
 }

package/plugin/src/test-in-run-mode.server.luau

@@ -27,21 +27,8 @@ if not loadStringEnabled then
 	return
 end
 
-local TestRunner = require(script.Parent["test-runner"])
-local jestOutput, gameOutput = TestRunner.runTestsAync(script, testArgs.config or {})
-
--- Inject snapshot writes from shared global table into jestOutput
-local snapshotWrites = _G.__snapshotWrites
-if snapshotWrites and next(snapshotWrites) then
-	local ok, decoded = pcall(function()
-		return HttpService:JSONDecode(jestOutput)
-	end)
-
-	if ok and type(decoded) == "table" then
-		decoded._snapshotWrites = snapshotWrites
-		jestOutput = HttpService:JSONEncode(decoded)
-	end
-end
+local Runner = require(script.Parent.shared.runner)
+local jestOutput, gameOutput = Runner.run(script, testArgs.config or {})
 
 StudioTestService:EndTest({
 	jestOutput = jestOutput,

package/plugin/sourcemap.json

@@ -1 +0,0 @@
-{"name":"JestRobloxRunner","className":"Script","filePaths":["src\\init.server.luau","plugin.project.json"],"children":[{"name":"test-in-run-mode","className":"Script","filePaths":["src\\test-in-run-mode.server.luau"]},{"name":"test-runner","className":"ModuleScript","filePaths":["src\\test-runner.luau"]}]}

package/plugin/src/patch/CoreScriptSyncService.luau

@@ -1,19 +0,0 @@
--- Mock CoreScriptSyncService: builds instance-to-path mapping
--- Uses custom getInstancePath that stops at game (excludes DataModel name)
-local function getInstancePath(instance: Instance): string
-	local parts = {}
-	local curr: Instance? = instance
-	while curr and curr ~= game do
-		table.insert(parts, 1, (curr :: Instance).Name)
-		curr = (curr :: Instance).Parent
-	end
-	return table.concat(parts, "/")
-end
-
-local CoreScriptSyncService = {}
-
-function CoreScriptSyncService:GetScriptFilePath(script_: Instance): string
-	return getInstancePath(script_)
-end
-
-return CoreScriptSyncService

package/plugin/src/patch/FileSystemService.luau

@@ -1,27 +0,0 @@
--- Mock FileSystemService: collects snapshot writes in-memory Uses
--- _G.__snapshotWrites so all module load contexts (standard Luau + Jest
--- runtime) share the same table. The test-runner creates this before patching.
-local snapshotWrites: { [string]: string } = _G.__snapshotWrites or {}
-
-local FileSystemService = {}
-
-function FileSystemService:WriteFile(path: string, contents: string)
-	-- Rewrite .snap.lua -> .snap.luau for Rojo compatibility
-	snapshotWrites[string.gsub(path, "%.snap%.lua$", ".snap.luau")] = contents
-end
-
-function FileSystemService:CreateDirectories(_path: string) end
-
-function FileSystemService:Exists(path: string): boolean
-	return snapshotWrites[string.gsub(path, "%.snap%.lua$", ".snap.luau")] ~= nil
-end
-
-function FileSystemService:Remove(path: string)
-	snapshotWrites[string.gsub(path, "%.snap%.lua$", ".snap.luau")] = nil
-end
-
-function FileSystemService:IsRegularFile(path: string): boolean
-	return snapshotWrites[string.gsub(path, "%.snap%.lua$", ".snap.luau")] ~= nil
-end
-
-return FileSystemService

package/plugin/src/patch/getDataModelService.luau

@@ -1,19 +0,0 @@
--- Patched getDataModelService: returns mock services for snapshot support
-local CoreScriptSyncService = require(script.Parent.CoreScriptSyncService)
-local FileSystemService = require(script.Parent.FileSystemService)
-
-return function(service: string)
-	if service == "FileSystemService" then
-		return FileSystemService
-	elseif service == "CoreScriptSyncService" then
-		return CoreScriptSyncService
-	end
-
-	local success, result = pcall(function()
-		local svc = game:GetService(service)
-		local _ = svc.Name
-		return svc
-	end)
-
-	return success and result or nil
-end

package/plugin/src/test-runner.luau

@@ -1,217 +0,0 @@
---!strict
-local HttpService = game:GetService("HttpService")
-local LogService = game:GetService("LogService")
-local ReplicatedStorage = game:GetService("ReplicatedStorage")
-
-local module = {}
-
-function module.findInstance(path: string): Instance
-	local parts = string.split(path, "/")
-
-	local result, current: Instance? = pcall(function(): Instance
-		return game:FindService(parts[1])
-	end)
-	assert(result, `Failed to find service {parts[1]}: {current}`)
-
-	for i = 2, #parts do
-		assert(current, `Failed to find instance at {parts[i]}`)
-		current = current:FindFirstChild(parts[i])
-	end
-
-	assert(current, `Failed to find instance at path {path}: {current}`)
-
-	return current
-end
-
-function module.getJest(config: { jestPath: string? }): ModuleScript
-	local jestPath = config.jestPath
-	if jestPath then
-		local instance = module.findInstance(jestPath)
-		assert(instance, `Failed to find Jest instance at path {jestPath}`)
-		assert(instance:IsA("ModuleScript"), `Instance at path {jestPath} is not a ModuleScript`)
-		return instance
-	end
-
-	local jestInstance = ReplicatedStorage:FindFirstChild("Jest", true)
-	assert(jestInstance, "Failed to find Jest instance in ReplicatedStorage")
-	assert(
-		jestInstance:IsA("ModuleScript"),
-		"Jest instance in ReplicatedStorage is not a ModuleScript"
-	)
-	return jestInstance
-end
-
--- Find RobloxShared relative to Jest module
-local function findRobloxShared(jestModule: ModuleScript): Instance?
-	local parent = jestModule.Parent
-	if parent then
-		local found = parent:FindFirstChild("RobloxShared")
-			or parent:FindFirstChild("jest-roblox-shared")
-		if found then
-			return found
-		end
-
-		if parent.Parent then
-			found = parent.Parent:FindFirstChild("RobloxShared")
-				or parent.Parent:FindFirstChild("jest-roblox-shared")
-			if found then
-				return found
-			end
-		end
-	end
-
-	return game:FindFirstChild("RobloxShared", true)
-end
-
--- Replace a child ModuleScript inside RobloxShared with a patched clone
-local function replaceChild(parent: Instance, name: string, patchSource: ModuleScript)
-	local original = parent:FindFirstChild(name)
-	if original then
-		original:Destroy()
-	end
-
-	local clone = patchSource:Clone()
-	clone.Name = name
-	clone.Parent = parent
-end
-
--- Patch RobloxShared by replacing ModuleScript children
-local function patchRobloxShared(jestModule: ModuleScript, patchFolder: Instance): boolean
-	local robloxShared = findRobloxShared(jestModule)
-	if not robloxShared then
-		warn("[jest-roblox-cli] Could not find RobloxShared; snapshot support disabled")
-		return false
-	end
-
-	local patchGetDataModelService = patchFolder:FindFirstChild("getDataModelService")
-	local patchFileSystemService = patchFolder:FindFirstChild("FileSystemService")
-	local patchCoreScriptSyncService = patchFolder:FindFirstChild("CoreScriptSyncService")
-
-	if not (patchGetDataModelService and patchFileSystemService and patchCoreScriptSyncService) then
-		warn("[jest-roblox-cli] Missing patch modules; snapshot support disabled")
-		return false
-	end
-
-	-- Replace children inside RobloxShared
-	replaceChild(robloxShared, "FileSystemService", patchFileSystemService :: ModuleScript)
-	replaceChild(robloxShared, "CoreScriptSyncService", patchCoreScriptSyncService :: ModuleScript)
-	replaceChild(robloxShared, "getDataModelService", patchGetDataModelService :: ModuleScript)
-
-	warn("[jest-roblox-cli] Patched RobloxShared at:", robloxShared:GetFullName())
-	return true
-end
-
-function module.runTestsAync(
-	callingScript: LuaSourceContainer,
-	config: {
-		[string]: any,
-	}
-): (string, string)
-	warn("Running tests with config:", config)
-	local t0 = os.clock()
-	local timingEnabled = config._timing
-
-	local t_findJest0 = os.clock()
-	local findSuccess, findValue = pcall(function(): ModuleScript
-		return module.getJest(config)
-	end)
-	local t_findJest = os.clock()
-
-	if not findSuccess then
-		local logSuccess, logHistory = pcall(function(): string
-			return HttpService:JSONEncode(LogService:GetLogHistory())
-		end)
-
-		return HttpService:JSONEncode({ success = false, err = findValue }),
-			if logSuccess then logHistory else "[]"
-	end
-
-	-- Snapshot support: create shared table BEFORE patching so all module
-	-- load contexts (standard Luau + Jest runtime) reference the same table
-	_G.__snapshotWrites = {}
-
-	local t_patchSnapshot0 = os.clock()
-	local patchFolder = (callingScript :: any).Parent.patch
-	if patchFolder then
-		patchRobloxShared(findValue, patchFolder)
-	end
-	local t_patchSnapshot = os.clock()
-
-	local t_requireJest0 = os.clock()
-	local Jest = (require :: any)(findValue)
-	local t_requireJest = os.clock()
-
-	local function run(): string
-		LogService:ClearOutput()
-
-		local t_resolveProjects0 = os.clock()
-		local projects = {}
-
-		assert(
-			config.projects and #config.projects > 0,
-			"No projects configured. Set 'projects' in jest.config.ts or pass --projects."
-		)
-
-		for _, projectPath in config.projects do
-			table.insert(projects, module.findInstance(projectPath))
-		end
-
-		config.projects = {}
-		local t_resolveProjects = os.clock()
-
-		local t_resolveSetupFiles0 = os.clock()
-		if config.setupFiles and #config.setupFiles > 0 then
-			local resolved = {}
-
-			for _, setupPath in config.setupFiles do
-				table.insert(resolved, module.findInstance(setupPath))
-			end
-
-			config.setupFiles = resolved
-		end
-		local t_resolveSetupFiles = os.clock()
-
-		config._timing = nil
-
-		local t_jestRunCLI0 = os.clock()
-		local jestResult = Jest.runCLI(callingScript, config, projects):expect()
-		local t_jestRunCLI = os.clock()
-
-		local result: { [string]: any } = {
-			success = true,
-			value = jestResult,
-		}
-
-		if timingEnabled then
-			result._timing = {
-				configDecode = 0,
-				findJest = t_findJest - t_findJest0,
-				patchSnapshot = t_patchSnapshot - t_patchSnapshot0,
-				requireJest = t_requireJest - t_requireJest0,
-				resolveProjects = t_resolveProjects - t_resolveProjects0,
-				resolveSetupFiles = t_resolveSetupFiles - t_resolveSetupFiles0,
-				jestRunCLI = t_jestRunCLI - t_jestRunCLI0,
-				total = os.clock() - t0,
-			}
-		end
-
-		return HttpService:JSONEncode(result)
-	end
-
-	local runSuccess, runValue = pcall(run)
-
-	local jestResult: string
-	if not runSuccess then
-		jestResult = HttpService:JSONEncode({ success = false, err = runValue })
-	else
-		jestResult = runValue
-	end
-
-	local logSuccess, logHistory = pcall(function(): string
-		return HttpService:JSONEncode(LogService:GetLogHistory())
-	end)
-
-	return jestResult, if logSuccess then logHistory else "[]"
-end
-
-return module