@quenty/gameproductservice 3.3.1 → 3.4.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/gameproductservice@3.3.1...@quenty/gameproductservice@3.4.0) (2022-07-31)
+
+
+### Features
+
+* API calls in GameProductService support passids or string keys to retrieve the passes. ([083170e](https://github.com/Quenty/NevermoreEngine/commit/083170e92bf2e71628edd17bf526d4b0936fe1a9))
+
+
+
+
+
 ## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/gameproductservice@3.3.0...@quenty/gameproductservice@3.3.1) (2022-07-19)
 
 **Note:** Version bump only for package @quenty/gameproductservice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/gameproductservice",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "description": "Generalized monetization system for handling products and purchases correctly.",
   "keywords": [
     "Roblox",
@@ -27,22 +27,22 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/attributeutils": "^6.1.0",
-    "@quenty/baseobject": "^5.0.0",
-    "@quenty/binder": "^6.2.0",
-    "@quenty/gameconfig": "^3.3.1",
+    "@quenty/attributeutils": "^6.2.0",
+    "@quenty/baseobject": "^5.1.0",
+    "@quenty/binder": "^6.3.0",
+    "@quenty/gameconfig": "^3.4.0",
     "@quenty/loader": "^5.0.0",
-    "@quenty/maid": "^2.3.0",
-    "@quenty/marketplaceutils": "^5.0.0",
-    "@quenty/playerbinder": "^6.2.0",
-    "@quenty/promise": "^5.0.0",
-    "@quenty/remoting": "^5.1.0",
-    "@quenty/rx": "^5.1.0",
-    "@quenty/rxbinderutils": "^6.2.0",
-    "@quenty/servicebag": "^5.0.0",
+    "@quenty/maid": "^2.4.0",
+    "@quenty/marketplaceutils": "^5.1.0",
+    "@quenty/playerbinder": "^6.3.0",
+    "@quenty/promise": "^5.1.0",
+    "@quenty/remoting": "^5.2.0",
+    "@quenty/rx": "^5.2.0",
+    "@quenty/rxbinderutils": "^6.3.0",
+    "@quenty/servicebag": "^5.1.0",
     "@quenty/signal": "^2.2.0",
-    "@quenty/statestack": "^6.1.0",
+    "@quenty/statestack": "^6.2.0",
     "@quenty/table": "^3.1.0"
   },
-  "gitHead": "67bd6a4f1957c3727c208d23c564c5757de6d7c8"
+  "gitHead": "e31b3a35aa475bb5699a24898a8639e107165b36"
 }

package/src/Client/GameProductServiceClient.lua

@@ -12,8 +12,6 @@ local GameProductServiceBase = require("GameProductServiceBase")
 local Signal = require("Signal")
 local GameConfigAssetTypes = require("GameConfigAssetTypes")
 local Promise = require("Promise")
-local RxStateStackUtils = require("RxStateStackUtils")
-local Rx = require("Rx")
 
 local GameProductServiceClient = GameProductServiceBase.new()
 
@@ -72,7 +70,7 @@ end
 function GameProductServiceClient:PromiseLocalPlayerOwnsPass(passIdOrKey)
 	assert(type(passIdOrKey) == "number" or type(passIdOrKey) == "string", "Bad passIdOrKey")
 
-	local passId = self:_toAssetId(GameConfigAssetTypes.PASS, passIdOrKey)
+	local passId = self:ToAssetId(GameConfigAssetTypes.PASS, passIdOrKey)
 	if not passId then
 		return Promise.rejected(("No asset with key %q"):format(tostring(passIdOrKey)))
 	end
@@ -92,29 +90,6 @@ end
 function GameProductServiceBase:ObserveLocalPlayerOwnsPass(passIdOrKey)
 	assert(type(passIdOrKey) == "number" or type(passIdOrKey) == "string", "Bad passIdOrKey")
 
-	if type(passIdOrKey) == "string" then
-		local picker = self._gameConfigService:GetConfigPicker()
-		return picker:ObserveActiveAssetOfAssetIdBrio()
-			:Pipe({
-				RxStateStackUtils.topOfStack();
-				Rx.switchMap(function(asset)
-					if asset then
-						return asset:ObserveAssetId()
-					else
-						return Rx.of(nil)
-					end
-				end);
-				Rx.switchMap(function(assetId)
-					if assetId then
-						return self:ObservePlayerOwnsPass(Players.LocalPlayer, passIdOrKey)
-					else
-						warn(("No asset with key %q"):format(tostring(passIdOrKey)))
-						return Rx.of(false)
-					end
-				end)
-			})
-	end
-
 	return self:ObservePlayerOwnsPass(Players.LocalPlayer, passIdOrKey)
 end
 
@@ -141,7 +116,7 @@ function GameProductServiceClient:HasPurchasedProductThisSession(productIdOrKey)
 	assert(self._serviceBag, "Not initialized")
 	assert(type(productIdOrKey) == "number" or type(productIdOrKey) == "string", "productIdOrKey")
 
-	local productId = self:_toAssetId(GameConfigAssetTypes.PRODUCT, productIdOrKey)
+	local productId = self:ToAssetId(GameConfigAssetTypes.PRODUCT, productIdOrKey)
 	if not productId then
 		warn(("No asset with key %q"):format(tostring(productIdOrKey)))
 		return false
@@ -155,7 +130,7 @@ function GameProductServiceClient:HasPurchasedProductThisSession(productIdOrKey)
 end
 
 function GameProductServiceClient:PromisePurchasedOrPrompt(passIdOrKey)
-	local gamepassId = self:_toAssetId(GameConfigAssetTypes.PASS, passIdOrKey)
+	local gamepassId = self:ToAssetId(GameConfigAssetTypes.PASS, passIdOrKey)
 	if not gamepassId then
 		return Promise.rejected(("No asset with key %q"):format(tostring(passIdOrKey)))
 	end
@@ -174,12 +149,12 @@ function GameProductServiceClient:PromiseGamepassOrProductUnlockOrPrompt(passIdO
 	assert(passIdOrKey, "Bad passIdOrKey")
 	assert(productIdOrKey, "Bad productIdOrKey")
 
-	local productId = self:_toAssetId(GameConfigAssetTypes.PRODUCT, productIdOrKey)
+	local productId = self:ToAssetId(GameConfigAssetTypes.PRODUCT, productIdOrKey)
 	if not productId then
 		return Promise.rejected(("No asset with key %q"):format(tostring(productIdOrKey)))
 	end
 
-	local gamepassId = self:_toAssetId(GameConfigAssetTypes.PASS, passIdOrKey)
+	local gamepassId = self:ToAssetId(GameConfigAssetTypes.PASS, passIdOrKey)
 	if not gamepassId then
 		return Promise.rejected(("No asset with key %q"):format(tostring(passIdOrKey)))
 	end
@@ -199,21 +174,4 @@ function GameProductServiceClient:PromiseGamepassOrProductUnlockOrPrompt(passIdO
 		end)
 end
 
-
-function GameProductServiceClient:_toAssetId(assetType, assetIdOrKey)
-	assert(type(assetIdOrKey) == "number" or type(assetIdOrKey) == "string", "Bad assetIdOrKey")
-
-	if type(assetIdOrKey) == "string" then
-		local picker = self._gameConfigService:GetConfigPicker()
-		local asset = picker:FindFirstActiveAssetOfKey(assetType, assetIdOrKey)
-		if asset then
-			return asset:GetAssetId()
-		else
-			return nil
-		end
-	end
-
-	return assetIdOrKey
-end
-
 return GameProductServiceClient

package/src/Client/Manager/PlayerProductManagerClient.lua

@@ -11,6 +11,7 @@ local Players = game:GetService("Players")
 local PlayerProductManagerBase = require("PlayerProductManagerBase")
 local PlayerProductManagerConstants = require("PlayerProductManagerConstants")
 local GameConfigServiceClient = require("GameConfigServiceClient")
+local Promise = require("Promise")
 
 local PlayerProductManagerClient = setmetatable({}, PlayerProductManagerBase)
 PlayerProductManagerClient.ClassName = "PlayerProductManagerClient"
@@ -24,15 +25,40 @@ function PlayerProductManagerClient.new(obj, serviceBag)
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._gameConfigServiceClient = self._serviceBag:GetService(GameConfigServiceClient)
 
+
 	if self._obj == Players.LocalPlayer then
+		self._pendingPassPromises = {}
+
 		self:PromiseRemoteEvent():Then(function(remoteEvent)
 			self:_setupRemoteEventLocal(remoteEvent)
 		end)
+
+		self._maid:GiveTask(MarketplaceService.PromptGamePassPurchaseFinished:Connect(function(player, gamePassId, isPurchased)
+			if player == self._obj then
+				self:_handlePassFinished(player, gamePassId, isPurchased)
+			end
+		end))
 	end
 
 	return self
 end
 
+function PlayerProductManagerClient:PromptGamePassPurchase(gamePassId)
+	assert(type(gamePassId) == "number", "Bad gamePassId")
+	assert(self._obj == Players.LocalPlayer, "Can only prompt local player")
+
+	if self._pendingPassPromises[gamePassId] then
+		return self._maid:GivePromise(self._pendingPassPromises[gamePassId])
+	end
+
+	MarketplaceService:PromptGamePassPurchase(self._obj, gamePassId)
+	local promise = Promise.new()
+
+	self._pendingPassPromises[gamePassId] = promise
+
+	return self._maid:GivePromise(promise)
+end
+
 function PlayerProductManagerClient:_setupRemoteEventLocal(remoteEvent)
 	-- Gear and other assets
 	self._maid:GiveTask(MarketplaceService.PromptPurchaseFinished:Connect(function(player, assetId, isPurchased)
@@ -61,4 +87,23 @@ function PlayerProductManagerClient:GetConfigPicker()
 	return self._gameConfigServiceClient:GetConfigPicker()
 end
 
+function PlayerProductManagerClient:_handlePassFinished(player, gamePassId, isPurchased)
+	assert(typeof(player) == "Instance", "Bad player")
+	assert(type(gamePassId) == "number", "Bad gamePassId")
+	assert(type(isPurchased) == "boolean", "Bad isPurchased")
+
+	local promise = self._pendingPassPromises[gamePassId]
+	if promise then
+		if isPurchased then
+			-- TODO: verify this on the server here
+			-- Can we break cache?
+			self:SetPlayerOwnsPass(gamePassId, true)
+		end
+
+		self._pendingPassPromises[gamePassId] = nil
+		promise:Resolve(isPurchased)
+	end
+end
+
+
 return PlayerProductManagerClient

package/src/Server/Manager/PlayerProductManager.lua

@@ -119,8 +119,8 @@ function PlayerProductManager:_handlePassFinished(player, gamePassId, isPurchase
 			self:SetPlayerOwnsPass(gamePassId, true)
 		end
 
-		promise:Resolve(isPurchased)
 		self._pendingPassPromises[gamePassId] = nil
+		promise:Resolve(isPurchased)
 	end
 end
 
@@ -133,8 +133,8 @@ function PlayerProductManager:_handlePromptFinished(player, productId, isPurchas
 	if promise then
 		-- Success handled by receipt processing
 		if not isPurchased then
-			promise:Resolve(false)
 			self._pendingProductPromises[productId] = nil
+			promise:Resolve(false)
 		end
 	end
 end

package/src/Shared/GameProductServiceBase.lua

@@ -7,6 +7,9 @@ local require = require(script.Parent.loader).load(script)
 local promiseBoundClass = require("promiseBoundClass")
 local Rx = require("Rx")
 local RxBinderUtils = require("RxBinderUtils")
+local GameConfigAssetTypes = require("GameConfigAssetTypes")
+local Promise = require("Promise")
+local RxStateStackUtils = require("RxStateStackUtils")
 
 local GameProductServiceBase = {}
 GameProductServiceBase.ClassName = "GameProductServiceBase"
@@ -22,14 +25,45 @@ function GameProductServiceBase:GetPlayerProductManagerBinder()
 	error("Not implemented")
 end
 
-function GameProductServiceBase:ObservePlayerOwnsPass(player, gamePassId)
+function GameProductServiceBase:ObservePlayerOwnsPass(player, passIdOrKey)
 	assert(typeof(player) == "Instance", "Bad player")
-	assert(type(gamePassId) == "number", "Bad gamePassId")
+
+	if type(passIdOrKey) == "string" then
+		local picker = self._gameConfigService:GetConfigPicker()
+		return picker:ObserveActiveAssetOfAssetTypeAndKeyBrio(GameConfigAssetTypes.PASS, passIdOrKey)
+			:Pipe({
+				RxStateStackUtils.topOfStack();
+				Rx.switchMap(function(asset)
+					if asset then
+						return asset:ObserveAssetId()
+					else
+						return Rx.of(nil)
+					end
+				end);
+				Rx.switchMap(function(assetId)
+					if assetId then
+						return self:_observePlayerOwnsPassForId(player, assetId)
+					else
+						warn(("No pass with key %q"):format(tostring(passIdOrKey)))
+						return Rx.of(false)
+					end
+				end)
+			})
+	elseif type(passIdOrKey) == "number" then
+		return self:_observePlayerOwnsPassForId(player, passIdOrKey)
+	else
+		error("[GameProductServiceBase.ObservePlayerOwnsPass] - Bad passIdOrKey")
+	end
+end
+
+function GameProductServiceBase:_observePlayerOwnsPassForId(player, passId)
+	assert(typeof(player) == "Instance", "Bad player")
+	assert(type(passId) == "number", "Bad passId")
 
 	return self:_observeManager(player):Pipe({
 		Rx.switchMap(function(manager)
 			if manager then
-				return manager:ObservePlayerOwnsPass(gamePassId)
+				return manager:ObservePlayerOwnsPass(passId)
 			else
 				return Rx.of(false)
 			end
@@ -37,29 +71,44 @@ function GameProductServiceBase:ObservePlayerOwnsPass(player, gamePassId)
 	})
 end
 
-function GameProductServiceBase:PromisePlayerOwnsPass(player, gamePassId)
+function GameProductServiceBase:PromisePlayerOwnsPass(player, passIdOrKey)
 	assert(typeof(player) == "Instance", "Bad player")
-	assert(type(gamePassId) == "number", "Bad gamePassId")
+	assert(type(passIdOrKey) == "number" or type(passIdOrKey) == "string", "Bad passIdOrKey")
+
+	local passId = self:ToAssetId(GameConfigAssetTypes.PASS, passIdOrKey)
+	if not passId then
+		return Promise.rejected(("No pass with key %q"):format(tostring(passIdOrKey)))
+	end
 
 	return self:_promiseManager(player)
 		:Then(function(manager)
-			return manager:PromisePlayerOwnsPass(gamePassId)
+			return manager:PromisePlayerOwnsPass(passId)
 		end)
 end
 
-function GameProductServiceBase:PromptGamePassPurchase(player, gamePassId)
+function GameProductServiceBase:PromptGamePassPurchase(player, passIdOrKey)
 	assert(typeof(player) == "Instance", "Bad player")
-	assert(type(gamePassId) == "number", "Bad gamePassId")
+	assert(type(passIdOrKey) == "number" or type(passIdOrKey) == "string", "Bad passIdOrKey")
+
+	local passId = self:ToAssetId(GameConfigAssetTypes.PASS, passIdOrKey)
+	if not passId then
+		return Promise.rejected(("No pass with key %q"):format(tostring(passIdOrKey)))
+	end
 
 	return self:_promiseManager(player)
 		:Then(function(manager)
-			return manager:PromptGamePassPurchase(gamePassId)
+			return manager:PromptGamePassPurchase(passId)
 		end)
 end
 
-function GameProductServiceBase:PromisePromptPurchase(player, productId)
+function GameProductServiceBase:PromisePromptPurchase(player, productIdOrKey)
 	assert(typeof(player) == "Instance", "Bad player")
-	assert(type(productId) == "number", "Bad productId")
+	assert(type(productIdOrKey) == "number", "Bad productIdOrKey")
+
+	local productId = self:ToAssetId(GameConfigAssetTypes.PRODUCT, productIdOrKey)
+	if not productId then
+		return Promise.rejected(("No product with key %q"):format(tostring(productIdOrKey)))
+	end
 
 	return self:_promiseManager(player)
 		:Then(function(manager)
@@ -67,6 +116,21 @@ function GameProductServiceBase:PromisePromptPurchase(player, productId)
 		end)
 end
 
+function GameProductServiceBase:ToAssetId(assetType, assetIdOrKey)
+	assert(type(assetIdOrKey) == "number" or type(assetIdOrKey) == "string", "Bad assetIdOrKey")
+
+	if type(assetIdOrKey) == "string" then
+		local picker = self._gameConfigService:GetConfigPicker()
+		local asset = picker:FindFirstActiveAssetOfKey(assetType, assetIdOrKey)
+		if asset then
+			return asset:GetAssetId()
+		else
+			return nil
+		end
+	end
+
+	return assetIdOrKey
+end
 
 function GameProductServiceBase:_observeManager(player)
 	assert(typeof(player) == "Instance", "Bad player")
@@ -81,4 +145,5 @@ function GameProductServiceBase:_promiseManager(player)
 end
 
 
+
 return GameProductServiceBase

package/src/Shared/Manager/PlayerProductManagerUtils.lua

@@ -2,8 +2,6 @@
 	@class PlayerProductManagerUtils
 ]=]
 
-local require = require(script.Parent.loader).load(script)
-
 local PlayerProductManagerUtils = {}
 
 function PlayerProductManagerUtils.toOwnedAttribute(assetKey)