@quenty/promisemaid 5.19.0 → 5.21.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.21.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/promisemaid@5.20.0...@quenty/promisemaid@5.21.0) (2026-07-23)
+
+### Features
+
+- Add promise tests ([ff0a2a6](https://github.com/Quenty/NevermoreEngine/commit/ff0a2a6f72bcd63dbecf1af0a57870bac62c77ca))
+
+# [5.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/promisemaid@5.19.0...@quenty/promisemaid@5.20.0) (2026-07-18)
+
+**Note:** Version bump only for package @quenty/promisemaid
+
 # [5.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/promisemaid@5.18.1...@quenty/promisemaid@5.19.0) (2026-07-18)
 
 **Note:** Version bump only for package @quenty/promisemaid

package/deploy.nevermore.json

@@ -0,0 +1,10 @@
+{
+  "targets": {
+    "test": {
+      "universeId": 9716264427,
+      "placeId": 76943796490766,
+      "project": "test/default.project.json",
+      "scriptTemplate": "test/scripts/Server/ServerMain.server.lua"
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/promisemaid",
-  "version": "5.19.0",
+  "version": "5.21.0",
   "description": "Utility methods around promises and maids",
   "keywords": [
     "Roblox",
@@ -29,11 +29,13 @@
   ],
   "dependencies": {
     "@quenty/loader": "10.11.0",
-    "@quenty/maid": "3.9.0",
-    "@quenty/promise": "10.19.0"
+    "@quenty/maid": "3.11.0",
+    "@quenty/nevermore-test-runner": "1.5.0",
+    "@quenty/promise": "10.21.0",
+    "@quentystudios/jest-lua": "3.10.0-quenty.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "cbbb89635bfdcbf32f26a40422ac736292917cca"
+  "gitHead": "1de37218a2bedb8e3f8614a2e09bba9eddc812da"
 }

package/src/Shared/PromiseMaidUtils.spec.lua

@@ -0,0 +1,96 @@
+--!nonstrict
+--[[
+	@class PromiseMaidUtils.spec.lua
+]]
+
+local require = require(script.Parent.loader).load(script)
+
+local Jest = require("Jest")
+local Promise = require("Promise")
+local PromiseMaidUtils = require("PromiseMaidUtils")
+
+local describe = Jest.Globals.describe
+local expect = Jest.Globals.expect
+local it = Jest.Globals.it
+
+describe("PromiseMaidUtils.whilePromise", function()
+	it("invokes the callback with a maid while the promise is pending", function()
+		local promise = Promise.new()
+		local received = { maid = nil }
+
+		PromiseMaidUtils.whilePromise(promise, function(maid)
+			received.maid = maid
+		end)
+
+		expect(received.maid).never.toEqual(nil)
+
+		promise:Resolve()
+	end)
+
+	it("cleans up the maid when the promise settles", function()
+		local promise = Promise.new()
+		local cleaned = { value = false }
+
+		PromiseMaidUtils.whilePromise(promise, function(maid)
+			maid:GiveTask(function()
+				cleaned.value = true
+			end)
+		end)
+
+		expect(cleaned.value).toEqual(false)
+
+		promise:Resolve()
+		expect(cleaned.value).toEqual(true)
+	end)
+
+	it("cleans up the maid when the promise rejects", function()
+		local promise = Promise.new()
+		promise:Catch(function() end)
+		local cleaned = { value = false }
+
+		PromiseMaidUtils.whilePromise(promise, function(maid)
+			maid:GiveTask(function()
+				cleaned.value = true
+			end)
+		end)
+
+		promise:Reject("boom")
+		expect(cleaned.value).toEqual(true)
+	end)
+
+	it("does not invoke the callback when the promise is already settled", function()
+		local called = { value = false }
+
+		PromiseMaidUtils.whilePromise(Promise.resolved(), function()
+			called.value = true
+		end)
+
+		expect(called.value).toEqual(false)
+	end)
+
+	it("cleans up immediately when the callback resolves the promise synchronously", function()
+		local promise = Promise.new()
+		local cleaned = { value = false }
+
+		PromiseMaidUtils.whilePromise(promise, function(maid)
+			maid:GiveTask(function()
+				cleaned.value = true
+			end)
+			promise:Resolve()
+		end)
+
+		expect(cleaned.value).toEqual(true)
+	end)
+
+	it("throws when given something that is not a promise", function()
+		expect(function()
+			PromiseMaidUtils.whilePromise(nil, function() end)
+		end).toThrow()
+	end)
+
+	it("throws when the callback is not a function", function()
+		expect(function()
+			PromiseMaidUtils.whilePromise(Promise.new(), nil)
+		end).toThrow()
+	end)
+end)

package/src/jest.config.lua

@@ -0,0 +1,3 @@
+return {
+	testMatch = { "**/*.spec" },
+}

package/test/default.project.json

@@ -0,0 +1,25 @@
+{
+  "name": "PromiseMaidTest",
+  "globIgnorePaths": [
+    "**/.package-lock.json",
+    "**/.pnpm",
+    "**/.pnpm-workspace-state-v1.json",
+    "**/.modules.yaml",
+    "**/.ignored",
+    "**/.ignored_*"
+  ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "$properties": {
+        "LoadStringEnabled": true
+      },
+      "promisemaid": {
+        "$path": ".."
+      },
+      "Script": {
+        "$path": "scripts/Server"
+      }
+    }
+  }
+}

package/test/scripts/Server/ServerMain.server.lua

@@ -0,0 +1,14 @@
+--!nonstrict
+--[[
+	@class ServerMain
+]]
+
+local ServerScriptService = game:GetService("ServerScriptService")
+
+local root = ServerScriptService.promisemaid
+local loader = root:FindFirstChild("LoaderUtils", true).Parent
+local require = require(loader).bootstrapGame(root)
+
+local NevermoreTestRunnerUtils = require("NevermoreTestRunnerUtils")
+
+NevermoreTestRunnerUtils.runTestsIfNeededAsync(root)