Add api permissions

plugin/src/HeadlessAPI.lua

@@ -1,22 +1,44 @@
+local MarketplaceService = game:GetService("MarketplaceService")
+
 local Parent = script:FindFirstAncestor("Rojo")
 local Plugin = Parent.Plugin
+local Packages = Parent.Packages
+
+local Log = require(Packages.Log)
 
 local Config = require(Plugin.Config)
 local Settings = require(Plugin.Settings)
 local ApiContext = require(Plugin.ApiContext)
 
+local cloudIdInfoCache = {}
+local apiPermissionAllowlist = {
+	Version = true,
+	ProtocolVersion = true,
+	RequestAccess = true,
+}
+
 local API  = {}
 
 function API.new(app)
 	local Rojo = {}
 
 	Rojo._notifRateLimit = {}
+	Rojo._permissions = Settings:get("apiPermissions") or {}
 	Rojo._changedEvent = Instance.new("BindableEvent")
+	Rojo._apiDescriptions = {}
 
 	Rojo.Changed = Rojo._changedEvent.Event
+	Rojo._apiDescriptions.Changed = "An event that fires when a headless API property changes"
+
 	Rojo.Connected = if app.serveSession then app.serveSession:getStatus() == "Connected" else false
+	Rojo._apiDescriptions.Connected = "Whether or not the plugin is connected to a Rojo server"
+
 	Rojo.Address = nil
+	Rojo._apiDescriptions.Address = "The address (host:port) that the plugin is connected to"
+
 	Rojo.ProjectName = nil
+	Rojo._apiDescriptions.ProjectName = "The name of the project that the plugin is connected to"
+
 	Rojo.Version = table.clone(Config.version)
 	Rojo.ProtocolVersion = Config.protocolVersion
 
@@ -26,59 +48,58 @@ function API.new(app)
 		Rojo._changedEvent:Fire(property, value, oldValue)
 	end
 
