@quenty/funnels 1.0.1-canary.522.1d2faf4.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.0.1-canary.522.1d2faf4.0 (2024-12-03)
+
+
+### Features
+
+* Add funnels helper package ([4dffc3c](https://github.com/Quenty/NevermoreEngine/commit/4dffc3ce700ff6f750cf5483d4a6fb95ebc1c80a))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2024 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 @@
+## Funnels
+
+<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>
+
+Funnel utility class
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/RecurringFunnel">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/funnels --save
+```

package/default.project.json

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

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@quenty/funnels",
+  "version": "1.0.1-canary.522.1d2faf4.0",
+  "description": "Funnel utility class",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "funnels"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/funnels/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/adorneedata": "7.14.1-canary.522.1d2faf4.0",
+    "@quenty/baseobject": "10.7.1",
+    "@quenty/binder": "14.15.1-canary.522.1d2faf4.0",
+    "@quenty/loader": "10.7.1",
+    "@quenty/propertyvalue": "7.13.1-canary.522.1d2faf4.0",
+    "@quenty/servicebag": "11.10.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "1d2faf48e778ada6f57aecb8000c7c6c76ac33cd"
+}

package/src/Server/Steps/FunnelStepLogger.lua

@@ -0,0 +1,66 @@
+--[=[
+	Server-side funnel logger
+
+	@class FunnelStepLogger
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local AnalyticsService = game:GetService("AnalyticsService")
+local HttpService = game:GetService("HttpService")
+
+local BaseObject = require("BaseObject")
+local FunnelStepTracker = require("FunnelStepTracker")
+
+local FunnelStepLogger = setmetatable({}, BaseObject)
+FunnelStepLogger.ClassName = "FunnelStepLogger"
+FunnelStepLogger.__index = FunnelStepLogger
+
+function FunnelStepLogger.new(player, funnelName)
+	local self = setmetatable(BaseObject.new(), FunnelStepLogger)
+
+	self._player = assert(player, "No player")
+	self._stepTracker = self._maid:Add(FunnelStepTracker.new())
+	self._funnelName = assert(funnelName, "Bad funnelName")
+	self._funnelSessionId = HttpService:GenerateGUID(false)
+	self._printDebugEnabled = false
+
+	local steps = self._stepTracker:GetLoggedSteps()
+	if next(steps) then
+		-- Give us time to print if we need
+		self._maid:GiveTask(task.defer(function()
+			for stepNumber, stepName in pairs(steps) do
+				self:_sendStep(stepNumber, stepName)
+			end
+		end))
+	end
+
+	self._maid:GiveTask(self._stepTracker.StepLogged:Connect(function(stepNumber, stepName)
+		self:_sendStep(stepNumber, stepName)
+	end))
+
+	return self
+end
+
+function FunnelStepLogger:SetPrintDebugEnabled(debugEnabled)
+	assert(type(debugEnabled) == "boolean", "Bad debugEnabled")
+
+	self._printDebugEnabled = debugEnabled
+end
+
+function FunnelStepLogger:LogStep(stepNumber, stepName)
+	assert(type(stepNumber) == "number", "Bad stepNumber")
+	assert(type(stepName) == "string", "Bad stepName")
+
+	self._stepTracker:LogStep(stepNumber, stepName)
+end
+
+function FunnelStepLogger:_sendStep(stepNumber, stepName)
+	AnalyticsService:LogFunnelStepEvent(self._player, self._funnelName, self._funnelSessionId, stepNumber, stepName)
+
+	if self._printDebugEnabled then
+		print(string.format("%s - %d - %s", self._funnelName, stepNumber, stepName))
+	end
+end
+
+return FunnelStepLogger

package/src/Shared/Steps/FunnelStepTracker.lua

@@ -0,0 +1,49 @@
+--[=[
+	@class FunnelStepTracker
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Signal = require("Signal")
+local BaseObject = require("BaseObject")
+
+local FunnelStepTracker = setmetatable({}, BaseObject)
+FunnelStepTracker.ClassName = "FunnelStepTracker"
+FunnelStepTracker.__index = FunnelStepTracker
+
+function FunnelStepTracker.new()
+	local self = setmetatable(BaseObject.new(), FunnelStepTracker)
+
+	self._stepsLogged = {}
+
+	self.StepLogged = self._maid:Add(Signal.new())
+
+	return self
+end
+
+function FunnelStepTracker:LogStep(stepNumber, stepName)
+	assert(type(stepNumber) == "number", "Bad stepNumber")
+	assert(type(stepName) == "string", "Bad stepName")
+
+	if self._stepsLogged[stepNumber] then
+		if self._stepsLogged[stepNumber] ~= stepName then
+			error(string.format("[FunnelStepTracker.LogStep] - Trying to log step with 2 separate names, %q and %q", self._stepsLogged[stepNumber], stepNumber))
+		end
+
+		return
+	end
+
+	self._stepsLogged[stepNumber] = stepName
+
+	self.StepLogged:Fire(stepNumber, stepName)
+end
+
+function FunnelStepTracker:GetLoggedSteps()
+	return table.clone(self._stepsLogged)
+end
+
+function FunnelStepTracker:ClearLoggedSteps()
+	table.clear(self._stepsLogged)
+end
+
+return FunnelStepTracker

package/src/node_modules.project.json

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

package/test/default.project.json

@@ -0,0 +1,12 @@
+{
+  "name": "FunnelsTest",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "funnels": {
+        "$path": ".."
+      }
+    }
+  }
+}