@isentinel/jest-roblox 0.0.1

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@isentinel/jest-roblox",
+  "version": "0.0.1",
+  "description": "Jest-compatible CLI for running roblox-ts tests via Roblox Open Cloud",
+  "keywords": [
+    "jest",
+    "roblox",
+    "rbxts",
+    "testing",
+    "cli"
+  ],
+  "license": "MIT",
+  "author": "Christopher Buss <christopher.buss@pm.me> (https://github.com/christopher-buss)",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./cli": "./dist/cli.mjs",
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.mts",
+  "bin": {
+    "jest-roblox": "./bin/jest-roblox.js"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "plugin",
+    "!dist/**/*.map",
+    "!dist/**/*.tsbuildinfo"
+  ],
+  "dependencies": {
+    "arktype": "2.1.29",
+    "highlight.js": "11.11.1",
+    "jiti": "2.6.1",
+    "tinyrainbow": "3.0.3",
+    "ws": "8.18.0"
+  },
+  "devDependencies": {
+    "@isentinel/eslint-config": "4.7.6",
+    "@rbxts/jest": "3.13.3-ts.1",
+    "@rbxts/types": "1.0.896",
+    "@types/node": "24.10.4",
+    "@types/ws": "8.5.13",
+    "better-typescript-lib": "2.12.0",
+    "bumpp": "10.4.1",
+    "publint": "0.3.15",
+    "tsdown": "0.20.1",
+    "type-fest": "5.2.0",
+    "vitest": "4.0.16"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "nx": {
+    "tags": [
+      "scope:tooling",
+      "type:cli"
+    ],
+    "projectType": "application",
+    "targets": {
+      "lint": {
+        "command": "eslint",
+        "hasTypeAwareRules": true
+      },
+      "test": {
+        "command": "vitest run",
+        "options": {
+          "cwd": "tools/jest-roblox-cli"
+        }
+      }
+    }
+  },
+  "scripts": {
+    "build": "tsdown",
+    "build:plugin": "rojo build plugin/plugin.project.json -o plugin/JestRobloxRunner.rbxm",
+    "release": "bumpp",
+    "watch": "tsdown --watch"
+  }
+}

package/plugin/plugin.project.json

@@ -0,0 +1,6 @@
+{
+	"name": "JestRobloxRunner",
+	"tree": {
+		"$path": "src"
+	}
+}

package/plugin/sourcemap.json

