Merge pull request #29 from metrik-tech/feature/ENG-174

feature/eng 174: Look into simplifying the Metrik API to remove the .Server call

Author: 4x8Matrix

Src/Server.luau

@@ -13,6 +13,8 @@ local Error = require(script.Parent.Enums.Error)
 local ErrorFormats = require(script.Parent.Data.ErrorFormats)
 local ApiPaths = require(script.Parent.Data.ApiPaths)
 
+local GetScriptFromFullName = require(script.Parent.Util.GetScriptFromFullName)
+
 local ActionBuilder = require(script.Parent.API.ActionBuilder)
 
 local ApiService = require(script.Parent.Services.ApiService)
@@ -51,6 +53,30 @@ function MetrikSDK.Private.FromError(_: MetrikPrivateAPI, errorEnum: string, ...
 	return string.format(ErrorFormats[errorEnum], ...)
 end
 
+function MetrikSDK.Private.GetCallingScript(_: MetrikPrivateAPI)
+	local level = 3
+	
+	while true do
+		local source = debug.info(level, "s")
+
+		if not source then
+			return nil
+		end
+
+		local instance = GetScriptFromFullName(source)
+
+		if not instance then
+			return nil
+		end
+
+		if instance:IsDescendantOf(script.Parent) or instance == script.Parent then
+			level += 1
+		else
+			return source
+		end
+	end
+end
+
 --[=[
 	...
 
@@ -61,7 +87,7 @@ end
 ]=]
 --
 function MetrikSDK.Public.CreateBreadcrumb(self: MetrikPublicAPI, message: string)
-	BreadcrumbService:CreateBreadcrumbFor(debug.info(2, "s"), message)
+	BreadcrumbService:CreateBreadcrumbFor(self.Private:GetCallingScript(), message)
 end
 
 --[=[
@@ -74,7 +100,7 @@ end
 ]=]
 --
 function MetrikSDK.Public.SetContext(self: MetrikPublicAPI, context: { [string]: any })
-	ContextService:CreateContextFor(debug.info(2, "s"), context)
+	ContextService:CreateContextFor(self.Private:GetCallingScript(), context)
 end
 
 --[=[

Src/init.luau

@@ -1,5 +1,10 @@
 local RunService = game:GetService("RunService")
 
+--[=[
+	@class MetrikSDK
+
+	The MetrikSDK class is the main entry point for interacting with the Metrik backend.
+]=]
 local MetrikSDK = {}
 
 if not RunService:IsRunning() then
@@ -12,4 +17,49 @@ else
 	end
 end
 
+function MetrikSDK.InitializeAsync(self: MetrikSDK, settings: {
+	projectId: string,
+	authenticationSecret: Secret
+}?)
+	if MetrikSDK.Server then
+		MetrikSDK.Server:InitializeAsync(settings)
+	else
+		MetrikSDK.Client:InitializeAsync()
+	end
+end
+
+function MetrikSDK.GetFlag(self: MetrikSDK, flagName: string)
+	if MetrikSDK.Server then
+		MetrikSDK.Server:GetFlag(flagName)
+	else
+		MetrikSDK.Client:GetFlag(flagName)
+	end
+end
+
+function MetrikSDK.IsServerUpToDate(self: MetrikSDK)
+	if MetrikSDK.Server then
+		MetrikSDK.Server:IsServerUpToDate()
+	else
+		error(`MetrikSDK.IsServerUpToDate() is not available on the client.`)
+	end
+end
+
+function MetrikSDK.CreateBreadcrumb(self: MetrikSDK, message: string)
+	if MetrikSDK.Server then
+		MetrikSDK.Server:CreateBreadcrumb(message)
+	else
+		MetrikSDK.Client:CreateBreadcrumb(message)
+	end
+end
+
+function MetrikSDK.SetContext(self: MetrikSDK, context: { [string]: any })
+	if MetrikSDK.Server then
+		MetrikSDK.Server:SetContext(context)
+	else
+		MetrikSDK.Client:SetContext(context)
+	end
+end
+
+export type MetrikSDK = typeof(MetrikSDK)
+
 return MetrikSDK

Tests/Development.server.luau

@@ -5,27 +5,12 @@ local RunService = game:GetService("RunService")
 
 local MetrikSDK = require(ReplicatedStorage.MetrikSDK)
 
-MetrikSDK.Server:InitializeAsync({
+MetrikSDK:InitializeAsync({
 	projectId = ServerStorage.__Project_Id.Value,
 	authenticationSecret = RunService:IsStudio() and ServerStorage.__Project_Auth.Value
 		or HttpService:GetSecret("metrik_token")
 }):andThen(function()
 	warn("Metrik SDK loaded!")
-
-	local action = MetrikSDK.Server.ActionBuilder.new()
-		:SetName("Hello World")
-		:SetDescription("Prints 'Hello, World' with an option for another message")
-		:AddArgument("Message", {
-			Required = true,
-			Type = "string",
-		})
-		:Build()
-
-	function action:OnRun(message: string)
-		print("Hello, World")
-
-		print(message)
-	end
 end):catch(function(exception)
 	warn("Metrik SDK failed: ", exception)
 end)