-	function Rojo:_getCallerFull()
+	function Rojo:_getCallerSource()
 		local traceback = string.split(debug.traceback(), "\n")
 		local topLevel = traceback[#traceback - 1]
 
-		local debugPlugin = string.match(topLevel, "^(PluginDebugService%.user_.-)%.")
-		if debugPlugin then
-			return debugPlugin
-		end
-
-		local localPlugin = string.match(topLevel, "^(user_.-)%.")
+		local localPlugin = string.match(topLevel, "(user_.-)%.")
 		if localPlugin then
 			return localPlugin
 		end
 
-		local cloudPlugin = string.match(topLevel, "(cloud_%d-%..-)%.")
+		local cloudPlugin = string.match(topLevel, "(cloud_%d-)%.")
 		if cloudPlugin then
 			return cloudPlugin
 		end
 
-		return "RobloxStudio.CommandBar"
+		return "RobloxStudio_CommandBar"
 	end
 
-	function Rojo:_getCaller()
+	function Rojo:_getCallerName()
 		local traceback = string.split(debug.traceback(), "\n")
 		local topLevel = traceback[#traceback - 1]
 
-		local debugPlugin = string.match(topLevel, "^PluginDebugService%.user_(.-)%.")
-		if debugPlugin then
-			return debugPlugin
-		end
-
-		local localPlugin = string.match(topLevel, "^user_(.-)%.")
+		local localPlugin = string.match(topLevel, "user_(.-)%.")
 		if localPlugin then
 			return localPlugin
 		end
 
-		local cloudPlugin = string.match(topLevel, "cloud_%d-%.(.-)%.")
-		if cloudPlugin then
-			return cloudPlugin
+		local cloudId, cloudInstance = string.match(topLevel, "cloud_(%d-)%.(.-)%.")
+		if cloudId then
+			local info = cloudIdInfoCache[cloudId]
+			if info then
+				return info.Name .. " by " .. info.Creator.Name
+			else
+				local success, newInfo = pcall(MarketplaceService.GetProductInfo, MarketplaceService, tonumber(cloudId), Enum.InfoType.Asset)
+				if success then
+					cloudIdInfoCache[cloudId] = newInfo
+					return newInfo.Name .. " by " .. newInfo.Creator.Name
+				end
+			end
+
+			-- Fallback to the name of the instance uploaded inside this plugin
+			-- The reason this is not ideal is because creators often upload a folder named "Main" or something
+			return cloudInstance
 		end
 
-		return "CommandBar"
+		return "Command Bar"
 	end
 
 	function Rojo:_getCallerType()
 		local traceback = string.split(debug.traceback(), "\n")
 		local topLevel = traceback[#traceback - 1]
 
-		if string.find(topLevel, "^PluginDebugService%.user_") then
-			return "Debug"
-		end
-
-		if string.find(topLevel, "^user_") then
+		if string.find(topLevel, "user_") then
 			return "Local"
 		end
 
@@ -89,28 +110,95 @@ function API.new(app)
 		return "CommandBar"
 	end
 
-	function Rojo:Test(...)
-		print("Rojo:Test called by", Rojo:_getCaller(), "with args", ...)
+	function Rojo:_permissionCheck(key: string): boolean
+		if apiPermissionAllowlist[key] then return true end
+
+		local source = Rojo:_getCallerSource()
+		if Rojo._permissions[source] == nil then
+			Rojo._permissions[source] = {}
+		end
+
+		return not not Rojo._permissions[source][key]
 	end
 
+	function Rojo:RequestAccess(apis: {string}): {[string]: boolean}
+		local source, name = Rojo:_getCallerSource(), Rojo:_getCallerName()
+
+		if Rojo._permissions[source] == nil then
+			Rojo._permissions[source] = {}
+		end
+
+		local alreadyAllowed = true
+		for _, api in apis do
+			if not Rojo._permissions[source][api] then
+				alreadyAllowed = false
+				break
+			end
+		end
+
+		if alreadyAllowed then
+			local response = {}
+			for _, api in apis do
+				response[api] = true
+			end
+			return response
+		end
+
+		local response = app:requestPermission(source, name, apis, Rojo._permissions[source])
+
+		for api, granted in response do
+			Log.warn(string.format(
+				"%s Rojo.%s for '%s'",
+				granted and "Granting permission to" or "Denying permission to", api, name
+			))
+			Rojo._permissions[source][api] = granted
+		end
+		Settings:set("apiPermissions", Rojo._permissions)
+
+		return response
+	end
+
+	function Rojo:Test(...)
+		local args = table.pack(...)
+		for i=1, args.n do
+			local v = args[i]
+			local t = type(v)
+			if t == "string" then
+				args[i] = string.format("%q", v)
+			else
+				args[i] = tostring(v)
+			end
+		end
+
+		print(string.format(
+			"Rojo:Test(%s) called from '%s'",
+			table.concat(args, ", "), Rojo:_getCallerName()
+		))
+	end
+	Rojo._apiDescriptions.Test = "Prints the given arguments to the console"
+
 	function Rojo:ConnectAsync(host: string?, port: number?)
 		app:startSession(host, port)
 	end
+	Rojo._apiDescriptions.ConnectAsync = "Connects to a Rojo server"
 
 	function Rojo:DisconnectAsync()
 		app:endSession()
 	end
+	Rojo._apiDescriptions.DisconnectAsync = "Disconnects from the Rojo server"
 
 	function Rojo:GetSetting(setting: string): any
 		return Settings:get(setting)
 	end
+	Rojo._apiDescriptions.GetSetting = "Gets a Rojo setting"
 
 	function Rojo:SetSetting(setting: string, value: any)
 		return Settings:set(setting, value)
 	end
+	Rojo._apiDescriptions.SetSetting = "Sets a Rojo setting"
 
 	function Rojo:Notify(msg: string, timeout: number?)
-		local source = Rojo:_getCallerFull()
+		local source = Rojo:_getCallerSource()
 
 		if Rojo._notifRateLimit[source] == nil then
 			Rojo._notifRateLimit[source] = 0
@@ -123,23 +211,37 @@ function API.new(app)
 			Rojo._notifRateLimit[source] -= 1
 		end)
 
-		app:addThirdPartyNotification(Rojo:_getCaller(), msg, timeout)
+		app:addThirdPartyNotification(Rojo:_getCallerName(), msg, timeout)
 		return
 	end
+	Rojo._apiDescriptions.Notify = "Shows a notification in the Rojo UI"
 
 	function Rojo:GetHostAndPort(): (string, string)
 		return app:getHostAndPort()
 	end
+	Rojo._apiDescriptions.GetHostAndPort = "Gets the host and port that Rojo is set to"
 
 	function Rojo:CreateApiContext(baseUrl: string)
 		return ApiContext.new(baseUrl)
 	end
+	Rojo._apiDescriptions.CreateApiContext = "Creates a new API context"
 
 	local ReadOnly = setmetatable({}, {
 		__index = function(_, key)
+			-- Don't expose private members
 			if string.find(key, "^_") then
-				return nil -- Don't expose private members
+				return nil
 			end
+
+			-- Permissions check
+			local granted = Rojo:_permissionCheck(key)
+			if not granted then
+				error(string.format(
+					"Attempted to read Rojo.%s, but the plugin does not have permission to do so.\nPlease first use Rojo:RequestAccess({ \"%s\" }) to gain access to this API.",
+					key, key
+				), 2)
+			end
+
 			return Rojo[key]
 		end,
 		__newindex = function(_, key, value)