@quenty/rx 3.7.0 → 3.8.0

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rx@3.7.1...@quenty/rx@3.8.0) (2022-01-17)
+
+
+### Features
+
+* Add Rx.toPromise(observable, cancelToken) ([1237fb4](https://github.com/Quenty/NevermoreEngine/commit/1237fb4155bb9bcca94ffd5f618fcea60026f694))
+* Add stack tracing to subscription if desired, and check pending state ([6cf8bc6](https://github.com/Quenty/NevermoreEngine/commit/6cf8bc6ab5916a0a2c237a2552fd9901dca1a756))
+
+
+
+
+
+## [3.7.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rx@3.7.0...@quenty/rx@3.7.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/rx
+
+
+
+
+
 # [3.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rx@3.6.0...@quenty/rx@3.7.0) (2022-01-07)
 
 **Note:** Version bump only for package @quenty/rx

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/rx",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "Quenty's reactive library for Roblox",
   "keywords": [
     "Roblox",
@@ -27,16 +27,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.3.0",
-    "@quenty/maid": "^2.0.2",
-    "@quenty/promise": "^3.5.0",
+    "@quenty/loader": "^3.4.0",
+    "@quenty/maid": "^2.1.0",
+    "@quenty/promise": "^3.6.0",
     "@quenty/signal": "^2.1.0",
     "@quenty/symbol": "^2.0.1",
     "@quenty/table": "^2.1.1",
-    "@quenty/throttle": "^3.4.0"
+    "@quenty/throttle": "^3.5.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5a3f3fb6c908fd3874f5ceacc70b404780275119"
+  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
 }

package/src/Shared/Observable.lua

@@ -15,9 +15,13 @@
 		sub:Complete() -- ends stream
 	end)
 
-	observable:Subscribe() --> Connected
-	observable:Subscribe() --> Connected
-	observable:Subscribe() --> Connected
+	local sub1 = observable:Subscribe() --> Connected
+	local sub2 = observable:Subscribe() --> Connected
+	local sub3 = observable:Subscribe() --> Connected
+
+	sub1:Destroy()
+	sub2:Destroy()
+	sub3:Destroy()
 	```
 
 	Note that emitted values may be observed like this

package/src/Shared/Rx.lua

@@ -118,6 +118,37 @@ function Rx.from(item)
 	end
 end
 
+--[=[
+	Converts a promise to an observable.
+	@param observable Observable<T>
+	@param cancelToken CancelToken?
+	@return Promise<T>
+]=]
+function Rx.toPromise(observable, cancelToken)
+	local maid = Maid.new()
+
+	local promise = Promise.new(function(resolve, reject)
+		if cancelToken then
+			if cancelToken:IsCancelled() then
+				reject()
+				return
+			end
+
+			maid:GiveTask(cancelToken.Cancelled:Connect(function()
+				reject()
+			end))
+		end
+
+		maid:GiveTask(observable:Subscribe(resolve, reject, reject))
+	end)
+
+	promise:Finally(function()
+		maid:DoCleaning()
+	end)
+
+	return promise
+end
+
 --[=[
 	https://rxjs-dev.firebaseapp.com/api/operators/merge
 
@@ -217,6 +248,8 @@ function Rx.tap(onFire, onError, onComplete)
 	assert(type(onComplete) == "function" or onComplete == nil, "Bad onComplete")
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			return source:Subscribe(
 				function(...)
@@ -251,6 +284,8 @@ end
 ]=]
 function Rx.start(callback)
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			sub:Fire(callback())
 
@@ -268,6 +303,8 @@ end
 function Rx.startFrom(callback)
 	assert(type(callback) == "function", "Bad callback")
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			for _, value in pairs(callback()) do
 				sub:Fire(value)
@@ -289,6 +326,8 @@ function Rx.startWith(values)
 	assert(type(values) == "table", "Bad values")
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			for _, item in pairs(values) do
 				sub:Fire(item)
@@ -313,12 +352,14 @@ end
 ]=]
 function Rx.defaultsTo(value)
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 
 			local fired = false
 
-			sub:GiveTask(source:Subscribe(
+			maid:GiveTask(source:Subscribe(
 				function(...)
 					fired = true
 					sub:Fire(...)
@@ -361,6 +402,8 @@ Rx.defaultsToNil = Rx.defaultsTo(nil)
 ]=]
 function Rx.endWith(values)
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 
@@ -405,6 +448,8 @@ function Rx.where(predicate)
 	assert(type(predicate) == "function", "Bad predicate callback")
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			return source:Subscribe(
 				function(...)
@@ -432,6 +477,8 @@ end
 ]=]
 function Rx.distinct()
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local last = UNSET_VALUE
 
@@ -459,6 +506,8 @@ end
 function Rx.mapTo(...)
 	local args = table.pack(...)
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			return source:Subscribe(function()
 				sub:Fire(table.unpack(args, 1, args.n))
@@ -487,6 +536,8 @@ function Rx.map(project)
 	assert(type(project) == "function", "Bad project callback")
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			return source:Subscribe(function(...)
 				sub:Fire(project(...))
@@ -514,6 +565,8 @@ end
 ]=]
 function Rx.mergeAll()
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 
@@ -583,22 +636,31 @@ end
 ]=]
 function Rx.switchAll()
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local outerMaid = Maid.new()
 			local topComplete = false
 			local insideComplete = false
 			local currentInside = nil
 
-			outerMaid:GiveTask(source:Subscribe(
+			outerMaid:GiveTask(function()
+				-- Ensure inner subscription is disconnected first. This prevents
+				-- the inner sub from firing while the outer is subscribed,
+				-- throwing a warning.
+				outerMaid._innerSub = nil
+				outerMaid._outerSuber = nil
+			end)
+
+			outerMaid._outerSuber = source:Subscribe(
 				function(observable)
 					assert(Observable.isObservable(observable), "Bad observable")
 
 					insideComplete = false
 					currentInside = observable
-					outerMaid._current = nil
+					outerMaid._innerSub = nil
 
-					local maid = Maid.new()
-					maid:GiveTask(observable:Subscribe(
+					outerMaid._innerSub = observable:Subscribe(
 						function(...)
 							sub:Fire(...)
 						end, -- Merge each inner observable
@@ -612,12 +674,10 @@ function Rx.switchAll()
 								insideComplete = true
 								if insideComplete and topComplete then
 									sub:Complete()
-									outerMaid:DoCleaning()
+									outerMaid:DoCleaning() -- Paranoid ensure cleanup.
 								end
 							end
-						end))
-
-					outerMaid._current = maid
+						end)
 				end,
 				function(...)
 					sub:Fail(...) -- Also reflect failures up to the top!
@@ -627,9 +687,9 @@ function Rx.switchAll()
 					topComplete = true
 					if insideComplete and topComplete then
 						sub:Complete()
-						outerMaid:DoCleaning()
+						outerMaid:DoCleaning() -- Paranoid ensure cleanup
 					end
-				end))
+				end)
 
 			return outerMaid
 		end)
@@ -649,6 +709,8 @@ function Rx.flatMap(project, resultSelector)
 	assert(type(project) == "function", "Bad project")
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 
@@ -722,6 +784,8 @@ function Rx.takeUntil(notifier)
 	assert(Observable.isObservable(notifier))
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 			local cancelled = false
@@ -813,6 +877,8 @@ function Rx.finalize(finalizerCallback)
 	assert(type(finalizerCallback) == "function", "Bad finalizerCallback")
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 
@@ -836,6 +902,8 @@ end
 ]=]
 function Rx.combineLatestAll()
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local observables = {}
 			local maid = Maid.new()
@@ -895,6 +963,8 @@ function Rx.catchError(callback)
 	assert(type(callback) == "function", "Bad callback")
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 
@@ -1058,6 +1128,8 @@ function Rx.take(number)
 	assert(number >= 0, "Bad number")
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			if number == 0 then
 				sub:Complete()
@@ -1135,6 +1207,8 @@ function Rx.withLatestFrom(inputObservables)
 	end
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 
@@ -1174,6 +1248,8 @@ function Rx.scan(accumulator, seed)
 	assert(type(accumulator) == "function", "Bad accumulator")
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local current = seed
 
@@ -1203,6 +1279,8 @@ function Rx.throttleTime(duration, throttleConfig)
 	assert(type(throttleConfig) == "table" or throttleConfig == nil, "Bad throttleConfig")
 
 	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 

package/src/Shared/Rx.spec.lua

@@ -12,11 +12,12 @@ return function()
 		local externalResult
 
 		it("should execute immediately", function()
-			observe:Subscribe(function(result)
+			local sub = observe:Subscribe(function(result)
 				externalResult = result
 			end)
 
 			expect(externalResult).to.be.a("table")
+			sub:Destroy()
 		end)
 	end)
 
@@ -25,12 +26,13 @@ return function()
 		local externalResult
 
 		it("should execute immediately", function()
-			observe:Subscribe(function(result)
+			local sub = observe:Subscribe(function(result)
 				externalResult = result
 			end)
 
 			expect(externalResult).to.be.a("table")
 			expect(externalResult.value).to.equal(5)
+			sub:Destroy()
 		end)
 	end)
 
@@ -39,12 +41,13 @@ return function()
 		local externalResult
 
 		it("should execute immediately", function()
-			observe:Subscribe(function(result)
+			local sub = observe:Subscribe(function(result)
 				externalResult = result
 			end)
 
 			expect(externalResult).to.be.a("table")
 			expect(externalResult.value).to.equal(5)
+			sub:Destroy()
 		end)
 	end)
 end

package/src/Shared/Subscription.lua

@@ -18,6 +18,8 @@ local require = require(script.Parent.loader).load(script)
 
 local MaidTaskUtils = require("MaidTaskUtils")
 
+local ENABLE_STACK_TRACING = false
+
 local Subscription = {}
 Subscription.ClassName = "Subscription"
 Subscription.__index = Subscription
@@ -45,6 +47,7 @@ function Subscription.new(fireCallback, failCallback, completeCallback, onSubscr
 
 	return setmetatable({
 		_state = stateTypes.PENDING;
+		_source = ENABLE_STACK_TRACING and debug.traceback() or "";
 		_fireCallback = fireCallback;
 		_failCallback = failCallback;
 		_completeCallback = completeCallback;
@@ -58,10 +61,17 @@ end
 	@param ... any
 ]=]
 function Subscription:Fire(...)
-	if self._state == stateTypes.PENDING and self._fireCallback then
-		self._fireCallback(...)
+	if self._state == stateTypes.PENDING then
+		if self._fireCallback then
+			self._fireCallback(...)
+		end
 	elseif self._state == stateTypes.CANCELLED then
 		warn("[Subscription.Fire] - We are cancelled, but events are still being pushed")
+
+		if ENABLE_STACK_TRACING then
+			print(debug.traceback())
+			print(self._source)
+		end
 	end
 end
 
@@ -153,6 +163,14 @@ function Subscription:Complete()
 	self:_doCleanup()
 end
 
+--[=[
+	Returns whether the subscription is pending.
+	@return boolean
+]=]
+function Subscription:IsPending()
+	return self._state == stateTypes.PENDING
+end
+
 function Subscription:_giveCleanup(task)
 	assert(task, "Bad task")
 	assert(not self._cleanupTask, "Already have _cleanupTask")