@@ -0,0 +1 @@
+{"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/init.server.luau

@@ -0,0 +1,193 @@
+--!strict
+local HttpService = game:GetService("HttpService")
+local ReplicatedStorage = game:GetService("ReplicatedStorage")
+local RunService = game:GetService("RunService")
+local StudioTestService = game:GetService("StudioTestService")
+
+if RunService:IsRunning() then
+	return
+end
+
+local WEBSOCKET_URL = "ws://localhost:3001"
+local RECONNECT_DELAY = 5
+
+local IsDebug = ReplicatedStorage:GetAttribute("JEST_ROBLOX_DEBUG") == true
+ReplicatedStorage:GetAttributeChangedSignal("JEST_ROBLOX_DEBUG"):Connect(function(): ()
+	IsDebug = ReplicatedStorage:GetAttribute("JEST_ROBLOX_DEBUG") == true
+end)
+
+local toolbar = plugin:CreateToolbar("Jest-Roblox")
+local startButton =
+	toolbar:CreateButton("Jest Roblox", "Connect to jest-roblox CLI", "rbxassetid://4458901886")
+local stopButton =
+	toolbar:CreateButton("Stop", "Disconnect from jest-roblox CLI", "rbxassetid://4458901886")
+startButton.Enabled = false
+
+local autoReconnect = true
+local ws: WebStreamClient? = nil
+local connections: { RBXScriptConnection } = {}
+
+local _print = print
+local _warn = warn
+
+local function print(...: any): ()
+	if IsDebug then
+		_print("[jest-roblox]", ...)
+	end
+end
+
+local function warn(...: any): ()
+	if IsDebug then
+		_warn("[jest-roblox]", ...)
+	end
+end
+
+local function clearConnections(): ()
+	for _, connection in connections do
+		connection:Disconnect()
+	end
+
+	table.clear(connections)
+end
+
+local function disconnect(): ()
+	clearConnections()
+
+	if ws then
+		pcall(function(): ()
+			assert(ws, "Luau")
+			ws:Close()
+		end)
+		ws = nil
+	end
+end
+
+local function connect(): ()
+	clearConnections()
+
+	print("[jest-roblox] Connecting to " .. WEBSOCKET_URL .. "...")
+
+	local success, socket = pcall(function(): WebStreamClient
+		return HttpService:CreateWebStreamClient(
+			Enum.WebStreamClientType.WebSocket,
+			{ Url = WEBSOCKET_URL }
+		)
+	end)
+
+	if not success then
+		warn("[jest-roblox] Failed to connect: " .. tostring(socket))
+		return
+	end
+
+	ws = socket
+	assert(ws, "Luau")
+
+	table.insert(
+		connections,
+		ws.MessageReceived:Connect(function(rawMessage: string): ()
+			assert(ws, "Luau")
+
+			local ok, message = pcall(function(): any
+				return HttpService:JSONDecode(rawMessage)
+			end)
+			if not ok then
+				warn("[jest-roblox] Failed to decode message:", rawMessage)
+				return
+			end
+
+			if message.action == "run_tests" then
+				print("[jest-roblox] Running tests via StudioTestService...")
+
+				local runOk, result = pcall(function(): any
+					return StudioTestService:ExecuteRunModeAsync({
+						test = true,
+						config = message.config,
+					})
+				end)
+
+				if not runOk then
+					warn("[jest-roblox] ExecuteRunModeAsync failed: " .. tostring(result))
+					ws:Send(HttpService:JSONEncode({
+						type = "results",
+						request_id = message.request_id,
+						jestOutput = HttpService:JSONEncode({
+							success = false,
+							err = tostring(result),
+						}),
+						gameOutput = "[]",
+					}))
+					return
+				end
+
+				ws:Send(HttpService:JSONEncode({
+					type = "results",
+					request_id = message.request_id,
+					jestOutput = result.jestOutput or HttpService:JSONEncode({
+						success = false,
+						err = "No jestOutput in run-mode result",
+					}),
+					gameOutput = result.gameOutput or "[]",
+				}))
+
+				print("[jest-roblox] Results sent")
+			end
+		end)
+	)
+
+	local opened = ws.Opened:Once(function(): ()
+		print("[jest-roblox] Connected to CLI")
+	end)
+	table.insert(connections, opened)
+
+	local err = ws.Error:Once(function(_statusCode: number, errorMessage: string): ()
+		warn("[jest-roblox] Connection error: " .. errorMessage)
+	end)
+	table.insert(connections, err)
+
+	local closed = ws.Closed:Once(function(): ()
+		ws = nil
+		if autoReconnect then
+			print("[jest-roblox] Disconnected, reconnecting in " .. RECONNECT_DELAY .. "s...")
+			local thread = task.delay(RECONNECT_DELAY, function(): ()
+				connect()
+			end)
+			table.insert(connections :: any, {
+				Disconnect = function(): ()
+					if coroutine.running() then
+						local wasCancelled = pcall(function()
+							task.cancel(thread)
+						end)
+
+						if not wasCancelled then
+							task.defer(function()
+								task.cancel(thread)
+							end)
+						end
+					end
+				end,
+			})
+		end
+	end)
+	table.insert(connections, closed)
+end
+
+startButton.Click:Connect(function(): ()
+	startButton.Enabled = false
+	stopButton.Enabled = true
+	autoReconnect = true
+	connect()
+end)
+
+stopButton.Click:Connect(function(): ()
+	stopButton.Enabled = false
+	startButton.Enabled = true
+	autoReconnect = false
+	disconnect()
+end)
+
+plugin.Unloading:Connect(function(): ()
+	autoReconnect = false
+	disconnect()
+end)
+
+task.defer(connect)

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

@@ -0,0 +1,36 @@
+--!strict
+local HttpService = game:GetService("HttpService")
+local RunService = game:GetService("RunService")
+local StudioTestService = game:GetService("StudioTestService")
+
+if not RunService:IsRunning() then
+	return
+end
+
+local testArgs = StudioTestService:GetTestArgs()
+if not testArgs or not testArgs.test then
+	return
+end
+
+local loadStringEnabled = pcall(function()
+	loadstring("return true")
+end)
+
+if not loadStringEnabled then
+	StudioTestService:EndTest({
+		jestOutput = HttpService:JSONEncode({
+			success = false,
+			err = "LoadString must be enabled in ServerScriptService to run tests",
+		}),
+		gameOutput = "[]",
+	})
+	return
+end
+
+local TestRunner = require(script.Parent["test-runner"])
+local jestOutput, gameOutput = TestRunner.runTestsAync(script, testArgs.config or {})
+
+StudioTestService:EndTest({
+	jestOutput = jestOutput,
+	gameOutput = gameOutput,
+})

package/plugin/src/test-runner.luau

@@ -0,0 +1,145 @@
+--!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
+
+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
+
+	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,
+				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