@quenty/receiptprocessing 1.1.0-canary.4b70f6d.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.1.0-canary.4b70f6d.0 (2023-04-20)
+
+
+### Features
+
+* Add ReceiptProcessing ([6590e0f](https://github.com/Quenty/NevermoreEngine/commit/6590e0fbb091956f903ddebc3110e4f86ec020d1))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2023 James Onnen (Quenty)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+## ReceiptProcessing
+
+<div align="center">
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
+  </a>
+  <a href="https://discord.gg/mhtGUS8">
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
+  </a>
+  <a href="https://github.com/Quenty/NevermoreEngine/actions">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
+  </a>
+</div>
+
+Centralize receipt processing within games since this is a constrained resource.
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ReceiptProcessingUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/receiptprocessing --save
+```

package/default.project.json

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

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@quenty/receiptprocessing",
+  "version": "1.1.0-canary.4b70f6d.0",
+  "description": "Centralize receipt processing within games since this is a constrained resource.",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "receiptprocessing"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/receiptprocessing/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/enumutils": "3.1.0",
+    "@quenty/loader": "6.2.1",
+    "@quenty/maid": "2.5.0",
+    "@quenty/promise": "6.5.0",
+    "@quenty/servicebag": "6.6.1",
+    "@quenty/signal": "2.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "4b70f6d72cee9393c70b1ce17e78d8e63771ac3c"
+}

package/src/Server/ReceiptProcessingService.lua

@@ -0,0 +1,120 @@
+--[=[
+	Centralize receipt processing within games since this is a constrained resource.
+
+	@class ReceiptProcessingService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local MarketplaceService = game:GetService("MarketplaceService")
+
+local Promise = require("Promise")
+local EnumUtils = require("EnumUtils")
+local Signal = require("Signal")
+local Maid = require("Maid")
+
+local ReceiptProcessingService = {}
+ReceiptProcessingService.ServiceName = "ReceiptProcessingService"
+
+function ReceiptProcessingService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	self.ReceiptCreated = Signal.new() -- :Fire(receiptInfo)
+	self._maid:GiveTask(self.ReceiptCreated)
+
+	self.ReceiptProcessed = Signal.new() -- :Fire(receiptInfo, productPurchaseDecision)
+	self._maid:GiveTask(self.ReceiptProcessed)
+
+	self._processors = {}
+end
+
+function ReceiptProcessingService:Start()
+	MarketplaceService.ProcessReceipt = function(...)
+		return self:_handleProcessReceiptAsync(...)
+	end
+end
+
+--[=[
+	Registers a new receipt processor. This works exactly like a normal receipt processor except it will also
+	take a Promise as a result (of which an error).
+
+	@param processor (receiptInfo) -> ProductPurchaseDecision | Promise<ProductPurchaseDecision> | nil
+	@param priority number
+]=]
+function ReceiptProcessingService:RegisterReceiptProcessor(processor, priority)
+	assert(self._processors, "Not initialized")
+	assert(type(processor) == "function", "Bad processor")
+	priority = priority or 0
+
+	local data = {
+		traceback = debug.traceback();
+		priority = priority;
+		timestamp = os.clock();
+		processor = processor;
+	}
+
+	table.insert(self._processors, data)
+	table.sort(self._processors, function(a, b)
+		if a.priority ~= b.priority then
+			-- larger priority first
+			return a.priority > b.priority
+		else
+			-- earlier first
+			return a.timestamp < b.timestamp
+		end
+	end)
+
+	return function()
+		local index = table.find(self._handles, data)
+		if index then
+			table.remove(self._handles, data)
+		end
+	end
+end
+
+function ReceiptProcessingService:_handleProcessReceiptAsync(receiptInfo)
+	if not self._processors then
+		warn("[ReceiptProcessingService._handleProcessReceiptAsync] - We're leaking memory. Receipt processing service is already cleaned up.")
+		return Enum.ProductPurchaseDecision.NotProcessedYet
+	end
+
+	self.ReceiptCreated:Fire(receiptInfo)
+
+	-- Chain of command this thing
+	for _, data in pairs(self._processors) do
+		local result = data.processor(receiptInfo)
+
+		-- Unpack pro
+		if Promise.isPromise(result) then
+			local ok, promiseResult = result:Yield()
+			if not ok then
+				warn(string.format("[ReceiptProcessingService._handleProcessReceiptAsync] - Promise failed with %q.\n%s", tostring(promiseResult), data.traceback))
+				continue
+			end
+
+			result = promiseResult
+		end
+
+		if EnumUtils.isOfType(Enum.ProductPurchaseDecision, result) then
+			self.ReceiptProcessed:Fire(receiptInfo, result)
+			return result
+		elseif result == nil then
+			continue
+		else
+			warn(string.format("[ReceiptProcessingService._handleProcessReceiptAsync] - Got unexpected result of type %q from receiptInfo.\n%s", typeof(result), data.traceback))
+		end
+	end
+
+	-- Retry in the future
+	self.ReceiptProcessed:Fire(receiptInfo, Enum.ProductPurchaseDecision.NotProcessedYet)
+	return Enum.ProductPurchaseDecision.NotProcessedYet
+end
+
+function ReceiptProcessingService:Destroy()
+	self._maid:DoCleaning()
+	self._processors = nil
+end
+
+return ReceiptProcessingService

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}