@quenty/textserviceutils 7.5.0 → 7.6.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.
 
+# [7.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/textserviceutils@7.5.0...@quenty/textserviceutils@7.6.0) (2022-12-27)
+
+
+### Features
+
+* Add TextServiceUtils.promiseTextBounds with a workaround for Roblox cancelling certain calls in weird ways. ([9f91df0](https://github.com/Quenty/NevermoreEngine/commit/9f91df0ddf8edcac7c68945b22772a964621a5fa))
+
+
+
+
+
 # [7.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/textserviceutils@7.4.0...@quenty/textserviceutils@7.5.0) (2022-12-05)
 
 **Note:** Version bump only for package @quenty/textserviceutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/textserviceutils",
-  "version": "7.5.0",
+  "version": "7.6.0",
   "description": "Holds utilities involving the Roblox TextService and text fitting to size.",
   "keywords": [
     "Roblox",
@@ -32,7 +32,8 @@
   "dependencies": {
     "@quenty/blend": "^6.5.0",
     "@quenty/loader": "^6.0.1",
+    "@quenty/promise": "^6.0.1",
     "@quenty/rx": "^7.2.0"
   },
-  "gitHead": "3040397f5f4601886ca7a1f664be7019b3941618"
+  "gitHead": "a4f99aa40c45080db30be7117cada229572f1574"
 }

package/src/Shared/TextServiceUtils.lua

@@ -7,9 +7,23 @@ local TextService = game:GetService("TextService")
 local require = require(script.Parent.loader).load(script)
 
 local Blend = require("Blend")
+local Promise = require("Promise")
+local Rx = require("Rx")
 
 local TextServiceUtils = {}
 
+--[=[
+	Gets the size for the label using legacy API surface.
+
+	:::warning
+	This will not handle new font faces well.
+	:::
+
+	@param textLabel TextLabel
+	@param text string
+	@param maxWidth number
+	@return Promise<Vector2>
+]=]
 function TextServiceUtils.getSizeForLabel(textLabel, text, maxWidth)
 	assert(typeof(textLabel) == "Instance", "Bad textLabel")
 	assert(type(text) == "string", "Bad text")
@@ -20,17 +34,139 @@ function TextServiceUtils.getSizeForLabel(textLabel, text, maxWidth)
 	return TextService:GetTextSize(text, textLabel.TextSize, textLabel.Font, Vector2.new(maxWidth, 1e6))
 end
 
+local lastPromise = nil
+
+--[=[
+	Promises the text bounds for the given parameters
+
+	@param params GetTextBoundsParams
+	@return Promise<Vector2>
+]=]
+function TextServiceUtils.promiseTextBounds(params)
+	assert(typeof(params) == "Instance" and params:IsA("GetTextBoundsParams"), "Bad params")
+
+	-- https://devforum.roblox.com/t/calling-textservicegettextboundsasync-multiple-times-leads-to-requests-never-completing-thread-leaks/2083178
+	-- This is a hack to work around a Roblox bug.
+	local promise
+	if lastPromise then
+		promise = lastPromise:Finally(function()
+			return Promise.defer(function(resolve, reject)
+				resolve(TextServiceUtils._promiseTextBounds(params))
+
+				-- We don't want everything breaking
+				task.delay(5, function()
+					reject("Timed out")
+				end)
+			end)
+		end)
+	else
+		promise = TextServiceUtils._promiseTextBounds(params)
+
+		-- We don't want everything breaking
+		task.delay(5, function()
+			promise:Reject("Timed out")
+		end)
+	end
+
+
+	-- Store this so we act as a queue :)
+	lastPromise = promise
+
+	-- Clean up
+	promise:Finally(function()
+		task.defer(function()
+			if lastPromise == promise then
+				lastPromise = nil
+			end
+		end)
+	end)
+
+	return promise
+end
+
+function TextServiceUtils._promiseTextBounds(params)
+	assert(typeof(params) == "Instance" and params:IsA("GetTextBoundsParams"), "Bad params")
+
+	return Promise.spawn(function(resolve, reject)
+		local size
+		local ok, err = pcall(function()
+			size = TextService:GetTextBoundsAsync(params)
+		end)
+
+		if not ok then
+			return reject(err)
+		end
+
+		return resolve(size)
+	end)
+end
+
+--[=[
+	Observes the current size for the current props. The properties
+	can be anything [Blend] would accept as an input. If FontFace is defined,
+	it will be used before Font. The following properties are available:
+
+	* `Text` - string
+	* `TextSize` - number
+	* `Font` - [Enum.Font]
+	* `FontFace` [Font]
+	* `MaxSize` - [Vector2]
+	* `LineHeight` - number
+
+	```lua
+	local stringValue = Instance.new("StringValue")
+	stringValue.Text = "Hello"
+
+	local observe = TextServiceUtils.observeSizeForLabelProps({
+		Text = stringValue;
+		Font = Enum.Font.;
+		MaxSize = Vector2.new(250, 100);
+		TextSize = 24;
+	})
+
+	-- Be sure to clean up the subscription
+	observe:Subscribe(function(size)
+		print(size)
+	end)
+
+	```
+
+	@param props table
+	@return Observable<Vector2> -- The text bounds reported
+]=]
 function TextServiceUtils.observeSizeForLabelProps(props)
 	assert(props.Text, "Bad props.Text")
 	assert(props.TextSize, "Bad props.TextSize")
-	assert(props.Font, "Bad props.Font")
 
-	return Blend.Computed(props.Text, props.TextSize, props.Font, props.MaxSize or Vector2.new(1e6, 1e6), props.LineHeight or 1,
-		function(text, textSize, font, maxSize, lineHeight)
-			local size = TextService:GetTextSize(text, textSize, font, maxSize)
+	if not (props.Font or props.FontFace) then
+		error("Bad props.Font or props.FontFace")
+	end
+
+	return Rx.combineLatest({
+		Text = Blend.toPropertyObservable(props.Text) or props.Text,
+		TextSize = Blend.toPropertyObservable(props.TextSize) or props.TextSize,
+		Font = Blend.toPropertyObservable(props.Font) or props.Font,
+		FontFace = Blend.toPropertyObservable(props.FontFace) or props.FontFace,
+		MaxSize = Blend.toPropertyObservable(props.MaxSize) or props.MaxSize or Vector2.new(1e6, 1e6),
+		LineHeight = Blend.toPropertyObservable(props.LineHeight) or 1,
+	}):Pipe({
+		Rx.switchMap(function(state)
+			if typeof(state.FontFace) == "Font" then
+				-- Yes, our font may have to stream in
+				local params = Instance.new("GetTextBoundsParams")
+				params.Text = state.Text
+				params.Size = state.TextSize
+				params.Font = state.Font
+				params.Width = state.MaxSize.x
+
+				return Rx.fromPromise(TextServiceUtils.promiseTextBounds(params))
+			elseif typeof(state.Font) == "EnumItem" then
+				local size = TextService:GetTextSize(state.Text, state.TextSize, state.Font, state.MaxSize)
 
-			return Vector2.new(size.x, lineHeight*size.y)
+				return Rx.of(Vector2.new(size.x, state.LineHeight*size.y))
+			end
 		end)
+	})
 end
 
 return TextServiceUtils